Overview

When using a PowerShell Script step in a Flow within Decisions, the way the script is executed plays a crucial role in determining how the output is handled and what path the Flow will follow afterward. This step provides automation capabilities by running PowerShell code within the Flow. This documentation explains how various types of outputs, including structured objects with properties and simple text strings, are managed. It also covers how the execution outcome affects the Flow's progression, whether it concludes as Done, Done With Errors, or Failed. Additionally, this guide explores how to handle non-terminating errors and configure remote execution for PowerShell steps.

Scripts that Output PowerShell Objects

Some PowerShell Scripts return lists of PowerShell objects from which Decisions can select the user's desired properties. The script below is an example of this. The sample script can be imported into Decisions.

   Powershell-Sample-Scripts.zip  

The step retrieves a list of processes running on the Decisions server, and the script definition tells Decisions to select the ID and Process Name properties from the objects that the script returns. Each of these properties appears in the Outputs area of the step as an array of values. The PowerShell Module Basics provides details on this sample script.

Scripts that Output Text

Other PowerShell scripts can return results as text. A simple example of this is the following PowerShell Script:

$Variable = "This is an example of string output."
Return $Variable

Because this PowerShell script does not return an object with properties, there are no properties for Decisions to select, and therefore no need to specify anything in the Outputs area of the script.

When this PowerShell Script is added as a Flow step, users can access the script's output in the Edit Input Mappings using the Script Raw Output, a single text string containing all of the lines of output that the script generated.

Non-terminating Errors

Some commands in PowerShell scripts do not halt script execution when they encounter a problem. They write error messages to a special error stream instead. This output can be mapped from a PowerShell Script step using the Non-terminating Errors output of the step.

This is a separate output stream from the Script's Raw Output and contains all the errors that any portion of the script wrote. An example script that writes to this output stream is:

$Error_Message = "This is a non-terminating error"
Write-Error $Error_Message
Return

PowerShell Script Step Paths

Because PowerShell scripts can run to completion but still generate error messages, Decisions provides multiple paths out of a PowerShell Script Step:

Note:

Both the Done With Errors and Failed paths can be hidden using the Hide Done With Errors Path and Hide Failed Path checkboxes under the properties panel on the right.

Running PowerShell Steps Remotely

PowerShell Script Steps can be Run Remotely by enabling the option "Run Remotely" from the properties panel.

Refer to and enter all the input details as per the following table:

Enabling the Run Remotely option will expose another setting, Use Constant Credentials. Enter all the input details as per the following table to make use of constant credentials to connect to the PowerShell: