...
Built-in variables are listed alphabetically within the following categories on this page:
- Built-In Variables#Agent Agent Variables
- BuiltAgent-In Variables#Agent-Based Task Instance VariablesBuilt-In Variables#Agent
- Agent Cluster Variables
- Agent File Monitor Task Instance/Trigger Variables
- Built-In Variables#Application Application Monitor Trigger VariablesBuilt-In Variables#Cluster
- Cluster Node Variables
- Built-In Variables#Common Common VariablesBuilt-In Variables#Composite
- Composite Trigger Variables
- Email Monitor Task Instance/Trigger Variables
- Built-In Variables#File File Transfer Task Instance VariablesBuilt-In Variables#OMS
- OMS Server Variables
- Built-In Variables#PeopleSoft PeopleSoft Task Instance VariablesBuilt-In Variables#Recurring
- Recurring Task Instance Variables
- Built-In Variables#Remote Remote File Monitor Task Instance VariablesBuilt-In Variables#SAP
- SAP Task Instance Variables
- Built-In Variables#SQL SQL and Stored Procedure Task Instance VariablesBuilt-In Variables#SQL
- SQL Task Instance Variables
- Built-In Variables#Stored Stored Procedure Task Instance VariablesBuilt-In Variables#System
- System Monitor Task Instance Variables
- Built-In Variables#Task Task Instance Variables
- Task Monitor Task Instance/Trigger Variables
- Built-In Variables#Trigger Trigger Variables
- Variable Monitor Task Instance/Trigger Variables
- Built-In Variables#Web Web Service Task Instance VariablesBuilt-
- In Variables#z/z/OS Task Instance Variables
Anchor | ||||
---|---|---|---|---|
|
The following agent variables can be used to pass information into an Agent notification.
Agent Hostname
Description | Resolves to the agent hostname. |
---|---|
Syntax | ${ops_agent_hostname} |
Example |
...
Note | ||
---|---|---|
| ||
Although they have the same syntax, ${ops_agent_id}, this Built-In Variables#Agent Agent Queue Name Agent variable resolves to a different value than the Built-In Variables#Agent Agent sys_id Agent-based task instance variable. |
...
Note | ||
---|---|---|
| ||
Although they have the same syntax, ${ops_agent_id}, this Built-In Variables#Agent Agent sys_id Agent-based task instance variable resolves to a different value than the Built-In Variables#Agent Agent Queue Name Agent variable. |
Agent Queue Name
...
Description | Resolves to the separator appropriate to the platform where the agent is running. For Windows, resolves to a backslash ( \ ); for Linux/Unix, resolves to forward slash ( / ). This variable may be useful if you want to piece together a pathname using a combination of text and variables. | ||||
---|---|---|---|---|---|
Syntax | ${ops_trigger_file_separator} | ||||
Example |
|
Trigger File Date
Description | Resolves to the file date of the file that fired the trigger. |
---|---|
Syntax | ${ops_trigger_file_date} |
Example |
...
Description | Resolves to the hostname of this cluster node. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_hostname} | ||||
Example |
|
Cluster Node ID
Description | Resolves to the cluster node's internally-generated build ID. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_id} | ||||
Example |
|
Cluster Node IP Address
Description | Resolves to the IP address of this cluster node. | |
---|---|---|
Syntax | ${ops_cluster_ipaddr} | |
Example |
|
Cluster Node Mode
|
Cluster Node Mode
Description | Resolves to the current mode of this cluster node: Offline, Active, Passive. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_mode} | ||||
Example |
|
Cluster Node Name
Description | ${ops_cluster_name} is an alias for the ${ops_cluster_id} variable. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_name} | ||||
Example |
|
Cluster Node Running Time
Description | Resolves to the numbers of days, hours, and minutes that this cluster node has been running since it was last started. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_uptime} | ||||
Example |
|
Cluster Node Start Time
Description | Resolves to the date and time the cluster node (server) was started. |
---|
...
Syntax | ${ops_cluster_start_time} | |
---|---|---|
Example |
|
...
|
Anchor | ||||
---|---|---|---|---|
|
The following variable is available for Task Instances, Agents, OMS Servers, and Cluster Nodes.
...
Description | Resolves to the value of the System Identifier Universal Controller system property. |
---|---|
Syntax | ${ops_system_identifier} |
Example |
...
Note | ||
---|---|---|
| ||
These variables differ from all other built-in variables in that they are resolved by Universal Data Mover (UDM) on a UDM agent, not by the Universal Controller. File Transfer variables are sent to an agent unresolved and UDM performs all resolution for them. The resolved value is never available to the Controller. Unlike the syntax of built-in variables resolved by Universal Controller - |
The following example illustrates the correct way to code them:
Panel |
---|
Source and Destination Variables |
Panel |
---|
Primary and Secondary Variables |
...
|
...
Description
...
Resolves to the source password.
...
Syntax
|
...
Example
...
|
...
|
...
|
...
|
...
Description
...
Resolves to the source user ID.
...
Syntax
|
Panel | ||
---|---|---|
Primary and Secondary Variables
|
...
|
...
Example
Anchor | ||
---|---|---|
|
...
|
...
|
...
Source Password
Description | Resolves to the destination source password. |
---|---|
Syntax | $(ops_dstsrc_cred_pwd) |
Example |
Anchor | ||
---|---|---|
|
...
|
...
|
...
Source User ID
Description | Resolves to the destination source user ID. |
---|---|
Syntax | $(ops_src_cred_user) |
Example |
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the destination password. |
---|---|
Syntax | $(ops_dst_cred_pwd) |
Example |
Anchor | ||||
---|---|---|---|---|
|
Description | Resolves to the destination user ID. |
---|---|
Syntax | $(ops_dst_cred_user) |
Example |
Anchor | ||||
---|---|---|---|---|
|
...
Description | Resolves to a comma-separated list of files that matched the wildcard, if one was specified in the Remote Filename field in the Remote File Monitor task. | ||
---|---|---|---|
Syntax | ${ops_trigger_files} | ||
Example | Description |
|
Remote Trigger File Name
|
Remote Trigger File Name
Description | Resolves to the remote file name. |
---|---|
Syntax | ${ops_trigger_file_name} |
Example |
...
Description | Resolves to the contents of the Remote Filename field in the Remote File Monitor task. | ||||
---|---|---|---|---|---|
Syntax | ${ops_trigger_wildcard} | ||||
Example |
|
Trigger Wildcard Path Only
Description | Resolves to the path only, with the final slash but without the file name, from the Remote Filename field in the Remote File Monitor task. | ||||
---|---|---|---|---|---|
Syntax | ${ops_trigger_wildcard_path} | ||||
Example |
|
Trigger Wildcard Path Only (without Final Slash)
...
Description | Resolves to the path only, without the final slash and without the file name, from the Remote Filename field in the Remote File Monitor task. | |
---|---|---|
Syntax | ${ops_trigger_wildcard_path_no_separator} | |
Example |
|
...
|
Anchor | ||||
---|---|---|---|---|
|
...
Description | Resolves to the hostname of the Active cluster node. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_hostname} | ||||
Example |
|
Cluster Node ID
Description | Resolves to the Active cluster node's internally-generated build ID. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_id} | ||||
Example |
|
Cluster Node IP Address
Description | Resolves to the IP address of the Active cluster node. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_ipaddr} | ||||
Example |
|
Cluster Node Mode
Description | Resolves to the current mode of the cluster node: Offline, Active, Passive. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_mode} | ||||
Example |
|
Cluster Node Name
Description | ${ops_cluster_name} is an alias for the ${ops_cluster_id} variable. | |
---|---|---|
Syntax | ${ops_cluster_name} | |
Example |
|
...
|
Cluster Node Running Time
Description | Resolves to the numbers of days, hours, and minutes that the Active cluster node has been running since it was last started. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_uptime} | ||||
Example |
|
Cluster Node Start Time
Description | Resolves to the date and time the Active cluster node (server) was started. | ||||
---|---|---|---|---|---|
Syntax | ${ops_cluster_start_time} | ||||
Example |
|
Command
Description | For tasks that launch a command on a Windows or Linux/Unix machine; resolves to the task command. |
---|---|
Syntax | ${ops_cmd} |
Example |
...
Description | Resolves to the Average Estimated End Time in the server's time zone. |
---|---|
Syntax | ${ops_avg_estimated_end_time} |
Example | ${ops_avg_estimated_end_time} > 2018-10-16 15:01:45 -0400 |
...
Description | Resolves to the Highest Estimated End Time in the server's time zone. |
---|---|
Syntax | ${ops_highest_estimated_end_time} |
Example | ${ops_highest_estimated_end_time} > 2018-10-16 15:01:45 -0400 |
...
Description | Resolves to the Lowest Estimated End Time in the server's time zone. |
---|---|
Syntax | ${ops_lowest_estimated_end_time} |
Example | ${ops_lowest_estimated_end_time} > 2018-10-16 15:01:44 -0400 |
...
Description | Resolves to the User Estimated End Time in the server's time zone. |
---|---|
Syntax | ${ops_user_estimated_end_time} |
Example | ${ops_user_estimated_end_time} > 2018-10-16 15:01:54 -0400 |
...
Trigger Task Name
Description | Resolves to the name of the task instance that matched the Task Monitor conditions and fired the trigger. |
---|---|
Syntax | ${ops_trigger_task_name} |
Example |
Trigger Task Status
Description | Resolves to the status of the task instance that matched the Task Monitor conditions and fired the trigger. |
---|---|
Syntax | ${ops_trigger_task_status} |
Example |
Trigger Task sys_id
Description | Resolves to the sys_id of of the task instance that matched the Task Monitor conditions and fired the trigger. |
---|---|
Syntax | ${ops_trigger_task_id} |
Example |
Trigger Task Type
Description | Resolves to the type of the task instance that matched the Task Monitor conditions and fired the trigger. |
---|---|
Syntax | ${ops_trigger_task_type} |
Example |
Trigger Workflow Name
Description | Resolves to the name of the workflow instance containing the task instance that fired the triggermatched the Task Monitor conditions and fired the trigger. This variable is available only for a Task Monitor task specified specified. If a workflow condition is specified, ${ops_trigger_workflow_name} will resolve to the name of the workflow instance that the workflow condition matched. |
---|---|
Syntax | ${ops_trigger_workflow_name} |
Example |
...
The following built-in variables are associated with all trigger types.
When a task is launched by a trigger, the values of the following built-in variables, if they are specified in the task, are passed into the task instance.
...
Description | Resolves to the value of user-defined field #1. |
---|---|
Syntax | ${ops_trigger_custom_field1} |
Example |
...
Description | Resolves to the value of user-defined field #2. |
---|---|
Syntax | ${ops_trigger_custom_field2} |
Example |
...
Description | Resolves to the scheduled time of the trigger or, if the trigger is not scheduled, the actual trigger time. If the task is triggered by date/time, it resolves to that specified date/time. |
---|---|
Syntax | ${ops_trigger_time} |
Example |
...
Description | Resolves to the trigger time in the time zone of the trigger. |
---|---|
Syntax | ${ops_trigger_time_tz} |
Example |
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Description | Name of a Universal Event Attribute. Facilitates the passing of matched Universal Event attributes to downstream instances within a workflow or to instances launched by a Universal Monitor Trigger. |
---|---|
Syntax | ${ops_trigger_eventName_attributeName} |
Example |
Anchor | ||||
---|---|---|---|---|
|
Description | Name of the Universal Event. |
---|---|
Syntax | ${ops_trigger_universal_event_name} |
Example |
Anchor | ||||
---|---|---|---|---|
|
Description | UUID of the Universal Task Instance that published the Universal Event, if applicable. |
---|---|
Syntax | ${ops_trigger_universal_event_publisher_id} |
Example |
Anchor | ||||
---|---|---|---|---|
|
Description | Time To Live (in minutes) for the Universal Event. |
---|---|
Syntax | ${ops_trigger_universal_event_ttl} |
Example |
Anchor | ||||
---|---|---|---|---|
|
Description | UUID of the Universal Template, if applicable. |
---|---|
Syntax | ${ops_trigger_universal_template_id} |
Example |
Anchor | ||||
---|---|---|---|---|
|
Description | UUID of the Universal Template Event Template, if applicable. |
---|---|
Syntax | ${ops_trigger_universal_template_event_template_id} |
Example |
Anchor | ||||
---|---|---|---|---|
|
Description | UUID of the Universal Event Template, if applicable. |
---|---|
Syntax | ${ops_trigger_universal_event_template_id} |
Example |
Anchor | ||||
---|---|---|---|---|
|
...