Edit with branch versioning

View on GitHub

Sample viewer app

Create, query and edit a specific server version using service geodatabase.

screenshot

Use case

Workflows often progress in discrete stages, with each stage requiring the allocation of a different set of resources and business rules. Typically, each stage in the overall process represents a single unit of work, such as a work order or job. To manage these, you can create a separate, isolated version and modify it. Once this work is complete, you can integrate the changes into the default version.

How to use the sample

Once loaded, the map will zoom to the extent of the feature layer. The current version is indicated at the top of the map. Click "Create Version" to open a dialog to specify the version information (name, access, and description). See the Additional information section for restrictions on the version name.

Click "Create" to create the version with the information that you specified. Select a feature to edit an attribute and/or click a second time to relocate the point.

Click the button in the top left corner to switch back and forth between the version you created and the default version. Edits will automatically be applied to your version when switching to the default version.

How it works

Create and load a ServiceGeodatabase with a feature service URL that has enabled Version Management.
Get the ServiceFeatureTable from the service geodatabase.
Create a FeatureLayer from the service feature table.
Create ServiceVersionParameters with a unique name, VersionAccess, and description.
- Note - See the additional information section for more restrictions on the version name.
Create a new version calling ServiceGeodatabase::createVersionAsync passing in the service version parameters.
Obtain the ServiceVersionInfo of the version created in your future async handler.
Switch to the version you have just created using ServiceGeodatabase::switchVersionAsync, passing in the version name obtained from the service version info from step 6.
Select a Feature from the map to edit its "TYPDAMAGE" attribute and location.
Apply these edits to your version by calling ServiceGeodatabase::applyEditsAsync.
Switch back and forth between your version and the default version to see how the two versions differ.

Relevant API

FeatureLayer
ServiceFeatureTable
ServiceGeodatabase
ServiceGeodatabase::applyEditsAsync
ServiceGeodatabase::createVersionAsync
ServiceGeodatabase::switchVersionAsync
ServiceVersionInfo
ServiceVersionParameters
VersionAccess

About the data

The feature layer used in this sample is Damage to commercial buildings located in Naperville, Illinois.

Additional information

Credentials:

Username: editor01
Password: S7#i2LWmYH75

The name of the version must meet the following criteria:

Must not exceed 62 characters
Must not include: Period (.), Semicolon (;), Single quotation mark ('), Double quotation mark (")
Must not include a space for the first character

Note - the version name will have the username and a period (.) prepended to it. E.g "editor01.MyNewUniqueVersionName"

Branch versioning access permission:

VersionAccess::Public - Any portal user can view and edit the version.
VersionAccess::Protected - Any portal user can view, but only the version owner, feature layer owner, and portal administrator can edit the version.
VersionAccess::Private - Only the version owner, feature layer owner, and portal administrator can view and edit the version.

Sample Code

EditWithBranchVersioning.cpp

EditWithBranchVersioning.h

EditWithBranchVersioning.qml

Use dark colors for code blocksCopy
// [WriteFile Name=EditWithBranchVersioning, Category=EditData]
// [Legal]
// Copyright 2020 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

#ifdef PCH_BUILD
#include "pch.hpp"
#endif // PCH_BUILD

// sample headers
#include "EditWithBranchVersioning.h"

// ArcGIS Maps SDK headers
#include "ArcGISFeature.h"
#include "AttributeListModel.h"
#include "AuthenticationManager.h"
#include "CalloutData.h"
#include "Credential.h"
#include "Envelope.h"
#include "ErrorException.h"
#include "FeatureEditResult.h"
#include "FeatureLayer.h"
#include "FeatureTableEditResult.h"
#include "IdentifyLayerResult.h"
#include "Layer.h"
#include "LayerListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "Point.h"
#include "Polyline.h"
#include "ServiceFeatureTable.h"
#include "ServiceGeodatabase.h"
#include "ServiceTypes.h"
#include "ServiceVersionInfo.h"
#include "ServiceVersionParameters.h"
#include "Viewpoint.h"

// Qt headers
#include <QFuture>

using namespace Esri::ArcGISRuntime;

namespace
{
  // Convenience RAII struct that deletes all pointers in given container.
  struct FeatureTableEditResultsScopedCleanup
  {
    FeatureTableEditResultsScopedCleanup(const QList<FeatureTableEditResult*>& list) : results(list) { }
    ~FeatureTableEditResultsScopedCleanup() { qDeleteAll(results); }
    const QList<FeatureTableEditResult*>& results;
  };
}

EditWithBranchVersioning::EditWithBranchVersioning(QObject* parent /* = nullptr */):
  QObject(parent),
  m_map(new Map(BasemapStyle::ArcGISStreets, this)),
  m_cred(new Credential("editor01", "S7#i2LWmYH75", this))
{
}

EditWithBranchVersioning::~EditWithBranchVersioning() = default;

void EditWithBranchVersioning::init()
{
  // Register the map view for QML
  qmlRegisterUncreatableType<AuthenticationManager>("Esri.Samples", 1, 0, "AuthenticationManager", "AuthenticationManager is uncreateable");
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<EditWithBranchVersioning>("Esri.Samples", 1, 0, "EditWithBranchVersioningSample");
}

MapQuickView* EditWithBranchVersioning::mapView() const
{
  return m_mapView;
}

// Set the view (created in QML)
void EditWithBranchVersioning::setMapView(MapQuickView* mapView)
{
  if (!mapView || mapView == m_mapView)
    return;

  m_mapView = mapView;
  m_mapView->setMap(m_map);

  m_busy = true;
  emit busyChanged();

  // When map is done loading set up service geodatabse signals and map signals
  connect(m_map, &Map::doneLoading, this, &EditWithBranchVersioning::onMapDoneLoading_);

  emit mapViewChanged();
}

AuthenticationManager *EditWithBranchVersioning::authManager() const
{
  return AuthenticationManager::instance();
}

void EditWithBranchVersioning::onMapDoneLoading_(const Error& error)
{
  if (!error.isEmpty())
    return;

  // connect all needed service geodatabase signals
  connectSgdbSignals();

  connect(m_mapView, &MapQuickView::mouseClicked, this, [this](QMouseEvent& mouseEvent)
  {
    m_busy = true;
    emit busyChanged();
    // first clear the selection
    m_featureLayer->clearSelection();

    emit hideWindow();

    // if feature is already selected, then move to new location
    if (m_selectedFeature)
    {
      if (m_serviceGeodatabase->versionName() == m_serviceGeodatabase->defaultVersionName())
      {
        clearSelectedFeature();
        m_busy = false;
        emit busyChanged();
        return;
      }
      const Point clickedPoint = m_mapView->screenToLocation(mouseEvent.position().x(), mouseEvent.position().y());
      moveFeature(clickedPoint);
    }
    else
    {
      // call identify on the map view
      m_mapView->identifyLayerAsync(m_featureLayer, mouseEvent.position(), 5, false, 1).then(this,
      [this](IdentifyLayerResult* identifyResult)
      {
        onIdentifyLayerCompleted_(identifyResult);
      });
    }
  });

  connect(m_mapView, &MapQuickView::viewpointChanged, this, [this]()
  {
    if (!m_featureLayer)
      return;

    m_featureLayer->clearSelection();
    clearSelectedFeature();
    emit hideWindow();
  });
}

void EditWithBranchVersioning::connectSgdbSignals()
{
  m_serviceGeodatabase = new ServiceGeodatabase(QUrl("https://sampleserver7.arcgisonline.com/server/rest/services/DamageAssessment/FeatureServer"), m_cred, this);
  m_busy = true;
  emit busyChanged();

  connect(m_serviceGeodatabase, &ServiceGeodatabase::doneLoading, this, &EditWithBranchVersioning::onSgdbDoneLoadingCompleted_);

  m_serviceGeodatabase->load();
}

void EditWithBranchVersioning::onSwitchVersionCompleted_()
{
  m_busy = false;
  emit busyChanged();
  // set the current version name for the UI
  m_sgdbCurrentVersionName = m_serviceGeodatabase->versionName();
  // if the current version is the default, prevent editing
  m_sgdbVersionIsDefault = m_sgdbCurrentVersionName == m_serviceGeodatabase->defaultVersionName() ? true : false;
  clearSelectedFeature();
  emit sgdbVersionIsDefaultChanged();
  emit sgdbCurrentVersionChanged();
}

void EditWithBranchVersioning::onSgdbDoneLoadingCompleted_(const Error& error)
{
  if (!error.isEmpty())
    return;

  // created service feature table from the table contained in the service geodatabase
  m_featureTable = m_serviceGeodatabase->table(0);

  connect(m_featureTable, &ServiceFeatureTable::doneLoading, this, [this](const Error& error)
  {
    if (!error.isEmpty())
      return;

    // once the service feature table is loaded set the mapview extent to the full extent of the feature layer
    m_mapView->setViewpointAsync(m_featureLayer->fullExtent());

    m_busy = false;
    emit busyChanged();
  });

  // create a feature layer from the service feature table
  m_featureLayer = new FeatureLayer(m_featureTable, this);

  // add the feature layer to the map
  m_map->operationalLayers()->append(m_featureLayer);

  // update current version for UI
  m_sgdbCurrentVersionName = m_serviceGeodatabase->versionName();
  emit sgdbCurrentVersionChanged();
}

void EditWithBranchVersioning::onCreateVersionCompleted_(ServiceVersionInfo* serviceVersionInfo)
{
  // check for local edits before switching versions
  if (m_serviceGeodatabase->hasLocalEdits())
    return;

  // ensure the created version was succesful
  if (!serviceVersionInfo)
    return;

  m_busy = false;
  emit busyChanged();
  emit createVersionSuccess();

  // store create version name for easy switching between default and created version
  m_createdVersionName = serviceVersionInfo->name();

  // switch to the version you just created
  m_serviceGeodatabase->switchVersionAsync(m_createdVersionName).then(this, [this]()
  {
    onSwitchVersionCompleted_();
  }).onFailed(this, [this](const ErrorException& e)
  {
    onTaskFailed_(e);
  });
}

void EditWithBranchVersioning::applyEdits()
{
  m_busy = true;
  emit busyChanged();

  if (m_serviceGeodatabase->hasLocalEdits())
  {
    emit applyingEdits();
    m_serviceGeodatabase->applyEditsAsync().then(this, [this](const QList<FeatureTableEditResult*>& featureTableEditResults)
    {
      onApplyEditsCompleted_(featureTableEditResults);
    });
  }
  else
    switchVersion();
}

void EditWithBranchVersioning::switchVersion()
{
  // if the current version is our created version switch to the default
  const QString versionName = m_serviceGeodatabase->versionName() == m_serviceGeodatabase->defaultVersionName() ?
        m_createdVersionName :
        m_serviceGeodatabase->defaultVersionName();

  m_serviceGeodatabase->switchVersionAsync(versionName).then(this, [this]()
  {
    onSwitchVersionCompleted_();
  }).onFailed(this, [this](const ErrorException& e)
  {
    onTaskFailed_(e);
  });
}

void EditWithBranchVersioning::updateAttribute(const QString& attributeValue)
{
  m_busy = true;
  emit busyChanged();
  if (!m_selectedFeature)
    return;

  if (sgdbVerionIsDefault())
  {
    clearSelectedFeature();
    return;
  }

  // update the attirbute with the selection from the combo box
  m_selectedFeature->attributes()->replaceAttribute("TYPDAMAGE", attributeValue);
  m_selectedFeature->featureTable()->updateFeatureAsync(m_selectedFeature).then(this, [this]()
  {
    m_busy = false;
    emit busyChanged();
  });
}

void EditWithBranchVersioning::createVersion(const QString& versionName, const QString& versionAccess, const QString& description)
{
  m_busy = true;
  emit busyChanged();
  // create parameters for version from the inputed fields from the UI
  ServiceVersionParameters* params = new ServiceVersionParameters(this);
  params->setName(versionName);
  params->setDescription(description);

  if (versionAccess == "Private")
    params->setAccess(VersionAccess::Private);
  else if (versionAccess == "Protected")
    params->setAccess(VersionAccess::Protected);
  else
    params->setAccess(VersionAccess::Public);

  m_serviceGeodatabase->createVersionAsync(params).then(this, [this](ServiceVersionInfo* serviceVersionInfo)
  {
    onCreateVersionCompleted_(serviceVersionInfo);
  }).onFailed(this, [this](const ErrorException& e)
  {
    onTaskFailed_(e);
  });
}

void EditWithBranchVersioning::moveFeature(const Point& mapPoint)
{
  if (sgdbVerionIsDefault())
  {
    clearSelectedFeature();
    return;
  }
  const Polyline geom = geometry_cast<Polyline>(m_selectedFeature->geometry());
  m_selectedFeature->setGeometry(mapPoint);

  // update the selected feature with the new geometry
  m_selectedFeature->featureTable()->updateFeatureAsync(m_selectedFeature).then(this, [this]()
  {
    m_busy = false;
    emit busyChanged();
  });
  clearSelectedFeature();
}

void EditWithBranchVersioning::clearSelection()
{
  // helper function to clear feature layer selection
  if (m_featureLayer)
    m_featureLayer->clearSelection();
}

bool EditWithBranchVersioning::sgdbVerionIsDefault() const
{
  // helper function to check if the current version is the default version
  return m_serviceGeodatabase->versionName() == m_serviceGeodatabase->defaultVersionName() ? true : false;
}

void EditWithBranchVersioning::clearSelectedFeature()
{
  // helper function to clean up the selected feature when invalidated
  delete m_selectedFeature;
  m_selectedFeature = nullptr;
  clearSelection();
}

void EditWithBranchVersioning::onIdentifyLayerCompleted_(IdentifyLayerResult* identifyResult)
{
  if (!identifyResult)
  {
    clearSelectedFeature();
    return;
  }
  if (!identifyResult->geoElements().empty())
  {
    m_selectedFeature = static_cast<ArcGISFeature*>(identifyResult->geoElements().at(0));
    // select the item in the result
    m_featureLayer->selectFeature(m_selectedFeature);

    // Obtain placename attribute for the callout title
    const QString featureName = m_selectedFeature->attributes()->attributeValue("PLACENAME").toString();
    m_mapView->calloutData()->setTitle(QString("<br><font size=\"+2\">%1</font>").arg(featureName));
    m_mapView->calloutData()->setLocation(m_selectedFeature->geometry().extent().center());

    m_currentTypeDamage = m_selectedFeature->attributes()->attributeValue("TYPDAMAGE").toString();
    emit currentTypeDamageChanged();
    emit featureSelected();
  }
  m_busy = false;
  emit busyChanged();
}

void EditWithBranchVersioning::onApplyEditsCompleted_(const QList<FeatureTableEditResult*>& featureTableEditResults)
{
  // A convenience wrapper that deletes the contents of featureEditResults when we leave scope.
  FeatureTableEditResultsScopedCleanup featureTableEditResultsCleanup(featureTableEditResults);

  for (FeatureTableEditResult* featureTableEditResult : featureTableEditResults)
  {
    const auto results = featureTableEditResult->editResults();
    for (FeatureEditResult* featureEditResult : results)
    {
      if (!featureEditResult->error().isEmpty())
      {
        m_errorMessage = featureEditResult->error().message() + " - " + featureEditResult->error().additionalMessage();
        emit errorMessageChanged();
        m_busy = false;
        emit busyChanged();
        return;
      }
    }
  }
  emit applyingEditsCompleted();
  switchVersion();
}

void EditWithBranchVersioning::onTaskFailed_(const ErrorException& taskException)
{
  m_errorMessage = taskException.error().message() + " - " + taskException.error().additionalMessage();
  emit errorMessageChanged();
  m_busy = false;
  emit busyChanged();
}