SharePoint PowerShell Command activity

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

Configure the SharePoint PowerShell Command activity

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

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
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?

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

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

Specifies the basic settings for the And activity.

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

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 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

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:

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

Specifies the PowerShell command to run in your SharePoint environment.

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