Display Name: SetupMapArea

Description: The Setup Map Area task creates packages for each service in the web map within the map area extent. The tool generates tile packages (.tpk or .vtpk) and SQLite Geodatabase format replica packages for exportTilesAllowed tiled services (i.e. basemap layer) and sync enabled feature services (i.e. operational layers). It adds an Area2Package relationship between the map area item and created package items. Existing package related to a map area will remain unchanged after running the task a second time as long as its corresponding layer remain existed in the web map and therefore a valid map layer. For example, if a web map is updated with a feature layer removed after a package is created for that layer using the GP tool, the package will be removed the next time executing it since its corresponding layer no longer exists in the web map thus becomes invalid.

Category:

Help URL: https://oehsportal.wvdhhr.org/arcgis/rest/directories/arcgisoutput/Utilities/OfflinePackaging_GPServer/Utilities_OfflinePackaging/SetupMapArea.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: mapAreaItemId

Data Type: GPString
Display Name Map Area Item ID
Description: Map area item ID, created by the Create Map Area tool.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: mapLayersToIgnore

Data Type: GPString
Display Name Map layers to ignore
Description: A JSON array of individual layers, specified with their service URLs, in the map to ignore. The task generates packages for all map layers by default.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: tileServices

Data Type: GPString
Display Name Tile Services
Description: An array of JSON objects that contains additional export tiles enabled tile services for which tile packages (.tpk or .vtpk) need to be created. Each tile service is specified with its URL and desired level of details.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: featureServices

Data Type: GPString
Display Name Feature Services
Description: An array of JSON objects that contains additional sync enabled feature services for which replicas need to be created. It can also be used to override layer definition query in the map. Each feature service is specified with its url, layers, layerQueries, returnAttachments, attachmentsSyncDirection, syncModel, and syncDirection properties.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: packages

Data Type: GPString
Display Name Packages
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:

Supported Operations:   Submit Job

Child Resources:   Metadata