Add and configure 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 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.

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, the following actions can be performed:

• If the Visible At Runtime option is enabled, parameter values can be provided and the step can be run by clicking Proceed.
• The step can be cancelled by clicking the Cancel Step button .

  Note:

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

• The step can be finished by clicking the Complete Step button .

Configure the step

To configure the step, do the following:

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

3. Provide a name for the step in the Step Name text box.
4. Type the URL of the geoprocessing service in the GP Service URL text box.
5. 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.
6. Click Edit in the Arguments section.

   The Step Arguments dialog box appears.

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

8. 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.
9. Update the return value as necessary.
10. Click the Options tab.
11. 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 your 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 that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.

    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

12. Optionally, provide help text for the step in the Step Help text box.

    You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

    'For further assistance, please contact ' + jobCreator($job) + '.'

13. Optionally, click the Style tab to change the shape and color of the step.
14. Optionally, click the About tab and provide a description for the step in the Step Description text box.

    Note:

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

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 values	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 be used as inputs for other steps throughout the workflow. The following table shows the step's output value:

Output value name	Description	ArcGIS Arcade expression syntax
<GeoprocessingServiceOutput>	Returns all output values received from the geoprocessing service.	jobOutputValue($job, '<step_id>','<geoprocessing_service_output_parameter_name>') Note: geoprocessing_service_output_parameter_name is an optional parameter. If a derived output parameter name is not provided, the first derived output value is returned.