PowerShell Command activity

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

Configure the PowerShell Command activity

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

Prerequisites

AgilePoint NX OnPremises or AgilePoint NX PrivateCloud.

Good to Know

This activity can run a command on any target machine that runs PowerShell.
An access token is required to access the target machine.
The file that stores the Powershell command must be stored on the AgilePoint Server machine.
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Utilities tab.
On the Utilities tab, drag the PowerShell Command activity onto your process.

Procedure

Complete the fields on the General Configuration screen.
Click PowerShell Command .
Configure Configuration for calling PowerShell Command screen.
For more information, refer to Run a PowerShell Command.
(Optional) Click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the PowerShell Command activity.

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts 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	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

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

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

PowerShell Command Configuration

Specifies the PowerShell command to run in your environment.

Fields

Field Name	Definition
PowerShell	Description: Specifies the access token that connects to your PowerShell. Allowed Values: A list of access tokens configured for your environment. Default Value: None Limitations: This field is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v8.0 Software Update 2 or higher
Create	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	Description: Specifies the location of the file that contains the PowerShell command. Allowed 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 Variables: Yes Limitations: This field is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v8.0 Software Update 2 or higher
Store The Return Value In This Variable	Description: Specifies the process data variable to store the response from the PowerShell command. Allowed Values: A variable. Format: String Accepted: Letters Numbers Spaces Special characters Default Value: None Accepts Variables: Yes Limitations: This field is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v8.0 Software Update 2 or higher