Add and configure Create Replica

License:

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

The Create Replica step creates a replica geodatabase from a specified data source using the Feature Service's Create Replica operation to enable offline editing workflows.

When creating offline editing workflows, this step should be one of the first steps in the workflow diagram. Once the edits are completed, changes can be synchronized with the replica geodatabase using the Open Pro Project Items step and applied to the default version using the Reconcile and Post step.

Configure the step

Do the following to configure the step:

1. Create or edit a workflow diagram to access the Step Library panel.
2. Drag Create Replica 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. Provide a name for the replica in the Replica Name text box.

   If you don't provide a name for the replica, the name of the current job is used by default.

   Caution:

   The replica name must not contain hyphens. Using hyphens in the replica name causes the step to fail.

5. Provide the path to the folder where the replica will be created in the Replica Location text box.

   This can be a local or network file path. ArcGIS Workflow Manager Server must have read and write access to the specified folder.

   Tip:

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

6. Do one of the following to configure the replica path location that ArcGIS Pro will use to access the replica:
   • If you configured the Replica Location parameter with a file path that is accessible by all users who will run steps that require access to the replica, ensure that the Same as replica path location check box is checked.
   • If you configured the Replica Location parameter with a local file path, uncheck the Same as replica path location check box and provide a path to the replica folder that is accessible by all users who will run steps that require access to the replica.
   • If Workflow Manager Server is deployed in a Linux environment, uncheck the Same as replica path location check box and provide a path to the replica folder that is accessible from Windows by all users who will run steps that require access to the replica.

   All users who will run steps that require access to the replica must have read and write access to the specified folder.

7. Click the Data Source drop-down arrow and choose a data source.

   Only one data source can be configured with the Create Replica step.

   Tip:

   Configure additional Create Replica steps in the workflow diagram to create a replica for more than one data source.

8. Optionally, click Edit in the Sublayers section to add or remove sublayers.

   The Select Layers dialog box appears.

   1. Check the Enabled check box next to the sublayers that you want to include.

      All sublayers are included by default.

   2. Click Save to save the changes or click Cancel to exit.
9. In the Define Geometry section, choose one of the following options to define the replica's geometry:
   • Job Location—Use the location defined in the job.
   • Arcade—Provide a dynamic value using an Arcade expression.
10. Optionally, check the check boxes in the Replica Options section to configure the following options:
    • Annotations and Dimensions—Include annotation or dimension feature layers.
    • Contingent Values—Include contingent values defined for the feature layer.
    • Utility Network Subset—Include utility network feature layers.
    • True Curves—Preserve true curves.
11. Click the Options tab.
12. 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 more automated steps without manual intervention.

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

      Learn more about scheduling options

13. 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, you must 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 run in the web app only support HTTP and HTTPS URL formats. Steps 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, you must 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:

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

14. Optionally, click the Style tab to change the shape and color of the step.
15. 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 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 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
dataSourceNames	Returns the data source associated with the replica.
layers	Returns an array of layer IDs associated with the replica.