Read Event activity

An activity that reads an event from Apache Kafka.


Read Event activity

Configure the Read Event 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 Apache Kafka tab.

    Open Apache Kafka tab
  3. On the Apache Kafka tab, drag the Read Event activity onto your process.

    Drag Read Event activity

General Configuration

Specifies the basic settings for the Read Event 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

Read Event Configuration > Event tab

Specifies the configuration to read an event from Apache Kafka.

Figure: Read Event Configuration > Event tab

Read Event Configuration Event tab

Fields

Field NameDefinition

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 Add Token icon

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 in which to read 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?

Consumer Group

Description:
Specifies the name of the consumer group who can read the event in Apache Kafka.
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?

Read Timeout (Sec)

Description:
Specifies the maximum amount of time, in seconds, to read the event.
Allowed Values:
An integer.

Represents

  • A number of seconds
Default Value:
60

Offset

Description:
Specifies whether to track the progress of the events to read in Apache Kafka.
Allowed Values:
  • Latest - Reads only recently published events in Apache kafka.
  • Earliest - Reads all the published events in Apache kafka.
Default Value:
Latest
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?

Content Type

Description:
Specifies the format of the event to read.
Allowed Values:
  • JSON
  • Text
  • XML
Default Value:
None

Map Payload To App Schema / Store Event In This Variable

Description:
Specifies how to read the event from a topic in Apache Kafka.
Allowed Values:
  • Map Payload To App Schema - Specifies a payload to read the 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.

  • Store Event In This Variable - Select this option if you want to store an event to a variable in the AgilePoint NX app.

    In the text field, specify a variable that stores the event.

Default Value:
Read Message From This Variable
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?

Read Event Timeout Flag (Boolean)

Description:
Specifies a variable to store a Boolean value of true or false, which indicates whether the event passed the read timeout process.
Allowed Values:
A variable.

Format:

  • Boolean

Response Values

  • True
  • False
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?

Read Event Configuration > Store Headers tab

Configures the headers for the event to read.

Figure: Read Event Configuration > Store Headers tab

Read Event Configuration Store Headers tab

Fields

Field NameDefinition

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 Add Token icon

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 in which to read 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?

Consumer Group

Description:
Specifies the name of the consumer group who can read the event in Apache Kafka.
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?

Read Timeout (Sec)

Description:
Specifies the maximum amount of time, in seconds, to read the event.
Allowed Values:
An integer.

Represents

  • A number of seconds
Default Value:
60

Offset

Description:
Specifies whether to track the progress of the events to read in Apache Kafka.
Allowed Values:
  • Latest - Reads only recently published events in Apache kafka.
  • Earliest - Reads all the published events in Apache kafka.
Default Value:
Latest
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?

Header Name

Description:
Specify a variable that stores the header name of the event to read.
Allowed Values:
A variable from Apache Kafka.
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:
Specify a variable that stores the value for the header to read.
Allowed Values:
A variable from Apache Kafka.
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 Create icon

Function:
Adds a row for the Header Name and Header Value.

Delete Delete icon

Function:
Deletes the selected row.