Panel

Table of Contents

...

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.

...

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

...

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

...

Note

title	Note

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

...

The following variables can be used to pass agent information into agent-based task (Windows, Linux/Unix, z/OS, and SAP) notificationstask 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}
Example

...

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

...

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

Anchor
Agent sys_id
Agent sys_id
Agent sys_id

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

Credential sys_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 sys_id.

Syntax

${ops_

agent

credential_

name

Example
id}

...

Credential Name

Description	Resolves to the

sys_id of the agent

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_

agent

credential_

id

name}
Example

Note

title	Note

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

Agent Queue Name

...

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

...

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

Panel

Html bobswift
<pre>${ops_trigger_file_fullpath}sub_folder_name ${ops_trigger_file_separator}filename.txt </pre>

...

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

Anchor
ops_trigger_file_name_nopath
ops_trigger_file_name_nopath
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

...

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

Cluster Node Hostname

...

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

Syntax

${ops_cluster_start_time}

Example

Panel

Html bobswift
<pre>ops_cluster_start_time = 2011-09-26 17:35:01 -0400</pre>

...

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 sys_id

Description	Resolves to the sys_id the Task’s credential.
Syntax	${ops_credential_id}
Example

Credential Name

Description	Resolves to the Name of the Task’s credential.
Syntax	${ops_credential_name}
Example

Body Field

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

...

Note

title	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:

Panel

Source and Destination Variables

Html bobswift
<pre> open src=srcserver user=$({ops_src_cred_user)} pwd=$({ops_src_cred_pwd)} dst=dstserver user=$({ops_dst_cred_user)} pwd=$({ops_dst_cred_pwd)} </pre>

Panel

Primary and Secondary Variables

Html bobswift
<pre> open src=srcserver user=$({ops_primary_cred_user)} pwd=$({ops_primary_cred_pwd)} secondary=secserver user=$({ops_secondary_cred_user)} pwd=$({ops_secondary_cred_pwd)} </pre>

Anchor
ops_src_cred_pwd
ops_src_cred_pwd
Source Password

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

Anchor
ops_src_cred_user
ops_src_cred_user
Source User ID

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

Anchor
ops_dst_cred_pwd
ops_dst_cred_pwd
Destination Password

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

Anchor
ops_dst_cred_user
ops_dst_cred_user
Destination User ID

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

Anchor
ops_src_cred_pwd
ops_src_cred_pwd
Primary Password

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

Anchor
ops_src_cred_user
ops_src_cred_user
Primary User ID

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

Anchor
ops_dst_cred_pwd
ops_dst_cred_pwd
Secondary Password

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

Anchor
ops_dst_cred_user
ops_dst_cred_user
Secondary User ID

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

Utility User ID

Description	Resolves to the Utility user ID.
Syntax	$({ops_utility_cred_user)}
Example

Utility Password

Description	Resolves to the Utility password.
Syntax	$({ops_utility_cred_pwd)}
Example

Utility Hostname

Description	Resolves to the Utility hostname.
Syntax	$({ops_utility_agent_hostname)}
Example

For Transfer Protocol = UDM

...

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

Anchor
Secondary File Name
Secondary File Name
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

Anchor
Primary Agent Hostname
Primary Agent Hostname
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

Anchor
Secondary Agent Hostname
Secondary 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}

Example

For Transfer Protocol = FTP/SFTP/FTPS

...

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

Anchor
Remote File Name
Remote File Name
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

Anchor
OMS Server Variables
OMS Server Variables
OMS Server Variables

...

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

...

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

...

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

...

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

...

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.

...

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

...

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

...

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

Panel

Html bobswift
<pre>ops_trigger_wildcard_path = /home/prod/stonebranch/ </pre>

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

Panel

Html bobswift
<pre>ops_trigger_wildcard_path_no_separator = /home/prod/stonebranch </pre>

...

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

Credential sys_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}
Example

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}
Example

Error Message

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

...

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

...

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

...

Description

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

Syntax

${ops_cluster_start_time}

Example

Panel

Html bobswift
<pre>ops_cluster_start_time = 2011-09-26 17:35:01 -0400</pre>

...

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

...

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

...

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

Anchor
Trigger Time (Trigger time zone)
Trigger Time (Trigger time zone)
Trigger Time

...

{Trigger time zone

...

}

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

...

Anchor
ops_trigger_universal_event_ttl
ops_trigger_universal_event_ttl
Universal Event Time To Live

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

...

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

Credential sys_id

Description	Resolves to the sys_id the Task’s credential.
Syntax	${ops_credential_id}
Example

Credential Name

Description	Resolves to the Name of the Task’s credential.
Syntax	${ops_credential_name}
Example

URL

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

...

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
z/OS Task Instance Variables
z/OS Task Instance Variables
z/OS Task Instance Variables

...

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

Agent Hostname

AnchorAgent sys_idAgent sys_idAgent sys_id

Credential sys_id

Credential Name

Agent Queue Name

File Directory

{with Final Directory Separator

}

File Directory

{without Final Directory Separator

}

Anchorops_trigger_file_name_nopathops_trigger_file_name_nopathTrigger File Name

{No Path

}

Cluster Node Hostname

Credential sys_id

Credential Name

Body Field

Anchorops_src_cred_pwdops_src_cred_pwdSource Password

Anchorops_src_cred_userops_src_cred_userSource User ID

Anchorops_dst_cred_pwdops_dst_cred_pwdDestination Password

Anchorops_dst_cred_userops_dst_cred_userDestination User ID

Anchorops_src_cred_pwdops_src_cred_pwdPrimary Password

Anchorops_src_cred_userops_src_cred_userPrimary User ID

Anchorops_dst_cred_pwdops_dst_cred_pwdSecondary Password

Anchorops_dst_cred_userops_dst_cred_userSecondary User ID

Utility User ID

Utility Password

Utility Hostname

For Transfer Protocol = UDM

AnchorSecondary File NameSecondary File NameSecondary File Name

AnchorPrimary Agent HostnamePrimary Agent HostnamePrimary Agent Hostname

AnchorSecondary Agent HostnameSecondary Agent HostnameSecondary Agent Hostname

For Transfer Protocol = FTP/SFTP/FTPS

AnchorRemote File NameRemote File NameRemote File Name

AnchorOMS Server VariablesOMS Server VariablesOMS Server Variables

Distribution Status

Process Instance

Run Status

Remote Trigger File Name

{No Path

}

Trigger File Directory

{with Final Directory Separator

}

Trigger File Directory

{without Final Directory Separator

}

Trigger Wildcard Path Only

{without Final Slash

}

Credential sys_id

Credential Name

Error Message

Actual Size

{Rounded

}

Actual Size

{Scale

}

Size

{Rounded

}

Time Zone

{Task time zone

}

Time Zone

{Trigger time zone

}

AnchorTrigger Time (Trigger time zone)Trigger Time (Trigger time zone)Trigger Time

{Trigger time zone

}

Anchorops_trigger_universal_event_ttlops_trigger_universal_event_ttlUniversal Event Time To Live

Credential sys_id

Credential Name

Anchor
Agent sys_id
Agent sys_id
Agent sys_id

Anchor
ops_trigger_file_name_nopath
ops_trigger_file_name_nopath
Trigger File Name

Anchor
ops_src_cred_pwd
ops_src_cred_pwd
Source Password

Anchor
ops_src_cred_user
ops_src_cred_user
Source User ID

Anchor
ops_dst_cred_pwd
ops_dst_cred_pwd
Destination Password

Anchor
ops_dst_cred_user
ops_dst_cred_user
Destination User ID

Anchor
ops_src_cred_pwd
ops_src_cred_pwd
Primary Password

Anchor
ops_src_cred_user
ops_src_cred_user
Primary User ID

Anchor
ops_dst_cred_pwd
ops_dst_cred_pwd
Secondary Password

Anchor
ops_dst_cred_user
ops_dst_cred_user
Secondary User ID

Anchor
Secondary File Name
Secondary File Name
Secondary File Name

Anchor
Primary Agent Hostname
Primary Agent Hostname
Primary Agent Hostname

Anchor
Secondary Agent Hostname
Secondary Agent Hostname
Secondary Agent Hostname

Anchor
Remote File Name
Remote File Name
Remote File Name

Anchor
OMS Server Variables
OMS Server Variables
OMS Server Variables

Anchor
Trigger Time (Trigger time zone)
Trigger Time (Trigger time zone)
Trigger Time

Anchor
ops_trigger_universal_event_ttl
ops_trigger_universal_event_ttl
Universal Event Time To Live

Anchor
z/OS Task Instance Variables
z/OS Task Instance Variables
z/OS Task Instance Variables