Skip to main content

Geoprocessing settings

System administrators can manage many ArcGIS Pro user application settings.

The settings described below should be added under the Geoprocessing element in the Pro.settingsConfig file.

Learn more about geoprocessing options

ToolParameters

Use this setting to override the default value of geoprocessing tool parameters. The ToolParameters element should contain one or many Parameter elements, each with the following attributes:

  • toolName—The name of the tool

  • toolboxAlias—The alias of the toolbox containing the tool

  • name—The name of the parameter

  • islocked—Whether the parameter value will be locked on the tool dialog box

Note:

The ToolParameters settings do not have corresponding user interface settings.

The tool name, toolbox alias, and parameter names can be found on each tool's tool reference page, in the Parameters section, on the Python tab.

An example of this setting used to set the Calculate Field tool’s Expression Type (expression_type) parameter default value to Arcade is shown below.

<ToolParameters>
     <Parameter toolName="calculatefield" toolboxAlias="management" name="expression_type" isLocked="true">ARCADE</Parameter>
</ToolParameters>

Environments

Use this setting to override the default values of geoprocessing environments. This setting will be automatically used by all tools and models that honor the environment and run from the tool dialog box or in ModelBuilder.

The Environments element contains one or more Environment elements, each with a name attribute to specify the name of the environment setting. For example, use this setting to set and lock the Output Coordinate System environment (outputCoordinateSystem) to GCS WGS 1984 (WKID 4326) as shown below.

<Environments>
     <Environment name="outputCoordinateSystem" isLocked="true">4326</Environment>
</Environments>

AddHistoryItem

In the user interface, on the Geoprocessing tab on the Options dialog box, click Logging > Write geoprocessing operations to Geoprocessing History to access the corresponding setting.

Possible values are the following:

  • true (default)

  • false

An example of this setting is shown below.

<AddHistoryItem isLocked="true">false</AddHistoryItem>

AddOutputsToMap

In the user interface, on the Geoprocessing tab on the Options dialog box, click Set options for running geoprocessing tools and scripts > Add output datasets to an open map to access the corresponding setting.

Possible values are the following:

  • true (default)

  • false

An example of this setting is shown below.

<AddOutputsToMap isLocked="true">false</AddOutputsToMap>

BlockNonSystemPythonToolbox

Opening a custom Python toolbox (.pyt file) runs third-party code that may be harmful. Use this setting to block or allow the custom code to run with or without a warning. This setting does not have a corresponding user interface setting, so the isLocked property is ignored.

Possible values are the following:

  • Always—Always block access to custom Python toolboxes.

  • Ask—Display a warning dialog box before a Python toolbox opens. This is the default. Selecting Yes on the dialog box allows the toolbox code to run. Selecting No blocks access to the Python toolbox. This choice is available for each Python toolbox and is stored between sessions. If the toolbox file or code is updated, the warning dialog box displays again. The warning dialog box does not display for toolboxes you create.

  • No—Do not block access to custom Python toolboxes, and do not display a warning dialog box when Python toolboxes open.

An example of this setting is shown below.

<BlockNonSystemPythonToolbox isLocked="true">Always</BlockNonSystemPythonToolbox>

EnableUndo

In the user interface, on the Geoprocessing tab on the Options dialog box, click Set options for running geoprocessing tools and scripts > Enable Undo toggled on by default to access the corresponding setting.

Possible values are the following:

  • true

  • false (default)

An example of this setting is shown below.

<EnableUndo isLocked="true">true</EnableUndo>

MessageLevelCommandSyntax

In the user interface, on the Geoprocessing tab on the Options dialog box, click Additional information messages > Command syntax to access the corresponding setting.

Possible values are the following:

  • true

  • false (default)

An example of this setting is shown below.

<MessageLevelCommandSyntax isLocked="true">true</MessageLevelCommandSyntax>

MessageLevelDiagnostics

In the user interface, on the Geoprocessing tab on the Options dialog box, click Additional information messages > Diagnostics to access the corresponding setting.

Possible values are the following:

  • true

  • false (default)

An example of this setting is shown below.

<MessageLevelDiagnostics isLocked="true">true</MessageLevelDiagnostics>

MessageLevelProjectionTransformation

In the user interface, on the Geoprocessing tab on the Options dialog box, click Additional information messages > Transformations to access the corresponding setting.

Possible values are the following:

  • true

  • false (default)

An example of this setting is shown below.

<MessageLevelProjectionTransformation isLocked="true">true</MessageLevelProjectionTransformation>

RecordGPHistoryInMetadata

In the user interface, on the Geoprocessing tab on the Options dialog box, click Logging > Write geoprocessing operations to dataset metadata to access the corresponding setting.

Possible values are the following:

  • true (default)

  • false

An example of this setting is shown below.

<RecordGPHistoryInMetadata isLocked="true">false</RecordGPHistoryInMetadata>

RemoveOverwrittenLayers

In the user interface, on the Geoprocessing tab on the Options dialog box, click Set options for running geoprocessing tools and scripts > Remove layers that reference data overwritten by geoprocessing tools to access the corresponding setting.

Possible values are the following:

  • true (default)

  • false

An example of this setting is shown below.

<RemoveOverwrittenLayers isLocked="true">false</RemoveOverwrittenLayers>

GPServiceAPI

Use this setting to select the request approach when accessing geoprocessing services. This setting does not have a corresponding user interface setting, so the isLocked property is ignored.

Possible values are the following:

  • SOAP (default)

  • REST

An example of this setting is shown below:

<GPServiceAPI isLocked="true">REST</GPServiceAPI>

GPServiceAutoUpload

Use this setting to upload input as a server item automatically when using the REST requests to access a geoprocessing service. This setting does not have a corresponding user interface setting, so the isLocked property is ignored.

Possible values are the following:

  • true (default)

  • false

An example of this setting is shown below:

<GPServiceAutoUpload isLocked="true">true</GPServiceAutoUpload>