Execute PowerShell Script

Optionally specify a friendly name for the action. If no name is specified, the workflow action type will be displayed instead.

• This name must be unique in the workflow and will be displayed in the workflow overview.

Specify the user name of the account that will execute the script (run as). For local accounts, the machine name is not required, while for domain accounts you need to specify the domain name (i.e. domain\user).

• The user name defined for the action needs to have proper permissions to execute the script. For example, if your script should create a file on the disk, the user name should at least have Modify permissions for that folder.

Please note that this is a required field.

Specify the password of the account stated at User Name, above.

• When duplicating the service or the workflow action, the Password field information will not be copied, for security reasons.

Please note that this is a required field.

Specify the actual script that will be executed. The execution is handled by the engine responsible for the transactions.

• To avoid waiting for long-running scripts, this workflow action execution is isolated from other actions. This allows transactions that do not contain any Execute PowerShell Script action to execute in parallel with no impact on performance.

• Execute PowerShell Script actions are executed one at a time. If you have multiple pending transactions that contain Execute PowerShell Script actions, they will wait for the previous ones to be executed or aborted before starting their own execution.

  Example

  Consider the following scenario:

  1. Two services are started shortly after each other; Service A has an Execute PowerShell Script action at step 2, while Service B has an Execute PowerShell Script action at step 7.

  2. Service A starts, runs into the Execute PowerShell Script workflow action, and starts working on it.

  3. Service B starts and reaches the Execute PowerShell Script workflow action while the PowerShell Script from Service A is still running. It now has to wait until the PowerShell Script action is complete for Service A.

  Note that Service B only needs to wait for the PowerShell Script within Service A to complete, and not for the entire service.

• The action can be aborted at any time, from the Transaction section of the Management Portal. By doing this, you stop the script execution thread and allow the next pending Execute PowerShell Script action to start its execution.

Specify a description of this action.

Used for mapping attributes from Identity Director to PowerShell variables.

• All the input parameters will be serialized upon compilation. This means that, if you need to perform certain operations on the parameters, you might need to cast them to the appropriate type. For example: $n = [int]#Service[n.Value]+1

  • Casting only works for basic types of parameters, such as integers.

    In the case of complex types, such as arrays, you must construct them instead of casting.

    Example

    1. Set the service attribute of type text you want to configure as array to 6;9;7;7;10;10.

    2. Construct the array in the PowerShell workflow action editor using the line below:

       $a = #Service[manualScores.Value].split(';') | % {iex $_}
       

• The attributes can be used in cmdlets or in advanced scripts. For example, the following command will create a file at the specified path: New-Item-Path #Global[RootFolder.Value]\#Service[FileName.Value] - ItemType File

• Attributes or other placeholders that contain space, dash, or underline characters are allowed. Any other special characters used in the attribute name are not supported.

• The script allows the use of any attribute.

Used for mapping variables from PowerShell to Identity Director attributes.

• The script only allows the mapping of Service Attributes of type Text.

• In order to map variables, you need to prefix the Identity Director parameter with $global:. For example, the following command will map the PowerShell output to the psVersion service attribute: $global:psVersion = [System.Environment]::OSVersion.Version

• To map a PowerShell value to a service attribute with spaces, enclose the attribute with curly brackets. For example: ${global:Job Title} = 'engineer'

This action can handle both compile and runtime errors.

• All the errors will be visible in the Transaction Engine log.

• For user-handled errors, we recommend the use of Write-Error.
  For example: Write-Error "Something went wrong!".

• Aborting the action will also be logged, together with an expected error that results from script interruption.

Only multiline comments are supported. This means that, for single line comments, you should use the same pattern. For example: <# this is a comment #>.