Overview

Built-in variables are maintained by Universal Controller and provide information about task instances, agents, Universal Message Service (OMS), and cluster nodes. They can be used in free text fields in triggers, tasks, task actions, and email notifications for agents, OMS servers, and cluster nodes.

Supported built-in variables and their descriptions are provided below. All built-in variables are prefixed with ops_.

Built-In Variable Categories

Built-in variables are listed alphabetically within the following categories on this page:

Agent Variables
Agent-Based Task Instance Variables
Agent Cluster Variables
Agent File Monitor Task Instance/Trigger Variables
Application Monitor Trigger Variables
Cluster Node Variables
Common Variables
Composite Trigger Variables
Email Monitor Task Instance/Trigger Variables
File Transfer Task Instance Variables
OMS Server Variables
PeopleSoft Task Instance Variables
Recurring Task Instance Variables
Remote File Monitor Task Instance Variables
SAP Task Instance Variables
SQL and Stored Procedure Task Instance Variables
SQL Task Instance Variables
Stored Procedure Task Instance Variables
System Monitor Task Instance Variables
Task Instance Variables
Task Monitor Task Instance/Trigger Variables
Trigger Variables
Universal Monitor Task Instance/Trigger and Universal Event Variables
Variable Monitor Task Instance/Trigger Variables
Web Service Task Instance Variables
Webhook Variables
z/OS Task Instance Variables

Agent Variables

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

Agent IP Address

Description	Resolves to the agent IP address (see `${ops_agent_ip`}, below.
Syntax	${ops_agent_ipaddr}
Example

Agent IP Address

Description	Resolves to the agent IP address.
Syntax	${ops_agent_ip}
Example

Agent Mode

Description	Resolves to the agent operational mode (Active, Offline).
Syntax	${ops_agent_mode}
Example

Agent Name

Description	Resolves to the agent name.
Syntax	${ops_agent_name}
Example

Agent Queue Name

Description	Resolves to the agent queue name. Note In the user interface, the queue name is labelled Agent Id.
Syntax	${ops_agent_id}
Example

Note

Although they have the same syntax, ${ops_agent_id}, this Built-In Variables#Agent Queue Name Agent variable resolves to a different value than the Built-In Variables#Agent sys_id Agent-based task instance variable.

Agent-Based Task Instance Variables

The following variables can be used to pass agent information into agent-based task (Windows, Linux/Unix, z/OS, and SAP) notifications; see Creating Email Notifications and Creating SNMP Notifications.

Agent Hostname

Description	Resolves to the agent hostname.
Syntax	${ops_agent_hostname}
Example

Agent IP Address

Description	Resolves to the agent IP address (see `${ops_agent_ip`}, below.
Syntax	${ops_agent_ipaddr}
Example

Agent IP Address

Description	Resolves to the agent IP address.
Syntax	${ops_agent_ip}
Example

Agent Name

Description	Resolves to the agent name.
Syntax	${ops_agent_name}
Example

Agent sys_id

Description	Resolves to the sys_id of the agent.
Syntax	${ops_agent_id}
Example

Note

Although they have the same syntax, ${ops_agent_id}, this Built-In Variables#Agent sys_id Agent-based task instance variable resolves to a different value than the Built-In Variables#Agent Queue Name Agent variable.

Agent Queue Name

Description	Resolves to the agent queue name. Note In the user interface, the queue name is labelled Agent Id.
Syntax	${ops_agent_queue_name}
Example

Agent Cluster Variables

The following agent cluster variables can be used to pass information into an Agent Cluster notification.

Agent Cluster Name

Description	Resolves to the agent cluster name.
Syntax	${ops_agent_cluster_name}
Example

Agent Cluster Distribution

Description	Resolves to the Distribution type for the agent cluster.
Syntax	${ops_agent_cluster_distribution}
Example

Agent Cluster Task Execution Limit

Description	Resolves to the type of Task Execution Limit for the agent cluster.
Syntax	${ops_agent_cluster_limit_type}
Example

Agent Cluster Suspended

Description	Resolves to the current suspension status of the agent cluster.
Syntax	${ops_agent_cluster_suspended}
Example

Agent Cluster Task Execution Limit Amount

Description	Resolves to the maximum number of tasks that can be running at the same time by Agents in this agent cluster.
Syntax	${ops_agent_cluster_limit_max}
Example

Agent Cluster Task Execution Current Limit

Description	Resolves to the current number of tasks currently being run by the Agents in this agent cluster.
Syntax	${ops_agent_cluster_limit_current}
Example

Agent Cluster Network Alias

Description	Resolves to the Network Alias of this agent cluster.
Syntax	${ops_agent_cluster_network_alias}
Example

Agent Cluster Network Alias Port

Description	Resolves to the Agent Port of this agent cluster.
Syntax	${ops_agent_cluster_network_alias_port}
Example

Agent Cluster Notification State

Description	Resolves to the Notification State for which the notification matched.
Syntax	${ops_agent_cluster_notification_state}
Example

Agent File Monitor Task Instance / Trigger Variables

When one or more tasks are launched by a Agent File Monitor trigger after the conditions in its associated Agent File Monitor task are met, the built-in variables described below are passed into the tasks being launched by the trigger.

For example, the Agent File Monitor trigger may specify the launch of a Windows task each time the associated Agent File Monitor task detects the creation of a specific file. The Windows task might use one of these built-in variables as a command argument. Or, if the Agent File Monitor task is not associated with a trigger but is running within a workflow, on completion you can propagate one or more of these built-in variable values to the parent workflow level using the Set Variable action. This allows you to pass information from the Agent File Monitor task to a successor task within the same workflow hierarchy.

Base File Name

Description	Resolves to the base file name.
Syntax	${ops_trigger_file_name_simple}

File Directory

Description	Resolves to the directory where the new file was created, but not the file itself. If the existence or non-existence of the final directory separator is a requirement, we recommend the use of `${ops_trigger_file_fullpath`} and `${ops_trigger_file_fullpath_no_separator`}, respectively.
Syntax	${ops_trigger_file_path}
Example

File Directory (with Final Directory Separator)

Description	Resolves to the directory where the new file was created, but not the file itself; includes the final directory separator.
Syntax	${ops_trigger_file_fullpath}
Example

File Directory (without Final Directory Separator)

Description	Resolves to the directory where the new file was created, but not the file itself; does not include the final directory separator.
Syntax	${ops_trigger_file_fullpath_no_separator}
Example

File Extension

Description	Resolves to the file extension of a file.
Syntax	${ops_trigger_file_name_extension}
Example

Separator

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

Trigger File Group

Description	Resolves to the file group of the file that fired the trigger.
Syntax	${ops_trigger_file_group}
Example

Trigger File Name

Description	Resolves to the name of the file that fired the trigger.
Syntax	${ops_trigger_file_name}
Example

Trigger File Name (No Path)

Description	Resolves to the name of the file that fired the trigger, but without any path information.
Syntax	${ops_trigger_file_name_nopath}
Example

Trigger File Owner

Description	Resolves to the file owner of the file that fired the trigger.
Syntax	${ops_trigger_file_owner}
Example

Trigger File Scan Result

Description	Resolves to the result of the file scan: FOUND or NOT_FOUND.
Syntax	${ops_trigger_file_scan}
Example

Trigger File Size

Description	Resolves to the file size of the file that fired the trigger.
Syntax	${ops_trigger_file_size}
Example

Application Monitor Trigger Variables

When a task is launched by an Application Monitor trigger, the following built-in variables are passed into the task being launched by the trigger:

Trigger Application Name

Description	Resolves to the name of the Application being monitored by the trigger.
Syntax	${ops_trigger_appl_name}
Example

Trigger Application Status

Description	Resolves to the status of the Application being monitored by the trigger.
Syntax	${ops_trigger_appl_status}
Example

Trigger Application sys_id

Description	Resolves to the sys_id of the application.
Syntax	${ops_trigger_appl_id}
Example

Trigger Application Type

Description	Resolves to the type of Application being monitored by the trigger, as defined by the Application Type field.
Syntax	${ops_trigger_appl_type}
Example

Cluster Node Variables

The following cluster node variables allow you to pass information into a cluster node (Controller server) notification:

Cluster Node Hostname

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

Description	Resolves to the current mode of this cluster node: Offline, Active, Passive. For more information, see Viewing Node Status.
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

Common Variables

The following variable is available for Task Instances, Agents, OMS Servers, and Cluster Nodes.

System Identifier

Description	Resolves to the value of the System Identifier Universal Controller system property.
Syntax	${ops_system_identifier}
Example

Composite Trigger Variables

The following built-in variable is associated with the Composite Trigger type. This variable is only available for Composite Trigger components that have a Built-in Variable Prefix specified.

Trigger Component Event Time

Description	Resolves to the time when a Composite Trigger component fired.
Syntax	${<prefix>_trigger_component_event_time}
Example

Email Monitor Task Instance/Trigger Variables

When one or more tasks are launched by an Email Monitor trigger after the conditions in its associated Email Monitor task are met, the built-in variables described below are passed into the tasks being launched by the trigger.

For example, the Email Monitor trigger may specify the launch of an Email task each time the associated Email Monitor task detects the status in a Mailbox folder. The Windows task might use one of these built-in variables as a command argument. Or, if the Agent File Monitor task is not associated with a trigger but is running within a workflow, on completion you can propagate one or more of these built-in variable values to the parent workflow level using the Set Variable action. This allows you to pass information from the Email Monitor task to a successor task within the same workflow hierarchy.

Body Field

Description	Resolves to the Body field of the Email.
Syntax	${ops_trigger_email_body}
Example

Cc Field

Description	Resolves to the Cc field of the Email.
Syntax	${ops_trigger_email_cc}
Example

From Field

Description	Resolves to the From field of the Email.
Syntax	${ops_trigger_email_from}
Example

HTML Body Field

Description	Resolves to the HTML Body field of the Email.
Syntax	${ops_trigger_email_body_html}
Example

Received Date Field

Description	Resolves to the Received Date field of the Email.
Syntax	${ops_trigger_email_received_date}
Example

Reply To Field

Description	Resolves to the Reply-To field of the Email.
Syntax	${ops_trigger_email_reply_to}
Example

Sent Date Field

Description	Resolves to the Sent Date field of the Email.
Syntax	${ops_trigger_email_sent_date}
Example

Subject Field

Description	Resolves to the Subject field of the Email.
Syntax	${ops_trigger_email_subject}
Example

To Field

Description	Resolves to the To field of the Email.
Syntax	${ops_trigger_email_to}
Example

File Transfer Task Instance Variables

For UDM Scripts

These File Transfer variables are available for use in UDM scripts.

The Source and Destination variables are the legacy variables. The Primary and Secondary variables are new for Universal Controller 7.0.0.0.

A UDM Script using the legacy variables will continue to work; those variables will be replaced with the new ones before the script is sent to the Agent.

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 - ${<variable-name>} - the syntax of File Transfer variables is the same as all UDM variables - $(<variable-name>).

The following example illustrates the correct way to code them:

Source and Destination Variables

Primary and Secondary Variables

Source Password

Description	Resolves to the source password.
Syntax	$(ops_src_cred_pwd)
Example

Source User ID

Description	Resolves to the source user ID.
Syntax	$(ops_src_cred_user)
Example

Destination Password

Description	Resolves to the destination password.
Syntax	$(ops_dst_cred_pwd)
Example

Destination User ID

Description	Resolves to the destination user ID.
Syntax	$(ops_dst_cred_user)
Example

Primary Password

Description	Resolves to the Primary password.
Syntax	$(ops_primary_cred_pwd)
Example

Primary User ID

Description	Resolves to the Primary user ID.
Syntax	$(ops_primary_cred_user)
Example

Secondary Password

Description	Resolves to the Secondary password.
Syntax	$(ops_secondary_cred_pwd)
Example

Secondary User ID

Description	Resolves to the Secondary user ID.
Syntax	$(ops_secondary_cred_user)
Example

For Transfer Protocol = UDM

Primary File Name

Description

Resolves to the Primary File(s) field values.

If the Primary File(s) field is empty, it resolves to empty string/blank.

Syntax

$(ops_primary_filename)

$(ops_primary_filename) is an alias for $(ops_local_filename).

Example

Secondary File Name

Description

Resolves to the Secondary File(s) field values.

If the Secondary File(s) field is empty, it resolves to empty string/blank.

Syntax

$(ops_secondary_filename)

$(ops_secondary_filename) is an alias for $(ops_remote_filename).

Example

Primary Agent Hostname

Description

If UDM Agent Option = UDM Agent Hostname; Resolves to the specified hostname.

If UDM Agent Option = UDM Agent or UDM Agent Cluster; Resolves to the IP address of the referenced Agent definition.

If UDM Agent Option = --None–; Resolves to empty string/blank.

If UDM Agent Option = Utility Agent; Resolves to *.

Syntax

${ops_primary_agent_hostname}

Example

Secondary Agent Hostname

Description

If UDM Agent Option = UDM Agent Hostname; Resolves to the specified hostname.

If UDM Agent Option = UDM Agent or UDM Agent Cluster; Resolves to the IP address of the referenced Agent definition.

If UDM Agent Option = --None–; Resolves to empty string/blank.

Syntax

${ops_secondary_agent_hostname}

Example

For Transfer Protocol = FTP/SFTP/FTPS

Local File Name

Description

Resolves to the Local Filename field values.

If the Local Filename field is empty, it resolves to empty string/blank.

Syntax

$(ops_local_filename)

$(ops_local_filename) is an alias for $(ops_primary_filename).

Example

Remote File Name

Description

Resolves to the Remote Filename field values.

If the Remote Filename field is empty, it resolves to empty string/blank.

Syntax

$(ops_remote_filename)

$(ops_remote_filename) is an alias for $(ops_secondary_filename).

Example

OMS Server Variables

The following OMS Server variables allow you to pass information into an OMS Server notification.

Last OMS Server Connected

Description	Resolves to the last OMS Server connected to the Controller in an OMS HA cluster.
Syntax	${ops_oms_last_connected}
Example

Last OMS Server Connected Time

Description	Resolves to the last time that the OMS Server connected to the Controller in an OMS HA cluster.
Syntax	${ops_oms_last_connected_time}
Example

OMS Server IP Address

Description	Resolves to the OMS Server IP address.
Syntax	${ops_oms_server_address}
Example

OMS Server Status

Description	Resolves to the current status of the OMS Server.
Syntax	${ops_oms_status}
Example

OMS Server sys_id

Description	Resolves to the sys_id of the OMS server.
Syntax	${ops_oms_id}
Example

OMS Server Messaging Sessions Status

Description	Resolves to the current status of the OMS Server messaging sessions (heartbeat, input, output): Operational, Impaired, None.
Syntax	${ops_oms_session_status}
Example

PeopleSoft Task and Task Instance Variables

The following built-in variables are available for PeopleSoft tasks and task instances:

Distribution Status

(For task instances only.)

Description	Resolves to the PeopleSoft task instance Distribution Status.
Syntax	${ops_distribution_status}
Example

Main Job Name

Description	Resolves to the PeopleSoft Main Job Name.
Syntax	${ops_main_job_name}
Example

Main Schedule Name

Description	Resolves to the PeopleSoft task/task instance Main Schedule Name.
Syntax	${ops_main_schedule_name}
Example

Process Instance

(For task instances only.)

Description	Resolves to the PeopleSoft task instance Process Instance.
Syntax	${ops_process_instance}
Example

Process Name

Description	Resolves to the PeopleSoft task/task instance Process/Job Name.
Syntax	${ops_process_name}
Example

Process Type

Description	Resolves to the PeopleSoft task/task instance Process Type.
Syntax	${ops_process_type}
Example

Run Status

(For task instances only.)

Description	Resolves to the PeopleSoft task instance Run Status.
Syntax	${ops_run_status}
Example

Recurring Task Instance Variables

The following built-in variables are available for Recurrent tasks and task instances:

Next Recurrence Time

Description	Resolves to the time when the Recurrence task next runs.
Syntax	${ops_next_recurrence_time}
Example

Recurrence Count

Description	Resolves to the current count of task recurrences.
Syntax	${ops_recurrence_count}
Example

Recurrence Count Minus One

Description	Resolves to the current count of task recurrences minus one.
Syntax	${ops_recurrence_count_minus_1}
Example

Source Instance ID

Description	Resolves to the ID of the Recurrence task instance.
Syntax	${ops_source_instance_id}
Example

Source Instance Name

Description	Resolves to the name of the Recurrence task instance.
Syntax	${ops_source_instance_name}
Example

Target Task ID

Description	Resolves to the ID of the target task.
Syntax	${ops_target_task_id}
Example

Target Task Name

Description	Resolves to the name of the target task.
Syntax	${ops_target_task_name}
Example

Remote File Monitor Task Instance Variables

The following built-in variables are available for Remote File Monitor task instances and provide information about the file or file(s) that matched the monitor's criteria.

You can use these variables in a Remote File Monitor action or in a successor task instance by propagating one or more of these built-in variable values to a parent workflow using the Set Variable action.

Base Trigger File Name

Description	Resolves to the base file name.
Syntax	${ops_trigger_file_name_simple}
Example

Files Matching Wildcard

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

Remote Trigger File Name

Description	Resolves to the remote file name.
Syntax	${ops_trigger_file_name}
Example

Remote Trigger File Name (No Path)

Description	Resolves to the remote file name without any path information.
Syntax	${ops_trigger_file_name_nopath}
Example

Trigger File Directory

Description	Resolves to the directory where the remote file is located, but not the file itself. ${ops_trigger_file_path} is an alias for ${ops_trigger_file_fullpath_no_separator}.
Syntax	${ops_trigger_file_path}
Example

Trigger File Directory (with Final Directory Separator)

Description	Resolves to the directory where the remote file is located, but not the file itself; includes the final directory separator.
Syntax	${ops_trigger_file_fullpath}
Example

Trigger File Directory (without Final Directory Separator)

Description	Resolves to the directory where the remote file is located, but not the file itself; does not include the final directory separator.
Syntax	${ops_trigger_file_fullpath_no_separator}
Example

Trigger File Extension

Description	Resolves to the file extension of the file.
Syntax	${ops_trigger_file_name_extension}
Example

Trigger Wildcard

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

SAP Task Instance Variables

For an SAP task instance, where applicable, the following built-in variables resolve to the SAP jobname and SAP jobid of the job running in the SAP system. If you need to use the SAP jobname and/or the SAP jobid from one SAP task instance in a successor SAP task instance, you can use the Set Variable action to propagate these built-in variable values to the parent workflow.

SAP InfoPackage Request ID

Description	Resolves to the SAP InfoPackage Request ID.
Syntax	${ops_sap_requestid}
Example

SAP Job ID

Description	Resolves to the SAP job ID.
Syntax	${ops_sap_jobid}
Example

SAP Job Name

Description	Resolves to the SAP job name.
Syntax	${ops_sap_jobname}
Example

SAP Process Chain ID

Description	Resolves to the SAP Process Chain ID.
Syntax	${ops_sap_chainid}
Example

SAP Process Chain Log ID

Description	Resolves to the SAP Process Chain Log ID.
Syntax	${ops_sap_logid}
Example

SQL and Stored Procedure Task Instance Variables

The following built-in variables are used in SQL tasks and Stored Procedure tasks to collect SQLException data, if any:

Error Message

Description	Resolves to any error message generated by the database.
Syntax	${ops_sql_error_msg}
Example

Processed Rows

Description	Resolves to the number of rows processed.
Syntax	${ops_sql_rows}
Example

Return Code for SQL Statement Outcome

Description	Resolves to a return code that indicates the outcome of the most recently executed SQL statement.
Syntax	${ops_sql_state}
Example

SQL Task Instance Variables

The following built-in variable is available for SQL task instances.

SQL Command Field

Description	Resolves to the value of the SQL Command field.
Syntax	${ops_sql_command}
Example

Stored Procedure Task Instance Variables

The following built-in variable is available for Stored Procedure task instances and provides information about the stored procedure itself.

Stored Procedure Name

Description	Resolves to the value from the Stored Procedure Name field.
Syntax	${ops_stored_proc_name}
Example

System Monitor Task Instance Variables

The following System Monitor variables show the results for Resource Available and Actual Available that can be utilized in System Monitor tasks.

Actual Size

Description	Actual size determined by the agent.
Syntax	${ops_sm_actual_size}
Example

Actual Size (Rounded)

Description	Same as ops_sm_actual_size, except rounded to the nearest integer.
Syntax	${ops_sm_actual_int_size}
Example

Actual Size (Scale)

Description	Scale of the actual size determined by the agent.
Syntax	${ops_sm_actual_scale}
Example

Scale

Description	Scale specified in the By Scale field for Resource Available of the System Monitor task definition.
Syntax	${ops_sm_scale}
Example

Size

Description	Size specified in the Resource Available field of the System Monitor task definition.
Syntax	${ops_sm_size}
Example

Size (Rounded)

Description	Same as ops_sm_size, except that ops_sm_int_size is rounded to the nearest integer.
Syntax	${ops_sm_int_size}
Example

Task Instance Variables

The following built-in variables are associated with task instances for all task types.

Cluster Node Hostname

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. For more information, see Viewing Node Status.
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

Command Parameters

Description	For tasks that launch a command on a Windows or Linux/Unix machine; resolves to the task command parameters.
Syntax	${ops_cmd_parms}
Example

Custom Field 1

Description	Resolves to the value of user-defined field #1.
Syntax	${ops_custom_field1}
Example

Custom Field 2

Description	Resolves to the value of user-defined field #2.
Syntax	${ops_custom_field2}
Example

Description

Description	Resolves to the value of the Task Description field.
Syntax	${ops_description}
Example

Duration

Description	Resolves to the task instance Duration.
Syntax	${ops_duration_text}
Example	ops_duration_text = 2 Minutes 10 Seconds

Duration In Seconds

Description	Resolves to the task instance Duration In Seconds.
Syntax	${ops_duration}
Example	ops_duration = 130000

End Time

Description	Resolves to the task ending time.
Syntax	${ops_end_time}
Example

End Time: Average Estimated

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

End Time: Highest Estimated

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

End Time: Lowest Estimated

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

End Time: User Estimated

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

Execution User ID

Description	Resolves to the ID of the user who launched the task or to the ID of the user who enabled the trigger that launched the task.
Syntax	${ops_execution_user}
Example

Instance Number

Description	Resolves to the sequentially assigned number, maintained per task, representing the creation order of the instance. For example, if you launch a task twice, the first task instance will have instance number 1, and the second task instance will have instance number 2.
Syntax	${ops_instance_number}
Example

Launch Time

Description	Resolves to the task launch time. For workflows, all descendants will have the same launch time as the top-level workflow.
Syntax	${ops_launch_time}
Example

Maximum Retry Count

Description	Resolves to the maximum retry count.
Syntax	${ops_retry_maximum}
Example

Parent Workflow Instance sys_id

Description	Resolves to the sys_id of the parent workflow task instance.
Syntax	${ops_workflow_id}
Example

Parent Workflow Name

Description	Resolves to the name of the parent workflow.
Syntax	${ops_workflow_name}
Example

Projected End Time of Workflow

Description	Resolves to the projected end time of workflow, based on its critical path calculations.
Syntax	${projected_end_time}
Example

Queued Time

Description	Resolves to the date and time that the task was queued for processing.
Syntax	${ops_queued_time}
Example

Reference Id

Description	Resolves to the sequentially assigned number, maintained per task, representing the creation order of the instance. For example, if you launch a task twice, the first task instance will have instance number 1, and the second task instance will have instance number 2. Note Although it still is supported, the Reference Id built-in variable has been superseded by the Instance Number built-in variable.
Syntax	${ops_task_ref_count}
Example

Retry Count

Description	Resolves to the current retry count.
Syntax	${ops_retry_count}
Example

Retry Interval

Description	Resolves to the retry interval (seconds).
Syntax	${ops_retry_interval}
Example

Script ID

Description	For Windows, Linux/Unix, and SAP tasks where a Script or SAP Definition from Scripts is specified; resolves to the Controller system ID of the script.
Syntax	${ops_script_id}
Example

Script Name

Description	For Windows, Linux/Unix, and SAP tasks where a Script or SAP Definition from Scripts is specified; resolves to the Controller name of the script.
Syntax	${ops_script_name}
Example

Script Parameters

Description	For tasks that run a script on a Windows or Linux/Unix machine; resolves to the task script parameters.
Syntax	${ops_script_parms}
Example

Starting Time

Description	Resolves to the task starting time.
Syntax	${ops_start_time}
Example

Task Instance Attempts

Description	Resolves to the current task instance attempt count. Each Re-run operation increments the attempt. Initial attempt is 1.
Syntax	${ops_attempt}
Example

Task Instance Definition ID

Description	Resolves to the task instance definition ID.
Syntax	${ops_task_definition_id}
Example

Task Instance Exit Code

Description	Resolves to the task instance exit code, if any.
Syntax	${ops_exit_code}
Example

Task Instance Name

Description	Resolves to the task instance name.
Syntax	${ops_task_name}
Example

Task Instance Status

Description	Resolves to the current task instance status.
Syntax	${ops_status}
Example

Task Instance Status Description

Description	Resolves to the task instance status description.
Syntax	${ops_status_description}
Example

Task Instance sys_id

Description	Resolves to the sys_id of the task instance.
Syntax	${ops_task_id}
Example

Task Name at Instance Creation Time

Description	Resolves to the name of the task at the time the task instance was created. Note If the name of the task contains variables, those variables contained in the task will be fully resolved when using this built-in variable, ${ops_task_security_name}.
Syntax	${ops_task_security_name}
Example

Task Type

Description	Resolves to the task type.
Syntax	${ops_task_type}
Example

Task Vertex ID

Description	Resolves to the value of the task’s vertex id in a workflow.
Syntax	${ops_vertex_id}
Example	Ops_vertex_id = 5

Time Zone (Task time zone)

Description	Resolves to the time zone of the task instance, as specified by the Time Zone Preference field.
Syntax	${ops_task_time_zone}
Example

Time Zone (Trigger time zone)

Description	Resolves to the time zone of the trigger that launched the task. If the task was launched by the Trigger Now/Launch Task command, the built-in variable will resolve to the command's time zone option, or if no time zone option was specified, the server time zone.
Syntax	${ops_time_zone}
Example

Top-Level Workflow Name

Description	Resolves to the name of the top-level workflow task instance.
Syntax	${ops_top_level_workflow_name}
Example

Top-Level Workflow Task Instance ID

Description	Resolves to the sys_id of the top-level workflow task instance.
Syntax	${ops_top_level_workflow_id}
Example

Virtual Resource Priority

Description	Resolves to the value of the task instance field Virtual Resource Priority.
Syntax	${ops_resource_priority}
Example

Task Monitor Task Instance/Trigger Variables

When the conditions of a Task Monitor task are met and its associated Task Monitor trigger launches one or more tasks, the following built-in variables are passed into the task instances being launched by the trigger.

For example, the Task Monitor trigger may specify an Email task that will launch each time the conditions in the associated Task Monitor task are met. You might want to specify one or more of these variables in the body of the email.

If the Task Monitor task is not associated with a trigger but is running within a workflow, on completion you can propagate one or more of these built-in variable values to the parent workflow level by using the Set Variable action. This allows you to pass information from the Task Monitor task to a successor task within the same workflow hierarchy.

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 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 Id

Description

Resolves to the uuid of the workflow instance containing the task instance that matched the Task Monitor conditions and fired the trigger.

This variable is available only if the task instance that matched the Task Monitor conditions and fired the trigger is invoked by a workflow.

Syntax

${ops_trigger_workflow_id}

Example

Trigger Workflow Name

Description	Resolves to the name of the workflow instance containing the task instance that matched the Task Monitor conditions and fired the trigger. This variable is available only for a Task Monitor task that has a Workflow Condition 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

Trigger Variables

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.

Custom Field 1

Description	Resolves to the value of user-defined field #1.
Syntax	${ops_trigger_custom_field1}
Example

Custom Field 2

Description	Resolves to the value of user-defined field #2.
Syntax	${ops_trigger_custom_field2}
Example

Trigger Name

Description	Resolves to the name of the trigger that launched the task instance.
Syntax	${ops_trigger_name}
Example

Trigger Time

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

Trigger Time (Trigger time zone)

Description	Resolves to the trigger time in the time zone of the trigger.
Syntax	${ops_trigger_time_tz}
Example

Universal Monitor Task Instance/Trigger and Universal Event Variables

Universal Event Attributes

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

Universal Event Business Services

Description

Business Services of the Universal Event.

If the Universal Event is published from a universal task instance, the Universal Event inherits the business services from the task instance.

If the Universal Event is a system-published event, it inherits the business services of the object the event is being published for.

If the Universal Event is published via our publish web service API, the business services are specified as part of the request body.

If the Universal Event is published via our push web service API, the business services are specified as part of the request query parameters.

Syntax

${ops_trigger_universal_event_business_services}

Example

Universal Event Name

Description	Name of the Universal Event.
Syntax	${ops_trigger_universal_event_name}
Example

Universal Event Publisher ID

Description	UUID of the Universal Task Instance that published the Universal Event, if applicable.
Syntax	${ops_trigger_universal_event_publisher_id}
Example

Universal Event Time To Live

Description	Time To Live (in minutes) for the Universal Event.
Syntax	${ops_trigger_universal_event_ttl}
Example

Universal Template ID

Description	UUID of the Universal Template, if applicable.
Syntax	${ops_trigger_universal_template_id}
Example

Universal Template Event Template ID

Description	UUID of the Universal Template Event Template, if applicable.
Syntax	${ops_trigger_universal_template_event_template_id}
Example

Universal Event Template ID

Description	UUID of the Universal Event Template, if applicable.
Syntax	${ops_trigger_universal_event_template_id}
Example

Variable Monitor Task Instance/Trigger Variables

When the conditions of a Variable Monitor task are met and its associated Variable Monitor trigger launches one or more tasks, the following built-in variables are passed into the task instances being launched by the trigger.

For example, the Variable Monitor trigger may specify an Email task that will launch each time the conditions in the associated Variable Monitor task are met. You might want to specify one or more of these variables in the body of the email.

If the Variable Monitor task is not associated with a trigger but is running within a workflow, on completion you can propagate one or more of these built-in variable values to the parent workflow level by using the Set Variable action. This allows you to pass information from the Variable Monitor task to a successor task within the same workflow hierarchy.

Trigger Variable Name

Description	Resolves to the name of the variable being monitored.
Syntax	${ops_trigger_variable_name}
Example

Trigger Variable Value

Description	Resolves to the current value of the variable being monitored.
Syntax	${ops_trigger_variable_value}
Example

Trigger Variable Previous Value

Description	Resolves to previous value of the variable being monitored.
Syntax	${ops_trigger_variable_prev_value}
Example

Web Service Task Instance Variables

The following built-in variables are available for Web Service task instances:

URL

Description	Resolves to the entire encoded URL containing the host, port, path and query.
Syntax	${ops_url}
Example

Raw Value of URL

Description	Resolves to the raw value of the URL field.
Syntax	${ops_url_raw}
Example

URL Host

Description	Resolves to the URL host.
Syntax	${ops_url_host}
Example

URL Port

Description	Resolves to the URL port.
Syntax	${ops_url_port}
Example

URL Path

Description	Resolves to the encoded URL path.
Syntax	${ops_url_path}
Example

Unencoded URL Path

Description	Resolves to the unencoded URL path.
Syntax	${ops_url_path_unencoded}
Example

URL Query

Description	Resolves to the URL query.
Syntax	${ops_url_query}
Example

Unencoded URL Query

Description	Resolves to the unencoded URL query.
Syntax	${ops_url_query_unencoded}
Example

Webhook Variables

The following built-in variables are available for Webhooks:

Universal Event Payload

Description	Resolves to same JSON payload for the matched Universal Event that would be used for a URL action.
Syntax	${ops_webhook_eventName_payload}
Example

Webhook Name

Description	Resolves to the name of the Webhook that launched the Task Instance.
Syntax	${ops_webhook_name}
Example

z/OS Task Instance Variables

The following built-in variables are available for z/OS task instances:

JCL Location

Description	Resolves to the file and member name containing the JCL script.
Syntax	${ops_jcl_location}
Example

Job Number

Description	Resolves to the job number assigned to the job by JES.
Syntax	${ops_job_id}
Example

Override JCL Location

Description	Resolves to the file and member name of the JCL location containing a potential override JCL script.
Syntax	${ops_override_jcl_location}
Example

Submitted JCL Location

Description	Resolves to the file and member name of the JCL location that was actually used for job submission.
Syntax	${ops_submitted_jcl_location}
Example

Browser not supported