Run a PowerShell Command

Prerequisites

• AgilePoint NX OnPremises or AgilePoint NX PrivateCloud.

Good to Know

• In most text fields, you can use process data variables as an alternative to literal data values.
• To enter the command from a file on the server, the file must have a .bat or .txt file extension.
• To run a PowerShell command on SharePoint, use the SharePoint PowerShell Command activity.
• 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?

How to Start

1. Open Process Builder.

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

   
   
   

2. Do one of these:
   • Add an activity:
     1. In Process Builder, in the Activity Library, open the Utilities tab.

        
        
        

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

        
        
        

   • Change an activity:
     1. In your process, double-click your activity.
3. Click PowerShell Command .

Procedure

1. To run a PowerShell command, on the Configuration for calling PowerShell Command screen,do one of these.
   • To enter the command manually, do this procedure.
     1. Select Input Text.
     2. In the Command field, enter your PowerShell command code.
   • To enter the command from a file on the server, do this procedure.
     1. Select Read From File.
     2. Complete these fields as necessary

        Field Name

        Value

        File Path (AgilePoint Server File Path)

        Description: Specifies the location of the file that contains the PowerShell command. To Open this Field: Select Read From File. Allowed 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 Variables: Yes Example: c:\My Documents\sample1.doc ${HomeDirectory}\sample2.doc http://demo3:8000/DocumentLib1/sample3.doc

2. In the Return Value field, enter the process data variable where you want to store the return value returned from your PowerShell command.