Download an offline map (on-demand)

Your ArcGIS Runtime app can use a web map while it has no internet connection, by first downloading an offline map from the web map. As soon as the offline map is downloaded, a mobile worker can disconnect their device and work with the map offline.

Mobile users can specify a geographic area of a web map to download as an offline map. Offline maps defined and created this way are known as on-demand offline maps. On-demand offline maps are useful for mobile users who don't necessarily know in advance where they will be working.

The main advantage of on-demand offline maps is that your app can specify parameters to ensure that only essential web map content is included in the offline map, such as:

• The area of interest
• The max and min scales
• Which layers to include
• Which features to include
• Which related records to include
• Whether to include attachments
• Editing characteristics

The steps to use on-demand offline maps are:

1. Create an offline map task
2. Examine the web map's offline capabilities
3. Create parameters to specify offline map content
4. Create a job to generate and download an offline map
5. Run the job

Create an offline map task

Create an OfflineMapTask from either an online ArcGISMap or from a PortalItem representing a web map.

1
2
3
4
5
//Create a task from a map
offlineMapTask = new OfflineMapTask(map);

//or from an online map's portal item
offlineMapTask = new OfflineMapTask(portalItem);

Examine the web map's offline capabilities

You should check which layers and tables in the web map can be taken offline by examining the web map's offline capabilities. This can help identify layers or tables that are missing in the offline map that is generated.

Get the OfflineMapCapabilities object by calling the getOfflineMapCapabilitiesAsync method on OfflineMapTask .

When true, the hasErrors property indicates that one or more layers or tables cannot be taken offline due to an error. You can check the layerCapabilities and tableCapabilities to determine which layer or table cannot be taken offline, and why.

Some layers do not support being taken offline (either they have not been offline-enabled, or the type of layer does not support being taken offline). An offline map can still include references to these online-only layers, allowing the layers to be accessed and displayed whenever a network connection is available. This capability is set by GenerateOfflineMapParameters OnlineOnlyServicesOption.

See Retain online services for more information.

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
final ListenableFuture<OfflineMapCapabilities> offlineMapCapabilitiesFuture =
    offlineMapTask.getOfflineMapCapabilitiesAsync(generateMapParameters);
offlineMapCapabilitiesFuture.addDoneListener(new Runnable() {
  @Override
  public void run() {
    try {
      OfflineMapCapabilities offlineMapCapabilities = offlineMapCapabilitiesFuture.get();
      if (offlineMapCapabilities.hasErrors()) {
        // Handle possible errors with layers
        for (java.util.Map.Entry<Layer, OfflineCapability> layerCapability :
            offlineMapCapabilities.getLayerCapabilities().entrySet()) {
          if (!layerCapability.getValue().isSupportsOffline()) {
            showMessage(layerCapability.getKey().getName() + " cannot be taken offline\n" +
                "Error: " + layerCapability.getValue().getError().getMessage());
          }
        }

        // Handle possible errors with tables
        for (java.util.Map.Entry<FeatureTable, OfflineCapability> tableCapability :
            offlineMapCapabilities.getTableCapabilities().entrySet()) {
          if (!tableCapability.getValue().isSupportsOffline()) {
            showMessage(tableCapability.getKey().getTableName() + " cannot be taken offline\n" +
                "Error : " + tableCapability.getValue().getError().getMessage());
          }
        }
      } else {
        // All layers and tables can be taken offline!
        showMessage("All layers are good to go!");
      }
    } catch (Exception e) {
      dealWithException(e);
    }
  }

});

Create parameters to specify offline map content

When you generate and download an offline map, it should contain content relevant to the mobile user for the geographic area in which they will be working. Take care not to include more content than needed, because this can impact the time it takes to generate and download the offline map. Different parameters are available to control the geographic coverage area and the content of the generated offline map.

1. Create the GenerateOfflineMapParameters by passing an area of interest to the createDefaultGenerateOfflineMapParametersAsync method on the OfflineMapTask .

2. Get and examine the returned parameters. These default parameters represent the advanced offline settings configured by the web map author.

3. To override default parameters see Advanced parameters. For example, you can automatically update and display online-only layers when a network connection is available (see Retain online services). You can also set the max and min scale, use a local basemap, or set a definition expression on features.

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
// generate the default offline map parameters
ListenableFuture<GenerateOfflineMapParameters> parametersListenableFuture =
  offlineMapTask.createDefaultGenerateOfflineMapParametersAsync(downloadArea);

// listen in for the completion
parametersListenableFuture.addDoneListener(()-> {
  // try to get the parameters
  try {
    GenerateOfflineMapParameters offlineMapParameters = parametersListenableFuture.get();

    // Update any of these parameters values, if needed
    offlineMapParameters.setMaxScale(5000);
    offlineMapParameters.setMinScale(10000);
    offlineMapParameters.setIncludeBasemap(true);
    offlineMapParameters.setDefinitionExpressionFilterEnabled(true);
    offlineMapParameters.setContinueOnErrors(true);
    offlineMapParameters.setReturnSchemaOnlyForEditableLayers(true);
    offlineMapParameters.setAttachmentSyncDirection(
      GenerateGeodatabaseParameters.AttachmentSyncDirection.UPLOAD);
    offlineMapParameters.setReturnLayerAttachmentOption(
      GenerateOfflineMapParameters.ReturnLayerAttachmentOption.EDITABLE_LAYERS);

    // Update the ItemInfo parameter if you want to change any of the information from the Portal...
    String title = offlineMapParameters.getItemInfo().getTitle() + " (Central)";
    offlineMapParameters.getItemInfo().setTitle(title);

  } catch (Exception e) {
    dealWithException(e);
  }
});

Create a job to generate and download an offline map

To generate and download the offline map, you must create a GenerateOfflineMapJob by providing the GenerateOfflineMapParameters to the generateOfflineMap method on OfflineMapTask . You must provide a directory on the device to store the offline map. If this download directory already exists, it must be empty. If the directory doesn't exist, it will be created by the job.

1
2
// create the job
offlineMapJob = offlineMapTask.generateOfflineMap(offlineMapParameters, downloadDir);

If you want to control the individual layer and table content, you also need to provide the GenerateOfflineMapParameterOverrides as well as the GenerateOfflineMapParameters to the generateOfflineMap result method on OfflineMapTask . For more details see Create offline map parameter overrides.

1
2
// create the job
offlineMapJob = offlineMapTask.generateOfflineMap(offlineMapParameters, downloadDir, overrides);

See the Tasks and jobs topic for more details on how to work with jobs in general.

Run the job

To generate the offline map and download it to your device, start the GenerateOfflineMapJob . When complete, the job returns a GenerateOfflineMapResult . If one or more tables or layers fails to be taken offline, the hasErrors property may be true (however a layer may be configured for "online-only", which is not an error). You can check the layerErrors and tableErrors dictionaries to identify problems.

If the ContinueOnErrors property of GenerateOfflineMapParameters is false, the job terminates if any layer or table fails to be taken offline.

If you want to display the map immediately, pass the GenerateOfflineMapResult.offlineMapGenerateOfflineMapResult.getOfflineMap result to the map view.

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
//start the job
offlineMapJob.start();

// listen for the job complete event
offlineMapJob.addJobDoneListener(() -> {
  // did the job succeed?
  if (offlineMapJob.getStatus() == Job.Status.SUCCEEDED) {
      GenerateOfflineMapResult offlineMapResult = offlineMapJob.getResult();

    // were there any errors?
    if (offlineMapResult.hasErrors()) {
      // get the layer errors
      Map<Layer, ArcGISRuntimeException> layerErrors = offlineMapResult.getLayerErrors();

      // get the table errors
      Map<FeatureTable, ArcGISRuntimeException> tableErrors = offlineMapResult.getTableErrors();

    } else {
      // get the offline map which can be used straight away
      ArcGISMap offlineMap = offlineMapResult.getOfflineMap();
    }

  } else {
    // code here to deal with failure
  }
});

Offline maps created by the on-demand workflow are stored in an unpacked mobile map package. When your app goes into the field, you need to open the map directly from this mobile map package downloadDirectory stored on your device.

Advanced parameters

You can set properties on GenerateOfflineMapParameters to control the offline map content. For example:

• The map's max and min scale
• Whether basemaps are included in the map
• Whether layers that reference online services are retained in the map
• Whether to allow synchronization of the map's geodatabases
• Whether to apply definition expression filters
• Whether to return all rows from a related table
• Whether to continue downloading the map if a single layer fails to be taken offline
• Including feature attachments
• Whether only the schema is provided for editable feature layers
• Update or replace the map's metadata

Scale range

A web map might include image tiled layers, which are composed of many tiles at different levels of detail (similar to a “zoom level”). The amount of space, generation time, and download time required to download tiled layers in a web map will increase with every level of detail. To increase performance, you should only download the levels of detail that are relevant for your app. You can control this by setting the minimum and maximum scale parameters minScale and maxScale.

If possible, choose a maximum scale that is not too “zoomed in” to prevent generating a large number of unnecessary tiles. Each service limits the number of tiles that can be taken offline. Make sure to set a scale range that avoids hitting this limit.

Include a map's basemap

A web map author can define whether offline maps should:

• Download the basemap defined by the web map. This is the default and ensures that a tile package is downloaded with the map.

• Use a tile package that is already on the device. The tile package must be downloaded or copied onto the device separately and can be referenced with an absolute file path or a path relative to the map. Make sure the tile package covers the areas required by your map area. The benefits of this option are that the map file will be smaller, the download time may be faster, and you can use the tile package in many different maps and apps.

  To use the tile package on your device, you must set the GenerateOfflineMapParameters referenceBasemapDirectory to the directory that contains the tile package. You should confirm that the tile package file, referenceBasemapFilename, exists on the device before running the GenerateOfflineMapJob . This job will add the tile package, as a basemap, to the offline map.

• Avoid using the basemap. Developers can choose to override this configured behavior when they download an offline map from a web map. To do this, set the GenerateOfflineMapParameters isIncludeBasemap property to false. In this case the GenerateOfflineMapJob will not download any layers included as part of the map's Basemap . This task will not use the local tile package, even if you have specified one.

Retain online services

Live, online services are supported in offline maps. You can take a web map offline that has a mix of local on-device content as well as live, online service content (such as weather or traffic information). When network connectivity is available, users can use data from online services. Otherwise, only the local (offline) content is available.

A value of Include for GenerateOfflineMapParameters OnlineOnlyServicesOption means that any data that can't be taken offline will be accessed via the URL in the offline map. Your offline map retains all of the information from the original web map, but requires a network connection and may require authentication.

Manage synchronization of the map's geodatabases

Typically, the updateModeon the GenerateOfflineMapParameters is set to syncWithFeatureServices. This mode allows you to synchronize any geodatabase changes with their online feature services.

If you want to avoid receiving any geodatabase updates, set the updateMode on the GenerateOfflineMapParameters to noUpdates. This disables data synchronization on the map’s geodatabases and prevents the corresponding feature services from creating synchronization replicas. The benefits of this option are that the burden on the feature server is reduced and you will not need to unregister geodatabases when they are no longer required.

Apply feature layer definition expression filters

When taking a map offline, the GenerateOfflineMapJob applies the feature layer's definition expression by default. Applying the definition expression may reduce the number of features taken offline for display and sync. If you do not want to apply the definition expression, set isDefinitionExpressionFilterEnabled to false.

Return all rows from a related table

If a map contains a layer or table with a relationship to another table, you can choose to download all rows or only related rows from the destination table. The default is to download only the related rows. If you want to return all rows, then you must set the value of DestinationTableRowFilter to be All.

If the table is a standalone table or the source of a relationship, all rows are returned.

Continue downloading the map if a single layer or table fails

By default, the GenerateOfflineMapJob continues to take layers and tables offline even if a layer or table fails. While this ensures that the map is taken offline, data may be missing. When the job completes, you should examine the job's result (discussed under Run the job) to identify if any layers have failed and determine whether or not to continue working with the map.

If you want the job to stop immediately when a layer or table fails, set the GenerateOfflineMapParameters ContinueOnErrors property to false. This ensures that if a map is successfully taken offline it contains all of its layers and tables.

Failure to take a layer or table offline may be due to an intermittent network connection, loss of the service, or an unsupported layer type.

Inclusion of feature attachments

Some feature services contain attachments (pictures, videos, and other documents) for individual features. Because these files can be large, you should consider your app's offline workflow to determine whether the attachments need to be taken offline, and whether they need to be synchronized with the service when the app is connected. These two behaviors are defined using the returnLayerAttachmentOption and attachmentSyncDirection properties on the GenerateOfflineMapParameters class.

• The return layer attachment property defines which layers should contain attachments in the offline map. The options are:

  • returnLayerAttachmentOption.NONE - None of the layers contain attachments.

  • returnLayerAttachmentOption.ALL_LAYERS - All layers have their attachments.

  • returnLayerAttachmentOption.READ_ONLY_LAYERS - Layers without editing enabled have attachments.

  • returnLayerAttachmentOption.EDITABLE_LAYERS - Layers with editing enabled have attachments.

• The attachment sync direction defines how the attachments are synchronized with the service. The options are:

  • attachmentSyncDirection.NONE - Attachments are not synchronized as part of the synchronization operation.

  • attachmentSyncDirection.UPLOAD - Attachments are uploaded from the client to the service, but any changes on the service are not downloaded to the client.

  • attachmentSyncDirection.BIDIRECTIONAL - Attachments are uploaded from client to the service, and changes on the service are pulled down to the client.

Inclusion of features from editable feature layers

Here are some workflows that describe how these two parameters affect each other:

• Workflow 1 — Download attachments for all layers in the map, allow the user to add or remove attachments from the layers, and then synchronize these changes between the service and the client when online. For example: multiple users collect data on the same area and they want to synchronize all the changes with the centralized services as well as sharing changes with other people in the field.

  • returnLayerAttachmentOption.ALL_LAYERS
  • attachmentSyncDirection.BIDIRECTIONAL

• Workflow 2 — Download attachments for all read-only layers and update these layers when online. For example: users are offline and viewing a layer of buildings with photos that show how the buildings look. If there are any new photos added to the service, these will be downloaded to the client during synchronization when online.

  • returnLayerAttachmentOption.READ_ONLY_LAYERS
  • attachmentSyncDirection.BIDIRECTIONAL

• Workflow 3 — Download attachments for editable layers only and upload them to the service when online. For example: users are offline and only need to view attachments for editable layers. If there are any read-only layers that provide context for the map, their attachments aren’t included to the local map. If users remove or add any new attachments, these changes can be synchronized to the service when online.

  • returnLayerAttachmentOption.EDITABLE_LAYERS
  • attachmentSyncDirection.BIDIRECTIONAL

• Workflow 4 — Do not download any attachments but allow any new attachments to be uploaded to the service when online. For example: users are offline and collecting new attachments in the field but do not need to view existing attachments.

  • returnLayerAttachmentOption.NONE
  • attachmentSyncDirection.UPLOAD

If users are collecting new information in the field where they do not need to access previously created features, you can create an offline map with empty editable feature layers. Do this by setting the GenerateOfflineMapParameters property setReturnSchemaOnlyForEditableLayers to True.

Update or replace map's metadata

Access an online map's metadata from the itemInfo property. It includes portal item properties such as the title, description, short description, and thumbnail. This information is populated from the portal item that contains the map. You can override any of these metadata properties before you take the map offline. For example, if you are creating offline maps of different areas of interest on the same map, you may want to change the map's title to indicate which area it contains.

You can also create a new OfflineMapItemInfo object and manually set all the details.

1
2
3
4
5
6
7
8
9
10
// Create new item info
OfflineMapItemInfo itemInfo = new OfflineMapItemInfo();

// Set metadata on the itemInfo
itemInfo.setTitle("Water network (Central)");
itemInfo.getTags().add("Water network");
itemInfo.getTags().add("Data validation");
itemInfo.setThumbnailData(thumbnail);

offlineMapParameters.setItemInfo(itemInfo);

Create offline map parameter overrides

You may want to control how individual layers or tables are taken offline to do things like:

• Reduce the amount of data (for example, tile data) for a given layer
• Alter the spatial extent of a given layer (for example, to give coverage beyond the study area)
• Filter features (for example, with a where clause) to only take those that are relevant to your fieldwork
• Take features with null geometry (for example, where the attributes are populated in the office but the geometry needs to be captured on-site)
• Omit individual layers
• Define which layers should reference online content

The GenerateOfflineMapParameterOverrides object provides control for these behaviors. It includes three dictionaries containing the generate geodatabase parameters (for feature layers), export vector tile parameters (for vector tile layers), and export tile cache parameters (for image tile layers), as well as two lists of layers and tables that will retain online access in the offline map (see Retain online services). Adjust any of these parameters and create the GenerateOfflineMapJob using the overrides object.

To control how individual layers and tables are taken offline, follow these steps:

1. Generate and modify the GenerateOfflineMapParameters as described in Create parameters to specify offline map content above.

2. Generate the parameter overrides object ( GenerateOfflineMapParameterOverrides ) using the generateOfflineMapParameterOverrides method on the OfflineMapTask . Provide the GenerateOfflineMapParameters generated from the previous step.

3. When the task completes, a pre-populated GenerateOfflineMapParameterOverrides object will be provided. This is a modifiable layer-by-layer representation of the supplied GenerateOfflineMapParameters and includes three dictonaries containing detailed parameters for each layer and table:

   • GenerateGeodatabaseParameters for feature layers.
   • ExportVectorTilesParameters for vector tile layers.
   • ExportTileCacheParameters for image tile layers.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// generate the offline map parameter overrides
ListenableFuture<GenerateOfflineMapParameterOverrides> overridesListener =
  offlineMapTask.createGenerateOfflineMapParameterOverridesAsync(offlineMapParameters);

// listen for the completion
overridesListener.addDoneListener(()-> {
  // try to get them
  try {
    GenerateOfflineMapParameterOverrides overrides = overridesListener.get();
    Map<OfflineMapParametersKey, ExportTileCacheParameters> tileCacheParams =
      overrides.getExportTileCacheParameters();
    Map<OfflineMapParametersKey, ExportVectorTilesParameters> vectorTileParams =
      overrides.getExportVectorTilesParameters();
    Map<OfflineMapParametersKey, GenerateGeodatabaseParameters> gdbParams =
      overrides.getGenerateGeodatabaseParameters();
  } catch (Exception e) {
    dealWithException(e);
  }
});

To override specific parameters for a layer, create a for the layer and use it to access the pre-populated parameters for that layer in the appropriate dictionary of the GenerateOfflineMapParameterOverrides . You can then modify individual properties for taking that layer offline.

1
2
3
4
5
6
7
8
//get the offline map parameter key for a feature layer
OfflineMapParametersKey parametersKey = new OfflineMapParametersKey(featureLayer);

//return the generate geodatabase parameters from the parameter overrides dictionaries
Map<OfflineMapParametersKey, GenerateGeodatabaseParameters> gdbParametersMap =
  overrides.getGenerateGeodatabaseParameters();
GenerateGeodatabaseParameters gdbParameters = gdbParametersMap.get(parametersKey);
gdbParameters.setReturnAttachments(false);

The GenerateOfflineMapParameterOverrides also includes two lists which can be modified to specify which Layer and ServiceFeatureTable objects should not have content downloaded but should instead access the original online data whenever a network connection is available (see Retain online services for more details).

After defining your overrides, you can create a GenerateOfflineMapJob by calling generateOfflineMap on the offline map task, supplying the parameters and the overrides.

Considerations

• Advanced symbols are supported only if they are defined in the original service. Any overrides with advanced symbols will result in empty symbols in an offline map.

• Area-of-interest geometries that cross the dateline are not currently supported.

• If more than one feature layer in a map refers to the same feature service endpoint, only one feature layer will be taken offline. The other feature layers will raise an error.