Web tool properties advanced settings

Change the heap size

The heap size setting controls the maximum file size that can be provided from the client . It can be set at two levels: server or service.

Changing the heap size at the service level provides better performance than changing the heap size from the server level. At ArcGIS Server 10.7 and later, the heap size can be set at the service level. The default size for each service is 64 MB. If you have an input file or feature class larger than the default size, change the service heap size as follows:

1. From a web browser, browse to https://machine.domain.com/webadaptor/admin/login.
2. Sign in to the ArcGIS Server Administrator Directory with an administrator account.
3. Click the Resources: Services link to see a new page that shows all the published services.
4. Click the service with the heap size you want to modify, and open the page with all the service properties.
5. On the service properties page, click the frameworkProperties link to see the page with editable service properties in JSON format.

   

6. If javaHeapSize is not listed in the service properties, add the {"javaHeapSize":"128"} property to the JSON. If javaHeapSize is included, increase the value to the appropriate amount.
7. Click Save Edits to save and finish editing.

To change the heap size at the server level, complete the steps below. By default, the server object component (SOC) maximum heap size is set to 64 MB. Increase the default of the property to an appropriate amount.

1. In a web browser, browse to https://machine.domain.com/webadaptor/admin/login.
2. Sign in to the ArcGIS Server Administrator Directory with an administrator account.
3. Click machines.
4. Click the <Your Server Name>.<domain>.com link.

   For example, a link may appear as server1.esri.com.

5. On the Server Machine Properties page, click the edit link.
6. Increase the value of SOC maximum heap size (in MB).
7. Click Save Edits to finish editing.

Set the upload size

The upload size setting controls the file size that can be uploaded by clients connecting to the service through a REST end point. These clients are typically web clients using the service through a custom web app. By default, the limit is set to 2 GB. Use this setting to provide an appropriate default to prevent large uploads for the service.

To set the upload size, complete the following steps:

1. In a web browser, browse to https://machine.domain.com/webadaptor/admin/login.
2. Sign in to the ArcGIS Server Administrator Directory with an administrator account.
3. Click services.
4. Click the name of the service.
5. Click the edit link at the bottom of the page under Supported Operations.
6. In the Service (in JSON format):* text box, find the maxUploadFileSize tag and set the maximum file size after the colon (:).

   A completed entry will look similar to "maxUploadFileSize": 100,.

7. Click Save Edits.

Set the upload type

Only certain files can be uploaded to a web tool. These files are restricted by their extension type, which is set at the service level.

To set the upload type, complete the following steps:

1. Inn a web browser, browse to https://machine.domain.com/webadaptor/admin/login.
2. Sign in to the ArcGIS Server Administrator Directory with an administrator account.
3. Click services.
4. Click the name of the service.
5. Click the edit link at the bottom of the page under Supported Operations.
6. In the Service (in JSON format):* text box, find the allowedUploadFileTypes tag and add the file extensions you want to allow inside the quotations after the colon (:).

   A completed entry will look similar to "allowedUploadFileTypes": ".kml,.gpx".

7. Click Save Edits.

Change the maximum domain count

The maxDomainCodeCount setting controls the number of domains that will be returned with a service response. The domain descriptions match to a code returned with the feature output response. This setting has a default of 1000. If the output features have more than 1,000 participating domains, no domain information will be returned. Returning domain information may increase the size of the response. If domains are not required, set this value to 0 or to a value less than the number of domains in a service.

To change the maximum domain count, complete the following steps:

1. In a web browser, browse to https://machine.domain.com/webadaptor/admin/login.
2. Sign in to the ArcGIS Server Administrator Directory with an administrator account.
3. Click services.
4. Click the name of the service.
5. Click the edit link at the bottom of the page under Supported Operations.
6. In the Service (in JSON format):* text box, find the maxDomainCodeCount tag and set the maximum limit after the colon (:).

   A completed entry will look similar to "maxDomainCodeCount": 25,.

7. Click Save Edits.

Local temp folder

The local temp folder is a directory where ArcGIS Server writes intermediate output when the server participates in a cluster with more than one machine, or the directories are referenced using a UNC path. This avoids the need to write intermediate data to a UNC path scratch geodatabase or scratch folder, which can improve service performance. On execution completion, results are copied from the local temp folder to the jobs directory, which can be a UNC path.

Reuse jobs directory for synchronous services

If your web tool is based on a synchronous geoprocessing service, you can reuse the jobs directory for better performance by applying "reusejobdir": "true". Normally, each time you execute a synchronous geoprocessing service, there will be a jobs folder created in the arcgisjobs folder on your server machine. Upon completion, ArcGIS Server will delete that jobs folder. By setting the reusejobdir property to true, the jobs folder will remain even after a job finishes execution. This can save time creating a scratch GDB and a scratch folder for the next execution, hence providing some performance benefits. Optionally, when you set this property back to "false", or remove this property, contact your administrator to delete any existing jobs folder for this service.

To set this property, contact your system administrator to edit the service property in the Administrator API.

{
    "serviceName": "sample",
    "type": "GPServer",
    "manyotherkeys": "manyothervalues",
    "properties": {
        "manyotherkeys": "manyothervalues",
        "reusejobdir": true,
        "executionType": "Synchronous"
    },
    "portalProperties": {},
    "extensions": []
}

Write messages to the ArcGIS Server log

If a web tool is published to ArcGIS Server 11.3 or later, you can include a copy of the messages from the web tool in the ArcGIS Server log. The ArcGIS Server log message level will match the web tool message level. For a web tool message, there are three levels—error, warning, and info—that match severe, warning, and info, respectively, in ArcGIS Server. Manually set web tool messages using script tool messages. Many geoprocessing tools also include preset messages. To ensure that messages are properly logged in ArcGIS Server, specify the server log settings accordingly.

To set the logGPMessages property, contact your system administrator to set the edit service property in the Administrator REST API.

{
    "serviceName": "sample",
    "type": "GPServer",
    "other_keys": "other_values",
    "properties": {
        "other_keys": "other_values",
        "logGPMessages": true,
        "executionType": "Asynchronous"
    },
    "portalProperties": {},
    "extensions": []
}

Return results in special cases

When an asynchronous geoprocessing service or a web tool based on an asynchronous geoprocessing service fails or is cancelled, no results are available. If such a web tool or geoprocessing service is published to ArcGIS Server 11.5 or later, you can still enable ArcGIS Server to return the results if you are accessing them through the results or result resources in the ArcGIS REST API. This feature is not available when using a synchronous geoprocessing service or a web tool based on a synchronous geoprocessing service. You cannot access the results in ArcGIS Pro for failed or cancelled jobs either.

To set the saveRESTResultsOnFailOrCancel property, contact your system administrator to set the edit service property in the Administrator REST API.

{
    "serviceName": "sample",
    "type": "GPServer",
    "other_keys": "other_values",
    "properties": {
        "other_keys": "other_values",
        "saveRESTResultsOnFailOrCancel": true,
        "executionType": "Asynchronous"
    },
    "portalProperties": {},
    "extensions": []
}

Block certain tools

When publishing web tools or geoprocessing services, it may be necessary to disable or block access to specific tasks. Starting at ArcGIS Server 11.5, add the blockedTools or allowedTools property to the service properties to block specific tools.

Use the blockedTools property to make specific tools unavailable. Use the allowedTools property to make only specific tools available; all other tools will be inaccessible. Use either property for convenience. To specify a task, use either the name or the display name of the task. When a task has a name that matches another task's display name, both tasks will be recognized and blocked or allowed together.

{
    "serviceName": "sample",
    "type": "GPServer",
    "other_keys": "other_values",
    "properties": {
        "other_keys": "other_values",
        "blockedTools": "extractData;bufferInputs",
        "executionType": "Synchronous"
    },
    "portalProperties": {},
    "extensions": []
}