1 Overview
2 Built-In Variable Categories
3 Agent Variables
- 3.1 Agent Hostname
- 3.2 Agent IP Address
- 3.3 Agent IP Address
- 3.4 Agent Mode
- 3.5 Agent Name
- 3.6 Agent Queue Name
4 Agent-Based Task Instance Variables
- 4.1 Agent Hostname
- 4.2 Agent IP Address
- 4.3 Agent IP Address
- 4.4 Agent Name
- 4.5 Agent sys_id
- 4.6 Credential ID
- 4.7 Credential Name
- 4.8 Agent Queue Name
5 Agent Cluster Variables
- 5.1 Agent Cluster Name
- 5.2 Agent Cluster Distribution
- 5.3 Agent Cluster Task Execution Limit
- 5.4 Agent Cluster Suspended
- 5.5 Agent Cluster Task Execution Limit Amount
- 5.6 Agent Cluster Task Execution Current Limit
- 5.7 Agent Cluster Network Alias
- 5.8 Agent Cluster Network Alias Port
- 5.9 Agent Cluster Notification State
6 Agent File Monitor Task Instance / Trigger Variables
- 6.1 Base File Name
- 6.2 File Directory
- 6.3 File Directory {with Final Directory Separator}
- 6.4 File Directory {without Final Directory Separator}
- 6.5 File Extension
- 6.6 Separator
- 6.7 Trigger File Date
- 6.8 Trigger File Group
- 6.9 Trigger File Name
- 6.10 Trigger File Name {No Path}
- 6.11 Trigger File Owner
- 6.12 Trigger File Scan Result
- 6.13 Trigger File Size
7 Application Monitor Trigger Variables
- 7.1 Trigger Application Name
- 7.2 Trigger Application Status
- 7.3 Trigger Application sys_id
- 7.4 Trigger Application Type
8 Cluster Node Variables
- 8.1 Cluster Node Hostname
- 8.2 Cluster Node ID
- 8.3 Cluster Node IP Address
- 8.4 Cluster Node Mode
- 8.5 Cluster Node Name
- 8.6 Cluster Node Running Time
- 8.7 Cluster Node Start Time
9 Common Variables
- 9.1 System Identifier
10 Composite Trigger Variables
- 10.1 Trigger Component Event Time
11 Email Monitor Task Instance/Trigger Variables
- 11.1 Credential ID
- 11.2 Credential Name
- 11.3 Body Field
- 11.4 Cc Field
- 11.5 From Field
- 11.6 HTML Body Field
- 11.7 Received Date Field
- 11.8 Reply To Field
- 11.9 Sent Date Field
- 11.10 Subject Field
- 11.11 To Field
12 File Transfer Task Instance Variables
13 For UDM Scripts
- 13.1 Source Password
- 13.2 Source User ID
- 13.3 Destination Password
- 13.4 Destination User ID
- 13.5 Primary Password
- 13.6 Primary User ID
- 13.7 Secondary Password
- 13.8 Secondary User ID
- 13.9 Utility User ID
- 13.10 Utility Password
- 13.11 Utility Hostname
14 For Transfer Protocol = UDM
- 14.1 Primary File Name
- 14.2 Secondary File Name
- 14.3 Primary Agent Hostname
- 14.4 Secondary Agent Hostname
15 For Transfer Protocol = FTP/SFTP/FTPS
- 15.1 Local File Name
- 15.2 Remote File Name
16 OMS Server Variables
- 16.1 Last OMS Server Connected
- 16.2 Last OMS Server Connected Time
- 16.3 OMS Server IP Address
- 16.4 OMS Server Status
- 16.5 OMS Server sys_id
- 16.6 OMS Server Messaging Sessions Status
17 PeopleSoft Task and Task Instance Variables
- 17.1 Distribution Status
- 17.2 Main Job Name
- 17.3 Main Schedule Name
- 17.4 Process Instance
- 17.5 Process Name
- 17.6 Process Type
- 17.7 Run Status
18 Recurring Task Instance Variables
- 18.1 Next Recurrence Time
- 18.2 Recurrence Count
- 18.3 Recurrence Count Minus One
- 18.4 Source Instance ID
- 18.5 Source Instance Name
- 18.6 Target Task ID
- 18.7 Target Task Name
19 Remote File Monitor Task Instance Variables
- 19.1 Base Trigger File Name
- 19.2 Files Matching Wildcard
- 19.3 Remote Trigger File Name
- 19.4 Remote Trigger File Name {No Path}
- 19.5 Trigger File Directory
- 19.6 Trigger File Directory {with Final Directory Separator}
- 19.7 Trigger File Directory {without Final Directory Separator}
- 19.8 Trigger File Extension
- 19.9 Trigger Wildcard
- 19.10 Trigger Wildcard Path Only
- 19.11 Trigger Wildcard Path Only {without Final Slash}
20 SAP Task Instance Variables
- 20.1 SAP InfoPackage Request ID
- 20.2 SAP Job ID
- 20.3 SAP Job Name
- 20.4 SAP Process Chain ID
- 20.5 SAP Process Chain Log ID
21 SQL and Stored Procedure Task Instance Variables
- 21.1 Credential ID
- 21.2 Credential Name
- 21.3 Error Message
- 21.4 Processed Rows
- 21.5 Return Code for SQL Statement Outcome
22 SQL Task Instance Variables
- 22.1 SQL Command Field
23 Stored Procedure Task Instance Variables
- 23.1 Stored Procedure Name
24 System Monitor Task Instance Variables
- 24.1 Actual Size
- 24.2 Actual Size {Rounded}
- 24.3 Actual Size {Scale}
- 24.4 Scale
- 24.5 Size
- 24.6 Size {Rounded}
25 Task Instance Variables
- 25.1 Cluster Node Hostname
- 25.2 Cluster Node ID
- 25.3 Cluster Node IP Address
- 25.4 Cluster Node Mode
- 25.5 Cluster Node Name
- 25.6 Cluster Node Running Time
- 25.7 Cluster Node Start Time
- 25.8 Command
- 25.9 Command Parameters
- 25.10 Custom Field 1
- 25.11 Custom Field 2
- 25.12 Description
- 25.13 Duration
- 25.14 Duration In Seconds
- 25.15 End Time
- 25.16 End Time: Average Estimated
- 25.17 End Time: Highest Estimated
- 25.18 End Time: Lowest Estimated
- 25.19 End Time: User Estimated
- 25.20 Execution User ID
- 25.21 Instance Number
- 25.22 Launch Time
- 25.23 Maximum Retry Count
- 25.24 Parent Workflow Instance sys_id
- 25.25 Parent Workflow Name
- 25.26 Projected End Time of Workflow
- 25.27 Queued Time
- 25.28 Reference Id
- 25.29 Retry Count
- 25.30 Retry Interval
- 25.31 Script ID
- 25.32 Script Name
- 25.33 Script Parameters
- 25.34 Starting Time
- 25.35 Task Instance Attempts
- 25.36 Task Instance Definition ID
- 25.37 Task Instance Exit Code
- 25.38 Task Instance Name
- 25.39 Task Instance Status
- 25.40 Task Instance Status Description
- 25.41 Task Instance sys_id
- 25.42 Task Name at Instance Creation Time
- 25.43 Task Type
- 25.44 Task Vertex ID
- 25.45 Time Zone {Task time zone}
- 25.46 Time Zone {Trigger time zone}
- 25.47 Top-Level Workflow Name
- 25.48 Top-Level Workflow Task Instance ID
- 25.49 Virtual Resource Priority
26 Task Monitor Task Instance/Trigger Variables
- 26.1 Trigger Task Name
- 26.2 Trigger Task Status
- 26.3 Trigger Task sys_id
- 26.4 Trigger Task Type
- 26.5 Trigger Workflow Id
- 26.6 Trigger Workflow Name
27 Trigger Variables
- 27.1 Custom Field 1
- 27.2 Custom Field 2
- 27.3 Trigger Name
- 27.4 Trigger Time
- 27.5 Trigger Time {Trigger time zone}
28 Universal Monitor Task Instance/Trigger and Universal Event Variables
- 28.1 Universal Event Attributes
- 28.2 Universal Event Business Services
- 28.3 Universal Event Name
- 28.4 Universal Event Publisher ID
- 28.5 Universal Event Time To Live
- 28.6 Universal Template ID
- 28.7 Universal Template Event Template ID
- 28.8 Universal Event Template ID
29 Variable Monitor Task Instance/Trigger Variables
- 29.1 Trigger Variable Name
- 29.2 Trigger Variable Value
- 29.3 Trigger Variable Previous Value
30 Web Service Task Instance Variables
- 30.1 Credential ID
- 30.2 Credential Name
- 30.3 URL
- 30.4 Raw Value of URL
- 30.5 URL Host
- 30.6 URL Port
- 30.7 URL Path
- 30.8 Unencoded URL Path
- 30.9 URL Query
- 30.10 Unencoded URL Query
31 Webhook Variables
- 31.1 Universal Event Payload
- 31.2 Webhook Name
32 z/OS Task Instance Variables
- 32.1 JCL Location
- 32.2 Job Number
- 32.3 Override JCL Location
- 32.4 Submitted JCL Location

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}

Built-In Variables

Overview

Built-In Variable Categories

Agent Variables

Agent Hostname

Agent IP Address

Agent IP Address

Agent Mode

Agent Name

Agent Queue Name