Process Activities / Utilities tab
Parent topic: Utilities tab

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 PrivateCloud (on-premises) environment.

Good to Know

How to Start

  1. On the Organizer, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Utilities tab.
      2. Utilities , drag the PowerShell Command activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click PowerShell Command .
  3. Configure Configuration for calling PowerShell Command screen.

    For more information, refer to Run a PowerShell Command.

  4. (Optional) Click Advanced > E-mail Notification .

    For more information, refer to Configure E-mail Notifications for Any Activity

General Configuration

Specifies the common information for a system activity.



Fields

Field Name Definition

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

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

Configuration for calling PowerShell Command

Specifies the PowerShell command to run in your environment.



Fields

Field Name Definition

Command Source
Function:
Specifies the source of the command.
Accepted Values:
  • Input Text - Lets you enter a command in text format in the Command field.
  • Read From File - Lets you upload a command from a file on your AgilePoint Server or SharePoint Server.
Default Value:
Input Text
Accepts Process Data Variables:
No

Command
Function:
Specifies a command or executable file to run. The command code must be in PowerShell format.
Accepted Values:
A valid PowerShell command or executable name.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
Install-SPSolution -WebApplication "${/pd:AP/pd:processFields/pd:sitecollection}" 
     -GACDeployment -FullTrustBinDeployment -Identity Ascentn.SharePoint.SettingsList.wsp 
     -CompatibilityLevel All

File Path (AgilePoint Server File Path)
Function:
Specifies the location of the file that contains the PowerShell command.
To Open this Field:
Select Read From File.
Accepted Values:
An absolute path and file name on the AgilePoint Server or SharePoint Server.

The file name must have the extension .bat or .txt.

Default Value:
None
Accepts Process Data Variables:
Yes
Example:
  • c:\My Documents\sample1.doc
  • ${HomeDirectory}\sample2.doc
  • http://demo3:8000/DocumentLib1/sample3.doc

Return Value (Get Console Output Value)
Function:
Stores output in specified process data variable.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes
Parent topic: Utilities tab

Quick Links:

Send Feedback

Quick Start

Process Activities

eForm Controls

AgilePoint NX Online Help

AgilePoint NX Technical Documentation

Support Portal

AgilePoint

AgilePoint NX

Documentation Updated: December 3, 2015

© 2015 AgilePoint, Inc. All rights reserved.