Built-In Variables

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

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 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 (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 Agent sys_id Agent-based task instance variable resolves to a different value than the 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

HTML

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