The Set Job Version step allows you to use an existing branch version of the workflow diagram's data source, created outside of ArcGIS Workflow Manager, with a job instead of creating a job-specific version with the Create Version step.
When the step is run, it sets the specified version as the job-specific version. If a job-specific version already exists, it overwrites the existing version and replaces it with the version specified. 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 the step's Workflow Administered check box is checked, Workflow Manager is allowed to administer the branch version and the Claim Version step and the Cleanup step 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 one of the following options:
- Select Source—Choose this option, click the Select Source drop-down arrow, and choose the data source from which you want to choose a version.
- Arcade Expression—Choose this option and provide an ArcGIS Arcade expression that returns the item ID of the data source from which you want to choose a version.
Tip:
Click This input supports Arcade Expressions
and choose an ArcGIS 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 multiple Set Job Version steps in your workflow diagram.
- In the Version section, choose one of the following options:
- Version GUID—Choose this option and provide the GUID of the branch version that you want to use. This is the preferred method as it provides improved performance.
- Version Name—Choose this option and provide the fully qualified version name of the branch version you want to use. For example, WORKFLOWUSER.JOB_44.
- Optionally, check the Workflow Administered check box to allow Workflow Manager to administer the branch version.
This also allows the Claim Version step and the Cleanup step 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 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 additional automated steps without manual intervention.
- 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.
You can also use ArcGIS Arcade expressions to provide a dynamic value for the step help. If the step help contains plain text and Arcade expressions, you'll need to format the text as follows:
'For further assistance, please contact ' + JobCreator($Job) + '.' - 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.
Note:
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 your 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 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 lists the step's output values:
| Output | Description |
|---|---|
| version | Returns an array of the set version. |
dataSource | Returns an array of the data source URL for which versions were successfully set. |