Apply scheduled updates to preplanned map area

View on GitHub

Sample viewer app

Apply scheduled updates to a downloaded preplanned map area.

Image of apply scheduled updates to preplanned map area

Use case

With scheduled updates, the author can update the features within the preplanned areas on the service once, and multiple end-users can request these updates to bring their local copies up to date with the most recent state. Importantly, any number of end-users can download the same set of cached updates which means that this workflow is extremely scalable for large operations where you need to minimize load on the server.

This workflow can be used by survey workers operating in remote areas where network connectivity is not available. The workers could download mobile map packages to their individual devices and perform their work normally. Once they regain internet connectivity, the mobile map packages can be updated to show any new features that have been added to the online service.

How to use the sample

Start the app. It will display an offline map, check for available updates, and show update availability and size. Select 'Apply Updates' to apply the updates to the local offline map and show the results.

How it works

Create an OfflineMapSyncTask with your offline map.
If desired, get OfflineMapUpdatesInfo from the task to check for update availability or update size.
Get a set of default OfflineMapSyncParameters for the task.
Set the parameters to download all available updates.
Use the parameters to create an OfflineMapSyncJob.
Start the job and get the results once it completes successfully.
Check if the mobile map package needs to be reopened, and do so if necessary.
Finally, display your offline map to see the changes.

Relevant API

MobileMapPackage
OfflineMapSyncJob
OfflineMapSyncParameters
OfflineMapSyncResult
OfflineMapSyncTask
OfflineMapUpdatesInfo

Offline Data

Download the data from ArcGIS Online.
Extract the contents of the downloaded zip file to disk.
Open your command prompt and navigate to the folder where you extracted the contents of the data from step 1.
Push the data into the scoped storage of the sample app:

adb push canyonlands/. /Android/data/com.esri.arcgisruntime.sample.applyscheduledupdatestopreplannedmaparea/files

About the data

The data in this sample shows the roads and trails in the Canyonlands National Park, Utah. Data by U.S. National Parks Service. No claim to original U.S. Government works.

Additional information

Note: preplanned areas using the Scheduled Updates workflow are read-only. For preplanned areas that can be edited on the end-user device, see the Download preplanned map area sample. For more information about offline workflows, see Offline maps, scenes, and data in the ArcGIS Developers guide.

Sample Code

MainActivity.java
Use dark colors for code blocksCopy
/*
 *  Copyright 2019 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.
 */

package com.esri.arcgisruntime.sample.applyscheduledupdatestopreplannedmaparea;

import android.os.Bundle;
import android.util.Log;
import android.widget.Button;
import android.widget.TextView;
import android.widget.Toast;

import androidx.appcompat.app.AppCompatActivity;

import com.esri.arcgisruntime.concurrent.Job;
import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.MobileMapPackage;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.tasks.offlinemap.OfflineMapSyncJob;
import com.esri.arcgisruntime.tasks.offlinemap.OfflineMapSyncParameters;
import com.esri.arcgisruntime.tasks.offlinemap.OfflineMapSyncResult;
import com.esri.arcgisruntime.tasks.offlinemap.OfflineMapSyncTask;
import com.esri.arcgisruntime.tasks.offlinemap.OfflineMapUpdatesInfo;
import com.esri.arcgisruntime.tasks.offlinemap.OfflineUpdateAvailability;
import com.esri.arcgisruntime.tasks.offlinemap.PreplannedScheduledUpdatesOption;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.concurrent.ExecutionException;

public class MainActivity extends AppCompatActivity {

  private static final String TAG = MainActivity.class.getSimpleName();

  private MapView mMapView;
  private File mCopyOfMmpk;
  private TextView mUpdateAvailableTextView;
  private TextView mUpdateSizeTextView;
  private Button mApplyScheduledUpdatesButton;
  // objects that implement Loadable must be class fields to prevent being garbage collected before loading
  private MobileMapPackage mMobileMapPackage;
  private MobileMapPackage mUpdatedMobileMapPackage;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    // create a map view
    mMapView = findViewById(R.id.mapView);

    // get a reference to the UI views
    mUpdateAvailableTextView = findViewById(R.id.updateAvailableTextView);
    mUpdateSizeTextView = findViewById(R.id.updateSizeTextView);
    mApplyScheduledUpdatesButton = findViewById(R.id.applyScheduledUpdatesButton);

    // this is the original mmpk, not updated by the scheduled update
    File originalMmpk = new File(getExternalFilesDir(null).getPath());
    // copy of the mmpk file which will have the update applied to it
    mCopyOfMmpk = new File(getCacheDir().getPath());

    try {
      // copy the original mmpk into the cache, overwriting any copy of the mmpk already there
      copyDirectory(originalMmpk, mCopyOfMmpk);
    } catch (IOException e) {
      Log.e(TAG, "Error copying MMPK file: " + e.getMessage());
    }

    // load the offline map as a mobile map package
    mMobileMapPackage = new MobileMapPackage(mCopyOfMmpk.getPath());
    mMobileMapPackage.loadAsync();
    mMobileMapPackage.addDoneLoadingListener(() -> {
      if (mMobileMapPackage.getLoadStatus() == LoadStatus.LOADED && !mMobileMapPackage.getMaps().isEmpty()) {
        // add the map from the mobile map package to the map view
        ArcGISMap offlineMap = mMobileMapPackage.getMaps().get(0);
        mMapView.setMap(offlineMap);
        // create an offline map sync task with the preplanned area
        OfflineMapSyncTask offlineMapSyncTask = new OfflineMapSyncTask(offlineMap);
        // check for updates to the offline map
        ListenableFuture<OfflineMapUpdatesInfo> offlineMapUpdatesInfoFuture = offlineMapSyncTask.checkForUpdatesAsync();
        offlineMapUpdatesInfoFuture.addDoneListener(() -> {
          try {
            // get and check the results
            OfflineMapUpdatesInfo offlineMapUpdatesInfo = offlineMapUpdatesInfoFuture.get();
            // update the UI with update info
            setUiUpdateInfo(offlineMapUpdatesInfo);
            // if there are available updates
            if (offlineMapUpdatesInfo.getDownloadAvailability() == OfflineUpdateAvailability.AVAILABLE) {
              mUpdateAvailableTextView
                  .setText(getString(R.string.update_status, OfflineUpdateAvailability.AVAILABLE.name()));
              // check and show update size
              mUpdateSizeTextView
                  .setText(getString(R.string.update_size, offlineMapUpdatesInfo.getScheduledUpdatesDownloadSize()));
              // enable the 'Apply Scheduled Updates' button
              mApplyScheduledUpdatesButton.setEnabled(true);
              // when the button is clicked, synchronize the mobile map package
              mApplyScheduledUpdatesButton.setOnClickListener(v -> {
                // create default parameters for the sync task
                ListenableFuture<OfflineMapSyncParameters> offlineMapSyncParametersFuture = offlineMapSyncTask
                    .createDefaultOfflineMapSyncParametersAsync();
                offlineMapSyncParametersFuture.addDoneListener(() -> {
                  try {
                    // get the offline sync parameters from the listenable future
                    OfflineMapSyncParameters offlineMapSyncParameters = offlineMapSyncParametersFuture.get();
                    // set the parameters to download all updates for the mobile map packages
                    offlineMapSyncParameters
                        .setPreplannedScheduledUpdatesOption(PreplannedScheduledUpdatesOption.DOWNLOAD_ALL_UPDATES);
                    // create a sync job using the parameters
                    OfflineMapSyncJob offlineMapSyncJob = offlineMapSyncTask.syncOfflineMap(offlineMapSyncParameters);
                    // start the job and get the results
                    offlineMapSyncJob.start();
                    offlineMapSyncJob.addJobDoneListener(() -> {
                      if (offlineMapSyncJob.getStatus() == Job.Status.SUCCEEDED) {
                        OfflineMapSyncResult offlineMapSyncResult = offlineMapSyncJob.getResult();
                        // if mobile map package reopen is required
                        if (offlineMapSyncResult.isMobileMapPackageReopenRequired()) {
                          // release the mobile map package maps from the map view
                          mMapView.setMap(null);
                          // close the old mobile map package
                          mMobileMapPackage.close();
                          // create a new instance of the now updated mobile map package
                          mUpdatedMobileMapPackage = new MobileMapPackage(mCopyOfMmpk.getPath());
                          mUpdatedMobileMapPackage.loadAsync();
                          // wait for the new instance of the mobile map package to load
                          mUpdatedMobileMapPackage.addDoneLoadingListener(() -> {
                            if (mUpdatedMobileMapPackage
                                .getLoadStatus() == LoadStatus.LOADED && !mUpdatedMobileMapPackage
                                .getMaps().isEmpty()) {
                              // add the map from the mobile map package to the map view
                              mMapView.setMap(mUpdatedMobileMapPackage.getMaps().get(0));
                            } else {
                              String error =
                                  "Failed to load mobile map package: " + mMobileMapPackage.getLoadError().getMessage();
                              Toast.makeText(this, error, Toast.LENGTH_LONG).show();
                              Log.e(TAG, error);
                            }
                          });
                        }
                        // check if the map is up to date against the server. This is not required, since in most cases,
                        // you'll be confident the update was applied because the offline map sync job completed successfully
                        // check for updates to the offline map
                        ListenableFuture<OfflineMapUpdatesInfo> offlineMapUpdatesInfoAfterUpdateFuture = offlineMapSyncTask
                            .checkForUpdatesAsync();
                        offlineMapUpdatesInfoAfterUpdateFuture.addDoneListener(() -> {
                          try {
                            // get the update results
                            OfflineMapUpdatesInfo offlineMapUpdatesInfoAfterUpdate = offlineMapUpdatesInfoAfterUpdateFuture.get();
                            // update the UI with update info
                            setUiUpdateInfo(offlineMapUpdatesInfoAfterUpdate);
                            Log.d(TAG, "Update: " + offlineMapUpdatesInfoAfterUpdate.getDownloadAvailability().name());
                          } catch (Exception e) {
                            String error = "Error checking for Scheduled Updates Availability: " + e.getMessage();
                            Toast.makeText(this, error, Toast.LENGTH_LONG).show();
                            Log.e(TAG, error);
                          }
                        });
                      } else {
                        String error = "Error syncing the offline map: " + offlineMapSyncJob.getError().getMessage();
                        Toast.makeText(this, error, Toast.LENGTH_LONG).show();
                        Log.e(TAG, error);
                      }
                      // disable the 'Apply Scheduled Updates' button
                      mApplyScheduledUpdatesButton.setEnabled(false);
                    });
                  } catch (InterruptedException | ExecutionException ex) {
                    String error = "Error creating DefaultOfflineMapSyncParameters" + ex.getMessage();
                    Toast.makeText(this, error, Toast.LENGTH_LONG).show();
                    Log.e(TAG, error);
                  }
                });
              });
            } else {
              mUpdateAvailableTextView
                  .setText(getString(R.string.update_status, offlineMapUpdatesInfo.getDownloadAvailability()));
            }
          } catch (Exception e) {
            String error = "Error checking for Scheduled Updates Availability: " + e.getMessage();
            Toast.makeText(this, error, Toast.LENGTH_LONG).show();
            Log.e(TAG, error);
          }
        });
      } else {
        String error = "Failed to load the mobile map package: " + mMobileMapPackage.getLoadError().getMessage();
        Toast.makeText(this, error, Toast.LENGTH_LONG).show();
        Log.e(TAG, error);
      }
    });
  }

  /**
   * Update UI with update status.
   */
  private void setUiUpdateInfo(OfflineMapUpdatesInfo offlineMapUpdatesInfo) {
    // set the download availability status to the text view
    mUpdateAvailableTextView
        .setText(getString(R.string.update_status, offlineMapUpdatesInfo.getDownloadAvailability().name()));
    if (offlineMapUpdatesInfo.getDownloadAvailability() != OfflineUpdateAvailability.NONE) {
      // server still reports that updates are available
      mUpdateSizeTextView
          .setText(getString(R.string.update_size, offlineMapUpdatesInfo.getScheduledUpdatesDownloadSize()));
      mApplyScheduledUpdatesButton.setEnabled(true);
    } else {
      // server reports that no updates are available
      mUpdateSizeTextView.setText(getString(R.string.update_size_na));
      mApplyScheduledUpdatesButton.setEnabled(false);
    }
  }

  @Override
  protected void onPause() {
    super.onPause();
    mMapView.pause();
  }

  @Override
  protected void onResume() {
    super.onResume();
    mMapView.resume();
  }

  @Override
  protected void onDestroy() {
    super.onDestroy();
    mMapView.dispose();
  }

  /**
   * Copy the given directory to the target directory.
   *
   * @param sourceLocation from which to copy
   * @param targetLocation to copy to
   * @throws IOException
   */
  private static void copyDirectory(File sourceLocation, File targetLocation) throws IOException {
    if (sourceLocation.isDirectory()) {
      if (!targetLocation.exists()) {
        targetLocation.mkdirs();
      }
      String[] children = sourceLocation.list();
      for (String child : children) {
        copyDirectory(new File(sourceLocation, child), new File(
            targetLocation, child));
      }
    } else {
      try (InputStream in = new FileInputStream(sourceLocation)) {
        try (OutputStream out = new FileOutputStream(targetLocation)) {
          byte[] buf = new byte[1024];
          int len;
          while ((len = in.read(buf)) > 0) {
            out.write(buf, 0, len);
          }
        }
      }
    }
  }
}