Publish Message activity

An activity that publishes a message to a topic in Amazon SNS.


Publish Message activity

Configure the Publish Message activity

Examples

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Amazon SNS tab.

    Open Amazon SNS tab
  3. On the Amazon SNS tab, drag the Publish Message activity onto your process.

    Drag Publish Message activity

General Configuration

Specifies the basic settings for the Publish Message activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Publish Message Configuration > Message Body tab

Specifies the content of the message to publish to a topic in Amazon SNS.

Figure: Publish Message Configuration > Message Body tab

Publish Message Configuration Message Body tab

Fields

Field NameDefinition

Amazon Web Services

Description:
Specifies the access token that connects to your Amazon Web Services.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon

Opens this Screen:
Access Token for Amazon Web Services
Function of this Screen:
Configure an access token to connect to Amazon Web Services.

Topic ARN

Description:
Specifies the Amazon Resource Name (ARN) of the topic to publish the message.

The topic ARN comes from Amazon SNS.

Allowed Values:
A topic ARN from Amazon SNS.

When you select the access token from the Amazon Web Service field, this field shows the topic ARNs associated with the access token.

Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Subject

Description:
Specifies the subject line for the message.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:

Identical Payload / Custom Payload

Description:
Specifies whether to customize the message to publish for each endpoint type.
Allowed Values:
  • Identical Payload – Publishes the same message to all subscribers, regardless of the subscribed endpoint type.
  • Custom Payload – Configures the message for each endpoint type.
Default Value:
Identical Payload
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Payload

Description:
Specifies the content of the message to send to all subscribers.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Endpoint

Description:
Specifies an endpoint type to which to send the message.

You must enter the message in the Message field to send to the subscribed endpoints associated with the endpoint type specified in this field.

To Open this Field:
  1. In the Identical Payload / Custom Payload field, Select Custom Payload.
Allowed Values:
An endpoint type from the list.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Message

Description:
Specifies the content of the message for the endpoint.
To Open this Field:
  1. In the Identical Payload / Custom Payload field, Select Custom Payload.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Create Add Token icon

Function:
Adds a row for the Endpoint and Message fields.

Delete Delete icon

Function:
Deletes the row.

Store Response Message ID In This Variable (String)

Description:
Specifies a variable to store the ID of the published message.

The message ID comes from Amazon SNS.

Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers
  • Special characters

Not Accepted:

  • Spaces
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Publish Message Configuration > Message Attributes tab

Configures the attributes for the message to publish in Amazon SNS.

Figure: Publish Message Configuration > Message Attributes tab

Publish Message Configuration Message Attributes tab

Fields

Field NameDefinition

Amazon Web Services

Description:
Specifies the access token that connects to your Amazon Web Services.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon

Opens this Screen:
Access Token for Amazon Web Services
Function of this Screen:
Configure an access token to connect to Amazon Web Services.

Topic ARN

Description:
Specifies the Amazon Resource Name (ARN) of the topic to publish the message.

The topic ARN comes from Amazon SNS.

Allowed Values:
A topic ARN from Amazon SNS.

When you select the access token from the Amazon Web Service field, this field shows the topic ARNs associated with the access token.

Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Subject

Description:
Specifies the subject line for the message.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:

Type

Description:
Specifies the type of attibute to add as metadata to the message in a key-value pair.
Allowed Values:
An attribute type from the list.
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Name

Description:
Specifies the name of the attibute to add as metadata to the message in a key-value pair.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Hyphens (-)
  • Underscores (_)

Not Accepted:

  • Spaces
  • Other special characters
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Value

Description:
Specifies the value of the attibute in a key-value pair.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Create Add Token icon

Function:
Adds a row for the Type, Name, and Value fields.

Delete Delete icon

Function:
Deletes the selected row.

Store Response Message ID In This Variable (String)

Description:
Specifies a variable to store the ID of the published message.

The message ID comes from Amazon SNS.

Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers
  • Special characters

Not Accepted:

  • Spaces
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?