The Set Job Version step allows you to set an existing branch version as the job's current version. When the step is run, the job version is overwritten with the specified version. If the specified version does not exist or the user running the step does not have access to the version, the step fails and an error message appears on the job tile.
When you enable Workflow Administered for the step, ArcGIS Workflow Manager administers the branch version, and the Claim Version and Cleanup steps can be used to alter or delete the version.
Configure the step
To configure the step, do the following:
- Create or edit a workflow diagram to access the Step Library panel.
- Drag Set Job Version from the Step Library panel 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.
- In the Data Source section, choose an option:
- Select Source—Click the Select Source drop-down arrow and choose the data source with the version you want to set.
Arcade Expression—Provide an ArcGIS Arcade expression that returns the data source with the version that you want to set.
The Arcade expression must return the data source ID instead of the data source name.
Tip:
Click This input supports Arcade Expressions
and choose an Arcade expression to add it to its associated text box.
Note:
Only one data source can be used for this step. If you need to set the job version for more than one data source, configure additional Set Job Version steps in the workflow diagram.
- In the Version section, choose an option:
- Version GUID—Provide the GUID of the branch version. This method is recommended for improved performance.
- Version Name—Provide the fully qualified version name of the branch version. For example, WORKFLOWUSER.JOB_44.
- Optionally, check the Workflow Administered check box to allow Workflow Manager to administer the branch version.
This enables the Claim Version and Cleanup steps to alter or delete the version.
- 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.
- Manual—Run the step manually.
- 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 values:
| Output | Description |
|---|---|
| version | An array of the set version is returned. |
dataSource | An array of the data source URL for which versions were successfully set is returned. |