GP JSON configuration - merkator-software/GaiaBuilder-manual GitHub Wiki
| Key | Type | Values | Description |
|---|---|---|---|
| action | string | "publishSD" | Required, must be publishSD |
| antialiasingMode | string | "FASTEST", "FAST", "NORMAL", "BEST", "NONE" | Optional, sets the geometry antialiasing mode |
| capabilities | string | "Uploads" or "" | Optional, configures the allowed operations, at present GP Services only support Uploads |
| choice_lists | json | Optional, sets the choice list for a Print service. example to limit to only PDF: `{"ExportWebMap.Format":["Portable Document Format (PDF)", "32-bit Portable Network Graphics (PNG32)"]}' | |
| constant_values | list | Optional, sets the default values for a Print service. | |
| content_status | string | "authoritative" / "deprecated" | Optional, label the content in portal as authoritative or deprecated |
| contentUser | string | Optional, the user account the published content must be assigned to | |
| copydata | bool | true / false | Optional, True allows data to be copied to ArcGIS Server when the data is not available using the server datastores. |
| credits | string | Optional, the Copyright credits of the mapservice | |
| description | string | Optional, description text of the mapservice | |
| executionType | string | "Asynchronous" / "Synchronous" | Optional, Synchronous for quick tasks and Asynchronous for longer tasks |
| extensions | array | extensionobjects | Required, but can be an empty array, enable and configure Mapservice extensions |
| jobdir | string | ||
| keepAliveInterval | integer | -1 - 3600 | Optional, sets the interval in seconds to check and repair instances. -1 disables the check |
| maxIdleTime | integer | 1 - 86400 | Optional, sets the time in seconds an idle Mapservice can be kept running |
| maxImageHeight | integer | 256 - 8192 | Optional, sets the maximum image height |
| maxImageWidth | integer | 256 - 8192 | Optional, sets the maximum image width |
| maximumRecords | integer | Optional, the maximum records returned by the GP Service | |
| maxInstancesPerNode | integer | 1 - 25 | Optional, sets the maximum number of instances of a Mapservice per server |
| maxRecordCount | integer | 1 - 100000 | Optional, sets the maximum number of records returned by a query operation |
| maxSampleSize | integer | 1 - 1000000 | Optional, sets the maximum sample size |
| maxStartupTime | integer | 1 - 2400 | Optional, sets the maximum startup time in seconds |
| maxUsageTime | integer | 1 - 2400 | Optional, sets the maximum time in seconds an instance can use to process a request before a timeout is returned |
| maxWaitTime | integer | 1 - 2400 | Optional, sets the maximum time in seconds an client can wait for a request to be processed before a timeout is returned |
| minInstancesPerNode | integer | 0 - 25 | Optional, sets the minimum number of instances of a Mapservice per server |
| name | string | Required, the service name | |
| outputdir | string | Optional, the output directory a geoprocessing service deployed to this ArcGIS Server should use, overrides the default from GaiaBuilder.ini | |
| portalFolder | string | Optional, the Portal folder the Mapservice is published to | |
| portalLogo | string | Optional, configures the item logo in portal with specified file. This file should be in the same directory | |
| printTemplateFolder | string | Required when publishing a Print Geoprocessing service, References the subdirectory where the print template files are (*.pagx) | |
| protected | bool | true / false | Optional, protect the items in portal from accidental removal |
| recycleInterval | integer | 1 - 48 | Optional, sets the recycle interval of the service in hours |
| recycleStartTime | string | "00:00" - "23:59" | Optional, sets the recycle start time, must be a formatted time string HH:mm |
| serverFolder | string | Optional, the ArcGIS Server folder the Mapservice is published to | |
| servers | array | ServerObject | Required, One or more server or environment configurations |
| serviceType | string | "GPServer" | Required, must be GPServer |
| stageScript | string | Required when publishing a Python Toolbox, The Python script to import and execute for running the job Tool and publishing the result | |
| summary | string | Required, the summary of the Mapservice | |
| tags | string | Required, comma separated list of tags for the service | |
| toolbox | string | Required, The fileame of the toolbox to import in the stage script | |
| uselimitations | string | Optional, use limitation description of the service |
Steps
The properties below can be included to force the configured step to be executed regardless the setting from the commandline
- configureService | bool | true / false | Optional, will override the configureService parameter from the commandline
- createSDFile | bool | true / false | Optional, will override the createSDFile parameter from the commandline
- deleteService | bool | true / false | Optional, will override the deleteService parameter from the commandline
- installService | bool | true / false | Optional, will override the installService parameter from the commandline
- startService | bool | true / false | Optional, will override the startService parameter from the commandline
- stopService | bool | true / false | Optional, will override the stopService parameter from the commandline
ServerObject
Any of the properties above can be re-used in the serverobject and this overwrites the global setting
Serverobject use the environment name as the Key Value
| Key | Type | Values | Description |
|---|---|---|---|
| sharing :json dictionary {string:string / list} | {"esriEveryone": "true / false","organization": "true / false","groups": ["Group1","Group2" ]} ,"managementgroups" :[ "Shared update group"] | Setting esriEveryone to "true" makes the content available to anonymous users. Setting organization to "true" makes the content available to logged in users. groups contains a list of group names, separated by comma, managementgroups contains a list of group names with the Shared Update capability set |