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 tile. 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 are converted to the appropriate values before the geoprocessing service starts running.
If the Visible At Runtime option is enabled, the step allows you to define parameter values before the geoprocessing service is started. If default values were configured for parameters, they appear when you run the step and can be overridden. Required parameters are highlighted in red.
If the step runs successfully, a Step Complete icon appears. If the step fails, a GP Step Failed icon appears.
If a parameter value obtained from an ArcGIS Arcade expression is incompatible with the geoprocessing service, 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 Proceed to continue running the step.
- Click the Cancel Step button to stop running the step.
In some cases, you may be unable to cancel this step after it starts running.
- Click the Complete Step button to finish the step.
Configure the step
Complete these steps to configure the Run GP Service step:
- Create or edit a workflow diagram to access the Step Library panel.
- Drag Run GP Service from the Step Library to a connection arrow of a step on the workflow canvas.
The Step Details panel appears.
- Provide a name for the step in the Step Name text box.
- Type the URL of the geoprocessing service in the GP Service URL text box.
- 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.
- Click Edit in the Arguments section.
The Step Arguments dialog box appears.
- Configure input parameter values in the Parameter Value text boxes as necessary.
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.
- 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.
- Update the return value as necessary.
- 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.
- Run on a Schedule—Run the step according to a schedule you set.
- Manual—Run the step manually.
- Optionally, provide help text for the step in the Step Help text 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.
The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.
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:
The step completed successfully, and the step returns the custom return code defined in the step.
The step failed to complete successfully.
The step completed successfully.
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:
All of the output values received from the geoprocessing service when the step was run.