Workflow Bridge Batch Forwarding Agent(4.2)

The Workflow Bridge forwarding agent is responsible for sending data to a Workflow Bridge collection agent.

You open the Workflow Bridge forwarding agent configuration dialog from a workflow configuration: you can right-click the agent icon and select Configuration..., or double-click the agent icon.

Workflow Bridge forwarding agent configuration dialog for a batch workflow

Configuration

Setting	Description

Setting

Description

Profile

This is the profile to use for communication between the workflows. For information about how to configure a Workflow Bridge profile, see Workflow Bridge (3.0).

Workflow Bridge supports one or several batch forwarding workflows connected to one or several collection workflows.

Workflows in the same workflow configuration can use different 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, see Workflow Table(3.0).

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

Transaction Behavior

Emits

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

Retrieves

The agent retrieves ConsumeCycleUDRs and WorkflowState UDRs from the collection workflow.

Input/Output Data

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

MIM

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

Publishes

MIM Parameter	Description

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 use of 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(4.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(4.1).

The agent produces the following debug events:

Connected to local:<Forwarding agent id>.workflow_bridge
This message is displayed when a connection has been established with a Workflow Bridge Real-time Collection agent.
Ready with transaction <transaction number>
This message is displayed each time a transaction has been finished, that is, after endBatch.
Disconnected
This message is displayed when a connection has been released.