Skip to content
View inMAUIUWPWPFWinUIView on GitHubSample viewer app

Synchronize offline edits with a feature service.

Image of edit and sync features

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

  1. Create a GeodatabaseSyncTask from a URL to a feature service.
  2. Use createDefaultGenerateGeodatabaseParametersAsync() on the geodatabase sync task to create GenerateGeodatabaseParameters, passing in an Envelope extent as the parameter.
  3. Create a GenerateGeodatabaseJob from the GeodatabaseSyncTask using generateGeodatabaseAsync(...), passing in the parameters and a path to where the geodatabase should be downloaded locally.
  4. Start the job and get the result Geodatabase.
  5. 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.
  6. Create SyncGeodatabaseParameters and set the sync direction.
  7. Create a SyncGeodatabaseJob from GeodatabaseSyncTask using .syncGeodatabaseAsync(...) passing in the parameters and geodatabase as arguments.
  8. Start the sync job to synchronize the edits.

Relevant API

  • FeatureLayer
  • FeatureTable
  • GenerateGeodatabaseJob
  • GenerateGeodatabaseParameters
  • GeodatabaseSyncTask
  • SyncGeodatabaseJob
  • SyncGeodatabaseParameters
  • SyncLayerOption

Offline data

This sample uses a San Francisco offline basemap tile package.

About the data

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

Tags

feature service, geodatabase, offline, synchronize

Sample Code

EditAndSyncFeatures.xaml.csEditAndSyncFeatures.xaml.csEditAndSyncFeatures.xaml
Use dark colors for code blocksCopy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 // Copyright 2018 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.  using ArcGIS.Samples.Managers; using Esri.ArcGISRuntime; using Esri.ArcGISRuntime.ArcGISServices; using Esri.ArcGISRuntime.Data; using Esri.ArcGISRuntime.Geometry; using Esri.ArcGISRuntime.Mapping; using Esri.ArcGISRuntime.Symbology; using Esri.ArcGISRuntime.Tasks; using Esri.ArcGISRuntime.Tasks.Offline; using Esri.ArcGISRuntime.UI; using System; using System.Collections.Generic; using System.Drawing; using System.IO; using System.Linq; using System.Threading.Tasks; using System.Windows;  namespace ArcGIS.WPF.Samples.EditAndSyncFeatures {  [ArcGIS.Samples.Shared.Attributes.Sample(  name: "Edit and sync features",  category: "Data",  description: "Synchronize offline edits with a feature service.",  instructions: "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.",  tags: new[] { "feature service", "geodatabase", "offline", "synchronize" })]  [ArcGIS.Samples.Shared.Attributes.OfflineData("e4a398afe9a945f3b0f4dca1e4faccb5")]  public partial class EditAndSyncFeatures  {  // Enumeration to track which phase of the workflow the sample is in.  private enum EditState  {  NotReady, // Geodatabase has not yet been generated.  Editing, // A feature is in the process of being moved.  Ready // The geodatabase is ready for synchronization or further edits.  }   // URI for a feature service that supports geodatabase generation.  private Uri _featureServiceUri = new Uri("https://sampleserver6.arcgisonline.com/arcgis/rest/services/Sync/WildfireSync/FeatureServer");   // Path to the geodatabase file on disk.  private string _gdbPath;   // Task to be used for generating the geodatabase.  private GeodatabaseSyncTask _gdbSyncTask;   // Flag to indicate which stage of the edit process we're in.  private EditState _readyForEdits = EditState.NotReady;   // Hold a reference to the generated geodatabase.  private Geodatabase _resultGdb;   public EditAndSyncFeatures()  {  InitializeComponent();   // Create the UI, setup the control references and execute initialization.  _ = Initialize();  }   private async Task Initialize()  {  // Create a tile cache and load it with the SanFrancisco streets tpk.  TileCache tileCache = new TileCache(DataManager.GetDataFolder("e4a398afe9a945f3b0f4dca1e4faccb5", "SanFrancisco.tpkx"));   // Create the corresponding layer based on the tile cache.  ArcGISTiledLayer tileLayer = new ArcGISTiledLayer(tileCache);   // Create the basemap based on the tile cache.  Basemap sfBasemap = new Basemap(tileLayer);   // Create the map with the tile-based basemap.  Map myMap = new Map(sfBasemap);   // Assign the map to the MapView.  MyMapView.Map = myMap;   // Create a new symbol for the extent graphic.  SimpleLineSymbol lineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Solid, Color.Red, 2);   // Create a graphics overlay for the extent graphic and apply a renderer.  GraphicsOverlay extentOverlay = new GraphicsOverlay  {  Renderer = new SimpleRenderer(lineSymbol)  };   // Add graphics overlay to the map view.  MyMapView.GraphicsOverlays.Add(extentOverlay);   // Set up an event handler for when the viewpoint (extent) changes.  MyMapView.ViewpointChanged += MapViewExtentChanged;   try  {  // Create a task for generating a geodatabase (GeodatabaseSyncTask).  _gdbSyncTask = await GeodatabaseSyncTask.CreateAsync(_featureServiceUri);   // Add all graphics from the service to the map.  foreach (IdInfo layer in _gdbSyncTask.ServiceInfo.LayerInfos)  {  // Get the URL for this particular layer.  Uri onlineTableUri = new Uri(_featureServiceUri + "/" + layer.Id);   // Create the ServiceFeatureTable.  ServiceFeatureTable onlineTable = new ServiceFeatureTable(onlineTableUri);   // Wait for the table to load.  await onlineTable.LoadAsync();   // Skip tables that aren't for point features.{  if (onlineTable.GeometryType != GeometryType.Point)  {  continue;  }   // Add the layer to the map's operational layers if load succeeds.  if (onlineTable.LoadStatus == LoadStatus.Loaded)  {  myMap.OperationalLayers.Add(new FeatureLayer(onlineTable));  }  }   // Update the graphic - needed in case the user decides not to interact before pressing the button.  UpdateMapExtent();   // Enable the generate button.  MyGenerateButton.IsEnabled = true;  }  catch (Exception e)  {  MessageBox.Show(e.ToString(), "Error");  }  }   private async void GeoViewTapped(object sender, Esri.ArcGISRuntime.UI.Controls.GeoViewInputEventArgs e)  {  try  {  // Disregard if not ready for edits.  if (_readyForEdits == EditState.NotReady) { return; }   // If an edit is in process, finish it.  if (_readyForEdits == EditState.Editing)  {  // Hold a list of any selected features.  List<Feature> selectedFeatures = new List<Feature>();   // Get all selected features then clear selection.  foreach (FeatureLayer layer in MyMapView.Map.OperationalLayers)  {  // Get the selected features.  FeatureQueryResult layerFeatures = await layer.GetSelectedFeaturesAsync();   // FeatureQueryResult implements IEnumerable, so it can be treated as a collection of features.  selectedFeatures.AddRange(layerFeatures);   // Clear the selection.  layer.ClearSelection();  }   // Update all selected features' geometry.  foreach (Feature feature in selectedFeatures)  {  // Get a reference to the correct feature table for the feature.  GeodatabaseFeatureTable table = (GeodatabaseFeatureTable)feature.FeatureTable;   // Ensure the geometry type of the table is point.  if (table.GeometryType != GeometryType.Point)  {  continue;  }   // Set the new geometry.  feature.Geometry = e.Location;   try  {  // Update the feature in the table.  await table.UpdateFeatureAsync(feature);  }  catch (ArcGISException)  {  MessageBox.Show("Feature must be within extent of geodatabase.");  }  }   // Update the edit state.  _readyForEdits = EditState.Ready;   // Enable the sync button.  MySyncButton.IsEnabled = true;   // Update the help label.  MyHelpLabel.Text = "4. Click 'Sync Geodatabase' or edit more features";  }  // Otherwise, start an edit.  else  {  // Define a tolerance for use with identifying the feature.  double tolerance = 15 * MyMapView.UnitsPerPixel;   // Define the selection envelope.  Envelope selectionEnvelope = new Envelope(e.Location.X - tolerance, e.Location.Y - tolerance, e.Location.X + tolerance, e.Location.Y + tolerance);   // Define query parameters for feature selection.  QueryParameters query = new QueryParameters()  {  Geometry = selectionEnvelope  };   // Track whether any selections were made.  bool selectedFeature = false;   // Select the feature in all applicable tables.  foreach (FeatureLayer layer in MyMapView.Map.OperationalLayers)  {  FeatureQueryResult res = await layer.SelectFeaturesAsync(query, SelectionMode.New);  selectedFeature = selectedFeature || res.Any();  }   // Only update state if a feature was selected.  if (selectedFeature)  {  // Set the edit state.  _readyForEdits = EditState.Editing;   // Update the help label.  MyHelpLabel.Text = "3. Tap on the map to move the point";  }  }  }  catch (Exception ex)  {  MessageBox.Show(ex.ToString(), "Error");  }  }   private void UpdateMapExtent()  {  // Return if mapview is null.  if (MyMapView == null) { return; }   // Get the new viewpoint.  Viewpoint myViewPoint = MyMapView.GetCurrentViewpoint(ViewpointType.BoundingGeometry);   // Return if viewpoint is null.  if (myViewPoint == null) { return; }   // Get the updated extent for the new viewpoint.  Envelope extent = myViewPoint.TargetGeometry as Envelope;   // Return if extent is null.  if (extent == null) { return; }   // Create an envelope that is a bit smaller than the extent.  EnvelopeBuilder envelopeBldr = new EnvelopeBuilder(extent);  envelopeBldr.Expand(0.80);   // Get the (only) graphics overlay in the map view.  GraphicsOverlay extentOverlay = MyMapView.GraphicsOverlays.FirstOrDefault();   // Return if the extent overlay is null.  if (extentOverlay == null) { return; }   // Get the extent graphic.  Graphic extentGraphic = extentOverlay.Graphics.FirstOrDefault();   // Create the extent graphic and add it to the overlay if it doesn't exist.  if (extentGraphic == null)  {  extentGraphic = new Graphic(envelopeBldr.ToGeometry());  extentOverlay.Graphics.Add(extentGraphic);  }  else  {  // Otherwise, simply update the graphic's geometry.  extentGraphic.Geometry = envelopeBldr.ToGeometry();  }  }   private async Task StartGeodatabaseGeneration()  {  // Create a task for generating a geodatabase (GeodatabaseSyncTask).  _gdbSyncTask = await GeodatabaseSyncTask.CreateAsync(_featureServiceUri);   // Get the (only) graphic in the map view.  Graphic redPreviewBox = MyMapView.GraphicsOverlays.First().Graphics.First();   // Get the current extent of the red preview box.  Envelope extent = redPreviewBox.Geometry as Envelope;   // Get the default parameters for the generate geodatabase task.  GenerateGeodatabaseParameters generateParams = await _gdbSyncTask.CreateDefaultGenerateGeodatabaseParametersAsync(extent);   // Create a generate geodatabase job.  GenerateGeodatabaseJob generateGdbJob = _gdbSyncTask.GenerateGeodatabase(generateParams, _gdbPath);   // Handle the progress changed event with an inline (lambda) function to show the progress bar.  generateGdbJob.ProgressChanged += (sender, e) =>  {  // Update the progress bar.  UpdateProgressBar(generateGdbJob.Progress);  };   // Show the progress bar.  MyProgressBar.Visibility = Visibility.Visible;   // Start the job.  generateGdbJob.Start();   // Get the result of the job.  _resultGdb = await generateGdbJob.GetResultAsync();   // Hide the progress bar.  MyProgressBar.Visibility = Visibility.Collapsed;   // Do the rest of the work.  _ = HandleGenerationCompleted(generateGdbJob);  }   private async Task HandleGenerationCompleted(GenerateGeodatabaseJob job)  {  // If the job completed successfully, add the geodatabase to the map, replacing the layer from the service.  if (job.Status == JobStatus.Succeeded)  {  // Remove the existing layers.  MyMapView.Map.OperationalLayers.Clear();   // Loop through all feature tables in the geodatabase and add a new layer to the map.  foreach (GeodatabaseFeatureTable table in _resultGdb.GeodatabaseFeatureTables)  {  // Skip non-point tables.  await table.LoadAsync();  if (table.GeometryType != GeometryType.Point)  {  continue;  }   // Create a new feature layer for the table.  FeatureLayer layer = new FeatureLayer(table);   // Add the new layer to the map.  MyMapView.Map.OperationalLayers.Add(layer);  }   // Enable editing features.  _readyForEdits = EditState.Ready;   // Update help label.  MyHelpLabel.Text = "2. Tap a point feature to select";  }  else  {  // Create a message to show the user.  string message = "Generate geodatabase job failed";   // Show an error message (if there is one).  if (job.Error != null)  {  message += ": " + job.Error.Message;  }  else  {  // If no error, show messages from the job.  foreach (JobMessage m in job.Messages)  {  // Get the text from the JobMessage and add it to the output string.  message += "\n" + m.Message;  }  }   // Show the message.  MessageBox.Show(message);  }  }   private async Task SyncGeodatabase()  {  // Return if not ready.  if (_readyForEdits != EditState.Ready) { return; }   // Disable the sync button.  MySyncButton.IsEnabled = false;   // Create parameters for the sync task.  SyncGeodatabaseParameters parameters = new SyncGeodatabaseParameters()  {  GeodatabaseSyncDirection = SyncDirection.Bidirectional,  RollbackOnFailure = false  };   // Get the layer ID for each feature table in the geodatabase, then add to the sync job.  foreach (GeodatabaseFeatureTable table in _resultGdb.GeodatabaseFeatureTables)  {  // Get the ID for the layer.  long id = table.ServiceLayerId;   // Create the SyncLayerOption.  SyncLayerOption option = new SyncLayerOption(id);   // Add the option.  parameters.LayerOptions.Add(option);  }   // Create job.  SyncGeodatabaseJob job = _gdbSyncTask.SyncGeodatabase(parameters, _resultGdb);   // Subscribe to progress updates.  job.ProgressChanged += (o, e) =>  {  // Update the progress bar.  UpdateProgressBar(job.Progress);  };   // Show the progress bar.  MyProgressBar.Visibility = Visibility.Visible;   // Start the sync job.  job.Start();   // Wait for the result.  await job.GetResultAsync();   // Hide the progress bar.  MyProgressBar.Visibility = Visibility.Hidden;   // Do the remainder of the work.  HandleSyncCompleted(job);   // Re-enable the sync button.  MySyncButton.IsEnabled = true;  }   private void HandleSyncCompleted(SyncGeodatabaseJob job)  {  // Tell the user about job completion.  if (job.Status == JobStatus.Succeeded)  {  // Update the progress bar's value.  UpdateProgressBar(0);   MessageBox.Show("Sync task completed");  }   // See if the job failed.  if (job.Status == JobStatus.Failed)  {  // Create a message to show the user.  string message = "Sync geodatabase job failed";   // Show an error message (if there is one).  if (job.Error != null)  {  message += ": " + job.Error.Message;  }  else  {  // If no error, show messages from the job.  foreach (JobMessage m in job.Messages)  {  // Get the text from the JobMessage and add it to the output string.  message += "\n" + m.Message;  }  }   // Show the message.  MessageBox.Show(message);  }  }   private async void GenerateButton_Clicked(object sender, RoutedEventArgs e)  {  // Fix the selection graphic extent.  MyMapView.ViewpointChanged -= MapViewExtentChanged;   // Update the Geodatabase path for the new run.  try  {  _gdbPath = Path.Combine(Environment.ExpandEnvironmentVariables("%TEMP%"), Path.GetTempFileName() + ".geodatabase");   // Prevent duplicate clicks.  MyGenerateButton.IsEnabled = false;   // Call the cross-platform geodatabase generation method.  await StartGeodatabaseGeneration();  }  catch (Exception ex)  {  MessageBox.Show(ex.ToString());  }  }   private void MapViewExtentChanged(object sender, EventArgs e)  {  // Call the cross-platform map extent update method.  UpdateMapExtent();  }   private void UpdateProgressBar(int progress)  {  // Due to the nature of the threading implementation,  // the dispatcher needs to be used to interact with the UI.  // The dispatcher takes an Action, provided here as a lambda function.  Dispatcher.Invoke(() =>  {  // Update the progress bar value.  MyProgressBar.Value = progress;  });  }   private async void SyncButton_Click(object sender, RoutedEventArgs e)  {  try  {  await SyncGeodatabase();  }  catch (Exception ex)  {  MessageBox.Show(ex.ToString());  }  }  } }

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.