Workflow Template

Workflow Template

The workflow template is the area where the workflow is designed. The workflow template has one workflow per default. You can add more workflows via the Add Workflow button.

Note!

A workflow configuration cannot be activated, the workflows in it however can.

Note!

Each configuration only allows 1 user to edit it at any one time. While editing the configuration, it is locked to the user's session. To release the lock, you must navigate away from the configuration to another page. It is advised not to close the browser tab without navigating away from the configuration first as this will cause the lock to stay in place until timeout.

image-20240702-063645.png

You create a workflow configuration by using one of the following methods:

  • Click Build → New Configuration. Select Workflow from the Configurations dialog or click the New button in the upper left part of the Workflow Template window.

  • Select a Workflow TypeBatch, Realtime, or Task, and then Ok.

  • Click Add agent to open the Agents selection dialog.

  • Click on the agent from the Agents selection dialog to deploy the agent to the template.

A workflow template can have multiple labels located next to the workflow template name. These labels serve to identify the workflow template. The following are the labels that may appear:

Label

Description

Label

Description

This label identifies the workflow as a Batch workflow. This label is mutually exclusive to Realtime and Task.

This label identifies the workflow as a Realtime workflow. This label is mutually exclusive to Batch and Task.

This label identifies the workflow as a Task workflow. This label is mutually exclusive to Batch and Realtime.

This label identifies the workflow as a Read Only workflow. Read Only workflows will be locked from any editing and you must click on the Edit button to modify a Read Only workflow.

valid_label.png

This label identifies the workflow as a valid workflow. For more information about validation, refer to Workflow Validation.

invalid_label.png

This label identifies the workflow as an invalid workflow. For more information about validation, refer to Workflow Validation.

Here are more things that you can do on the workflow template:

Configuration

Note!

Due to the agents' relationships within a workflow configuration, it is preferable that all agents and routes are added before the configuration is started.

Each agent in the workflow configuration has a specific configuration dialog named after the agent type. You can access these configurations by double-clicking the agent or the route. Subsequently you can also click on the

button when selecting an agent or a route. This causes a dialog to appear with options. See Agent Options or Route Options for more information.

When an agent is deployed into the workflow template it receives a default name located underneath it. The same applies to routes when they are added. These names may be modified to ease identification in monitoring facilities and logs.

All editing and triggering from the workflow template generate changes to the workflow configuration. Examples of this are adding and removing agents, altering agent positions, and editing agent settings and preferences. If you have the Workflow Monitor open, the changes made after saving the workflow template will be reflected. 

The workflow table is affected if it includes columns that correspond to an agent removed from the workflow template.

Routing Agents

To create a data flow, agents need to be connected to each other. To connect the agents, click the left mouse button on the center of the source agent and without releasing the left mouse button, move the pointer to the target agent and release there. This creates a route between the two agents indicating the data flow.

You can also create a route between agents by using the button under agent options and selecting the target agent in the dialog. You can modify a route name by clicking on its name and typing a new name. Route names must be unique within a workflow configuration and may only contain the a-z, A-Z, 0-9, "-" and "_" characters.

Route Options

Clicking on a route in the workflow template provides you with a couple of options.

Route Options

Options

Description

Options

Description

Opens the Edit Route dialog where you can then edit the route name and route style. You can also double-click the route itself to open the Edit Route dialog.

A route name is modified by typing a new name. Route names must be unique within a workflow configuration and may only contain the a-z, A-Z, 0-9, "-" and "_" characters.

You can also change the appearance of the routes by selecting from the following Route Style options; Orthogonal, Bezier, or Straight. The default route style is Bezier .

Note!

In a real-time workflow a fourth kind of routing type appears by default when a response is returned to an agent that sent out a request. The route is shown as a dot-dashed line.

Edit Route dialog box

Removes the selected route.

Agent Options

Clicking an agent in the workflow template provides you with a few options.

Agent options

Options

Description

Options

Description

Opens the Agent Configuration dialog where you can add or edit the settings and configuration values for the selected agent. You can also double-click the agent itself to open the Agent Configuration dialog.

In a read only configuration mode, you can proceed to edit directly on the agent configuration dialog. To save, click Edit on the dialog bar as shown below.

A read only agent configuration dialog

Note!

By clicking Edit on the dialog bar, the system will validate if any other changes have been performed and saved on the same agent and prompt a version change dialog. You can then decide to accept the saved changes and discard your local changes or choose to have your local changes overwrite the other version.

Removes the agent and all its stored configuration. This action will not prompt you with any dialog and it is final so be absolutely sure that you want to remove the agent.

Opens a dialog with an option to route the selected agent to another agent.

Connect agent to dialog box

 

wf_monitor_agent_info_button.png

 

Brings up an information dialog that displays parts of the agent's configuration.

Agent information dialog