Register a dataset as branch versioned

Available with Standard or Advanced license.

When you initially add or create a table or feature class (hereafter referred to as a dataset) in an enterprise geodatabase, the dataset is not registered as versioned, and it is considered nonversioned data. Before you can edit a dataset in a named version, you must register the dataset as versioned. To learn more about why you would edit a dataset in a named version, see Overview of versioning.

There are two versioning types you can use when registering datasets as versioned—branch and traditional. The information below refers to branch versioning.

Learn more about versioning types

Note:

Regardless of the type of versioning used, it is recommended that you load all the data into the feature class or table before you register it as versioned. Both versioning types add a number of system-maintained tables, indexes, and attributes that can add to the processing time of data loading operations.

Register a dataset

The prerequisite steps along with the registration process will prepare the datasets for use throughout the platform, offline, and across portals.

Prerequisite:

Before you register a dataset as branch versioned, there are requirements that must be met:

  • The enterprise geodatabase must be at release 10.6 or later. The following database platforms are supported:
  • The dataset must contain a global ID field.
  • Editor tracking using UTC time standard must be enabled on the dataset.

You cannot register a dataset as branch versioned if any of the following is true:

  • The dataset is already registered for traditional versioning.
  • The dataset has archiving enabled.
  • The dataset participates in a relationship class, and the primary key of the relationship is the Object ID field.
  • The dataset has unique indexes defined.
  • The dataset is a raster dataset.
  • The dataset is an Oracle compressed table.

Caution:

Once you register a dataset as branch versioned, the minimum client version required to access the dataset is ArcGIS AllSource 2.1. This also means that the dataset will no longer be available for use in ArcMap.

To register a dataset as branch versioned, complete the following steps:

  1. Connect to the enterprise geodatabase as the dataset owner.

    To learn how to connect to the geodatabase, see the instructions specific to the database in which the geodatabase is stored:

  2. Right-click the dataset and click Manage.

    The properties dialog box appears with the Manage tab active.

  3. Check Versioning and ensure that Branch is selected.

    Archiving is automatically checked. Global IDs and Editor tracking are also automatically checked if not previously configured for the dataset.

  4. Click OK.

The dataset is now registered as branch versioned. During registration, archiving is enabled to track historical edits for insert, update, and delete operations, and the following system fields are added. These fields are important for managing versioned representations of the features and objects.

  • GDB_FROM_DATE—The moment in time of an edit
  • GDB_IS_DELETE—Marks the feature as active or retired
  • GDB_BRANCH_ID—A branch identifier to isolate edits
  • GDB_ARCHIVE_OID—The unique row identifier

The two additional fields below are added to the feature class or table and allow tracking of deletions; these work in conjunction with the standard editor tracking fields:

  • GDB_DELETED_AT
  • GDB_DELETED_BY

The next step is to publish the datasets to your organization's portal. This will make the data accessible for editing as a web feature layer.

To learn more, see Share branch versioned data.

Unregister a dataset as versioned

You can unregister a dataset as versioned if it is no longer needed in the versioning environment or if you need to perform data loading and don't want the overhead from the extra version tables and indexes. To unregister as versioned, an exclusive lock is required on the dataset.

Caution:
When you unregister a dataset as versioned, all versioned edits made to the data in named versions that are not posted to default will be deleted. To prevent these edits from being lost, ensure that all named versions are reconciled and posted to default before unregistering the dataset as versioned.

To unregister a dataset as versioned, complete the following steps:

  1. Connect to the enterprise geodatabase as the dataset owner.

    To learn how to connect to the geodatabase, see the instructions specific to the database in which the geodatabase is stored:

  2. Right-click the dataset and click Manage.

    The properties dialog box appears with the Manage tab active.

  3. Uncheck Versioning.
  4. Click OK.

The dataset is now unregistered as versioned.