Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Activities

PS Script

This activity runs a powershell script.

...

  • Command (text box editor type) (type: string): 
    • the PowerShell inline script. This parameter takes precedence over the Script Code parameter. Without $using, a $a workflow variable (variable defined via workflow, visible in the Variables area) is not visible in the script. $Using imports the variable and its current value (e.g. {$a = $using:a+1; $a})
    • the Command editor has a syntax highlighting toggle, for displaying the lines according to the chosen language. In the example below, PowerShell was used:
    • the user can also use an external editor of his/her choice via the button to the left of the edit field (). The external editor is by default Windows notepad, but it can be changed in the Designer Settings.


  • Include Administrator Scripts (combobox editor type) (type: string): this parameter specifies whether to include the execution of the scripts assigned to the workflow in Administrator. The workflow selected from Administrator will be executed first and added to the result of the powershell script.
  • Parameters collection (collection editor type) (type: string): the parameters you want to send with the request. e.g. Name: -ArgumentList and Value:arg1.
  • Password Name (text box editor type) (type: string): the name for the password variable used in the script. This is used in case of scripts that are using password variables, in order for a plain text password display to be avoided. 
  • Password (password box editor type) (type: string): the value for the password that will be used in the script (encrypted).
  • Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the script.
  • Script Code (text box editor type) (type: string): the Powershell script code to be executed. For example: "mkdir 'C:\FlowsterSolutions'" (this command creates a folder with the specified path).
  • Script File (text box editor type) (type: string): the Powershell script file. This parameter takes precedence over the Command and the Script Code parameter.
  • Script Parameters (text box editor type) (type: string): the parameters that will be passed to the PowerShell code stored in a PowerShell script file. For multiple parameters, separate the values with comma ( , ). This parameter will take effect only when a script file is selected for execution.

...

Note: The destination server must have powershell version 4 or later and the mod file must be named after the ComputerName

Powershell Script External

This activity runs an external powershell script (allowing the user to pass on parameters directly via the activity and not by using arguments list). 

Activity Parameters

The Powershell Script External activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image Added

Parameters:

  • Parameters Collection (collection editor type) (type: string): this parameter is populated with members' names mirroring the parameters' names in the selected powershell script (params() section), after the selection of the powershell script using Script file parameter (by default, this parameter is empty).  

    Image AddedImage Added


     If parameters are added to the powershell script, in order to reflect the changes in the Parameters Collection parameter, the powershell script must be chosen again using the Script file parameter. 
    Note that only the members' names are populated in the Parameters Collection. Values must be added by the user. Type string and Int32 can be used as direct values, whereas for boolean and array type parameter, variables/arguments must be used. 

    Image AddedImage AddedImage Added

  • Script file (file browser type) (type: string): this parameter specifies a file path of a powershell script. 

The Read Only Output variable are the possible output values that the activity will provide:

  • Output (type: collection<PSObjects>): outputs a collection of 'PSObject' type objects. 
  • Output Rows (type: Int32): outputs the number of 'PSOBjects' type objects returned by the execution of the script. 

Execution:
Image Added