Navigation:  IM Sequencer > Schedule tasks > Steps > Custom step >

Powershell step

Previous pageReturn to chapter overviewNext page

 

The Powershell step is a custom step that will execute a Powershell script

 

       General setting
       All general custom step settings are described below, to develop your own step plugin read more here.

 

Type
 
The Powershell step is called "Traxion.IM.Scheduler.Plugins.Powershell.PowershellStep"

 

Parameters

 
The following parameters apply for the Powershell step.

 

Script file
This points to a Powershell script with the extension *.ps1, you can configure this or use the Script text parameter

 

Direct execute script
If you configured the Script file parameter then the contents will be read from the file and then executed, when you set this to true the Script file will be started directly without reading the contents.

 

Script text
This can contain the direct Powershell commands to be executed, you can configure this or use the Script file parameter

 

Script parameters
The parameters that need to be provided to the Powershell script file, this does not apply for the Script text parameter
The parameter format is like "encryption=true;remote=false;url=http://localhost", multiple parameters are splitted using ';', if the parameter has no value ommit the '=' and only provide the parameter name.

 

Custom result variable
You can use this to give back a alternative result code (must be a valid integer), set a global variable name like this "$global:<variableName>" in your Powershell command where the variable name is the same as the value configured for the "Custom Result Variable" parameter.

 

Script credential variables

       If the script needs to have a specific username or password it can be configured and stored encrypted, this way you do not need to store the username/password in the script directly.

       You can access the configured username and password via the global variables like "$global:ScriptUserName" for the username and "$global:ScriptUserPassword" for the password.

 

Bypass execution policy
Set to true to bypass the powershell execution policy for this step only. You can also disable or change the powershell execution policy on the system by opening a powershell console using administrator rights and type 'Set-ExecutionPolicy Unrestricted', see https://technet.microsoft.com/en-us/library/ee176961.aspx for more information about the powershell execution policy.
 
                               Powershell step type settings

 


Page url: http://www.traxionsolutions.com/imsequencer/help/index.html?powershellsteptype.htm