Process Activities / Utilities tab
Parent topic: Utilities tab

External Command activity

An activity that specifies a command line action, such as a DOS or UNIX command, that a process runs started from a process.



Configure the External Command activity

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

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. On the Utilities tab, drag the External 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 the External Command Activity.

  2. Click External Command .
  3. Complete the fields on the Configuration for calling External Command screen.

    For more information, refer to Do a Loop to Repeat an Action.

  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 the External Command 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

Connection Timeout (Seconds)
Function:
Specifies the number of seconds permitted to complete an action before the connection stops.
Accepted Values:
An integer that represents a number of seconds.
Default Value:
600
Accepts Process Data Variables:
No

Configuration For Calling External Command

Specifies the details for calling an external command. .



Fields

Field Name Definition

Environment Variable
Function:
Specifies a set of dynamic named values that controls how processes run on a computer.
Accepted Values:
An environment variable that exists on the target machine.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Path

Command
Function:
Specifies a command or executable to run.
Accepted Values:
A valid command or executable name.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
CMD

Arguments
Function:
Specifies the parameters necessary to complete the command.
Accepted Values:
A valid argument for the specified command.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
DIR

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.