Skip To Content ArcGIS for Developers Sign In Dashboard

Update an offline map

Offline maps can be created either using ArcGIS Pro or the ArcGIS Runtime SDKs. Their ability to accept updates depends on how the original map is authored (for example, scheduled updates are enabled) and how the mobile map package is created (with ArcGIS Runtime or ArcGIS Pro). The following update options are available:

  • Take a map offline - ArcGIS Pro - the geodatabases in this offline map are read-only and cannot be updated. In this case you need to recreate the mobile map package and redeploy it to all devices.
  • Take a map offline - on-demand - the geodatabases in this offline map can be updated by synchronization with feature services.
  • Take a map offline - preplanned - the geodatabases in this offline map can be updated by synchronization with feature services or by applying scheduled update files.

Synchronize or apply scheduled updates

The offline map sync task is used to perform both synchronization and applying scheduled updates to offline maps.

  1. Create the OfflineMapSyncTask from a map created by the on-demand or preplanned workflows.
  2. Retrieve the task's OfflineMapUpdateCapabilities to identify which update strategy the offline map supports (sync or scheduled updates).
  3. Determine whether there are any updates available by calling the task's checkForUpdatesAsync method.
    • If the map supportsScheduledUpdatesForFeatures then you can examine the downloadAvailability on the OfflineMapUpdatesInfo object. If there are downloads available then you can check to see how large the download is using the scheduledUpdatesDownloadSize. You can use this information to determine whether you want to download updates immediately - for example based on available disk space or network availability.
    • If the map supportsSyncWithFeatureServices you can examine the uploadAvailability to see if the offline map has any edits to upload. If so go to Step 4. It is not possible to determine whether there are online changes to download without performing a full feature synchronization.
  4. Obtain the default offline map sync parameters using the createDefaultOfflineMapSyncParametersAsyncmethod. Override any of these parameters, as required. For example, if resources are limited you may want to overwrite the sync direction to just Upload local edits to the online service.
  5. Create the offline map sync job, offlineMapSyncJob using the offline map sync parameters and run it.
  6. Upon completion check the OfflineMapSyncResult for any errors.
  7. If supportsScheduledUpdatesForFeatures then determine whether the mobile map file needs to be reopened by examining the mobileMapPackageReopenRequired property on the OfflineMapUpdatesInfo object. If so then close the offline map before reopening it.

  • Create an OfflineMapSyncTask.
  • Add code to respond when the job is complete, by calling OfflineMapSyncTask.addJobDoneListener. Optionally, also call OfflineMapSyncTask.addJobStatusChanged in order to monitor a job's progress during its execution.
  • Create an OfflineMapSyncParameters object with appropriate values.
  • Create an OfflineMapSyncJob by calling syncOfflineMap on the task, passing in the parameters object you defined.
  • Call OfflineMapSyncJob.start to start the sync job.
OfflineMapSyncTask offlineMapSyncTask = new OfflineMapSyncTask(map);

//create the offline map sync parameters
OfflineMapSyncParameters parameters = new OfflineMapSyncParameters();
parameters.setRollbackOnFailure(true);
parameters.setSyncDirection(SyncGeodatabaseParameters.SyncDirection.BIDIRECTIONAL);

//instantiate the sync job using the synchronization parameters
final OfflineMapSyncJob offlineMapSyncJob = offlineMapSyncTask.syncOfflineMap(parameters);

// Add listener to check and report on the current sync status
offlineMapSyncJob.addJobChangedListener(new Runnable() {
  @Override
  public void run() {

    // Deal with any errors found while syncing the map
    if (offlineMapSyncJob.getError() != null) {
      dealWithException(offlineMapSyncJob.getError());
    } else {
      // While job is in progress, review job messages or update progress in logs or user interface...
      updateUiWithJobProgress(offlineMapSyncJob);
    }
  }
});

// Add listener to deal with the completed job
offlineMapSyncJob.addJobDoneListener(new Runnable() {
  @Override
  public void run() {
    // Check the job state is complete, deal with any errors
    if ((offlineMapSyncJob.getStatus() != Job.Status.SUCCEEDED) || (offlineMapSyncJob.getError() != null)) {
      dealWithException(offlineMapSyncJob.getError());
    } else {
      // Get the OfflineMapSyncResult returned from the sync
      OfflineMapSyncResult result = offlineMapSyncJob.getResult();
      if (result != null) {
        // Check sync results, for example update the UI, deal with specific layer errors, etc
        dealWithSyncResults(result);
      }
    }
  }
});

//start the job
offlineMapSyncJob.start();

Next

When you have finished working with the mobile map package ensure that you release its maps, layers, and geodatabases before closing or terminating the application. See Finish using an offline map for more details.