Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

Overview

The Universal Monitor task allows you to monitor published Universal Events.

To define an Universal Monitor, you must specify either a:

For continuous monitoring of published Universal Events, assign the Universal Monitor to a Universal Monitor Trigger, with the trigger firing each time the Universal Event match criteria has been met,

For non-continuous monitoring of published Universal Events, with Universal Monitor completing only when the Universal Event match criteria has been met, add Universal Monitor to a workflow or launch it directly (stand-alone).

Built-In Variables

The following built-in variables can be used in a Universal Monitor task to pass data where appropriate:

Creating a Universal Monitor Task

Step 1

From the Automation Center navigation pane, select Tasks > Universal Monitors. The Universal Monitor Tasks list displays a list of all currently defined Universal Monitor tasks.
 
Below the list, Universal Monitor Task Details for a new Universal Monitor task displays.
 

Step 2

Enter/select Details for a new Universal Monitor task, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.
  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.
  • Temporarily hide the list above the Details.
  • Click the New button above the list to display a pop-up version of the Details.

Step 3

Click a Save button. The task is added to the database, and all buttons and tabs in the Task Details are enabled.

Note

To open an existing record on the list, either:

  • Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
  • Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
  • Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

Universal Monitor Task Details

The following Universal Monitor Task Details is for an existing Email Monitor task.

Depending on the values that you enter / select for these fields, and whether or not the Universal Monitor task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the Universal Monitor Task Details.
 

Universal Monitor Task Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the Universal Monitor Task Details.

Field Name

Description

General

This section contains general information about the task.

Name

User-defined name of this task (Maximum = 255 alphanumeric characters); variables supported. It is the responsibility of the user to develop a workable naming scheme for tasks.

Version

System-supplied; version number of the current record, which is incremented by the Controller every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning.

Description

Description of this record. (Maximum = 255 characters.)

Member of Business Services

User-defined; Allows you to select one or more Business Services that this record belongs to.  (You also can Check All or Uncheck All Business Services for this record.)

You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service.

If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted.

Resolve Name Immediately

If enabled, the Instance Name of the task instance will be resolved immediately at trigger/launch time.

Time Zone Preference

User-defined; Allows you to specify the time zone that will be applied to the task.

Options:

  • – System Default –
    Time zone is based on the value of the Task Timezone Preference Universal Controller system property: Server or Inherited.
  • Server (xxx)
    Where (xxx) is the time zone ID of the server; time zone is evaluated in the time zone of the server.
  • Inherited
    Time zone is evaluated in the time zone of the Parent Workflow or Trigger / Launch specification in the case there is no Parent Workflow.

Hold on Start

If enabled, when the task is launched it appears in the Activity Monitor with a status of Held. The task runs when the user releases it.

Hold Reason

Information about why the task will be put on hold when it starts.

Virtual Resource Priority

Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task.

Options: 1 (high) - 100 (low).

Default is 10.

Hold Resources on Failure

If enabled, the task instance will continue to hold Renewable resources if the task instance fails. Renewable resources will be returned only if the task instance status is either Complete, Finished, or Skipped.

Universal Monitor Details

This section contains assorted detailed information about the task.

Event Type

Type of Universal Event to monitor:

  • Global
  • Local

Universal Event Template

Unable to render {include} The included page could not be found.

Universal Template

Unable to render {include} The included page could not be found.

Event Template

Unable to render {include} The included page could not be found.

Universal Task Publisher

Optional; Universal Extension-based Universal Task that will be:

  • Launched when the Universal Monitor task starts.
  • Force Finished/Cancelled when the Universal Monitor task ends.

The Running Universal Task Publisher can only publish Universal Events to this Universal Monitor, and this Universal Monitor can only match on Universal Events published by the Running Universal Task Publisher.

The Publisher is expected to publish the events that this Universal Monitor is expecting to come in.

  • If the Universal Monitor is specified by a Universal Monitor Trigger (or the Universal Monitor Trigger component of a Composite Trigger), the Publisher will run indefinitely until the Trigger is disabled. At that time, a Cancel and Force Finish will be issued to the Universal Monitor, and the Universal Monitor will propagate these commands to the associated Universal Task Publisher instance that is running.
  • If the Universal Monitor is run stand-alone or within a workflow, the Publisher will not run continuously, as the Universal Monitor will complete when the event coming in is matched or the Time Scope (if specified) is reached.

A Universal Monitor Task Instance that specifies a Publisher will show the associated Universal Task Instance representing the Publisher.

Time Scope

Allows monitoring of Universal Events that were published prior to the Universal Monitor task running,  or limits how long the Universal Monitor task continues to monitor before becoming Failed,

Options:

  • -- None --
  • Relative

Expiration Action

If Time Scope is Relative; State to transition to if Relative Time Scope conditions are not met within the specific window.

Options:

  • Failed
  • Finished

From

Format is (+/-)hh:mm

If Time Scope = Relative; Together with the Time Scope To field, it allows you to specify a window of time, relative to the time the Universal Monitor task launched, during which the conditions of the Universal Monitor must be met.

If the conditions are not met within the specified window, the Universal Monitor task instance will transition to Failed (default) or Finished status, as determined by the Expiration Action.

hh must be a positive integer. mm must be a positive integer between 0 and 59 inclusive. For example, -124:00, -12:00, -6:00, 00:00, 6:00, 12:00, or 124:00.

To

Format is (+/-)hh:mm

If Time Scope = Relative; Together with the Time Scope From field, it allows you to specify a window of time, relative to the time the Universal Monitor task launched, during which the conditions of the Universal Monitor must be met.

If the conditions are not met within the specified window, the Universal Monitor task instance will transition to Failed (default) or Finished status, as determined by the Expiration Action.

hh must be a positive integer. mm must be a positive integer between 0 and 59 inclusive. For example, -124:00, -12:00, -6:00, 00:00, 6:00, 12:00, or 124:00.

Universal Monitor Criteria

This section contains criteria for selecting Universal Events to monitor.

Match All / Match Any

Criteria for matching attributes of the selected Universal Event Template.

  • Match All
  • Match Any

If no match criteria is specified, the Universal Monitor will match any published Universal Event of the selected Universal Event Template.

Wait / Delay Options

This section contains specifications for waiting to start and/or delaying on start the task.

Wait To Start

Unable to render {include} The included page could not be found.

Wait Time

Unable to render {include} The included page could not be found.

Wait Day Constraint

Unable to render {include} The included page could not be found.

Wait Duration

Unable to render {include} The included page could not be found.

Wait Duration In Seconds

Unable to render {include} The included page could not be found.

Delay On Start

Unable to render {include} The included page could not be found.

Delay Duration

Unable to render {include} The included page could not be found.

Delay Duration In Seconds

Unable to render {include} The included page could not be found.

Workflow Only

Unable to render {include} The included page could not be found.

Time Options

This section contains time-related statistics for task instances of the task.

Late Start

Unable to render {include} The included page could not be found.

Late Start Type

Unable to render {include} The included page could not be found.

Late Start Time

Unable to render {include} The included page could not be found.

Late Start Day Constraint

Unable to render {include} The included page could not be found.

Late Start Nth Amount

Unable to render {include} The included page could not be found.

Late Start Duration

Unable to render {include} The included page could not be found.

Late Finish

Unable to render {include} The included page could not be found.

Late Finish Type

Unable to render {include} The included page could not be found.

Late Finish Offset Type

Unable to render {include} The included page could not be found.

Late Finish Percentage Offset ( + )

Unable to render {include} The included page could not be found.

Late Finish Duration Offset ( + )

Unable to render {include} The included page could not be found.

Late Finish Duration Offset Unit

Unable to render {include} The included page could not be found.

Late Finish Time

Unable to render {include} The included page could not be found.

Late Finish Day Constraint

Unable to render {include} The included page could not be found.

Late Finish Nth Amount

Unable to render {include} The included page could not be found.

Late Finish Duration

Unable to render {include} The included page could not be found.

Early Finish

Unable to render {include} The included page could not be found.

Early Finish Type

Unable to render {include} The included page could not be found.

Early Finish Offset Type

Unable to render {include} The included page could not be found.

Early Finish Percentage Offset ( - )

Unable to render {include} The included page could not be found.

Early Finish Duration Offset ( - )

Unable to render {include} The included page could not be found.

Early Finish Duration Offset Unit

Unable to render {include} The included page could not be found.

Early Finish Time

Unable to render {include} The included page could not be found.

Early Finish Day Constraint

Unable to render {include} The included page could not be found.

Early Finish Nth Amount

Unable to render {include} The included page could not be found.

Early Finish Duration

Unable to render {include} The included page could not be found.

User Estimated Duration

Unable to render {include} The included page could not be found.

Critical Path Options

This section contains Critical Path-related specifications for the task.

CP Duration

Unable to render {include} The included page could not be found.

CP Duration (Resolved)

Unable to render {include} The included page could not be found.

CP Duration Unit

Unable to render {include} The included page could not be found.

Workflow Execution Options

This section contains Execution Restriction specifications for the task if it is within a Workflow.

Execution Restriction

Unable to render {include} The included page could not be found.

Restriction Period

Unable to render {include} The included page could not be found.

Before Date

Unable to render {include} The included page could not be found.

Before Time

Unable to render {include} The included page could not be found.

After Date

Unable to render {include} The included page could not be found.

After Time

Unable to render {include} The included page could not be found.

Date List

Unable to render {include} The included page could not be found.

Statistics

This section contains time-related statistics for task instances of the task.

First Execution

Unable to render {include} The included page could not be found.

Last Execution

Unable to render {include} The included page could not be found.

Last Instance Duration

Unable to render {include} The included page could not be found.

Lowest Instance Time

Unable to render {include} The included page could not be found.

Average Instance Time

Unable to render {include} The included page could not be found.

Highest Instance Time

Unable to render {include} The included page could not be found.

Number of Instances

Unable to render {include} The included page could not be found.

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Buttons

This section identifies the buttons displayed above and below the Task Details that let you perform various actions.

Save

Saves a new task record in the Controller database.

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Save & View

Saves a new record in the Controller database and continues to display that record.

New

Displays empty (except for default values) Details for creating a new task.

Update

Unable to render {include} The included page could not be found.

Launch Task

Unable to render {include} The included page could not be found.

View Parents

Unable to render {include} The included page could not be found.

Copy

Creates a copy of this task, which you are prompted to rename.

Delete

Unable to render {include} The included page could not be found.

Note

You cannot delete a task if it is either:

  • Specified in an enabled Trigger.
  • The only task specified in a disabled Trigger.

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this task.

Tabs

This section identifies the tabs across the top of the Task Details that provide access to additional information about the task.

Variables

Unable to render {include} The included page could not be found.

Actions

Unable to render {include} The included page could not be found.

Virtual Resources

Unable to render {include} The included page could not be found.

Mutually Exclusive

Unable to render {include} The included page could not be found.

Instances

Lists all instances of the task.

Universal Monitor Triggers

Lists all Universal Monitor triggers that reference this task in the Universal Monitor field of the trigger Details; that is, a list of all Email Monitor triggers that execute this task. For instructions on creating triggers, see Triggers.

Triggers

Unable to render {include} The included page could not be found.

Notes

Unable to render {include} The included page could not be found.

Versions

Unable to render {include} The included page could not be found.

Viewing a Universal Monitor Task Instance

When a Universal Monitor task is launched, the Controller creates a task instance record of that task.

A task instance contains detailed information about a single execution of that task.

You can access a task instance from:

Universal Monitor Task Instance Details

The following Universal Monitor Task Instance Details contains information on the execution of the task shown in the Universal Monitor Task Details.
 

Universal Monitor Task Instance Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in Universal Monitor Task Instance Details.

Field Name

Description

General

This section contains general information about the task instance.

Instance Name

Name of this task instance.

Instance Number

Unable to render {include} The included page could not be found.

Description

Unable to render {include} The included page could not be found.

Member of Business Services

Unable to render {include} The included page could not be found.

Task

Unable to render {include} The included page could not be found.

Source Version

Unable to render {include} The included page could not be found.

Launch Source

Unable to render {include} The included page could not be found.

Source Instance

Unable to render {include} The included page could not be found.

Invoked by

Unable to render {include} The included page could not be found.

Execution User

Unable to render {include} The included page could not be found.

Calendar

Unable to render {include} The included page could not be found.

Time Zone Preference

Unable to render {include} The included page could not be found.

Virtual Resource Priority

Unable to render {include} The included page could not be found.

Hold Resources on Failure

Unable to render {include} The included page could not be found.

Status

This section contains information about the current status of the task instance.

Status

Unable to render {include} The included page could not be found.

Exit Code

Unable to render {include} The included page could not be found.

Status Description

Unable to render {include} The included page could not be found.

Operational Memo

Unable to render {include} The included page could not be found.

Evaluation Time

Unable to render {include} The included page could not be found.

Critical

Unable to render {include} The included page could not be found.

Wait Until Time

Unable to render {include} The included page could not be found.

Queued Time

Unable to render {include} The included page could not be found.

Trigger Time

Unable to render {include} The included page could not be found.

Launch Time

Unable to render {include} The included page could not be found.

Start Time

Unable to render {include} The included page could not be found.

End Time

Unable to render {include} The included page could not be found.

Duration

Unable to render {include} The included page could not be found.

Universal Monitor Details

This section contains assorted detailed information about the task.

Event Type

Type of Universal Event to monitor:

  • Global
  • Local

Universal Event Template

Unable to render {include} The included page could not be found.

Universal Template

Unable to render {include} The included page could not be found.

Event Template

Unable to render {include} The included page could not be found.

Universal Task Publisher

Optional; Universal Extension-based Universal Task that will be:

  • Launched when the Universal Monitor task starts.
  • Force Finished/Cancelled when the Universal Monitor task ends.

The Running Universal Task Publisher can only publish Universal Events to this Universal Monitor, and this Universal Monitor can only match on Universal Events published by the Running Universal Task Publisher.

The Publisher is expected to publish the events that this Universal Monitor is expecting to come in.

  • If the Universal Monitor is specified by a Universal Monitor Trigger (or the Universal Monitor Trigger component of a Composite Trigger), the Publisher will run indefinitely until the Trigger is disabled. At that time, a Cancel and Force Finish will be issued to the Universal Monitor, and the Universal Monitor will propagate these commands to the associated Universal Task Publisher instance that is running.
  • If the Universal Monitor is run stand-alone or within a workflow, the Publisher will not run continuously, as the Universal Monitor will complete when the event coming in is matched or the Time Scope (if specified) is reached.

A Universal Monitor Task Instance that specifies a Publisher will show the associated Universal Task Instance representing the Publisher.

Time Scope

Allows monitoring of Universal Events that were published prior to the Universal Monitor task running,  or limits how long the Universal Monitor task continues to monitor before becoming Failed,

Options:

  • -- None --
  • Relative

Expiration Action

If Time Scope is Relative; State to transition to if Relative Time Scope conditions are not met within the specific window.

Options:

  • Failed
  • Finished

From

Format is (+/-)hh:mm

If Time Scope = Relative; Together with the Time Scope To field, it allows you to specify a window of time, relative to the time the Universal Monitor task launched, during which the conditions of the Universal Monitor must be met.

If the conditions are not met within the specified window, the Universal Monitor task instance will transition to Failed (default) or Finished status, as determined by the Expiration Action.

hh must be a positive integer. mm must be a positive integer between 0 and 59 inclusive. For example, -124:00, -12:00, -6:00, 00:00, 6:00, 12:00, or 124:00.

To

Format is (+/-)hh:mm

If Time Scope = Relative; Together with the Time Scope From field, it allows you to specify a window of time, relative to the time the Universal Monitor task launched, during which the conditions of the Universal Monitor must be met.

If the conditions are not met within the specified window, the Universal Monitor task instance will transition to Failed (default) or Finished status, as determined by the Expiration Action.

hh must be a positive integer. mm must be a positive integer between 0 and 59 inclusive. For example, -124:00, -12:00, -6:00, 00:00, 6:00, 12:00, or 124:00.

Universal Monitor Criteria

This section contains criteria for selecting emails to monitor.

Match All / Match Any

Criteria for matching attributes of the selected Universal Event Template.

  • Match All
  • Match Any

If no match criteria is specified, the Universal Monitor will match any published Universal Event of the selected Universal Event Template.

Wait / Delay Options

This section contains specifications for waiting to start and/or delaying on start the task.

Wait To Start

Unable to render {include} The included page could not be found.

Wait Time

Unable to render {include} The included page could not be found.

Wait Day Constraint

Unable to render {include} The included page could not be found.

Wait Duration

Unable to render {include} The included page could not be found.

Wait Duration In Seconds

Unable to render {include} The included page could not be found.

Delay On Start

Unable to render {include} The included page could not be found.

Delay Duration

Unable to render {include} The included page could not be found.

Delay Duration In Seconds

Unable to render {include} The included page could not be found.

Time Options

This section contains time-related specifications for the task instance.

Late Start

Unable to render {include} The included page could not be found.

Started Late

Unable to render {include} The included page could not be found.

Late Start Type

Unable to render {include} The included page could not be found.

Late Start Time

Unable to render {include} The included page could not be found.

Late Start Day Constraint

Unable to render {include} The included page could not be found.

Late Start Nth Amount

Unable to render {include} The included page could not be found.

Late Start Duration

Unable to render {include} The included page could not be found.

Computed Late Start Time

Unable to render {include} The included page could not be found.

Late Finish

Unable to render {include} The included page could not be found.

Finished Late

Unable to render {include} The included page could not be found.

Late Finish Type

Unable to render {include} The included page could not be found.

Late Finish Offset Type

Unable to render {include} The included page could not be found.

Late Finish Percentage Offset ( + )

Unable to render {include} The included page could not be found.

Late Finish Duration Offset ( + )

Unable to render {include} The included page could not be found.

Late Finish Duration Offset Unit

Unable to render {include} The included page could not be found.

Late Finish Time

Unable to render {include} The included page could not be found.

Late Finish Day Constraint

Unable to render {include} The included page could not be found.

Late Finish Nth Amount

Unable to render {include} The included page could not be found.

Late Finish Duration

Unable to render {include} The included page could not be found.

Computed Late Finish Time

Unable to render {include} The included page could not be found.

Early Finish

Unable to render {include} The included page could not be found.

Finished Early

Unable to render {include} The included page could not be found.

Early Finish Type

Unable to render {include} The included page could not be found.

Early Finish Offset Type

Unable to render {include} The included page could not be found.

Early Finish Percentage Offset ( - )

Unable to render {include} The included page could not be found.

Early Finish Duration Offset ( - )

Unable to render {include} The included page could not be found.

Early Finish Duration Offset Unit

Unable to render {include} The included page could not be found.

Early Finish Time

Unable to render {include} The included page could not be found.

Early Finish Day Constraint

Unable to render {include} The included page could not be found.

Early Finish Nth Amount

Unable to render {include} The included page could not be found.

Early Finish Duration

Unable to render {include} The included page could not be found.

Projected Late

Unable to render {include} The included page could not be found.

Critical Path Options

This section contains Critical Path-related specifications for the task.

CP Duration

Unable to render {include} The included page could not be found.

CP Duration (Resolved)

Unable to render {include} The included page could not be found.

CP Duration Unit

Unable to render {include} The included page could not be found.

Workflow Execution Options

This section contains Execution Restriction specifications for the task if it is within a Workflow.

Execution Restriction

Unable to render {include} The included page could not be found.

Restriction Period

Unable to render {include} The included page could not be found.

Before Date

Unable to render {include} The included page could not be found.

Before Time

Unable to render {include} The included page could not be found.

After Date

Unable to render {include} The included page could not be found.

After Time

Unable to render {include} The included page could not be found.

Date List

Unable to render {include} The included page could not be found.

Statistics

This section contains time-related statistics for the task instance.

User Estimated End Time

Unable to render {include} The included page could not be found.

Lowest Estimated End Time

Unable to render {include} The included page could not be found.

Average Estimated End Time

Unable to render {include} The included page could not be found.

Highest Estimated End Time

Unable to render {include} The included page could not be found.

Projected End Time

System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration.

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Status History

History of all statuses that the task instance has gone through.

Buttons

This section identifies the buttons displayed above and below the Task Instance Details that let you perform various actions.

Update

Unable to render {include} The included page could not be found.

Force Finish

Unable to render {include} The included page could not be found.

Hold

Unable to render {include} The included page could not be found.

Skip

Unable to render {include} The included page could not be found.

Re-run

Unable to render {include} The included page could not be found.

View Parent

Unable to render {include} The included page could not be found.

Delete

Unable to render {include} The included page could not be found.

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this task instance.

Tabs

This section identifies the tabs across the top of the Task Instance Details that provide access to additional information about the task instance.

Virtual Resources

Unable to render {include} The included page could not be found.

Exclusive Requests

Unable to render {include} The included page could not be found.

Notes

Unable to render {include} The included page could not be found.

Running a Universal Monitor Task

You can run a Universal Monitor task:

Monitoring Task Execution

You can monitor all system activity from the Activity Monitor and can view activity history from the History list.

  • No labels