Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGIS Runtime SDK for Qt

Apply scheduled updates to preplanned map area

Sample Viewer View Sample on GitHub

Apply scheduled updates to a downloaded 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 Scheduled Updates' to apply the updates to the local offline map and show the results.

How it works

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

Relevant API

  • MobileMapPackage
  • OfflineMapSyncJob
  • OfflineMapSyncParameters
  • OfflineMapSyncResult
  • OfflineMapSyncTask
  • OfflineMapUpdatesInfo

Offline data

Read more about how to set up the sample's offline data here.

Link Local Location
Canyonlands MMPK <userhome>/ArcGIS/Runtime/Data/mmpk/canyonlands.zip

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 Take a map offline - preplanned.

Tags

offline, preplanned, pre-planned, synchronize, update

Sample Code

import QtQuick 2.6
import QtQuick.Controls 2.4
import Esri.ArcGISRuntime 100.9
import Esri.ArcGISExtras 1.1

Rectangle {
    id: rootRectangle
    clip: true
    width: 800
    height: 600

    readonly property string tempDataPath: System.temporaryFolder.path + "/" + new Date().getTime()
    readonly property string origMmpkPath: System.userHomePath + "/ArcGIS/Runtime/Data/mmpk/canyonlands/canyonlands.zip"
    readonly property string destMmpkPath: tempDataPath + "/canyonlands.zip"
    property MobileMapPackage mmpk

    // For the purposes of demonstrating the sample,
    // create a temporary copy of the local offline map files,
    // so that updating does not overwrite them permanently
    Component.onCompleted: {
        // copy the zip
        fileFolder.makePath(tempDataPath)
        fileFolder.copyFile(origMmpkPath, destMmpkPath);

        // unzip the archive
        zipArchive.extractAll(tempDataPath + "/canyonlands")
    }

    function createMmpk() {
        mmpk = ArcGISRuntimeEnvironment.createObject("MobileMapPackage", {
                                                         path: System.resolvedPathUrl(tempDataPath + "/canyonlands")
                                                     });
        mmpk.loadStatusChanged.connect(()=> {
                                           if (mmpk.loadStatus === Enums.LoadStatusLoaded) {
                                               // check size of maps
                                               if (mmpk.maps.length === 0)
                                                   return;

                                               // get map from mmpk
                                               const map = mmpk.maps[0];

                                               // set on the mapview for display
                                               mapView.map = map;

                                               // hook up to offline map task
                                               offlineMapSyncTask.map = map;

                                               // check for updates
                                               offlineMapSyncTask.checkForUpdates();
                                           } else if (mmpk.loadStatus === Enums.LoadStatusFailedToLoad) {
                                               console.log("failed to load", mmpk.error.message, mmpk.error.additionalMessage);
                                           }
                                       });

        mmpk.load();
    }

    MapView {
        id: mapView
        anchors.fill: parent
    }

    OfflineMapSyncTask {
        id: offlineMapSyncTask

        property var syncJob

        onCheckForUpdatesStatusChanged: {
            if (checkForUpdatesStatus === Enums.TaskStatusInProgress) {
                console.log("Check for updates in progress...");
            } else if (checkForUpdatesStatus === Enums.TaskStatusErrored) {
                console.log("Check for updates error:", error.message, error.additionalMessage);
            } else if (checkForUpdatesStatus === Enums.TaskStatusCompleted) {
                console.log("Check for updates complete");

                // if updates are available, enable the download button & set detail text
                if (checkForUpdatesResult.downloadAvailability === Enums.OfflineUpdateAvailabilityAvailable) {
                    // enable the button
                    downloadUpdatesButton.enabled = true;

                    // set the text
                    availabilityText.text = "Updates Available";
                    availabilityDetailsText.text = "Updates size: %1 bytes".arg(offlineMapSyncTask.checkForUpdatesResult.scheduledUpdatesDownloadSize);
                } else {
                    // disable the button
                    downloadUpdatesButton.enabled = false;

                    // set the text
                    availabilityText.text = "No updates available";
                    availabilityDetailsText.text = "The preplanned map area is up to date"
                }

                busyIndicator.visible = false;
            }
        }

        onCreateDefaultOfflineMapSyncParametersStatusChanged: {
            if (createDefaultOfflineMapSyncParametersStatus === Enums.TaskStatusInProgress) {
                console.log("Create Parameters in progress...");
            } else if (createDefaultOfflineMapSyncParametersStatus === Enums.TaskStatusErrored) {
                console.log("Create Parameters error:", error.message, error.additionalMessage);
            } else if (createDefaultOfflineMapSyncParametersStatus === Enums.TaskStatusCompleted) {
                console.log("Create Parameters complete");

                // get the parameters result
                const params = createDefaultOfflineMapSyncParametersResult;

                // set the parameters to download all updates for the mobile map packages
                params.preplannedScheduledUpdatesOption = Enums.PreplannedScheduledUpdatesOptionDownloadAllUpdates;

                // create the job
                syncJob = offlineMapSyncTask.syncOfflineMap(createDefaultOfflineMapSyncParametersResult);

                // connect to the job signals
                syncJob.jobStatusChanged.connect(()=> {
                                                     if (syncJob.jobStatus === Enums.JobStatusSucceeded) {
                                                         const mapResult = syncJob.result;

                                                         if (mapResult.mobileMapPackageReopenRequired) {
                                                             // close and reopen the MMPK if required
                                                             mmpk.close();
                                                             createMmpk();
                                                         } else {
                                                             console.log("not required");
                                                         }
                                                         busyIndicator.visible = false;

                                                         // re-check if updates are available
                                                         offlineMapSyncTask.checkForUpdates();
                                                     } else if (syncJob.jobStatus === Enums.JobStatusFailed) {
                                                         console.log("sync job failed");
                                                         busyIndicator.visible = false;
                                                     }
                                                 });

                // start the job
                syncJob.start();
            }
        }
    }

    Rectangle {
        anchors.fill: controlColumn
        anchors.margins: -5
        color: "#404040"
    }

    Column {
        id: controlColumn
        anchors {
            left: parent.left
            top: parent.top
            margins: 10
        }
        spacing: 5

        Button {
            id: downloadUpdatesButton
            text: "Apply Scheduled Updates"
            enabled: false

            onClicked: {
                busyIndicator.visible = true;
                offlineMapSyncTask.createDefaultOfflineMapSyncParameters();
            }
        }

        Text {
            id: availabilityText
            color: "white"
        }

        Text {
            id: availabilityDetailsText
            color: "white"
        }
    }

    ZipArchive {
        id: zipArchive
        path: destMmpkPath

        onExtractCompleted: {
            // create the mmpk once the zip archive is copied
            createMmpk();
        }
    }

    FileFolder {
        id: fileFolder
    }

    BusyIndicator {
        id: busyIndicator
        anchors.centerIn: parent
    }
}