Orchestration Monitor overview

The Orchestration Monitor gives you granular control over your plan, enabling you to take direct action over every item.

The Orchestration Monitor is a UI section that functions like a control hub that oversees all of your workload associated with a specific engine. The page uses the autorefresh mechanism, and you can modify the autorefresh timeout to control how often status information is updated. From there, you can monitor:

Workstations
Workflows
Tasks
Event sources
Resources
Endpoints

v2.1.6+Workflow view

The Workflow view displays workflows, tasks, and prompts as interactive flowcharts so that you can follow processing paths, the current states of tasks, and internal or external dependencies visually. Most other monitoring items, such as workstations, event sources, resources, and endpoints, are not included in the graphical view and remain accessible through the standard list and query view.

For information on canvas controls, view options, the properties panel, data refresh, run history, and foreach task iterations, see Workflow view.

Monitored items

Workstations: You can monitor the availability and connection status of the computing resources where your tasks run. For each workstation, you can view the State (such as Linked or Unlinked) and operational flags (such as Ignored). You can also perform actions such as Set Online (Link) to establish a connection or Set Offline (Unlink) to disconnect a workstation to prevent task submission.
Workflows: For each workflow, you can view the State, the scheduled start time, and dependency information. You can also perform actions such as Release to force a workflow to proceed, Cancel to stop processing, or Submit to launch new instances.
Tasks: For each task, you can view the State, return codes, and task logs. You can perform actions such as Rerun to restart failed tasks, Stop to stop tasks, or Confirm to manually validate completion.
Event sources: You can monitor the status of the plug-ins configured to receive external events. For each event source, you can view the Status (Online or Offline) and the Actual status (such as Connected, Listening, or Error). You can also perform actions such as Set Online to enable event listening or Set Offline to disable it.
Resources: You can monitor the usage levels of the physical or logical assets required by your workload dependencies. For each resource, you can view the Total units defined, the units currently In Use, and the Available units. You can also perform actions such as Change resource to update the available quantity to manage workflow throughput.
Endpoints: You can monitor the health and connectivity of your external system connections. For each endpoint, you can view the Status (Online or Offline) and the Actual status (Available, Error, or Unknown) derived from automated connectivity tests. You can also perform actions such as Set Online to enable task submission or Set Offline to pause operations on a specific endpoint.

Queries: You can use queries to search for specific items, and from there you can take direct control by performing manually a range of actions, depending on which item you have queried. Queries can also be saved and shared with other users or groups, to speed up your monitoring operations.

Tree view: The tree view enables workload monitoring through the folders that contain the items in the plan. The tree view is updated in real time, always showing the up to date folder system that contains the monitored items.

Dependencies: The Dependencies action displays the dependencies of tasks and workflows. Internal dependencies between items within the same workflow are shown by default. External dependencies, which connect items across different workflows, can be loaded on demand and are presented in a read-only format.

Operator instructions

When monitoring tasks and workflows, operators can access the Operator instructions panel from the More actions menu to retrieve definition information from the Description and Documentation fields. The availability of this information within the Orchestration Monitor facilitates rapid comprehension of task or workflow parameters during monitoring activities.

The Operator instructions panel displays definition information based on the selected item. For a workflow, the panel presents the content of the Description and Documentation fields from the workflow definition. For a task, the panel displays three sections:

Workflow: Displays the Description and Documentation fields of the workflow to which the selected task instance belongs.
Task instance: Displays the Description and Documentation fields of the selected task instance.
Task definition: Displays the Description field of the task definition referenced by the selected job instance.

v2.1.5+ View JSON Context: For each task run instance, you can open a viewer that displays the full JSON context recorded at run time. The viewer supports syntax highlighting, search and filter, and copy to clipboard. For more information, see Viewing the run context of a task.

For more information on how to use the Orchestration Monitor, see this Orchestration Monitor scenario