| Panel | |
|---|---|
|
...
The following variables can be used to pass agent information into agent-based task 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 sys_id of the agent. |
|---|---|
Syntax | ${ops_agent_id} |
Example |
...
| Note | ||
|---|---|---|
| ||
Although they have the same syntax, ${ops_agent_id}, this Agent sys_id Agent-based task instance variable resolves to a different value than the Agent Queue Name Agent variable. |
Credential 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_idCredential ID. |
|---|---|
Syntax | ${ops_credential_id} |
Example |
...
Description | Resolves to the 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_credential_name} |
Example |
...
| title | Note |
|---|
...
Agent Queue Name
Description | Resolves to the agent queue name.
| |||||
|---|---|---|---|---|---|---|
Syntax | ${ops_agent_queue_name} | |||||
Example |
...
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
...
ID
Description | Resolves to the sys_id the Task’s credential. |
|---|---|
Syntax | ${ops_credential_id} |
Example |
...
| Panel | ||
|---|---|---|
Primary and Secondary Variables
|
| Anchor | ||||
|---|---|---|---|---|
|
...
Description | Resolves to the Primary password. |
|---|---|
Syntax | ${(ops_primary_cred_pwd}) |
Example |
| Anchor | ||||
|---|---|---|---|---|
|
Description | Resolves to the Primary user ID. |
|---|---|
Syntax | ${(ops_primary_cred_user}) |
Example |
| Anchor | ||||
|---|---|---|---|---|
|
Description | Resolves to the Secondary password. |
|---|---|
Syntax | ${(ops_secondary_cred_pwd}) |
Example |
| Anchor | ||||
|---|---|---|---|---|
|
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 |
...
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 used in SQL tasks and Stored Procedure tasks to collect SQLException data, if any:
Credential
...
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 |
...
The following built-in variables are available for Web Service task instances:
Credential
...
ID
Description | Resolves to the sys_id the Task’s credential. |
|---|---|
Syntax | ${ops_credential_id} |
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 | ||||
|---|---|---|---|---|
|
...