Built-In Variables

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
  • z/OS Monitor Task Instance/Trigger 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}

Agent IP Address

Description

Resolves to the agent IP address {see ${ops_agent_ip}, below.

Syntax

${ops_agent_ipaddr}

Agent IP Address

Description

Resolves to the agent IP address.

Syntax

${ops_agent_ip}

Agent Mode

Description

Resolves to the agent operational mode {Active, Offline}.

Syntax

${ops_agent_mode}

Agent Name

Description

Resolves to the agent name.

Syntax

${ops_agent_name}

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}

Note

Although they have the same syntax, ${ops_agent_id}, this Agent Queue Name Agent variable resolves to a different value than the 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 notifications; see Creating Email Notifications and Creating SNMP Notifications.

Agent-based task types:

  • Linux/Unix
  • Windows
  • z/OS
  • Universal Command
  • SAP
  • PeopleSoft
  • File Transfer
  • Agent File Monitor
  • Remote File Monitor
  • System Monitor
  • Universal

Agent Hostname

Description

Resolves to the agent hostname.

Syntax

${ops_agent_hostname}

Agent IP Address

Description

Resolves to the agent IP address {see ${ops_agent_ip}, below.

Syntax

${ops_agent_ipaddr}

Agent IP Address

Description

Resolves to the agent IP address.

Syntax

${ops_agent_ip}

Agent Name

Description

Resolves to the agent name.

Syntax

${ops_agent_name}

Agent sys_id

Description

Resolves to the sys_id of the agent.

Syntax

${ops_agent_id}

Note

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

Credential ID

Description

Resolves to the sys_id of the credential defined in the Agent Details section of the task definition (Utility Credential or Credential).

If a credential is defined on the agent and not in the Agent Details section of the task definition, it will be the agent’s Credential ID.

Syntax

${ops_credential_id}

Credential Name

Description

Resolves to the Name of the credential defined in the Agent Details section of the task definition (Utility Credential or Credential).

If a credential is defined on the agent and not in the Agent Details section of the task definition, it will be the agent’s credential Name.

Syntax

${ops_credential_name}

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}

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}

Agent Cluster Distribution

Description

Resolves to the Distribution type for the agent cluster.

Syntax

${ops_agent_cluster_distribution}

Example

${ops_agent_cluster_distribution} → Any

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

${ops_agent_cluster_limit_type} → Unlimited

Agent Cluster Suspended

Description

Resolves to the current suspension status of the agent cluster.

Syntax

${ops_agent_cluster_suspended}

Example

${ops_agent_cluster_suspended} → true

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

${ops_agent_cluster_limit_max} → 5

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

${ops_agent_cluster_limit_current} → 3

Agent Cluster Network Alias

Description

Resolves to the Network Alias of this agent cluster.

Syntax

${ops_agent_cluster_network_alias}

Agent Cluster Network Alias Port

Description

Resolves to the Agent Port of this agent cluster.

Syntax

${ops_agent_cluster_network_alias_port}

Agent Cluster Notification State

Description

Resolves to the Notification State for which the notification matched.

Syntax

${ops_agent_cluster_notification_state}

Example

${ops_agent_cluster_notification_state} → Suspended


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}

Example${ops_trigger_file_name_simple} → file

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

${ops_trigger_file_path} C:\stonebranch

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

${ops_trigger_file_fullpath} C:\stonebranch\

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

${ops_trigger_file_fullpath_no_separator} C:\stonebranch

File Extension

Description

Resolves to the file extension of a file.

Syntax

${ops_trigger_file_name_extension}

Example

${ops_trigger_file_name_extension} → dat 

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

${ops_trigger_file_separator} → \

Trigger File Date

Description

Resolves to the file date of the file that fired the trigger.

Syntax

${ops_trigger_file_date}

Example

${ops_trigger_file_date} 20241018104639

Trigger File Group

Description

Resolves to the file group of the file that fired the trigger.

Syntax

${ops_trigger_file_group}

Trigger File Name

Description

Resolves to the name of the file that fired the trigger.

Syntax

${ops_trigger_file_name}

Example

${ops_trigger_file_name} → C:\stonebranch\file.dat

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

${ops_trigger_file_name_nopath} → file.dat

Trigger File Owner

Description

Resolves to the file owner of the file that fired the trigger.

Syntax

${ops_trigger_file_owner}

Example

${ops_trigger_file_owner} → Administrator

Trigger File Scan Result

Description

Resolves to the result of the file scan: FOUND or NOT_FOUND.

Syntax

${ops_trigger_file_scan}

Trigger File Size

Description

Resolves to the file size of the file that fired the trigger.

Syntax

${ops_trigger_file_size}

Example

${ops_trigger_file_size} 141085

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}

Trigger Application Status

Description

Resolves to the status of the Application being monitored by the trigger.

Syntax

${ops_trigger_appl_status}

Example

${ops_trigger_appl_status} → Starting

Trigger Application sys_id

Description

Resolves to the sys_id of the application.

Syntax

${ops_trigger_appl_id}

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

${ops_trigger_appl_type} → Windows Service

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

${ops_cluster_hostname} MACHINEC19A

Cluster Node ID

Description

Resolves to the cluster node's internally-generated build ID.

Syntax

${ops_cluster_id}

Example

${ops_cluster_id} → MACHINEC19A:8080-uc

Cluster Node IP Address

Description

Resolves to the IP address of this cluster node.

Syntax

${ops_cluster_ipaddr}

Example

${ops_cluster_ipaddr} → 10.N.N.NN

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

${ops_cluster_mode} → Active

Cluster Node Name

Description

${ops_cluster_name} is an alias for the ${ops_cluster_id} variable.

Syntax

${ops_cluster_name}

Example

${ops_cluster_name} → MACHINEC19A:8080-uc

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

${ops_cluster_uptime} → 1 Hour 10 Minutes 57 Seconds

Cluster Node Start Time

Description

Resolves to the date and time the cluster node {server} was started.

Syntax

${ops_cluster_start_time}

Example

${ops_cluster_start_time} → 2024-10-14 08:54:09 -0400

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

${ops_system_identifier} → QA UC6

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}

Examples

${filetrigger_component_event_time} → 2024-10-21 14:38:29 -0400

${timetrigger_component_event_time} → 2024-10-21 14:38:29 -0400

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.

Credential ID

Description

Resolves to the sys_id of the Task’s credential.

Syntax

${ops_credential_id}

Credential Name

Description

Resolves to the Name of the Task’s credential.

Syntax

${ops_credential_name}

Body Field

Description

Resolves to the Body field of the Email.

Syntax

${ops_trigger_email_body}

Cc Field

Description

Resolves to the Cc field of the Email.

Syntax

${ops_trigger_email_cc}

From Field

Description

Resolves to the From field of the Email.

Syntax

${ops_trigger_email_from}

HTML Body Field

Description

Resolves to the HTML Body field of the Email.

Syntax

${ops_trigger_email_body_html}

Received Date Field

Description

Resolves to the Received Date field of the Email.

Syntax

${ops_trigger_email_received_date}

Example

${ops_trigger_email_received_date} 2024-10-16 13:01:33 -0700

Reply To Field

Description

Resolves to the Reply-To field of the Email.

Syntax

${ops_trigger_email_reply_to}

Sent Date Field

Description

Resolves to the Sent Date field of the Email.

Syntax

${ops_trigger_email_sent_date}

Example

${ops_trigger_email_sent_date} → 2024-10-16 13:01:27 -0700

Subject Field

Description

Resolves to the Subject field of the Email.

Syntax

${ops_trigger_email_subject}

To Field

Description

Resolves to the To field of the Email.

Syntax

${ops_trigger_email_to}


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}

Source User ID

Description

Resolves to the source user ID.

Syntax

${ops_src_cred_user}

Destination Password

Description

Resolves to the destination password.

Syntax

${ops_dst_cred_pwd}

Destination User ID

Description

Resolves to the destination user ID.

Syntax

${ops_dst_cred_user}

Primary Password

Description

Resolves to the Primary password.

Syntax

$(ops_primary_cred_pwd)

Primary User ID

Description

Resolves to the Primary user ID.

Syntax

$(ops_primary_cred_user)

Secondary Password

Description

Resolves to the Secondary password.

Syntax

$(ops_secondary_cred_pwd)

Secondary User ID

Description

Resolves to the Secondary user ID.

Syntax

$(ops_secondary_cred_user)

Utility User ID

Description

Resolves to the Utility user ID.

Syntax

${ops_utility_cred_user}

Utility Password

Description

Resolves to the Utility password.

Syntax

${ops_utility_cred_pwd}

Utility Hostname

Description

Resolves to the Utility hostname.

Syntax

${ops_utility_agent_hostname}


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

${ops_primary_filename} → file.dat

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

${ops_secondary_filename} → file.dat

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}

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}

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

${ops_local_filename} → file.dat

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

${ops_remote_filename} → file.dat


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}

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

${ops_oms_last_connected_time} → 2024-10-17 10:18:06 -0400

OMS Server IP Address

Description

Resolves to the OMS Server IP address.

Syntax

${ops_oms_server_address}

OMS Server Status

Description

Resolves to the current status of the OMS Server.

Syntax

${ops_oms_status}

Example

${ops_oms_status} → Connected

OMS Server sys_id

Description

Resolves to the sys_id of the OMS server.

Syntax

${ops_oms_id}

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}

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}

Main Job Name

Description

Resolves to the PeopleSoft Main Job Name.

Syntax

${ops_main_job_name}

Main Schedule Name

Description

Resolves to the PeopleSoft task/task instance Main Schedule Name.

Syntax

${ops_main_schedule_name}

Process Instance

{For task instances only.}

Description

Resolves to the PeopleSoft task instance Process Instance.

Syntax

${ops_process_instance}

Process Name

Description

Resolves to the PeopleSoft task/task instance Process/Job Name.

Syntax

${ops_process_name}

Process Type

Description

Resolves to the PeopleSoft task/task instance Process Type.

Syntax

${ops_process_type}

Run Status

{For task instances only.}

Description

Resolves to the PeopleSoft task instance Run Status.

Syntax

${ops_run_status}

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

${ops_next_recurrence_time} 2024-10-18 11:46:28 -0400

Recurrence Count

Description

Resolves to the current count of task recurrences.

Syntax

${ops_recurrence_count}

Example

${ops_recurrence_count} → 3

Recurrence Count Minus One

DescriptionResolves to the current count of task recurrences minus one.
Syntax${ops_recurrence_count_minus_1}
Example${ops_recurrence_count_minus_1} → 2

Source Instance ID

Description

Resolves to the ID of the Recurrence task instance.

Syntax

${ops_source_instance_id}

Source Instance Name

Description

Resolves to the name of the Recurrence task instance.

Syntax

${ops_source_instance_name}

Target Task ID

Description

Resolves to the ID of the target task.

Syntax

${ops_target_task_id}

Target Task Name

Description

Resolves to the name of the target task.

Syntax

${ops_target_task_name}


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

${ops_trigger_file_name_simple} → file

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

${ops_trigger_files} COMPANY-2011-11-22.xls, COMPANY-2011-11-23.xls, COMPANY-2011-11-24.xls

Remote Trigger File Name

Description

Resolves to the remote file name.

Syntax

${ops_trigger_file_name}

Example

${ops_trigger_file_name} → file.dat

Remote Trigger File Name {No Path}

Description

Resolves to the remote file name without any path information.

Syntax

${ops_trigger_file_name_nopath}

Example

${ops_trigger_file_name_nopath} → file.dat

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}

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}

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}

Trigger File Extension

Description

Resolves to the file extension of the file.

Syntax

${ops_trigger_file_name_extension}

Example

${ops_trigger_file_name_extension} → dat

Trigger Wildcard

Description

Resolves to the contents of the Remote Filename field in the Remote File Monitor task.

Syntax

${ops_trigger_wildcard}

Example

${ops_trigger_wildcard} /home/prod/stonebranch/COMPANY*.xls

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

${ops_trigger_wildcard_path} /home/prod/stonebranch/

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

${ops_trigger_wildcard_path_no_separator} /home/prod/stonebranch

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 Credential ID

Description
Resolves to the sys_id of the SAP credential.
Syntax${ops_sap_credential_id}

SAP Credential Name

Description
Resolves to the Name of the SAP credential.
Syntax${ops_sap_credential_name}

SAP InfoPackage Request ID

Description

Resolves to the SAP InfoPackage Request ID.

Syntax

${ops_sap_requestid}

SAP Job ID

Description

Resolves to the SAP job ID.

Syntax

${ops_sap_jobid}

SAP Job Name

Description

Resolves to the SAP job name.

Syntax

${ops_sap_jobname}

SAP Process Chain ID

Description

Resolves to the SAP Process Chain ID.

Syntax

${ops_sap_chainid}

SAP Process Chain Log ID

Description

Resolves to the SAP Process Chain Log ID.

Syntax

${ops_sap_logid}

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:

Credential ID

Description

Resolves to the sys_id of either the Task’s credential or the Database Connection's credential. Task credential is higher precedence.

Syntax

${ops_credential_id}

Credential Name

Description

Resolves to the Name of either the Task’s credential or the Database Connection's credential. Task credential is higher precedence.

Syntax

${ops_credential_name}

Error Message

Description

Resolves to any error message generated by the database.

Syntax

${ops_sql_error_msg}

Processed Rows

Description

Resolves to the number of rows processed.

Syntax

${ops_sql_rows}

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}

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}

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}

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

${ops_sm_actual_size} → 36.11

Actual Size {Rounded}

Description

Same as ops_sm_actual_size, except rounded to the nearest integer.

Syntax

${ops_sm_actual_int_size}

Example

${ops_sm_actual_int_size} → 36

Actual Size {Scale}

Description

Scale of the actual size determined by the agent.

Syntax

${ops_sm_actual_scale}

Example

${ops_sm_actual_scale} → GB

Scale

Description

Scale specified in the By Scale field for Resource Available of the System Monitor task definition.

Syntax

${ops_sm_scale}

Example

${ops_sm_scale} → MB

Size

Description

Size specified in the Resource Available field of the System Monitor task definition.

Syntax

${ops_sm_size}

Example

${ops_sm_size} → 5.0

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

${ops_sm_int_size} → 5

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}

Cluster Node ID

Description

Resolves to the Active cluster node's internally-generated build ID.

Syntax

${ops_cluster_id}

Cluster Node IP Address

Description

Resolves to the IP address of the Active cluster node.

Syntax

${ops_cluster_ipaddr}

Cluster Node Mode

Description

Resolves to the current mode of the cluster node: Offline, Active, Passive.
 
For more information, see Viewing Node Status.

Syntax