Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Universal Controller allows you to monitor running Workflows in graphical format. As the Workflow progresses, the display provides up-to-date textual and color-coded status information for each task instance in the Workflow. You can also intervene in processing where necessary.

Anchor
Monitoring a Running Workflow
Monitoring a Running Workflow

Monitoring a Running Workflow

Note
titleNote

A Workflow already must be running in order for you to monitor its status.

...

Note
titleNote

The name of the workflow that you are monitoring is shown:

  1. At the bottom right corner of the Workflow Monitor.
  2. By hovering over the Workflow Monitor tab at the top of the Workflow Monitor.

Anchor
Workflow Monitor Modes
Workflow Monitor Modes

Workflow Monitor Modes

The Workflow Monitor has two modes. Each mode, which you select by clicking the appropriate icon in the Workflow Monitor toolbar, allows you to use one or more specific Workflow Monitor tools.
 

Icon

Mode

Description

Anchor
Select
Select
Select

Clicking the Select 63556725 icon on the Workflow Monitor toolbar places the Workflow Editor in Select mode, which allows you to use all Workflow Monitor tools except Connect 63556725 and Pan 63556725. The Select mode is the default mode for the Workflow Monitor.

Anchor
Pan mode
Pan mode
Pan

Clicking the Pan 63556725 icon on the Workflow Monitor toolbar places the Workflow Monitor in Pan mode, which allows you to scroll around in the Workflow. (You also can use the Outline 63556725 tool in any mode) to scroll around in the Workflow.
 
In Pan mode, you also can use all other Workflow Monitor tools.
 

Note
titleNote

Pan mode does not allow you to use the drag and drop method for moving, deleting, and copying groups of Workflow elements.


Anchor
Viewing Predecessors/Successors of Task Instances in a Workflow
Viewing Predecessors/Successors of Task Instances in a Workflow

Viewing Predecessors/Successors of Task Instances in a Workflow

You can view the predecessors/successors of all task instances in a workflow from the Activity Monitor, Task Instances list, and the Workflow task instance Details.

...

See Viewing Task Predecessors/Successors.


Anchor
Viewing Predecessors/Successors of Task Instances in a Workflow
Viewing Predecessors/Successors of Task Instances in a Workflow

Viewing Blocking Ancestors of Task Instances in a Workflow

You can view the blocking ancestors of task instances in a Workflow task instance from:

...

See Viewing a Timeline for a Workflow Task Instance.

Anchor
Workflow Monitor Toolbar
Workflow Monitor Toolbar

Workflow Monitor Toolbar

The Workflow Monitor toolbar, which displays above the Workflow Monitor, contains icons for every tool that you need to monitor a Workflow.

A shadowed outline around the icon in the toolbar indicates the currently selected Workflow Monitor mode.

The following example shows that the Workflow Monitor is in Select mode.


 

Anchor
Workflow Monitor Tools
Workflow Monitor Tools

Workflow Monitor Tools

The following table describes the tools used to monitor Workflows, including the tools associated with the two Workflow Monitor modes. The tools are listed by icon, as they appear - left to right - in the Workflow Monitor toolbar.
 

Icon

Tool

Description

Anchor
Go to Parent
Go to Parent

View Parent

If this Workflow is embedded in another Workflow, navigates to the parent. If this Workflow has more than one parent, clicking this icon displays a list of all parent Workflows; in this case, to navigate to a parent Workflow, double-click the Workflow's icon. To return to your original Workflow, click its name. (The current Workflow name displays in the lower right corner of the editor.)
 

Note
titleNote

To open an embedded Workflow (sub-Workflow) from its Parent Workflow, double-click the embedded Workflow.


Anchor
Print
Print

Print

Prints the current Workflow.

Anchor
Select
Select

Select

Places the Workflow Monitor in Select mode 63556725.

Anchor
Pan
Pan

Pan

Places the Workflow Monitor in Pan mode 63556725.
 
To pan around the Workflow, click anywhere in the Workflow Monitor canvas and drag your cursor to display any section of the Workflow.
 
To return to your original location, click the Actual Size 63556725 icon.

Anchor
Undo
Undo

Undo

Click to undo the most recent change.

Anchor
Redo
Redo

Redo

Click to redo the most recent change that you undid by clicking Undo 63556725.

Anchor
Fit
Fit

Fit

Fits the Workflow into the display. If necessary, this shrinks the icons and size of the Workflow in order to make it fit. You can undo a Fit 63556725 by clicking the Actual Size 63556725 icon.

Anchor
Zoom In
Zoom In

Zoom In

Zooms in (enlarges) the Workflow. To return the Workflow to its default size, click the Actual Size 63556725 icon.

Anchor
Zoom Out
Zoom Out

Zoom Out

Zooms out (diminishes) the Workflow. To return the Workflow to its default size, click the Actual Size 63556725 icon.

Anchor
Actual Size
Actual Size

Actual Size

Returns the Workflow to its default size after a Fit 63556725 or Zoom 63556725.

Anchor
Zoom
Zoom

Zoom

Opens a window that allows you to specify a zoom ratio. For example, to double the size of the Workflow, enter 200 and click OK. To return the Workflow to its default size, click the Actual Size 63556725 icon.

Anchor
Horizontal Layout
Horizontal Layout

Horizontal Layout

Reformats the Workflow into a horizontal layout.

Anchor
Vertical Layout
Vertical Layout

Vertical Layout

Reformats the Workflow into a vertical layout.

Anchor
Toggle Vertex Style
Toggle Vertex Style

Toggle Vertex Style

For running Workflows, switches the icon display between status-related icons and task-related icons (see Workflow Monitor Display Mode 63556725). This icon only appears on the icon bar when you are monitoring a running Workflow.

Anchor
Toggle Critical Path View
Toggle Critical Path View

Toggle Critical Path View

Toggles between the normal view of the Workflow and the Critical Path View.
 

Note
titleNote

This icon displays in the toolbar only if the Critical Path Calculations Permitted Universal Controller system property is set to true.


Anchor
Outline
Outline

Outline

For large Workflows, the outline provides a way of positioning a specific area of the Workflow in the display, without using the Pan mode 63556725.

  1. Click the Outline icon. The Outline window opens.
  2. In the Outline window, move and/or resize the blue box to identify the area of the Workflow you want to work on. The display repositions to show only the area within the blue box.

Anchor
Help
Help

Help

Displays help documentation for Workflows.

Anchor
Console
Console

Console

While a Workflow is running, you can click the Console icon to display processing messages.

Anchor
Workflow Monitor Display Mode
Workflow Monitor Display Mode

Workflow Monitor Display Mode

The default display mode for the Workflow Monitor identifies each task instance in the workflow by:

Anchor
Task Name
Task Name

Task Name

The task name is the name given to a task when it was created (see Creating Tasks).

Anchor
Task Type
Task Type

Task Type

The task type of each task instance is represented by an icon that displays above the task instance name.
 

...

Note
titleNote

You can change the Workflow Monitor so that the icon above each task instance name represents the current status of that task instance (see Displaying Task Status Icons 63556725).

Anchor
Task Instance Status
Task Instance Status

Task Instance Status

The current status of each task instance displays below the task instance name.

...

Note

In the Activity or Task Instance List, you can add the Simulate field to determine if an instance is running under simulation mode. However, in the Workflow Monitor, the Status is followed by an asterisk if the instance is executed under simulation mode. For example, the instances in this workflow were executed under simulation mode:


Anchor
Task Instance Details
Task Instance Details

Task Instance Details

You can display the following detailed information (including status) for any task instance by hovering your mouse over the task instance.

...

Note
titleNote

The Next Retry Time field displays in the menu only if the task instance is in Failed status and scheduled for retry.

The Task Description field displays in the menu only if the Workflow Monitor Task Description Enabled Universal Controller system property is set to true.

The Exit Code is displayed in parenthesis only if the instance is in end state (Success, Failed, Finished).

Anchor
Task Instance Actions
Task Instance Actions

Task Instance Actions

For each task instance in a Workflow, the Controller provides a menu of actions that you can take on that task instance. You can perform task instance actions in either Workflow Monitor mode: Select or Pan.

To display the menu of task instance actions, right-click a task instance.
 

...

Action

Description

View/Edit

Allows you to view and edit the Task Instance Details for this task instance.

View/Edit In Tab

Allows you to view and edit the Task Instance Details for this task instance in a new tab.

View Children

For a workflow task instance only; Allows you to view a list of children task instances of this workflow task instance.

View Tree

For a workflow task instance only; Allows you to view a tree of this workflow task instance and its tasks, including children tasks of any sub-Workflow task, and, optionally, lets you display the Details for any of those tasks.

Commands

Allows you to run a command against the task instance.

View Predecessors/Successors

Allows you to view all predecessors and successors of this task instance in the Workflow.

Insert Task As Predecessor

Allows you to insert a task as a predecessor to this task instance.

Insert Task As Successor

Allows you to insert a task as a successor to this task instance.

Details > Show Details

Allows you to display complete database details for this task instance.

Details > Show Variables

Allows you to display a list of all variables available to this task instance.

Properties

Displays a menu of properties for the task instance.

Anchor
Task Instance Actions for Workflow
Task Instance Actions for Workflow

Task Instance Actions for Workflow

For a workflow task instance being monitored, the Controller provides a menu of actions that you can take on that workflow task instance. You can perform these actions in any Workflow Monitor mode.

To display the menu of workflow task instance actions, right-click anywhere in the Workflow Monitor canvas.
 

...

Action

Description

View/Edit

Allows you to view and edit the Task Instance Details for this workflow task instance.

View/Edit In Tab

Allows you to view and edit the Task Instance Details for this workflow task instance in a new tab.

View Children

Allows you to view a list of children task instances of this workflow task instance.

View Tree

Allows you to view a tree of this workflow task instance and its tasks, including children tasks of any sub-Workflow task, and, optionally, lets you display the Details for any of those tasks.

Commands

Allows you to run a command against this workflow task instance.

Show Skipped/Restore

Allows you to show any skipped tasks for this workflow task instance.

Hide Skipped

Allows you to hide any skipped tasks for this workflow task instance.

Find In Workflow...

Allows you to find a task instance in this workflow task instance.

Pan To Top

Allows you to restore the displayed Workflow Monitor for this workflow task instance to its default, top-left position.

Insert Task...

Allows you to insert a task.

Details > Show Details

Allows you to display complete database details for this workflow task instance.

Details > Show Variables

Allows you to display a list of all variables available to this workflow task instance.

Anchor
Task Instance Properties
Task Instance Properties

Task Instance Properties

One of the task actions available for any task instance in a Workflow is to display a list of properties for that task instance.
 


 

Anchor
Connector Details
Connector Details

Connector Details

You can display the following detailed information for any Connector by hovering your mouse over the connector.

Anchor
Connector Actions
Connector Actions

Connector Actions

For each connector in a Workflow, the Controller provides a menu of actions that you can take on that connector. You can perform connector actions in any Workflow Monitor mode.

To display the menu of connector actions, right-click a connector.
 

...

Action

Description

Conditions

Allows you to select a dependency condition for the connecor.

Go To Source

Highlights the predecessor task for the connector and moves it to the center of the Workflow Editor display.

Go To Target

Highlights the successor task for the connector and moves it to the center of the Workflow Editor display.

Commands

Allows you to run a command (Mark as Satisfied) against the connector.

Properties

Displays a menu of properties for the connector.

Anchor
Connector Properties
Connector Properties

Connector Properties

One of the connector actions available for any connector in a Workflow is to display a list of properties for that connector.
 

...

The information in the Connector properties is view-only.

Anchor
Displaying Task Status Icons
Displaying Task Status Icons

Displaying Task Instance Status Icons

You can switch the Workflow Monitor display mode, which by default shows icons that represent task instance types, so that the icons represent task instance status types, as shown in the following example.
 

...

If you select a command from either Actions menu, the Console window automatically opens and displays processing information.
 

Anchor
Monitoring the Critical Path in a Workflow
Monitoring the Critical Path in a Workflow

Monitoring the Critical Path in a Workflow

You can instruct the Controller to calculate the Critical Path of a Workflow, which is the path of task instances in the Workflow that will take the longest time to complete.

...

Note
titleNote

Critical Path settings for tasks and Workflows are not exported/imported.

Anchor
Critical Path Settings
Critical Path Settings

Critical Path Settings

To monitor the Critical Path of a Workflow, you must set the following:

By default, any Workflow with the Calculate Critical Path field enabled will be displayed in the Workflow Monitor in Critical Path View. To toggle in and out of Critical Path View, click the Toggle Critical Path View 63556725 icon.
 

Note
titleNote

If you are using View In Workflow to open the Workflow Monitor, or the Workflow being opened has a status of Skipped, Critical Path View will be toggled off by default.

Anchor
Running a Workflow Enabled for Critical Path
Running a Workflow Enabled for Critical Path

Running a Workflow Enabled for Critical Path

When you run a Workflow enabled for Critical Path, the Workflow Monitor initially displays the Critical Path based on historical average duration statistics and any CP Duration override values for any tasks in the Workflow. When a task instance completes, the Critical Path could change, based on the actual time it took the task instance to complete. For example, if you specified a Critical Path Duration of 5 minutes for a task, but the task instance completed in 30 seconds, the Controller might adjust the Critical Path to show a path that it now estimates will take the longest to complete.
 

...

If you are in Critical Path View, but you want to see Skipped task instances, you can restore the standard view by clicking the Toggle Critical Path View 63556725 icon in the Workflow Monitor toolbar.

Also, in Critical Path View, Show Skipped / Restore and Hide Skipped are disabled in the Workflow Monitor pop-up menu of commands and options. When the Workflow completes, the final Critical Path displays.
 

Anchor
Critical Path Status
Critical Path Status

Critical Path Status

Activity Monitor and Task Instances List

...