Skip To Content

Run Pro GP Tool

The Run Pro GP Tool step runs a configured geoprocessing tool, Python script, or 模型构建器 model in ArcGIS Pro.

When the step is run, the Starting icon Starting 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.

注:

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

When you run the step, you can perform the following actions:

  • If the Visible At Runtime option is enabled, provide parameter values and click Run in the Geoprocessing pane to run the tool.
  • Click Cancel on the job tile to stop running the step.
    注:

    In some cases, you may be unable to cancel this step after it starts running.

Configure the step

Complete these steps to configure the Run Pro GP Tool step:

  1. Create or edit a workflow diagram to access the Step Library panel.
  2. Drag Run Pro GP Tool from the Step Library panel to a connection arrow of a step on the workflow canvas.

    The Step Details panel appears.

  3. Provide a name for the step in the Step Name text box.
  4. Optionally, add the message you want to appear when the step is run in the User Prompt text box.
  5. 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
  6. 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 view 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.

  7. Type the name of the tool that you want to run in the Tool Name text box.

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

  8. Optionally, check the Visible At Runtime check box to allow parameter values to be set when the step is run in ArcGIS Pro.
  9. Click Add New Parameter.
  10. 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.

  11. Optionally, click the Show Default Value button Show Default Value 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.
  12. Repeat steps 9 through 11 to add more parameters.
  13. Optionally, type the name of the derived output parameter you want to use as a return code 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.

  14. Optionally, check the Attach GP Log check box to save the tool's history as a job attachment.
  15. Optionally, provide the name of the folder in which logs will be stored in the Folder text box.

    The folder name can't contain special characters.

    注:

    If no folder name is provided, a folder named General is automatically created.

  16. Click the Options tab.
  17. 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.
    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

  18. Optionally, provide help text for the step in the Step Help text box.
  19. Optionally, click the Style tab to change the shape and color of the step.
  20. Optionally, click the About tab and provide a description for the step in the Step Description text box.
    注:

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

Return codes

When the step finishes running, it sends a return code to indicate the result of the step. The return code is evaluated, and the workflow follows all paths that match the step's return value. The following table lists the step's return codes:

Return codeDescription

<CustomReturnCode>

The step completed successfully, and the step returns the custom return code defined in the step.

Failure

The step failed to complete successfully.

Success

The step completed successfully.

Step output

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

OutputDescription

<GeoprocessingToolOutput>

The configured derived output value received from the tool when the step was run is returned.

F000001

The step failed to complete successfully.

S000001

The step completed successfully.

相关主题