Branch Version Editing widget

The Branch Version Editing widget allows end users to edit branch versioned datasets, manage branch versions, and streamline editing workflows in an app. This widget also supports versioned editing with options to save, discard, undo, and redo changes, as well as the ability to reconcile and post data after editing.

Examples

Use this widget to support app design requirements such as the following:

• You want to allow end users to switch to a named version for versioned editing.
• You want to allow end users to save, discard, undo, or redo edits.
• You want to allow end users to reconcile and post edits.

Usage notes

This widget requires connection to a Map widget that must be connected to a web map data source with the Version Management capability enabled.

Depending on the user type and the versioning operation, the end user may need the Advanced Editing user type extension. For more information about licensing, refer to the ArcGIS Enterprise Geodatabase Capabilities table in the ArcGIS Enterprise Functionality Matrix.

The following functionalities are supported:

• Switch to a named version.
• Create a named version.
• Delete a named version.
• Modify an existing named version.
• Change the owner of a version.
• Save or discard edits.
• Undo or redo edits.
• Reconcile a named version with the default version.
• Post changes to the default version after a reconcile operation.

When using this widget, consider the following:

• The edit toolbar, which by default consists of the Save, Discard, Undo, Redo, Reconcile, and Post buttons, is available only during an edit session when editing data in a named version. Edits made in the default version do not initiate an edit session.
• The edit toolbar can be used in conjunction with other widgets in the app. For example, you can edit attributes in the Table widget, save the edits, and post the edits to the default version.
• The Post button is only enabled in the edit toolbar after performing a reconcile operation.

Settings

The Branch Version Editing widget includes the following settings:

• Select a Map widget—Connect the Branch Version Editing widget to a Map widget. Any Map widgets added to the app appear in a list.
• Default Versions—Configure settings related to the version to load at run time and related to the ability to manage versions and enable edit sessions.

  Note:

  The label above the drop-down menu is based on the name of the data source. Click the drop-down menu to specify the version to load at run time.

  Caution:

  The version you set to load at run time only loads if the widget is open when the app loads, or if the version is set using a URL parameter. If you add the Branch Version Editing widget to a Widget Controller, you must set the Branch Version Editing widget to open when the app loads in the Widget Controller's settings.

  • Manage Versions Enabled—Turn on this setting to make the Manage versions button available in the widget panel at run time.
  • Edit Sessions Enabled—Turn on this setting to enable edit sessions and to make the edit toolbar available in the widget panel at run time.
• Edit Toolbar Settings—These settings appear if the Edit Sessions Enabled setting is turned on. Configure settings to include or remove specific functionalities in the edit toolbar as follows:
  • Save Enabled—Turn on this setting to make the Save button available on the edit toolbar. If this setting is turned off, any edits will be immediately saved.
  • Discard Enabled—Turn on this setting to make the Discard button available on the edit toolbar.
  • Undo Enabled—Turn on this setting to make the Undo button available on the edit toolbar.
  • Redo Enabled—Turn on this setting to make the Redo button available on the edit toolbar.
  • Reconcile Enabled—Turn on this setting to make the Reconcile button available on the edit toolbar.
  • Post Enabled—Turn on this setting to make the Post button available on the edit toolbar.
  • Show dialog on save—Check this check box to display a warning dialog box before saving edits.
  • Show dialog on discard—Check this check box to display a warning dialog box before discarding edits.
• Edit Toolbar Display—Configure settings related to the display of the edit toolbar. These settings appear if the Edit Sessions Enabled setting is turned on.
  • Scale—Change the scale of the edit toolbar.
  • Display Type—Choose between the Docked and Floating options for the edit toolbar.
  • Dock Position—Choose a position for the edit toolbar, either the top, bottom, left, or right of the widget panel. This setting appears if you have a docked edit toolbar.
  • Layout Type—Choose a layout type for the edit toolbar, either horizontal or vertical. This setting appears if you have a floating edit toolbar.
  • Default Position—Define where the edit toolbar appears on the page by width, height, and location. You can specify height and width values in pixels (px) or percent (%). You can use the nine-panel grid to position the edit toolbar to one of the anchor points on the page. You can also set x and y offsets. These settings appear if you have a floating edit toolbar.