Tasks and jobs

Tasks are bound to online or offline data or services, and provide methods to perform asynchronous operations using those resources. By using tasks you can:

  • Download, collect, and update geographic information using GeodatabaseSyncTask
  • Download and display tiled basemaps using ExportTileCacheTask
  • Locate addresses and find addresses from map locations using LocatorTask
  • Calculate point-to-point or multi-stop routes and get driving directions using RouteTask
  • Perform complex GIS analysis by executing geoprocessing models using GeoprocessingTask

Tasks either return their results directly from asynchronous methods on the task, or make use of jobs to provide status updates and results.

Tasks

Some operations return their results directly from asynchronous methods on the task, for example LocatorTask.geocodeAsync and RouteTask.solveRouteAsync. For more complex or longer running operations, tasks make use of jobs instead.

To use tasks that return results directly:

  1. Create the task by initializing it to use the required data or service.
  2. Define the task inputs.
    • Some operations require only simple value inputs (for example a simple geocode operation may only require an address string as input).
    • Others require parameters to be defined (for example, to limit a geocode operation to a specific country).
  3. Call the async operation method, passing in the inputs you defined.
  4. Use the results from the operation as required, for example to display geocode results on a map.

The code below creates a LocatorTask using the default Esri global locator, and passes in an address to geocode. When the operation is complete, the result location is retrieved and displayed in a GraphicsOverlay.

// Call geocodeAsync passing in an address
final LocatorTask onlineLocator =
  new LocatorTask("http://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer");
final ListenableFuture<List<GeocodeResult>> geocodeFuture =
  onlineLocator.geocodeAsync("380 New York Street, Redlands, CA");
geocodeFuture.addDoneListener(() -> {
  try {
    // Get the results of the async operation
    List<GeocodeResult> geocodeResults = geocodeFuture.get();


    if (geocodeResults.size() > 0) {
      // Use the first result - for example display in an existing Graphics Overlay
      GeocodeResult topResult = geocodeResults.get(0);
      Graphic gecodedLocation = new Graphic(topResult.getDisplayLocation(), topResult.getAttributes(),
        new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.SQUARE, 0xFFFF0000, 20.0f));
      graphicsOverlay.getGraphics().add(gecodedLocation);
    }
  } catch (InterruptedException | ExecutionException e) {
    // deal with exception appropriately...
  }
});

Some Tasks are loadable, and will load themselves when you call an asynchronous method (like that shown above) that requires the task to be in a loaded state. Loadable objects are generally required to be loaded before their properties are filled out.

Define input parameters

Tasks offer numerous options that allow you to tailor the operation to your requirements. For example, when geocoding you can restrict your search to a specific area, country, category of place, and/or number of results. When an author publishes a service or packages a resource, they can choose default values for these options that suit the specific data or the most common use case for the service.

To find these default parameter values, tasks provide async methods that create parameters objects, initialized with these service-specific values. You can then make any changes to the parameter values, before using to execute an operation. Creating parameter objects in this way can be especially useful for operations with many options, such as solving a route.

The code below gets the default parameters for a RouteTask, and then ensures that results using these parameters will return both a route and directions, and also that the output spatial reference matches that of the MapView.

// use async method on RouteTask to get default parameters (task can be loaded or not loaded)
final ListenableFuture<RouteParameters> defaultParametersFuture = routeTask.createDefaultParametersAsync();
defaultParametersFuture.addDoneListener(() -> {
  try {
    // get the parameters from the future
    RouteParameters routeParameters = defaultParametersFuture.get();


    // update properties of route parameters
    routeParameters.setReturnDirections(true);
    routeParameters.setReturnRoutes(true);
    if (routeParameters.getOutputSpatialReference() != mapView.getSpatialReference()) {
      routeParameters.setOutputSpatialReference(mapView.getSpatialReference());
    }
    // Use the updated parameters to solve a route...
  } catch (InterruptedException | ExecutionException e) {
    // deal with exception appropriately...
  }
});

Alternatively, some parameters objects have constructors that you can use if you know the values of all the input parameters you want to use. This can be more efficient where parameter settings are simple.

For example, the code below creates geocoding parameters that restrict the country within which to geocode, and to limit the maximum returned results.

GeocodeParameters geocodeParams = new GeocodeParameters();
geocodeParams.setCountryCode("France");
geocodeParams.setMaxResults(5);

Work online or offline

Many tasks can work either online by using services, or offline by using local data and resources. For example, you can geocode an address by using the default Esri geocoding service, your own geocoding service, a locator file (.loc) or a mobile map package (.mmpk).

// create an online locator from a geocoding service - here we use esri's default global locator...
final LocatorTask onlineLocator =
  new LocatorTask("http://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer");


// create an offline locator from a local .loc file - coverage will depend on the packaged locator dataset...
final LocatorTask offlineLocator = new LocatorTask("local/path/to/file/.loc");


// mobile map packages can also contain locators - use this to get a reference to an offline locator...
final MobileMapPackage mmpk = new MobileMapPackage("local/path/to/file/.mmpk");
mmpk.addDoneLoadingListener(() -> {
  if (mmpk.getLoadStatus() == LoadStatus.LOADED) {
    LocatorTask mmpkLocator = mmpk.getLocatorTask();
    // use locator from a mobile map package according to the packaged locator coverage...
  }
});
mmpk.loadAsync();

Tasks and jobs

Some tasks expose operations that have multiple stages (like preparing and downloading a geodatabase), and can generate multiple progress messages (such as percentage complete). These types of tasks are always bound to ArcGIS Server or Local Server. An example is generateGeodatabaseAsync on GeodatabaseSyncTask.

Instead of returning results directly, these tasks make use of jobs to monitor status, return progress updates, and return their results. Each Job represents a specific operation of a task. Jobs are useful for longer-running operations, because they can also be paused, resumed, and cancelled. Your app can support a user action or host OS terminating a running job object, and then re-create and resume the job later.

To use operations like these:

  1. Create the task by initializing it to use the required data or service.
  2. Define the input parameters for the task.
  3. Call the async operation method to get a job, passing in the input parameters you defined.
  4. Start the job.
  5. Optionally, listen for changes to the job status and check the job messages, for example to update a UI and report progress to the user.
  6. Listen for the job completion and get the results from the operation. Check for errors in the job, and if successful, use the results.

// Create the export tile cache
ExportTileCacheTask exportTilesTask =
  new ExportTileCacheTask("http://sampleserver6.arcgisonline.com/arcgis/rest/services/World_Street_Map/MapServer");


// Define the parameters for the new tile cache - in this case, using the parameter object constructor
ExportTileCacheParameters exportTilesParameters = new ExportTileCacheParameters();
exportTilesParameters.getLevelIDs().addAll(Arrays.asList(0, 1, 2, 3, 4, 5, 6, 7, 8, 9));
exportTilesParameters.setAreaOfInterest(
  new Envelope(-1652366.0, 2939253.0, 2537014.0, 8897484.0, SpatialReferences.getWebMercator()));


// Create the export task, passing in parameters, and file path ending in ".tpk"
final ExportTileCacheJob exportJob =
  exportTilesTask.exportTileCacheAsync(exportTilesParameters, "local/path/to/store/file/.tpk");


// Listen for job status updates, and report the most recent message to the user...
exportJob.addJobChangedListener(() -> {
  List<Job.Message> messages = exportJob.getMessages();
  System.out.println("Messgae: " + messages.get(messages.size() - 1).getMessage());
});


// Listen for when the job is completed
exportJob.addJobDoneListener(() -> {
  // Check if there was an error
  if (exportJob.getError() != null) {
    // deal with exception appropriately...
  }


  if (exportJob.getStatus() == Job.Status.SUCCEEDED) {
    // Get the TileCache resulting from the successfull export job, and use it by adding a layer to a MapView
    final TileCache exportedTileCache = exportJob.getResult();
    ArcGISTiledLayer tiledLayer = new ArcGISTiledLayer(exportedTileCache);
    mapView.getMap().getOperationalLayers().add(tiledLayer);
  }
});


// Start the ExportTileCacheJob
exportJob.start();

Calling Job.getStatus retrieves the current point in the job's workflow. Started jobs periodically receive job changed events; this happens with decreasingly frequency as a job progresses; more than one JobMessage may have been added to the job for each call. The job done listener is called as soon as the job is complete, for both successes and failures. Completed jobs, whether they have succeeded or failed, cannot be restarted.

Report job progress

A job represents an asynchronously running operation that might take some time to finish. As described previously, you can monitor changes to job status for notification when a job has completed, failed, or been cancelled, but what about the time in-between? Users may become frustrated waiting for a long job to complete without getting feedback on it's progress. Fortunately, jobs provide a mechanism for reporting the current progress (percentage complete) for the running operation they represent.

As the job runs it . You can get the current progress of the job from the job's Progress property, an integer representing the percentage of the operation that has been completed. This allows your app to provide more specific information about the status of a running job using UI elements like progress bars, for example.

The following example displays the percentage complete for the job using a JavaFX Progress Bar and then gets the Tile Cache when complete.

exportJob.start();
// Add a listener to display the % of the job done
exportJob.addProgressChangedListener(() -> {
  // display progress using progress bar
  progressBar.setProgress((double) exportJob.getProgress() / 100.0);
});
// Add a listener to get the result when job is done
exportJob.addJobDoneListener(() -> {
  TileCache exportedTileCacheResult = exportJob.getResult();
});

Pause, resume, or cancel job

Jobs are designed to effectively handle a user exiting an app while the job is running, and to handle the app being terminated by the host operating system. Jobs also deal with explicit pausing and cancellation of the operation.

Cancel a job

Sometimes the results of a job are no longer required. For example, a user could change their mind about the area of a tile cache they want to download and want to cancel the job and start over.

Calling Job.cancel on a job immediately changes its status to Job.Status.FAILED and adds additional information to the job error object. The job completion listener will be called. The error object indicates the error domain and code, which allows you to identify when cancellation has occurred.

The code below shows, for a running ExportTileCacheJob, adding a JobDoneListener. Within the listener the code checks for the appropriate error code and domain that indicates that the job has been cancelled. At this point, the code checks in case the tile cache file was already created, and if so, deletes it.

// For a job that is running, listen for when the job is completed
runningJob.addJobDoneListener(() -> {
  // Check if there was an error
  ArcGISRuntimeException jobError = runningJob.getError();
  if (jobError != null) {


    // Failure status can indicate cancellation, or other types of failure
    if (runningJob.getStatus() == Job.Status.FAILED) {


      // Check the error information to confirm if this was a user cancellation
      if ((jobError.getErrorCode() == 18) &&
        (jobError.getErrorDomain() == ArcGISRuntimeException.ErrorDomain.ARCGIS_RUNTIME)) {


        // UI can be updated to indicate cancellation
        System.out.println("Export has been cancelled");


        // Could check if tile cache was downloaded before the task was cancelled, and clean up the file...
        File tileCacheFile = new File("local/path/to/store/file/.tpk");
        if (tileCacheFile.exists()) {
          tileCacheFile.delete();
        }
      }
    }


    // ... Deal with other types of failures...
  }


  // ... Deal with a successful job
});

Cancelled jobs cannot be restarted, although you can start a new job by re-using the same parameters. Cancelling a job does not necessarily stop any server-side processes, because not all services support cancellation on the server side.

Pause and resume a job

Jobs can be long running operations, so there is no guarantee that they will be completed while the app is running. You can pause a job explicitly using Job.pause. For example when an app is backgrounded and does not have permissions for background operation. Pausing may also be useful if a user wishes to temporarily stop network access for any reason.

Job changed messages will not be received for a paused job. Pausing a job does not stop any server-side processes from executing. While a job is paused, outstanding requests can complete, and therefore it's possible that a resuming a job will result in it having a different state to when it was paused.

You can serialize a job to JSON to persist it if your app is backgrounded, or the process is otherwise terminated. When you deserialize it again, the job will be in the Job.Status.PAUSED state regardless of its state when serialized, and should be restarted to resume listening for completion. The job changed listener can be a good place to update the job JSON for storage by your app.

The code below shows, for an existing running Job, serializing the job to JSON.

runningJob.addJobChangedListener(() -> {
  // Every time the job changes, update the stored JSON that represents the Job.
  storedJobJson = runningJob.toJson();
});

The Job can then be deserialized back from stored JSON, and restarted. Remember to set the job changed and done listeners again to be informed when the job changes, and when it is complete and the result can be retrieved.

if (jobJson != null && !jobJson.isEmpty()) {
  runningJob = Job.fromJson(jobJson);


  if (runningJob != null) {
    // Deserialized jobs have Job.Status.PAUSED, so restart the job.
    runningJob.start();


    // Resume listening for status changes and job completion.
    runningJob.addJobChangedListener(() -> {
      // ... deal with job changes
    });


    runningJob.addJobDoneListener(() -> {
      // ... deal with job done
    });
  }
}

Loss of network connection

Additionally, jobs using services are designed to handle situations where network connectivity is temporarily lost without needing to be immediately paused. A started job will ignore errors such as network errors for a period of up to 10 minutes. If errors continue for longer, the job will fail and the message will indicate the loss of network connection.

To deal with partially-connected workflows, you can serialize and pause a job when your app detects that network connectivity has been lost for a few minutes to avoid job failure purely due to this lack of network connectivity (as failed jobs cannot be restarted). The job can then be deserialized and resumed when connectivity is reinstated.