Add and configure Create Version

License:

Organization members must be assigned the ArcGIS Advanced Editing user type extension to use this step.

Versioning allows multiple users to complete work with their own version of spatial data so that they can reconcile and post edits to the default branch version. This ensures that users are accessing the right data at the right time and avoids editing conflicts.

When the step is run, it checks each of the feature service data references defined in the workflow for an existing job-specific version of the data. If the data reference doesn't contain a job-specific version, the Create Version step automatically creates one and associates it with the job. The Create Version step only supports creating a single job version per feature service for the data references defined in the job's workflow diagram. The Create Version step can only create versions of feature services published to the same ArcGIS Enterprise portal as ArcGIS Workflow Manager.

When the step finishes running, a message appears on the job tile with the result of the step.

If a data reference has not been defined for the step, or if the step fails to create versions, a CreateVersionFailed message appears and the job doesn't proceed to the next step. Hover over the error message to display more information about the error.

If the step fails and the return codes don't match any of the configured paths, and the step isn't optional, the step remains in a failed state and can’t be skipped.

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 Create Version 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. Optionally, provide a name for the version in the Version Name text box.

   Tip:

   To add a unique ID to the version name, type [index] where you want the unique ID to appear in the version name.

5. Choose one of the following permission levels for versions in the Access Permission section:
   • Private
   • Public
   • Protected

   This setting allows you to restrict versions from being viewed or edited by users other than the version owner. The default is Private.

6. In the Data Sources section, choose one of the following options:
   • All—Create a version for all data references configured with the workflow diagram.

     Note:

     Only feature service data references hosted on the current ArcGIS Enterprise portal that have the branch versioning capability will have a job version created.

   • Select Sources—Choose the data references that you want to create versions for from the drop-down menu.

     If you don't have a feature service data reference associated with the workflow diagram, click Add data reference from the drop-down menu and add a data reference by doing one of the following:

     • Browse for item—Browse and choose from a list of items on the current portal.

       Tip:

       You can refine results by applying filters and tags to the search.

     • Enter item ID manually—Provide the item ID and reference name in the Item ID and Reference Name text boxes.

       The item is automatically validated by Workflow Manager and the data reference type is set in the Type bar.

       If the data reference cannot be validated, you must provide the item ID to a valid data reference that matches the set data reference type.

     Learn more about managing data references

   • Arcade Expression—Provide an ArcGIS Arcade expression that returns the data reference's item ID to dynamically determine the data reference that you want to create versions for when the step is run.

     The Arcade expression must return the spatial data reference ID and not the spatial data reference name. If you need to choose more than one data reference, you'll need to format your expression as follows:

     '["' + JobExtendedProperty($Job, 'versions', 'datareference1') + '"' + ',' + '"' + JobExtendedProperty($Job, 'versions', 'datareference2') + '"]'

     Tip:

     Click This input supports Arcade Expressions and choose an Arcade expression to add it to its associated text box.

7. Click the Options tab.
8. 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.

     Learn more about scheduling options

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

10. Optionally, click the Style tab to change the shape and color of the step.
11. 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
versions	Returns an array of all created versions.
dataSources	Returns an array of all data reference URLs for which versions were successfully created.
dataSourceNames	Returns an array of all data reference names for each created version.