Versions Compared

Key

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

...

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


...

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


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

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

Cluster Node Name


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

...

Description

Resolves to the value of the System Identifier Universal Controller system property.

Syntax

${ops_system_identifier}

Example


...

Panel

Source and Destination Variables

Panel

Primary and Secondary Variables

...

Html bobswift
<pre> open src=srcserver user=$(ops_src_cred_

...

Description

...

Resolves to the source password.

...

Syntax

user) pwd=$(ops_src_cred_pwd)

...

Example

...

 dst=dstserver user=$(ops_

...

dst_cred_user

...

) pwd=$(ops_

...

dst_cred_

...

Description

...

Resolves to the source user ID.

...

Syntax

pwd)
</pre>



Panel

Primary and Secondary Variables

Html bobswift
<pre> open src=srcserver user=$(ops_

...

primary_cred_user)

...

Example

...

 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 destination source password.

Syntax

$(ops_dstsrc_cred_pwd)

Example


Anchor
ops_

...

src_cred_user
ops_

...

src_cred_user

...

Source User ID

Description

Resolves to the destination source user ID.

Syntax

$(ops_dstsrc_cred_user)

Example


Anchor
ops_

...

dst_cred_pwd
ops_

...

dst_cred_pwd

...

Destination Password

Description

Resolves to the Primary destination password.

Syntax

$(ops_primarydst_cred_pwd)

Example


Anchor
ops_

...

dst_cred_user
ops_

...

dst_cred_user

...

Destination User ID

Description

Resolves to the Primary destination user ID.

Syntax

$(ops_primarydst_cred_user)

Example


Anchor
ops_

...

src_cred_pwd
ops_

...

src_cred_pwd

...

Primary Password

Description

Resolves to the Secondary Primary password.

Syntax

$(ops_secondaryprimary_cred_pwd)

Example


Anchor
ops_

...

src_cred_user
ops_

...

src_cred_user

...

Primary User ID

Description

Resolves to the Secondary 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


...

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

Description

Resolves


Panel

Remote Trigger File Name


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



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

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

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>



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 Average Estimated End Time in the server's time zone.

Syntax

${ops_avg_estimated_end_time}

Example

${ops_avg_estimated_end_time} > 2018-10-16 15:01:45 -0400

...

Description

Resolves to the Highest Estimated End Time in the server's time zone.

Syntax

${ops_highest_estimated_end_time}

Example

${ops_highest_estimated_end_time} > 2018-10-16 15:01:45 -0400

...

Description

Resolves to the Lowest Estimated End Time in the server's time zone.

Syntax

${ops_lowest_estimated_end_time}

Example

${ops_lowest_estimated_end_time} > 2018-10-16 15:01:44 -0400

...

Description

Resolves to the User Estimated End Time in the server's time zone.

Syntax

${ops_user_estimated_end_time}

Example

${ops_user_estimated_end_time} > 2018-10-16 15:01:54 -0400

...

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
fired the trigger
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


...

The following built-in variables are associated with all trigger types.

When a task is launched by a trigger, the values of the following built-in variables, if they are specified in the task, are passed into the task instance.

...

Description

Resolves to the value of user-defined field #1.

Syntax

${ops_trigger_custom_field1}

Example


...

Description

Resolves to the value of user-defined field #2.

Syntax

${ops_trigger_custom_field2}

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
Universal Event Task Instance Trigger Variables
Universal Event Task Instance Trigger Variables
Universal Event Task Instance/Trigger Variables

...

Anchor
ops_trigger_eventName_attributeName
ops_trigger_eventName_attributeName
Universal Event Attributes

Description

Name of a Universal Event Attribute.

Facilitates the passing of matched Universal Event attributes to downstream instances within a workflow or to instances launched by a Universal Monitor Trigger

...

ops_trigger_eventName_attributeName

Additionally, standard built-in variables will be available to a completed non-continuous Universal Monitor Instance or to instances triggered by the Universal Monitor Trigger.

.

Syntax

${ops_trigger_eventName_attributeName}

Example


Anchor
ops_trigger_universal_event_name
ops_trigger_universal_event_name
Universal Event Name

Description

Name of the Universal Event.

Syntax

${ops_trigger_universal_event_name}

Example


Anchor
ops_trigger_universal_event_publsiher_id
ops_trigger_universal_event_publsiher_id
Universal Event Publisher ID

Description

UUID of the Universal Task Instance that published the Universal Event, if applicable.

Syntax

${ops_trigger_universal_event_publisher_id}

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


Anchor
ops_trigger_universal_template_id
ops_trigger_universal_template_id
Universal Template ID

Description

UUID of the Universal Template, if applicable.

Syntax

${ops_trigger_universal_template_id}

Example


Anchor
ops_trigger_universal_template_event_template_

...

id
ops_trigger_universal_template_event_

...

template_id
Universal Template Event

...

Template ID

Description

Name UUID of the Universal Template Event Template, if applicable.

Syntax

${ops_trigger_universal_template_event_nametemplate_id}

Example


Anchor
ops_trigger_universal_event_

...

template_id
ops_trigger_universal_event_

...

template_id
Universal Event

...

Template ID

Description

UUID of the Universal Task Instance that published the Universal Event Template, if applicable.

Syntax

${ops_trigger_universal_event_publishertemplate_id}

Example


Anchor
Variable Monitor Task Instance Trigger Variables
Variable Monitor Task Instance Trigger Variables
Variable Monitor Task Instance/Trigger Variables

...