PowerShell Command activity

An activity that specifies a PowerShell command to run from a process.


PowerShell Command activity

Configure the PowerShell Command activity

To configure the PowerShell Command activity, do the procedure in this topic.

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In the Process Builder, in the Activity Library, open the Utilities tab.

    Open Utilities tab
  3. On the Utilities tab, drag the PowerShell Command activity onto your process.

    Drag PowerShell Command activity

Procedure

  1. Complete the fields on the General Configuration screen.
  2. Click PowerShell Command PowerShell Command icon.
  3. Configure Configuration for calling PowerShell Command screen.

    For more information, refer to Run a PowerShell Command.

  4. (Optional) Click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the PowerShell Command activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field NameDefinition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

PowerShell Command Configuration

Specifies the PowerShell command to run in your environment.

Figure: PowerShell Command Configuration screen

PowerShell Command Configuration screen

Fields

Field NameDefinition

PowerShell

Function:
Specifies the access token that connects to your PowerShell.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Limitations:

This field is available in these releases:

Create Add Token icon

Opens this Screen:
Access Token for PowerShell
Function of this Screen:
Configure an access token to connect to PowerShell.

Script File Path On AgilePoint Server Machine

Function:
Specifies the location of the file that contains the PowerShell command.
Accepted Values:
An absolute path and file name on the AgilePoint Server machine.

If the command runs on a Windows machine, the file name must have one of these extensions:

  • .bat
  • .txt
  • .ps1
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

This field is available in these releases:

Store The Return Value In This Variable

Function:
Specifies the process data variable to store the response from the PowerShell command.
Accepted Values:
A process data variable that accepts an alphanumeric string that can have spaces and special characters.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

This field is available in these releases: