System parameters


When you are creating a process with the TrueSight Orchestration Development Studio application, you can use system parameters to assign a variable value to a context item. The value for a system parameter is determined at the process run time.

System parameters eliminate the need to prompt for input with an Operator Dialog activity within an operator process, or to define additional activities to capture this data within a standard process.

System parameters

Parameter name

Description

ASSIGNED PEER_NAME

Retrieves the name of the peer on which the process is run.
If you run the process in TrueSight Orchestration Development Studio, the host name is returned in the response.

HOST_NAME

Retrieves the host name of the server on which the process is run.

IP_ADDRESS

Retrieves the IP address of the server on which the process is run.

JOB_EXECUTOR_USERID

Retrieves the user ID of the person who initiated the process execution. When you are testing a process in TrueSight Orchestration Development Studio, the default value of SYSTEM is used.

JOB_EXECUTOR_CREDENTIALS

This parameter is always empty.

MODULE_NAME

Retrieves the name of the module which contains the process

OS_NAME

Retrieves the name of the operating system on the process is run.

ROOT_JOB_ID

Retrieves the Job ID of the top-level process that triggered the currently executing process. If there are multiple levels of called processes, this might not be the ID of the process that called the currently executing process. This ID is for the top-most process.

ROOT_PROCESS_NAME

Retrieves the name of the process.

ROOT_PROCESS_ID

Retrieves the module and the process name.

To assign a system parameter value to a context item

  1. On the TrueSight Orchestration Development Studio process canvas, double-click the Assign activity.
  2. From the Property Panel of an Assign activity, select System Parameter from the Parameter Type menu in the Input pane.
  3. Select the system parameter from the Name menu.
  4. Define the context item to which the selected system parameter is assigned in the output pane.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Platform 24.3