Run GP Service

The Run GP Service step runs a configured geoprocessing service. The step can be used to run geoprocessing tools, Python script tools, and ModelBuilder models that have been published to an ArcGIS Enterprise portal as services.

When the step is run, the Starting icon appears on the job and when the service starts, the Running icon appears to indicate that the geoprocessing service is running.

If any of the step parameters are configured with an ArcGIS Arcade expression, they will be converted to the appropriate value before the geoprocessing service starts running.

If the Visible At Runtime option is enabled, a dialog box appears in ArcGIS Pro when the step is run to allow you to define parameter values. If a default value was configured, it appears in the dialog box. Required parameters are highlighted in red. When you are finished defining parameter values, click Proceed to continue running the step.

If the step runs successfully, a Step Complete icon appears. If the step fails, a GP Step Failed icon appears.

Note:

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

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

• Click the Cancel Step button to stop the running geoprocessing service.

  Note:

  In some cases, you may be unable to cancel this step once it has started running.

• Click the Complete Step button to finish the step.

Configure the step

Complete these steps to configure the Run GP Service step:

1. Create or edit a workflow diagram to access the Step Library panel.
2. Drag Run GP Service from the Step Library 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.

3. Provide a name for the step in the Step Name text box.
4. Optionally, provide a description for the step in the Step Description text box.
5. Configure step options in the Options section as necessary.
   • Automatically Executes—Runs the step as soon as it becomes active.
   • Can Be Skipped—Allows the step to be finished without being run.
6. In the Logic section, type the URL of the geoprocessing service in the GP Service URL text box.
7. Optionally, uncheck the Secure check box if the geoprocessing service is not secured and doesn't require a token to be provided in the request.
8. Click Edit next to Arguments.

   The Step Arguments dialog box appears.

9. Configure input parameter values in the Parameter Value text boxes as necessary.

   Note:

   You can also use ArcGIS Arcade expressions for parameter values. If a parameter doesn't support string values, click the Token button to use an Arcade expression.

10. Optionally, check the Visible At Runtime check box next to a parameter to allow its value to be set when the step is run in ArcGIS Pro.
11. Update the return value as necessary.
12. Optionally, click the Help tab and provide help text for the step in the Help text box.
13. Optionally, click the Style tab to change the shape and color of the step.

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 code	Description
<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.