Description:

The Send Msg to EventHub step belongs to the Azure category in FlowWright. Its XML definition identifies the step as sendazureeventhubmessage, with the label “Sends a message to the Azure Event Hub”, namespace FlowWright.Workflow.SendAzureEventHubMessage, and display name “Send Msg to EventHub.” The step uses FlowWright.Workflow.dll and is defined as a Process step with two input and two output connections.

The step sends a specified message to an Azure Event Hub using the configured Azure connection string and Event Hub name. It also provides a Message parameters property for mapping message parameters.

Typical uses include:

• Publishing workflow events to an Azure Event Hub
• Sending business-process events to downstream consumers
• Integrating FlowWright workflows with event-driven applications
• Publishing workflow completion or status events
• Sending application or business event messages
• Triggering downstream event-processing pipelines
• Passing workflow-generated values into an Event Hub message
• Connecting FlowWright processes to Azure-based event-streaming architectures

Azure Service Bus connection string parameters

The Azure Service Bus connection string contains the following information:

• Endpoint: The URL for 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 in 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 look:

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

This connection string would enable 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:

The Send Msg to EventHub step is typically placed after a workflow has generated or completed an event that needs to be published externally.

When the workflow reaches the step, FlowWright uses the configured Azure connection string and Event Hub name and sends the configured message with its message parameters. The step then follows the appropriate True or False path. The four required inputs are explicitly defined in the XML.

Example:

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

• Create a new definition called “sendAzureEventHubMessageDef” and open the definition in designer mode.
• Drag a “sendAzureEventHubMessage” step to the canvas. 
• Connect the dots between the “Start” and “sendAzureEventHubMessage”  steps, as shown above. 
• Click the "sendAzureEventHubMessage" step to configure its "Required" properties. Provide a name for the step. Provide the Azure connection string. Provide the event hub name. Provide the message to send. Click the button to configure multiple message parameters. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

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

• The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 instance, and execute it. Render the process instance. Click the process step to view its properties. The step should send the message to the Azure event hub. 

Tips:

• Configure all four required properties before executing the step. 
• Verify that the Azure connection string has access to the intended Event Hub.
• Verify that the Event Hub name is correct.
• Use workflow variables to construct dynamic messages where appropriate.
• Use Message parameters to map values needed by the message.
• Avoid embedding sensitive information in event messages unless the workflow's security and data-handling requirements permit it.
• Use the True path for successful continuation.
• Use the False path for error handling, logging, notification, or recovery processing.
• Test the Event Hub integration independently before incorporating it into a production workflow.
• Ensure downstream consumers understand the message structure produced by the workflow.
• Keep event message formats consistent when multiple workflows publish to the same Event Hub.

Notes:

• The step belongs to the Azure category. 
• Internal name: sendazureeventhubmessage. 
• Display name: Send Msg to EventHub. 
• Label: Sends a message to the Azure Event Hub. 
• Namespace: FlowWright.Workflow.SendAzureEventHubMessage. 
• DLL: FlowWright.Workflow.dll. 
• It is a Process step. 
• It has 2 input connections and 2 output connections. 
• Azure connection string is required. 
• Event hub name is required. 
• Message to send is required. 
• Message parameters is required. 
• The first three properties use the string data type. 
• Message parameters use the MessageParms data type. 
• The MessageParms property type is described as “Map message parameters.” 
• The step provides False and True return paths. 
• The XML does not expose additional properties such as timeout, retry count, partition configuration, batching, result storage, or transaction settings. These should not be documented as configurable features of this step based on the supplied XML.

sendAzureEventHubMessage vs. sendAzureSBMessage:

Both steps provide outbound Azure messaging functionality and have nearly identical FlowWright configuration models.

The important difference is the Azure messaging destination.

Event Hub

sendAzureEventHubMessage is specifically defined to send a message to Azure Event Hub. Its destination property is:

Event hub name (eventHubName).

Service Bus

sendAzureSBMessage is specifically defined to send a message to Azure Service Bus. Its destination property is:

Message queue name (messageQueue).

The Service Bus XML confirms the same four-property structure: Azure connection string, message queue name, message, and message parameters.

When to Use sendAzureEventHubMessage

Use sendAzureEventHubMessage when the workflow needs to publish an event to an Azure Event Hub.

Typical scenarios include:

• Publishing business events
• Sending workflow events to event-stream processing
• Publishing application events
• Integrating FlowWright with event-driven consumers
• Sending high-volume workflow events to an Event Hub
• Broadcasting workflow-generated event information to downstream processing systems

The step definition itself establishes the Event Hub as its destination; specific event-stream architecture decisions are outside the XML definition.

When to Use sendAzureSBMessage

Use sendAzureSBMessage when the workflow needs to send a message to an Azure Service Bus message queue.

Typical scenarios include:

• Sending workflow work items to a queue
• Triggering downstream processing
• Integrating FlowWright with queue-based applications
• Placing business messages into a Service Bus queue
• Separating workflow execution from downstream message processing

The step definition explicitly identifies its destination as the Azure Service Bus and exposes a Message queue name property.

Key Distinction

The simplest way to distinguish the two steps is:

sendAzureEventHubMessage: “Send this message to the specified Azure Event Hub.”

sendAzureSBMessage: “Send this message to the specified Azure Service Bus queue.”

In short:

• Event Hub = Event Hub destination
• Service Bus = Message queue destination
• Both require an Azure connection string.
• Both require a destination name.
• Both require a Message to send.
• Both require Message parameters.
• Both provide True and False execution paths.
• Both use string properties for the connection, destination, and message.
• Both use MessageParms for message-parameter mapping.

Definition Sample:

You may download the sample definition and later import it by drag-and-drop into the FlowWright Process Definition (XML file) page.

After importing the sample, verify and complete any environment-specific configuration, including:

• Azure connection string
• Event Hub name
• Message content
• Message parameter mappings
• Azure permissions/access
• Workflow variable mappings
• Environment-specific settings

After verifying the configuration, save the Process Definition before execution.

The established FlowWright documentation pattern uses this same approach for definition samples: import the definition, verify missing configuration, save the definition, and then execute the process.

Click here to download the sample file.