Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
  • Built-In Variables#Trigger Trigger Variables
  • Variable

    Universal Monitor Task Instance/Trigger

    VariablesBuilt-In Variables#Web

    and Universal Event Variables

  • Variable Monitor Task Instance/Trigger Variables

  • Web Service Task Instance Variables
  • Built-In Variables#zz/OS Task Instance Variables

Anchor
Agent Variables
Agent Variables
Agent Variables

...

Note
titleNote

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

...

Note
titleNote

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

Agent Queue Name

...

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>




Trigger File Date

Description

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

Syntax

${ops_trigger_file_date}

Example


...

Description

Resolves to the hostname of this cluster node.

Syntax

${ops_cluster_hostname}

Example


Panel


Html bobswift
<pre>ops_cluster_hostname = MACHINEC19A</pre>




Cluster Node ID

Description

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

Syntax

${ops_cluster_id}

Example


Panel

Cluster Node IP Address


Html bobswift
<pre>ops_cluster_id = MACHINEC19A:8080-uc</pre>




Cluster Node IP Address

Description

Resolves to the IP address of this cluster node.

Syntax

${ops_cluster_ipaddr}

Example


Panel


Html bobswift
<pre>ops_cluster_ipaddr = 10.N.N.NN</pre>




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


Panel


Html bobswift
<pre>ops_cluster_mode = Active</pre>




Cluster Node Name

Description

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

Syntax

${ops_cluster_name}

Example


Panel


Html bobswift
<pre>ops_cluster_name = MACHINEC19A:8080-uc</pre>




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


Panel


Html bobswift
<pre>ops_cluster_uptime = 7 Seconds</pre>




Cluster Node Start Time

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>




Anchor
Common Variables
Common Variables
Common Variables

The following variable is available for Task Instances, Agents, OMS Servers, and Cluster Nodes.

...

Panel

Source and Destination Variables

Panel

Primary and Secondary Variables

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


Panel


Html bobswift
<pre>ops_trigger_files = COMPANY-2011-11-22.xls, COMPANY-2011-11-23.xls,COMPANY-2011-11-24.xls</pre>




Remote Trigger File Name

Description

Resolves to the remote file name.

Syntax

${ops_trigger_file_name}

Example


...

Description

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

Syntax

${ops_trigger_wildcard}

Example


Panel


Html bobswift
<pre>ops_trigger_wildcard = /home/prod/stonebranch/COMPANY*.xls</pre>




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

Syntax

${ops_trigger_wildcard_path}

Example


Panel


Html bobswift
<pre>ops_trigger_wildcard_path
}

Example

Panel
 = /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>




Anchor
SAP Task Instance Variables
SAP Task Instance Variables
SAP Task Instance Variables

...

Description

Resolves to the hostname of the Active cluster node.

Syntax

${ops_cluster_hostname}

Example


Panel


Html bobswift
<pre>ops_cluster_hostname = MACHINEC19A</pre>




Cluster Node ID

Description

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

Syntax

${ops_cluster_id}

Example


Panel


Html bobswift
<pre>ops_cluster_id = MACHINEC19A:8080-uc</pre>




Cluster Node IP Address

Description

Resolves to the IP address of the Active cluster node.

Syntax

${opsops_cluster_ipaddr}

Example


Panel


Html bobswift
<pre>ops_cluster_ipaddr
}

Example

Panel
 = 10.N.N.NN</pre>




Cluster Node Mode

Description

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

Syntax

${ops_cluster_mode}

Example


Panel


Html bobswift
<pre>ops_cluster_mode = Active</pre>




Cluster Node Name

Description

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

Syntax

${ops_cluster_name}

Example


Panel


Html bobswift
<pre>ops_cluster_name = MACHINEC19A:8080-uc</pre>




Cluster Node Running Time

Description

Resolves to the numbers of days, hours, and minutes that the Active cluster node has been running since it was last started.

Syntax

${ops_cluster_uptime}

Example


Panel


Html bobswift
<pre>ops_cluster_uptime = 7 Seconds</pre>




Cluster Node Start Time

_cluster_start_time}

Description

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

Syntax

${ops_cluster_start_time}

Example

Panel

Example


Panel


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




Command

Description

For tasks that launch a command on a Windows or Linux/Unix machine; resolves to the task command.

Syntax

${ops_cmd}

Example


...

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.
 

Note
titleNote

Although it still is supported, the Reference Id built-in variable has been superseded by the Instance Number built-in variable.


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)

...

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 containing the task instance that matched the Task Monitor conditions and fired the trigger.
 
This variable is available only for a Task Monitor
task
 task that has a Workflow Condition
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 Event Task Instance Trigger Variables
Universal Event Task Instance Trigger Variables
Universal

...

Monitor Task Instance/Trigger and Universal Event Variables

Anchor
ops_trigger_eventName_attributeName
ops_trigger_eventName_attributeName
Universal Event Attributes

...