Publish Event activity

An activity that publishs an event to one or more topics in Apache Kafka.

Configure the Publish Event activity

Examples

(External) AgilePoint NX Connector For Apache Kafka
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.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Apache Kafka tab.
On the Apache Kafka tab, drag the Publish Event activity onto your process.

General Configuration

Specifies the basic settings for the Publish Event activity.

Good to Know

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

Fields

Field Name	Definition
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

Field Name

Definition

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:

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 Event Configuration > Event tab

Specifies the configuration to publish an event to one or more topics in Apache Kafka.

Fields

Field Name	Definition
Apache Kafka	Description: Specifies the access token that connects to your Apache Kafka service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access tokens for Apache Kafka Function of this Screen: Configure an access token to connect to Apache Kafka..
Topic	Description: Specifies one or more topics to store the event in Apache Kafka. Allowed Values: A topic name from the list. When you select the access token from the Apache Kafka field, this field shows the topics associated with the access token. One or more topic names, separated by semicolons (;). 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?
Auto Create Topic	Description: Specifies whether to create the topics if they do not exist in Apache Kafka. This field only creates the topics that are specified in the Topic field. Allowed Values: Use Server Default - The Apache Kafka server decides whether to create a topic for the event. It throws an error if the topic is not created. Yes - Creates a new topic if the specified topic does not exist. No - Does not create a new topic if the specified topic does not exist, and throws an error. Default Value: Use Server Default 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?
Key	Description: Specifies an unique identifier for the event you publish in Apache Kafka. Allowed Values: One line of text (a 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?
Content Type	Description: Specifies the format of the event to publish. Allowed Values: JSON Text XML Default Value: None
Map Payload To App Schema / Read Event From This Variable	Description: Specifies how to publish the event to a topic in Apache Kafka. Allowed Values: Map Payload To App Schema - Specifies a payload to publish an event. In the text field, specify a payload in JSON or XML format. Click Map Schema button to open the Schema Mapper screen. Use this screen to connect the values in the payload to your AgilePoint process schema. Read Event From This Variable - Select this option if you want to publish an event from a variable in the AgilePoint NX app. In the text field, specify a variable that stores the event. Default Value: Map Payload To App Schema 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 Event Configuration > Advanced tab

Configures the headers for the event that is published in Apache Kafka.

Fields

Field Name	Definition
Apache Kafka	Description: Specifies the access token that connects to your Apache Kafka service. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access tokens for Apache Kafka Function of this Screen: Configure an access token to connect to Apache Kafka..
Topic	Description: Specifies one or more topics to store the event in Apache Kafka. Allowed Values: A topic name from the list. When you select the access token from the Apache Kafka field, this field shows the topics associated with the access token. One or more topic names, separated by semicolons (;). 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?
Auto Create Topic	Description: Specifies whether to create the topics if they do not exist in Apache Kafka. This field only creates the topics that are specified in the Topic field. Allowed Values: Use Server Default - The Apache Kafka server decides whether to create a topic for the event. It throws an error if the topic is not created. Yes - Creates a new topic if the specified topic does not exist. No - Does not create a new topic if the specified topic does not exist, and throws an error. Default Value: Use Server Default 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?
Key	Description: Specifies an unique identifier for the event you publish in Apache Kafka. Allowed Values: One line of text (a 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?
Header Name	Description: Specifies the name of the header to add to the event 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 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?
Header Value	Description: Specifies the value for the header 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 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	Function: Adds a row for the Header Name and Header Value.
Delete	Function: Deletes the selected row.