Skip To Content ArcGIS for Developers Sign In Dashboard

GeoprocessingTask QML Type

GeoprocessingTask is used to run a geoprocessing task that is published as a web service. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Methods

Detailed Description

GeoprocessingTask is the main component when running geoprocessing tasks. The task can be published through ArcGIS Server using either synchronous execute or asynchronous submit execution type. When GeoprocessingParameters is created to pass into createJob, it is important to match its executionType to the value on the service.

  1. Create a GeoprocessingTask using the full URL to the target geoprocessing task endpoint.
  2. Create a GeoprocessingParameters providing corresponding Enums.GeoprocessingExecutionType.
  3. Create the necessary GeoprocessingParameters and add them to GeoprocessingParameters::inputs, where key is the name of the parameter and value is the created parameter.
  4. Set environmental variables on GeoprocessingParameters if needed, such as GeoprocessingParameters::returnZ or GeoprocessingParameters::outputSpatialReference.
  5. Create a GeoprocessingJob with createJob.
  6. Start listening for status and message changes using the GeoprocessingJob::jobStatusChanged signal.
  7. Run the targeted geoprocessing task using GeoprocessingJob::start which sets GeoprocessingResult when finished.
  8. Handle returned values accordingly. Access output parameters through GeoprocessingResult::outputs dictionary where key is the name of the output parameter and the value is the returned parameter. If used geoprocessing service is configured to use result map service, GeoprocessingResult::mapImageLayer might be created for you.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

TypeDefault Property
Credentialcredential (since Esri.ArcGISRuntime 100.1)
RequestConfigurationrequestConfiguration (since Esri.ArcGISRuntime 100.1)

See also Loadable, RemoteResource, and Cancelable.

Property Documentation

createDefaultParametersResult : GeoprocessingParameters

Results from createDefaultParameters(), giving access to the default GeoprocessingParameters (read-only).

Obtain this property after the createDefaultParametersStatusChanged signal emits, and the createDefaultParametersStatus is complete.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


createDefaultParametersStatus : Enums.TaskStatus

Returns the current status of the createDefaultParameters method (read-only).

Wait until the createDefaultParametersStatus is Enums.TaskStatusComplete before obtaining the createDefaultParametersResult.

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Enums.TaskStatus.


[default] credential : Credential

The credential to be used for a secured online geoprocessing service.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


error : Error

Returns the error object (read-only).

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable and Error.


geoprocessingTaskInfo : GeoprocessingTaskInfo

The GeoprocessingTaskInfo of this GeoprocessingTask.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.


loadStatus : Enums.LoadStatus

Returns the load status (read-only).

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable and Enums.LoadStatus.


[default] requestConfiguration : RequestConfiguration

The configuration parameters used for network requests sent by this task.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


url : url

The URL of this GeoprocessingTask.

This QML property was introduced in Esri.ArcGISRuntime 100.0.


Signal Documentation

createDefaultParametersStatusChanged()

Emitted when the createDefaultParametersStatus property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


credentialChanged()

Emitted when the credential property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


geoprocessingTaskInfoChanged()

The signal emitted when the geoprocessingTaskInfo property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


loadErrorChanged()

Emitted when the loadError property of this GeoprocessingTask changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property of this GeoprocessingTask changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.


requestConfigurationChanged()

Emitted when the requestConfiguration property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


urlChanged()

The signal emitted when the url property changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.0.


Method Documentation

void cancelLoad()

See Loadable

This QML method was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.


bool cancelTask(string taskId)

This QML method was introduced in Esri.ArcGISRuntime 100.1.

See also Cancelable.


string createDefaultParameters()

Creates default geoprocessing parameters from the service.

The createDefaultParametersStatusChanged signal will emit once the operation is complete, giving access to the createDefaultParametersResult.

This QML method was introduced in Esri.ArcGISRuntime 100.1.


GeoprocessingParameters createDefaultParametersResult()

The resulting parameters created by the async createDefaultParameters method.

This QML method was introduced in Esri.ArcGISRuntime 100.1.


Creates and returns a GeoprocessingJob populated with a set of task parameters.


void load()

See Loadable

This QML method was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.


void retryLoad()

See Loadable

This QML method was introduced in Esri.ArcGISRuntime 100.1.

See also Loadable.



Feedback on this topic?