SendAzureEventHubMessage Step

Use this step to send message to Azure event hub.

Last published at: November 21st, 2024

Description:

This step sends a message to the Azure event hub.

 

Helpjuice Info Callout Title

  • connectionString - Azure connection
  • eventHubName - Event hub name
  • message - Message to send
  • messageParms - Message parameters 
 

 

Returns

  • True – step executed successfully
  • False – step failed to execute 
 

 

Azure Service Bus connection string parameters

The Azure Service Bus connection string contains the following pieces of information:

  • Endpoint: The URL that points to the Azure Service Bus instance you want to connect to.
  • Shared Access Key Name (SharedAccessKeyName): The name of the shared access key that provides security credentials for authentication.
  • Shared Access Key (SharedAccessKey): The actual security key associated with the shared access key name used to establish secure communication.
  • Entity Path (EntityPath): If you’re connecting to a specific queue or topic within the Service Bus, this specifies the path to that entity. This key value is optional

Here’s a typical example of how an Azure Service Bus connection string might be represented:

Endpoint=sb://your-servicebus-name.servicebus.windows.net/;SharedAccessKeyName=YourKeyName;SharedAccessKey=YourKey;EntityPath=YourQueueOrTopicName

This connection string would allow your application to securely connect to the Azure Service Bus instance and interact with the specified queue or topic.

Here's a link to the article for more information on the Azure Service Bus connection. 

 

Usage:

 

 

Example:

Let’s build and execute the “sendAzureEventHubMessageDef” example.          

  • Create a new definition called “sendAzureEventHubMessageDef” 
  • Select the definition and click the “design” button
  • Drag a “sendAzureEventHubMessage” step from the toolbox
  • Connect the dots between the start and “sendAzureEventHubMessage”  step
  • Click on the "sendAzureEventHubMessage" step to configure its "Settings" properties. Provide a name to the step. Provide Azure connection string. Provide event hub name. Provide a message to send. Click on the button to configure multiple message parameters. 

 

  • Click on the button to configure multiple message parameters. Click the Add Row (+) button to insert an empty row. Provide the message parameter and value. Click the Save button. You may add multiple parameters by inserting more rows. 

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new process instance, and execute. Render the process instance. Click on the process step to view its properties. The step should send the message to the Azure event hub. 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.

Click here to download the sample file.