Version: 2.2
Category: Output
Extended Category: Run
Action Package: Standard Actions
Description
Launch an external application or script. If there are any spaces in ANY parameter, wrap ‘ ‘ around for ALL parameters.
| Parameter | Description | Example |
| Launch Command | [Mandatory] The launch command including all parameters. Use SESSION(attributeName) to insert session attribute values. Use quotation marks ” ” for parameters that has a value containing spaces. A full path to executables and UNC paths should be provided i.e, “C:\Program Files\PhenixID\PIP\scripts\createHomeDir.cmd” “SESSION(sAMAccountName)” Supports SESSION() and GLOBAL(). | c:\1.bat |
| Milliseconds to Sleep | [Optional] The number of milliseconds to sleep between execution of the script/command. Default is 0. | 10 |
| Only Run Once | [Optional] If the application should run once and not for all objects in the session. (true/false) Default is false. | true |
| Max Execution Time (secs) | [Optional] The maximum number of seconds the script/command can run before being forced to terminate. Use 0 for unlimited time. Default: 0 (unlimited) | 10 |
| Success String | [Optional] Check for a specific return value to detect if the launch of the application was successful. Leave blank to ignore. Supports SESSION() and GLOBAL(). | Success |
| Failed String | [Optional] Check for a specific return value to detect if the launch of the application has failed. Leave blank to ignore. Supports SESSION() and GLOBAL(). | Fail |
| Status Session Attribute | [Optional] If the success string or failed string was detected, a status attribute will be set with either the value SUCCESS or FAILED. Leave blank to ignore. | Status |
| Stop on Failure (false/true) | [Optional] If the failed string was detected or success string has not been detected, stop the action from further execution and return with an action failure. Default: false. | true |
| Read Error Stream (true/false) | [Optional] If the error stream should be read and written to the log file. (true/false) Default: false. | true |
Use Cases
Example 1: Launches a script to create home directories
This action will launch any application or script as long as it can be reached from the server running the Identity Provisioning service. The Identity Provisioning service user will be the user launching the script.
| Parameter | Value |
| Launch Command | “C:\Program Files\PhenixID\PIP\scripts\createHomeDir.cmd” “SESSION(sAMAccountName)” |
| Milliseconds to Sleep | [BLANK] |
| Only Run Once | [BLANK] |
| Max Execution Time (secs) | [BLANK] |
| Success String | [BLANK] |
| Failed String | [BLANK] |
| Status Session Attribute | [BLANK] |
| Stop on Failure (false/true) | [BLANK] |
| Read Error Stream (true/false) | [BLANK] |
DISCLAIMER
Information provided in this document is for your information only. PhenixID makes no explicit or implied claims to the validity of this information. Any trademarks referenced in this document are the property of their respective owners.The origin of this information may be internal or external to PhenixID. PhenixID makes all reasonable efforts to verify this information.
PhenixID - support.phenixid.se