Read Message from Event Hub activity

An activity that reads a device-to-cloud message from Event Hub that is registered in Microsoft Azure IoT.

Configure the Read Message from Event Hub activity

To configure the Read Message from Event Hub activity, do the procedure in this topic.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Good to Know

To send an e-mail notification, click Advanced > E-mail Notifications .
For more information, refer to Configure E-mail Notifications for Any Activity.
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?
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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

On the Application Explorer screen, do one of these:
- Open a Process.
- Create a Process.
Do one of these:
- Add an activity:
  1. In the Process Builder, in the Activity Library open the Microsoft Azure IoT tab.
  2. On the Microsoft Azure IoT tab, drag the Read Message From Event Hub activity onto your process.
- Change an activity:
  1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Read Message from Event Hub activity.

Fields

Field Name	Definition
Display Name	Function: Specifies the activity name that shows in your process. Accepted Values: One line of text that can have spaces. Default Value: None Accepts Process Data 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	Function: Specifies an optional text description for your activity. Accepted Values: More than one line of text. Default Value: None Accepts Process Data Variables: No

Field Name

Definition

Display Name

Function:

Specifies the activity name that shows in your process.

Accepted Values:

One line of text that can have spaces.

Default Value:

None

Accepts Process Data 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

Function:: Specifies an optional text description for your activity.
Accepted Values:: More than one line of text.
Default Value:: None
Accepts Process Data Variables:: No

Read Message from Event Hub Configuration

Configures how to store the message from Event Hub.

Fields

Field Name	Definition
Microsoft Azure IoT	Function: Specifies the access token that connects to your Microsoft Azure IoT service. Accepted Values: A list of access tokens configured for your environment. Default Value: None Accepts Process Data Variables: No
Add Token	Opens this Screen: Access Token for Microsoft Azure IoT Function of this Screen: Configure an access token to connect to Microsoft Azure IoT.
Device ID	Function: Specifies the device ID for your IoT device to read message. Accepted Values: A device ID from Microsoft Azure IoT. Default Value: None Accepts Process Data Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?
Retry Count	Function: Specifies the number of times Microsoft Azure IoT tries to read messages from Event Hub. Accepted Values: A positive integer. Default Value: 60 Accepts Process Data Variables: Yes
Delay Between Retry (milliseconds)	Function: Specifies a time interval in milliseconds between each retry. Accepted Values: A positive integer. Default Value: 1000 Accepts Process Data Variables: Yes
Payload	Function: Specifies the payload to store at runtime. Accepted Values: Save Response to This Variable - Specifies a process data variable to store the JSON payload at runtime. Map Response to Process Schema - Connects the values in your payload with your AgilePoint schema. Click Map Schema button to open the Schema Mapper. Use this screen to connect the response to process schema. Default Value: None Accepts Process Data Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?
Sample Payload JSON	Function: Specifies a JSON code snippet that connects your payload to the schema. To Open this Field: On the Read Message from Event Hub Configuration screen, click Map Response to Process Schema. Accepted Values: A JSON code snippet. Default Value: None Accepts Process Data Variables: No
Map Schema	Opens this Screen: Schema Mapper To Open this Field: On the Read Message from Event Hub Configuration screen, click Map Response to Process Schema. Function of this Screen: Maps SharePoint fields, form fields, web methods, or other input sources to an XML schema.. Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?