Workflow Bridge Real-time Forwarding Agent(3.1)

The Workflow Bridge forwarding agent sends data to a Workflow Bridge collection agent. Open the Workflow Bridge Forwarding agent configuration dialog from a workflow configuration. Either right-click the agent icon and select Configuration or double-click the agent icon.

Workflow Bridge forwarding agent configuration dialog for a real-time workflow

Setting	Description

Setting

Description

Workflow Bridge Profile

This is the profile to use for communication between the workflows. For information about how to configure a Workflow Bridge profile, see Section Workflow Bridge Profile Configuration.

All workflows in the same workflow configuration can use separate profiles. For this to work, the profile must be set to Default in the Workflow Table tab found in the Workflow Properties dialog. For further information on the Workflow Table tab, refer toWorkflow Table Tab(3.1).

To select a profile, click on the Browse... button, select the profile to use, and then click OK .

Stream ID

Workflow Bridge collection and forwarding agents use Stream IDs to manage connections between multiple workflow instances. Instead of creating separate profiles for each pair of workflows, you can use a single profile and assign a Stream ID to ensure that the correct workflows are linked. This is particularly useful when scaling your system, as it allows new workflow instances to automatically find their corresponding counterparts.

Example – Configuring a Stream ID in Workflow Bridge Collection and Forwarding Agents

Scenario: You need to scale your system by adding multiple instances of connected workflows. Instead of manually configuring separate Workflow Bridge profiles for each instance, you can use Stream IDs to automatically pair workflows.

For example, if three processing workflows (A, B, and C) need to send data to three corresponding collection workflows (X, Y, and Z), you can define stream IDs like "A-X", "B-Y", and "C-Z". This ensures each processing workflow sends data to the correct collection workflow while maintaining a simpler, more scalable configuration.

Transaction Behavior

For information about the general Usage Engine transaction behavior, see Workflow Monitor (3.1).

Emits

The agent emits data in the ConsumeCycleUDR and the WorkflowState UDRs.

Retrieves

The agent retrieves ConsumeCycleUDRs and ErrorCycleUDRs from the collection workflow.

Input/Output Data

The agent consumes bytearray types and any UDRs, as configured in the profile, refer to Workflow Bridge (3.1) for more information.

MIM

For information about the Usage Engine MIM and a list of the general MIM parameters, see Administration and Management(3.1).

Publishes

MIM Parameter	Description
Number of collectors	`Number of collectors` is of the int type and indicates the number of collectors configured in the Workflow Bridge profile.
Forwarding Queue Size	Forwarding Queue Size is of the int type and contains the value of forwardingQueueSize , which is defined under the Advanced tab in the Workflow Bridge profile configuration.
Forwarding Queue Utilization	Forwarding Queue Utilization is of the any type and contains a hashmap of the number of UDRs that are currently queued in the forwarding workflows. The loadId values of the collecting workflows are used as keys to the hashmap. If loadId is not used, the key will have the value 1. The hashmap is periodically refreshed and cached in order to prevent impact on performance when the MIM value is repeatedly queried.

Example - Forwarding Queue Utilization in APL

consume { 
  map<int, int> queueMap = (map<int, int>) 
   mimGet("Workflow_Bridge_1", "Forwarding Queue Utilization"); 
  int loadId = 1; 
  int queueSize = mapGet(queueMap, loadId); 
  debug("Queue Utilization: " + queueSize); 
  wfb.ConsumeCycleUDR ccUDR = udrCreate(wfb.ConsumeCycleUDR); 
  ccUDR.Data = input; 
  udrRoute(ccUDR); 
 }

Accesses

The agent does not access any MIM resources.

Agent Message Events

There are no agent message events for this agent.

For information about the agent message event type, see Agent Event(3.1).

Debug Events

Debug messages are dispatched in debug mode. During execution, the messages are displayed in the Workflow Monitor.

You can configure Event Notifications that are triggered when a debug message is dispatched. For further information about the debug event type, see Debug Event(3.1).

The agent produces the following debug events:

Connected to local <Collector agent address>
This message is displayed when a connection has been established with a Collection agent.
Disconnected from <Collector agent address>
This message is displayed when a connection has been released.
Trying to connect to <Collector agent address>
This message is displayed when a forwarding agent is trying to connect to a collector.