Timer Task
Overview
The Timer task allows you to execute a timer command for a specified period of time or until a specific time. This task is helpful, for example, if you need to impose a pause in the processing of a Workflow.
Built-In Variables
The following built-in variables can be used in a Manual task to pass data where appropriate:
Creating a Timer Task
Step 1 | From the Automation Center navigation pane, select Tasks > Timer Tasks. The Timer Tasks list displays a list of all currently defined Timer tasks. |
|---|---|
Step 2 | Enter/select Details for a new Timer task, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can either:
|
Step 3 | Click a 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).
Timer Task Details
The following Linux/Unix Task Details is for an existing Linux/Unix task.
Depending on the values that you enter / select for these fields, and whether or not the Timer 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 Timer Task Details.
Timer Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the Timer 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 length is 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:
|
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 | |
Hold Resources on Failure | |
Mutually Exclusive With Self | |
Simulate | |
Timer Details | This section contains assorted detailed information about the task. |
Timer Type | |
Timer Time (HH:MM) | |
Timer Day Constraint | |
Timer Duration | |
Timer Duration in Seconds | |
Time Options | This section contains time-related specifications for the task. |
Late Start | |
Late Start Type | |
Late Start Time | |
Late Start Day Constraint | |
Late Start Nth Amount | |
Late Start Duration | |
Late Finish | |
Finished Late | |
Late Finish Type | |
Late Finish Offset Type | |
Late Finish Percentage Offset ( + ) | |
Late Finish Duration Offset ( + ) | |
Late Finish Duration Offset Unit | |
Late Finish Time | |
Late Finish Day Constraint | |
Late Finish Nth Amount | |
Late Finish Duration | |
Early Finish | |
Finished Early | |
Early Finish Type | |
Early Finish Offset Type | |
Early Finish Percentage Offset ( - ) | |
Early Finish Duration Offset ( - ) | |
Early Finish Duration Offset Unit | |
Early Finish Time | |
Early Finish Day Constraint | |
Early Finish Nth Amount | |
Early Finish Duration | |
User Estimated Duration | |
Critical Path Options | This section contains Critical Path-related specifications for the task. |
CP Duration | |
CP Duration (Resolved) | |
CP Duration Unit | |
Workflow Execution Options | This section contains Critical Path-related specifications for the task. |
Execution Restriction | |
Restriction Period | |
Before Date | |
Before Time | |
After Date | |
After Time | |
Date List | |
Statistics | This section contains time-related statistics for the task instances of the task. |
First Execution | |
Last Execution | |
Last Instance Duration | |
Lowest Instance Time | |
Average Instance Time | |
Highest Instance Time | |
Number of Instances | |
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 | |
Launch Task | |
View Parents | |
Copy | Creates a copy of this task, which you are prompted to rename. |
Delete | Note You cannot delete a task if it is either:
|
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 | |
Actions | |
Virtual Resources | |
Mutually Exclusive | |
Instances | Lists all instances of the task. |
Triggers | |
Notes | |
Versions |
Viewing a Timer Task Instance
When a Timer 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:
Instances tab on the Timer Task Details for that task
Timer Task Instance Details
The following Timer Task Instance Details contains information on the execution of the task shown in the Timer Task Details.
Timer Task Instance Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in Timer 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 | |
Description | |
Member of Business Services | |
Task | |
Source Version | |
Launch Source | |
Source Instance | |
Invoked by | |
Execution User | |
Calendar | |
Time Zone Preference | |
Virtual Resource Priority | |
Hold Resources on Failure | |
Mutually Exclusive With Self | |
Simulate | |
Status | This section contains information about the current status of the task instance. |
Status | |
Exit Code | |
Status Description | |
Operational Memo | |
Evaluation Time |