Skip to main content

Set PS Variables

Description

Set PS Variables defines Process Studio variables with global or local scope within a process. Use this process entry when you need to pass values between workflows in the same process — for example, storing a file path, a record count, or a status flag that downstream workflows or process entries will reference. Global variables persist throughout the parent process lifecycle, while local variables are limited to the current process level.

Configurations

Field NameDescription
Step nameName of the process entry. This name has to be unique in a single process.
Field values (Tabular):
Variable nameSpecify the variable name to be set.
ScopeSpecify the scope of the variable (Local or Global).

Note: Global variables are available throughout the lifecycle of the parent workflow/process. They can be created at any sub-level and it will be available after that to the entire scope. They will be destroyed after the main or parent workflow/process ends.

Local variables are available only in the workflow/process where it has been created. They are not available to the child workflow/process.The same variable name can be used for global and local scopes simultaneously. The value modified or fetched is completely based on the scope specified as mentioned in the note below.

Note: The PS variables are added to the existing list which pops up on Ctrl-Space where applicable. The format of these variables in the list will be as ${GLOBAL.varname} and ${LOCAL.varname}. The PS variables created in ‘User Defined Java Class’ or ‘Modified Java Script’, are not visible in this list.

However, If the child workflow/process is already opened and a variable is added in the parent workflow/process. This variable is not reflected directly at design time (i.e. on Ctrl-Space) although there no issues during runtime. There are two options for this,

• The user can type the variable name where required

• Reopen the child workflow/process (from Open referenced object) after the variable is added.

SecretSelect true or false to set the secret status of the variable. The entry applies this setting based on the data source:

- Incoming data (Automatic runtime override): If the input row field is already a secret, the PS variable becomes a secret at runtime. Even if the secret is explicitly set to false, the runtime overrides it to ensure the variable remains protected.

- Default values: This setting directly controls any static text entered into the Default Value cell:

o Select true to protect the default value. The entry displays a masked pop-up dialog for data entry, encrypts the value inside the saved workflow file, and masks it (shows ********) during runtime.

o Select false to keep the default value visible as plain text.

Important:

- Workflow boundaries: The secret status carries across workflow boundaries to parent workflows when using the Set Workflow Result step. The system securely encrypts the data before sending it to the server.

- Lost protection on rename: Renaming a secret column using the Rename Fields step removes the secret status and exposes the data as plain text.

- Lost protection on modification: Modifying the data upstream (for example, using a Calculator step to build "Token: " + secretField) treats the result as a brand-new field and removes the secret status.
Default valueSpecify the default value of the variable.

Note: The PS variables set in this cannot be used for database connection details.

Field NameDescription
Common Buttons
OKOn click of this button. It will check the field values. If any required field values are missing then it will display validation error message. If all the required field values are provided then it will save the field values.
CancelOn click of this button, it will cancel the window and does not save any values.
Get FieldsClick this button to fetch the fields from the previous steps in the workflow stream.