You open the Azure Event Hub Consumer agent configuration dialog from a workflow configuration: you can right-click the agent icon and select Configuration..., or double-click the agent icon.
Azure Event Hub Consumer agent configuration
| Setting | Description |
|---|---|
| Profile | Select the Azure profile that has been configured with the connection details for the Azure Event Hub. For more information about how to configure the profile, refer to 1 8.4 Azure Profile. |
| Partition | Enter the partition name of the event hub to be used by the agent. This field is optional. |
| Storage Directory | Enter the directory path of where the data checkpoints are to be collected fromstored on the local directory of the EC server the workflow is running on. The data checkpoint consists of a sequence number stored in a binary file that is used by the Event Hub Consumer agent will be usingagent to resume data collection from where it stopped. Should the field be left empty, the agent will either Start at latest or Start at earliest, depending on the configuration set below. |
| Consumer Group | Enter the name of the consumer group the agent will be retrieving from. |
| Start at latest (from end) | Events are selected from the last offset from when the workflow was started. If you select this option, there is a risk that data can be lost after a restart. This configuration will only be applied when the workflow is running for the first time or if the Storage Directory is left empty or missing. |
| Start at earliest (from beginning) | Events are collected from the first offset. If you select this option, there is a risk that events will be processed multiple times after a restart. This configuration will only be applied when the workflow is running for the first time or if the Storage Directory is left empty or missing. |
| Use EventDataUDR | By default, the consumer agent sends the event body as a bytearray. Selecting this option will cause the consumer agent to send the event body data as a string, along with any additional metadata that the EventHub provides. |
Advanced Tab
The Advanced tab contains additional settings for checkpointing the offset of events collection when the workflow is initiated. When a directory path is specified in the Storage Directory field, the settings under the Advanced tab will override the settings for Start at latest (from end) and Start at earliest (from beginning) in the General tab.
Azure Event Hub Consumer agent - Advanced tab
| Setting | Description |
|---|---|
| Ignore out of sequence range | Select this checkbox to enable the following options to predefine where you would like the reading of offset to take place after a workflow restarts. |
| Start at latest (from end) | Events are selected from the last offset from when the workflow was started. If you select this option, there is a risk that data can be lost after a restart. |
| Start at earliest (from beginning) | Events are collected from the first offset. If you select this option, there is a risk that events will be processed multiple times after a restart. |
| Scroll ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||