Panel | |
---|---|
|
Overview
...
Built-in variables are listed alphabetically within the following categories on this page:
- Built-In Variables#Agent Agent Variables
- Built-In Variables#AgentAgent-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
- Trigger VariablesBuilt-In Variables#Trigger
- Universal Monitor Task Instance/Trigger and Universal Event Variables
- Variable Monitor Task Instance/Trigger Variables
- Built-In Variables#Web Web Service Task Instance Variables
- Webhook Variables
- Built-In Variables#zz/OS Task Instance Variables
Anchor | ||||
---|---|---|---|---|
|
...
Note | ||
---|---|---|
| ||
Although they have the same syntax, ${ops_agent_id}, this Built-In Variables#Agent Queue Name 63578354 Agent variable resolves to a different value than the Built-In Variables#Agent sys_id 63578354 Agent-based task instance variable. |
...
Note | ||
---|---|---|
| ||
Although they have the same syntax, ${ops_agent_id}, this Built-In Variables#Agent sys_id 63578354 Agent-based task instance variable resolves to a different value than the Built-In Variables#Agent Queue Name 63578354 Agent variable. |
Agent Queue Name
...
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 |
Anchor | ||||
---|---|---|---|---|
|
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
...
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 time when the Recurrence task next runscurrent count of task recurrences. |
---|---|
Syntax | ${ops_next_recurrence_timecount} |
Example |
Recurrence Count Minus One
Description | Resolves to the current 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 |
...
Description | Same as ops_sm_size, except that ops_sm_int_size is rounded to the nearest integer. |
---|---|
Syntax | ${ops_sm_int_size} |
Example |
Anchor | ||||
---|---|---|---|---|
|
Task Instance Variables
The following built-in variables are associated with task instances for all task types.
...
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_task_ref_count} | |||||
Example |
...
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 |
...
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 that 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 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 |
...
Description | Resolves to the trigger time in the time zone of the trigger. |
---|---|
Syntax | ${ops_trigger_time_tz} |
Example |
Anchor | ||||
---|---|---|---|---|
|
Universal
...
Monitor Task Instance/Trigger and Universal Event Variables
Anchor | ||||
---|---|---|---|---|
|
...
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 |
Anchor | ||||
---|---|---|---|---|
|
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 |
Anchor | ||||
---|---|---|---|---|
|
...