Create a checkout replica

Available with Standard or Advanced license.

Checkout/check-in replication allows you to edit data in the child replica and synchronize these edits with the parent replica. See Replication types for more information.

You can use the Create Replica option from the Distributed Data context menu to access the Create Replica tool from an enterprise geodatabase. Once a checkout replica is synchronized, it is unregistered. If additional edits are required, you must create a checkout/check-in replica.

Before getting started, see Prepare data for replication to review the data requirements. For a list of data types supported with geodatabase replication in ArcGIS Pro, see Replication and geodatabase compatibility.

Follow these steps to create a checkout replica:

1. Start ArcGIS Pro and open an existing ArcGIS Pro project, or begin without a template.
2. In the Catalog pane, right-click an existing geodatabase connection and click the Distributed Geodatabase context menu.

   

   Note:

   To create a replica, you must connect to the enterprise geodatabase as a user with privileges to create data in the database.

3. Select Create Replica .

   

   The Create Replica geoprocessing tool dialog box appears with default settings.

   

4. For Replica Datasets, use the browse button to select the layers to replicate.

   

   Note:

   • There must be at least one layer in the map for the Add Many button to appear.
   • Use Add Many next to Replica Datasets to add multiple datasets at once.
   • If you are replicating a subset of data, apply definition queries as described in Determine datasets to replicate. Then use the drop-down menu to add datasets containing a subset of data to this replica. If the browse button is used to select datasets containing a subset of data instead of the drop-down menu, the definition queries will not be honored, and the default behavior will be applied.
   • When including tables in the replica, it’s important to understand that the default behavior is to replicate only the schema of the table. To replicate all records for a specific table, follow the steps in Create a subset of data to be replicated to specify the SQL expression 1=1 as the definition query on the table. To replicate all the records for all tables to the child geodatabase replica, use the All records for tables option on the Create Replica geoprocessing tool under Advanced Setting. To replicate a subset of records, set the appropriate SQL expression.

5. For Replica Type, select Check out replica from the drop-down menu.

   

6. For Output Type, from the drop-down menu, choose Geodatabase (the default value) or XML file.
   • If you choose Geodatabase, click the browse button next to Geodatabase to replicate data to and browse to the geodatabase or geodata service that will host the child replica. This geodatabase can be a file or enterprise geodatabase or may reference a geodata service on an ArcGIS Server site.

     Tip:

     If you choose a database connection to an enterprise geodatabase, ensure that the database connection you choose contains credentials for a user that has privileges to create data in the database.

     If the file geodatabase doesn’t exist, you can create a file geodatabase directly from the Geodatabase to replicate data to dialog box that appears when you click the browse button:

     1. Under Project, select Folders.

     2. Select a folder where the file geodatabase will be stored.

     3. From the New Item menu, select File Geodatabase.

   • If you choose XML file, click the browse button next to XML file to replicate data to to browse to the location and provide a name for the XML file that will host the child replica.

     Tip:

     You can later use this output XML file as input to another geodatabase by using the Import XML Workspace Document   tool.

     Replicating data in a disconnected environment is only possible if you replicate the data to an XML workspace document. To learn more, see Replicas in a disconnected environment.

7. For Replica Name, type a name to identify the replica.

   The name of each replica must be unique to the user creating the replica.

   Note:

   When deciding on a replica name, make note of these additional rules:

   • Names must begin with a letter, not a number or special character such as an asterisk or percent sign.
   • Names cannot contain spaces. If you have a two-part name for the replica, connect the words with an underscore.
   • The length of a replica's name is limited to 128 characters.
   • Names cannot contain reserved words, such as select or add. Reserved words for object names are specific to the database where the geodatabase resides; therefore, consult the database documentation for additional reserved words.

   See Name and Alias for more information regarding rules for geodatabase objects.
8. Click Advanced Setting to expand additional options if you want to override the replication default options. If you are not changing the default options, skip to step 15.

   

9. Under Advanced Setting, for Replica Access Type, choose Full or Simple for the geodatabase model.
   Learn more about the replica access type options
10. From Expand Feature Classes and Tables, select one of the following four options:
    • Use defaults—Adds the expanded feature classes and tables related to the feature classes and tables in the replica. The default for feature classes is to replicate all features intersecting the spatial filter. If no spatial filter has been provided, all features are included. The default for tables is to replicate the schema only.
    • Add with schema only—Adds only the schema for the expanded feature classes and tables.
    • All rows—Adds all rows for expanded feature classes and tables.
    • Do not add—Doesn't add expanded feature classes and tables.
11. Optionally, for Re-use Schema, choose from one of the two available options, Reuse or Do not reuse, which is the default setting.

    The Reuse schema option creates a replica using a template, allowing you to reuse a geodatabase that contains the schema of the data you want to replicate. This reduces the amount of time required to replicate the data.

    The Reuse schema option is intended for an empty schema on the child. You should delete the data from the child replica prior to using the reuse schema option.

    Note:

    This option is available for checkout replicas only and can only be performed when replicating to a file geodatabase.

12. For Replicate Related Data, choose Get related or Do not get related to specify whether to replicate rows related to rows already in the replica.

    Get related is the default setting.

    Note:

    See Replication and related data to learn more about how this setting works when replicating data.

13. Use one of the following options to define which features will be included in the replica:
    • Choose a feature layer from the Replica Geometry Features drop-down menu.

      The replica geometry features can be a feature layer that contains one or more points, lines, or polygons.

      If there is one feature in the feature layer, the features in the replica datasets that intersect that feature will be replicated. If there are two or more features in the feature layer, the geometries are merged, and only data that intersects the merged geometries will be replicated.

      If filters (such as a definition query) have been defined on the replica geometry features, only features that satisfy these filters will be used to define the replica geometry.

    • Use the Extent environment setting to define which features will be included in the replica.

    If both Replica Geometry Features and the Extent environment are set, the Replica Geometry Features setting is used.

    If neither Replica Geometry Features nor the Extent environment is specified, the full extent of the data is used.

14. Optionally, check Register existing data only if the data already exists in the child geodatabase and is used to define the replica datasets.

    If Register existing data only is unchecked, which is the default, data in the parent geodatabase is copied to the child geodatabase.

    

    Note:

    • If the Register existing data only option is checked, the All records for tables option will not be available.
    • See Register existing data only for a list of additional geodatabase replication requirements that must be met prior to selecting this option on the Create Replica geoprocessing tool.

15. Optionally, use All records for tables to specify whether all records or only the schema will be copied to the child geodatabase for tables that do not have filters applied (such as selections or definition queries).
    • Checked—For tables with no applied filters, all records will be copied to the child geodatabase for tables. This option will override the Expand Feature Classes and Tables parameter value.
    • Unchecked—For tables with no applied filters, only the schema will be copied to the child geodatabase for tables. Tables with applied filters will be honored. This is the default.

    

    Note:

    The All records for tables option will not be available if the Register existing data only option is checked.

16. Click Run to create the replica.

    Note:

    You can click the Run drop-down menu and select Schedule Run to run the tool at a later date and time and, optionally, with recurrence.

    

    Learn more about scheduling geoprocessing tools