Add and configure Run Pro GP Tool—ArcGIS Workflow Manager

The Run Pro GP Tool step runs a configured tool, Python script, or ModelBuilder model in ArcGIS Pro.

When the step is run, the Starting icon appears on the job tile. When the tool starts, the Running icon Running appears to indicate that the tool is running.

If any of the step parameters are configured with ArcGIS Arcade expressions, they are converted to the appropriate values before the tool starts running.

If the Visible At Runtime option is enabled, the tool configured in the step opens in the Geoprocessing pane and allows you to define parameter values before the tool is run. If default parameter values were configured, they appear when you run the step and can be overridden. If User Prompt and Step Help values aren't configured for the step, the step completes automatically when it is run.

Note:

If a parameter value obtained from an ArcGIS Arcade expression is incompatible with the tool, the step fails.

When the step is run, the following actions can be performed:

If the Visible At Runtime option is enabled, parameters values can be provided and the step can be run by clicking Run in the Geoprocessing pane.
The step can be canceled by clicking Cancel.
Note:
In some cases, you may be unable to cancel this step after it starts running.

Configure the step

To configure the step, do the following:

Create or edit a workflow diagram to access the Step Library panel.
Drag Run Pro GP Tool from the Step Library panel to a connection arrow of a step on the workflow canvas.
Learn more about adding steps to a workflow diagram

The Step Details panel appears.
Provide a name for the step in the Step Name text box.
Optionally, add the message that you want to appear when the step is run in the User Prompt text box.
If the user prompt contains plain text and ArcGIS Arcade expressions, format the text as follows:
```
'This job is currently assigned to ' + JobOwner($Job) + '.'
```
Tip:
Click This input supports Arcade Expressions and choose an Arcade expression to add it to its associated text box.
Choose the type of tool you want to run in the Arguments section:
- System Toolbox—Geoprocessing tools included with ArcGIS Pro and toolboxes imported into an ArcGIS Pro project
- Other Toolbox—Custom geoprocessing tools and scripts

Do one of the following:

Tools in the system toolboxes

Type the toolbox alias of the toolbox that contains the tool that you want to run in the Toolbox Alias text box.

The toolbox alias can be found on the Python tab on the tool’s help page in the ArcGIS Pro documentation.

Tools imported into an ArcGIS Pro project

Type the toolbox alias of the toolbox that contains the tool that you want to run in the Toolbox Alias text box.

Right-click the toolbox in the Catalog pane and click Properties to show the toolbox alias.

Custom geoprocessing tools and scripts

Type the full path to the toolbox in the Toolbox Path text box. The path to the toolbox can also reference toolboxes stored in a file geodatabase or an enterprise geodatabase. The path must be accessible in ArcGIS Pro.

You can also use ArcGIS Arcade expressions to provide a dynamic value.

Type the name of the tool that you want to run in the Tool Name text box.
Note:
If the name of the geoprocessing tool in the Tool Name text box matches the name of an Arcade function, such as Buffer or Clip, you must surround the name of the tool in single or double quotation marks so that it is not evaluated as an Arcade expression.
The tool name can be found on the Python tab on the tool’s help page in the ArcGIS Pro documentation.
You can also use ArcGIS Arcade expressions to provide a dynamic value.
Optionally, check the Visible At Runtime check box to allow parameter values to be set when the step is run in ArcGIS Pro.
Click Add New Parameter.
Type the name of the parameter in the Parameter Name text box.
The tool's parameter names can be found on the Python tab on the geoprocessing tool's help page in the ArcGIS Pro documentation.
Optionally, click the Show Default Value button to define the default value of the parameter when the step is run.
1. Choose one of the following options:
  - Value—Provide a static value.
  - Arcade Expression—Provide a dynamic value using an Arcade expression.
2. Provide a default value for the property in the Value or Arcade Expression text box.
Repeat steps 9 through 11 to add more parameters.
Optionally, type the name of the derived output parameter you want to use as an output value when the tool finishes running.
The tool's derived output parameters can be found on the Python tab on the tool's help page in the ArcGIS Pro documentation.
Optionally, check the Attach GP Log check box to save the tool's history as a job attachment.
Note:
When the Attach GP Log check box is checked, the attachment ID of the tool's history log is included in the step's output values.
Optionally, provide the name of the folder in which logs will be stored in the Folder text box.
The folder name can't contain a file system path or special characters. If a folder name isn't provided, a folder named General is automatically created.
Note:
The folder is contained within the workflow item and is not a file system path.
Click the Options tab.
Configure Step Options as necessary:
- Manual—Run the step manually.
  - Optional—Allow the step to be finished without being run.
- Automatic—Run the step as soon as it becomes active.
  Note:
  If the workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token expires will not run automatically. The ArcGIS Workflow Manager Server Advanced role is required to run additional automated steps without manual intervention.
- Run on a Schedule—Run the step according to a set schedule.
  Learn more about scheduling options
Optionally, choose one of the following options to configure help in the step:
- None—Configure the step without step help.
- Text—Configure help text for the step in the Text text box.
  You can use ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, format the text as follows:
```
'For further assistance, please contact' + JobCreator($Job) + '.'
```
- URL—Configure the step with a link to a help resource in the URL text box.
  Note:
  Steps that are run in the web app only support HTTP and HTTPS URL formats. Steps that are run in ArcGIS Pro support HTTP, HTTPS, and file formats.
  
  You can also use Arcade expressions to provide a dynamic value. If the URL contains plain text and Arcade expressions, format the text as follows:
```
'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'
```
  Configure the Automatically Encode Arcade Result check box as follows:
  - If an Arcade expression returns special characters that must be escaped when converted to a URL, such as a space or a forward slash, ensure that the Automatically Encode Arcade Result check box is checked.
  - If an Arcade expression is used to form the base URL, uncheck the Automatically Encode Arcade Result check box.
Optionally, click the Style tab to change the shape and color of the step.
Optionally, click the About tab and provide a description for the step in the Step Description text box.
Tip:
The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output. Click Copy Step ID to copy the step ID to the clipboard.

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:


Return value	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.

Output value

When the step is completed, its output value is stored and can be used to determine the path the workflow follows or can be used as inputs for other steps throughout the workflow. The following table lists the step's output value:


Output	Description
<DerivedOutputParameterValue>	Returns the configured derived output value received from the tool.
attachmentId	Returns an array of attachment IDs added to the step.

Note:

Note:

Configure the step

Tip:

Note:

Note:

Note:

Note:

Note:

Tip:

Return value

Output value

Related topics

In this topic