Edit and sync features

View on GitHub

Sample viewer app

Synchronize offline edits with a feature service.

screenshot

Use case

A survey worker who works in an area without an internet connection could take a geodatabase of survey features offline at their office, make edits and add new features to the offline geodatabase in the field, and sync the updates with the online feature service after returning to the office.

How to use the sample

Pan and zoom to position the red rectangle around the area you want to take offline. Click "Generate geodatabase" to take the area offline. When complete, the map will update to only show the offline area. To edit features, click to select a feature, and click again anywhere else on the map to move the selected feature to the clicked location. To sync the edits with the feature service, click the "Sync geodatabase" button.

How it works

Create a GeodatabaseSyncTask from a URL to a feature service.
Create GenerateGeodatabaseParameters, passing in an Envelope extent as the parameter.
Create a GenerateGeodatabaseJob from the GeodatabaseSyncTask using generateGeodatabase(...), passing in the parameters and a path to where the geodatabase should be downloaded locally.
Start the job and get the result Geodatabase.
Load the geodatabase and get its feature tables. Create feature layers from the feature tables and add them to the map's operational layers collection.
Create SyncGeodatabaseParameters and set the sync direction.
Create a SyncGeodatabaseJob from GeodatabaseSyncTask using syncGeodatabase(...) passing in the parameters and geodatabase as arguments.
Start the sync job to synchronize the edits.

Relevant API

FeatureLayer
FeatureTable
GenerateGeodatabaseJob
GenerateGeodatabaseParameters
GeodatabaseSyncTask
SyncGeodatabaseJob
SyncGeodatabaseParameters
SyncLayerOption

Offline Data

To set up the sample's offline data, see the Use offline data in the samples section of the Qt Samples repository overview.

Link	Local Location
San Francisco Streets TPKX	`<userhome>`/ArcGIS/Runtime/Data/tpkx/SanFrancisco.tpkx

About the data

The basemap uses an offline tile package of San Francisco. The online feature service has features with wildfire information.

Sample Code

EditAndSyncFeatures.cpp

EditAndSyncFeatures.h

EditAndSyncFeatures.qml

Use dark colors for code blocksCopy
// [WriteFile Name=EditAndSyncFeatures, Category=EditData]
// [Legal]
// Copyright 2016 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 "EditAndSyncFeatures.h"

// ArcGIS Maps SDK headers
#include "ArcGISFeature.h"
#include "ArcGISTiledLayer.h"
#include "Basemap.h"
#include "Envelope.h"
#include "Error.h"
#include "FeatureLayer.h"
#include "GenerateGeodatabaseJob.h"
#include "GenerateGeodatabaseParameters.h"
#include "GenerateLayerOption.h"
#include "Geodatabase.h"
#include "GeodatabaseFeatureTable.h"
#include "GeodatabaseSyncTask.h"
#include "GeometryEngine.h"
#include "IdentifyLayerResult.h"
#include "LayerListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapViewTypes.h"
#include "Point.h"
#include "ServiceFeatureTable.h"
#include "SpatialReference.h"
#include "SyncGeodatabaseJob.h"
#include "SyncLayerOption.h"
#include "TaskTypes.h"
#include "TileCache.h"
#include "Viewpoint.h"

// Qt headers
#include <QFuture>
#include <QStandardPaths>
#include <QUrl>
#include <QUuid>
#include <QtCore/qglobal.h>

using namespace Esri::ArcGISRuntime;

// helper method to get cross platform data path
namespace
{
  QString defaultDataPath()
  {
    QString dataPath;

  #ifdef Q_OS_IOS
    dataPath = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
  #else
    dataPath = QStandardPaths::writableLocation(QStandardPaths::HomeLocation);
  #endif

    return dataPath;
  }
} // namespace

EditAndSyncFeatures::EditAndSyncFeatures(QQuickItem* parent /* = nullptr */):
  QQuickItem(parent),
  m_dataPath(defaultDataPath() + "/ArcGIS/Runtime/Data/")
{
}

EditAndSyncFeatures::~EditAndSyncFeatures()
{
  // unregister geodatabase
  auto f = m_syncTask->unregisterGeodatabaseAsync(m_offlineGdb);
  Q_UNUSED(f)
}

void EditAndSyncFeatures::init()
{
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<EditAndSyncFeatures>("Esri.Samples", 1, 0, "EditAndSyncFeaturesSample");
}

void EditAndSyncFeatures::componentComplete()
{
  QQuickItem::componentComplete();

  // find QML MapView component
  m_mapView = findChild<MapQuickView*>("mapView");
  m_mapView->setWrapAroundMode(WrapAroundMode::Disabled);

  // Create a map using a local tile package
  TileCache* tileCache = new TileCache(m_dataPath + "tpkx/SanFrancisco.tpkx", this);
  ArcGISTiledLayer* tiledLayer = new ArcGISTiledLayer(tileCache, this);
  Basemap* basemap = new Basemap(tiledLayer, this);
  m_map = new Map(basemap, this);

  // add a feature service to the map
  ServiceFeatureTable* featureTable = new ServiceFeatureTable(QUrl(m_featureServiceUrl + QString::number(m_featureLayerId)), this);
  FeatureLayer* featureLayer = new FeatureLayer(featureTable, this);
  m_map->operationalLayers()->append(featureLayer);

  // set an initial viewpoint
  Envelope env(-122.50017, 37.74500, -122.43843, 37.81638, SpatialReference(4326));
  Viewpoint viewpoint(env);
  m_map->setInitialViewpoint(viewpoint);

  // Set map to map view
  m_mapView->setMap(m_map);

  // create the GeodatabaseSyncTask
  m_syncTask = new GeodatabaseSyncTask(QUrl(m_featureServiceUrl), this);

  connectSignals();
}

void EditAndSyncFeatures::connectSignals()
{
  // lambda expression for the mouse clicked signal on the mapview
  connect(m_mapView, &MapQuickView::mouseClicked, this, [this](QMouseEvent& mouseEvent)
  {
    if (m_isOffline)
    {
      if (!m_selectedFeature)
      {
        m_mapView->identifyLayerAsync(m_map->operationalLayers()->first(), mouseEvent.position(), 5, false, 1).then(this, [this](IdentifyLayerResult* identifyResult)
        {
          // once the identify is done
          if (!identifyResult)
            return;

          // clear any existing selection
          FeatureLayer* featureLayer = static_cast<FeatureLayer*>(m_map->operationalLayers()->first());
          featureLayer->clearSelection();
          m_selectedFeature = nullptr;

          if (identifyResult->geoElements().length() > 0)
          {
            GeoElement* geoElement = identifyResult->geoElements().at(0);
            m_selectedFeature = static_cast<ArcGISFeature*>(geoElement);
            featureLayer->selectFeature(m_selectedFeature);
            emit updateInstruction("Tap on map to move feature");
          }
        });
      }
      else
      {
        // connect to feature table signal
        FeatureLayer* featureLayer = static_cast<FeatureLayer*>(m_map->operationalLayers()->at(0));

        // get the point from the mouse point
        const Point mapPoint = m_mapView->screenToLocation(mouseEvent.position().x(), mouseEvent.position().y());
        m_selectedFeature->setGeometry(mapPoint);
        featureLayer->featureTable()->updateFeatureAsync(m_selectedFeature).then(this, [this, featureLayer]()
        {
          featureLayer->clearSelection();
          m_selectedFeature = nullptr;
          emit updateInstruction("Tap the sync button");
          emit showButton();
        });
      }
    }
  });
}

//! [EditAndSyncFeatures parameters generate]
GenerateGeodatabaseParameters EditAndSyncFeatures::getGenerateParameters(Envelope gdbExtent)
{
  // create the parameters
  GenerateGeodatabaseParameters params;
  params.setReturnAttachments(false);
  params.setOutSpatialReference(SpatialReference::webMercator());
  params.setExtent(gdbExtent);

  // set the layer options for 1 layer
  QList<GenerateLayerOption> layerOptions;
  GenerateLayerOption generateLayerOption(m_featureLayerId);
  layerOptions << generateLayerOption;
  params.setLayerOptions(layerOptions);

  return params;
}
//! [EditAndSyncFeatures parameters generate]

//! [EditAndSyncFeatures parameters sync]
SyncGeodatabaseParameters EditAndSyncFeatures::getSyncParameters()
{
  // create the parameters
  SyncGeodatabaseParameters params;
  params.setGeodatabaseSyncDirection(SyncDirection::Bidirectional);

  // set the layer options for 1 layer
  QList<SyncLayerOption> layerOptions;
  SyncLayerOption syncLayerOption(m_featureLayerId);
  layerOptions << syncLayerOption;
  params.setLayerOptions(layerOptions);

  return params;
}
//! [EditAndSyncFeatures parameters sync]

//! [EditAndSyncFeatures generate]
void EditAndSyncFeatures::generateGeodatabaseFromCorners(double xCorner1, double yCorner1, double xCorner2, double yCorner2)
{
  // create an envelope from the QML rectangle corners
  const Point corner1 = m_mapView->screenToLocation(xCorner1, yCorner1);
  const Point corner2 = m_mapView->screenToLocation(xCorner2, yCorner2);
  const Envelope extent(corner1, corner2);
  const Envelope geodatabaseExtent = geometry_cast<Envelope>(GeometryEngine::project(extent, SpatialReference::webMercator()));

  // get the updated parameters
  GenerateGeodatabaseParameters params = getGenerateParameters(geodatabaseExtent);

  // execute the task and obtain the job
  const QString outputGdb = m_temporaryDir.path() + "/Wildfire.geodatabase";
  GenerateGeodatabaseJob* generateJob = m_syncTask->generateGeodatabase(params, outputGdb);

  // connect to the job's status changed signal
  if (generateJob)
  {
    connect(generateJob, &GenerateGeodatabaseJob::statusChanged, this, [this, generateJob](JobStatus jobStatus)
    {
      // connect to the job's status changed signal to know once it is done
      switch (jobStatus) {
      case JobStatus::Failed:
        emit updateStatus("Generate failed");
        emit hideWindow(5000, false);
        break;
      case JobStatus::NotStarted:
        emit updateStatus("Job not started");
        break;
      case JobStatus::Paused:
        emit updateStatus("Job paused");
        break;
      case JobStatus::Started:
        emit updateStatus("In progress...");
        break;
      case JobStatus::Succeeded:
        m_isOffline = true;
        m_offlineGdb = generateJob->result();
        emit isOfflineChanged();
        emit updateStatus("Complete");
        emit hideWindow(1500, true);
        emit updateInstruction("Tap on a feature");
        addOfflineData();
        break;
      default:
        break;
      }
    });

    // start the generate job
    generateJob->start();
  }
  //! [EditAndSyncFeatures generate]
  else
  {
    emit updateStatus("Generate failed");
    emit hideWindow(5000, false);
  }
}

void EditAndSyncFeatures::addOfflineData()
{
  // remove the original online feature layers
  m_map->operationalLayers()->clear();

  // load the geodatabase
  connect(m_offlineGdb, &Geodatabase::doneLoading, this, [this](Error)
  {
    // create a feature layer from each feature table, and add to the map
    const auto tables = m_offlineGdb->geodatabaseFeatureTables();
    for (GeodatabaseFeatureTable* featureTable : tables)
    {
      FeatureLayer* featureLayer = new FeatureLayer(featureTable, this);
      m_map->operationalLayers()->append(featureLayer);
    }
  });
  m_offlineGdb->load();
}

bool EditAndSyncFeatures::isOffline() const
{
  return m_isOffline;
}

//! [EditAndSyncFeatures executeSync]
void EditAndSyncFeatures::executeSync()
{
  // get the updated parameters
  SyncGeodatabaseParameters params = getSyncParameters();

  // execute the task and obtain the job
  SyncGeodatabaseJob* syncJob = m_syncTask->syncGeodatabase(params, m_offlineGdb);

  // connect to the job's status changed signal
  if (syncJob)
  {
    connect(syncJob, &GenerateGeodatabaseJob::statusChanged, this, [this](JobStatus jobStatus)
    {
      // connect to the job's status changed signal to know once it is done
      switch (jobStatus) {
      case JobStatus::Failed:
        emit updateStatus("Sync failed");
        emit hideWindow(5000, false);
        break;
      case JobStatus::NotStarted:
        emit updateStatus("Job not started");
        break;
      case JobStatus::Paused:
        emit updateStatus("Job paused");
        break;
      case JobStatus::Started:
        emit updateStatus("In progress...");
        break;
      case JobStatus::Succeeded:
        m_isOffline = true;
        emit isOfflineChanged();
        emit updateStatus("Complete");
        emit hideWindow(1500, true);
        emit updateInstruction("Tap on a feature");
        break;
      default:
        break;
      }
    });

    // start the sync job
    syncJob->start();
  }
  //! [EditAndSyncFeatures executeSync]
  else
  {
    emit updateStatus("Sync failed");
    emit hideWindow(5000, false);
  }
}