Skip to main content

Project settings

System administrators can manage many ArcGIS Pro user application settings.

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

Note:

You can use Windows environment variables in paths. For example, %USERNAME% inserts the name of the current user, and %APPDATA% inserts the path to the AppData folder on the local computer.

CreateBackup

In the user interface, on the General tab on the Options dialog box, click Project Recovery > Create a backup when the project has unsaved changes to access the corresponding setting.

Learn more about backup options

Possible values are the following:

  • true (default)

  • false

An example of this setting is shown below.

<CreateBackup isLocked="true">true</CreateBackup>

BackupIntervalMinutes

In the user interface, on the General tab on the Options dialog box, click Project Recovery > Save a backup after this time interval has elapsed to access the corresponding setting. Use this setting with the CreateBackup setting.

Learn more about backup interval options

Possible values are the following:

  • A positive integer representing minutes. The default value is 5.

The minimum value is 1 and the maximum value is 999.

An example of this setting is shown below.

<BackupIntervalMinutes isLocked="true">3</BackupIntervalMinutes>

CreatePortalProjects

The CreatePortalProjects setting controls whether users can create portal projects on an ArcGIS Enterprise portal. This setting does not have a corresponding user interface setting.

Possible values are the following:

  • true (default)

  • false

Note:

If isLocked="true" and the value is false, new projects can only be created in local and network folders, and local projects cannot be saved as portal projects. However, users can open, update, and save existing portal projects.

An example of this setting is shown below.

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

Local project settings

Add the following settings under the LocalProject element in the Pro.settingsConfig file.

Learn more about options for creating projects on a local or network computer

CustomDefaultLocation

In the user interface, on the General tab on the Options dialog box, click Create projects > On a local or network computer > Project location to access the corresponding setting.

Possible values are the following:

  • A valid folder path. The default value is %USERPROFILE%\Documents\ArcGIS\Projects.

The default setting is to save new projects in the default location.

Note:

If isLocked="false" and a path is specified, the path appears as a suggestion in the New projects are saved in a custom location input box on the Options dialog box. However, the default setting is not changed.

An example of this setting is shown below.

<LocalProject>
  <CustomDefaultLocation isLocked="true">\\dataserver1\TeamDefaults\Projects</CustomDefaultLocation>
</LocalProject>

CreateProjectInNewFolder

In the user interface, the General tab on the Options dialog box, click Create projects > On a local or network computer > Project location > Create a folder for the project to access the corresponding setting.

This setting also appears in the user interface on the New Project dialog box.

Possible values are the following:

  • true (default)

  • false

An example of this setting is shown below.

<LocalProject>
  <CreateProjectInNewFolder isLocked="true">false</CreateProjectInNewFolder>
</LocalProject>

HomeFolder

In the user interface, on the Current Settings tab on the Options dialog box, click Home folder to access the corresponding setting.

Possible values are the following:

  • A valid folder path. The default value is the path to the folder that contains the project file.

An example of this setting is shown below.

<LocalProject>
  <HomeFolder isLocked="true">\\dataserver1\TeamDefaults\Output</HomeFolder>
</LocalProject>

DefaultGeodatabase

In the user interface, on the General tab on the Options dialog box, click Create projects > On a local or network computer > Default Geodatabase to access the corresponding setting.

Possible values are the following:

  • A valid folder path to a file, mobile, or enterprise geodatabase

The default setting is to create a new default geodatabase for each project.

Note:

If isLocked="false" and a path is specified, the path appears as a suggestion in the Same default geodatabase for all projects input box on the Options dialog box. However, the default setting is not changed.

An example of this setting is shown below.

<LocalProject>
  <DefaultGeodatabase isLocked="true">\\dataserver1\TeamDefaults\Data\TeamData.sde</DefaultGeodatabase>
</LocalProject>

DefaultToolbox

In the user interface, on the General tab on the Options dialog box, click Create projects > On a local or network computer > Default Toolbox to access the corresponding setting.

Possible values are the following:

  • A valid folder path to a toolbox (.atbx), Python toolbox (.pyt), or legacy toolbox (.tbx)

The default setting is to create a new ArcGIS toolbox (.atbx) for each project.

Note:

If isLocked="false" and a path is specified, the path appears as a suggestion in the Same default toolbox for all projects input box on the Options dialog box. However, the default setting is not changed.

An example of this setting is shown below.

<LocalProject>
  <DefaultToolbox isLocked="true">\\dataserver1\TeamDefaults\Tools\TeamTools.atbx</DefaultToolbox>
</LocalProject>

Portal project settings

Add the following settings under the PortalProject element in the Pro.settingsConfig file.

Learn more about options for creating projects on an ArcGIS Enterprise portal

LocalCacheLocation

In the user interface, on the General tab on the Options dialog box, click Create projects > On an ArcGIS Enterprise portal > Download location to access the corresponding setting.

Possible values are the following:

  • A valid folder path. The default value is %USERPROFILE%\Documents\ArcGIS\OnlineProjects.

An example of this setting is shown below.

<PortalProject>
  <LocalCacheLocation isLocked="true">C:\PortalProjectCache</LocalCacheLocation>
</PortalProject>

HomeFolder

In the user interface, on the General tab on the Options dialog box, click Create projects > On an ArcGIS Enterprise portal > Home folder to access the corresponding setting.

Possible values are the following:

  • A valid folder path. There is no default value.

An example of this setting is shown below.

<PortalProject>
  <HomeFolder isLocked="true">\\dataserver2\TeamHome</HomeFolder>
</PortalProject>

DefaultGeodatabase

In the user interface, on the General tab on the Options dialog box, click Create projects > On an ArcGIS Enterprise portal > Default Geodatabase to access the corresponding setting.

Possible values are the following:

  • A valid folder path to a file, mobile, or enterprise geodatabase. There is no default value.

An example of this setting is shown below.

<PortalProject>
  <DefaultGeodatabase isLocked="true">\\dataserver2\TeamHome\TeamData.sde</DefaultGeodatabase>
</PortalProject>

DefaultToolbox

In the user interface, on the General tab on the Options dialog box, click Create projects > On an ArcGIS Enterprise portal > Default Toolbox to access the corresponding setting.

Possible values are the following:

  • A valid folder path to an ArcGIS toolbox (.atbx). There is no default value.
Note:

Other toolbox types are not allowed.

An example of this setting is shown below.

<PortalProject>
  <DefaultToolbox isLocked="true">\\dataserver2\TeamHome\TeamTools.atbx</DefaultToolbox>
</PortalProject>

ConflictsDialogOpenTimerDuration

This setting specifies the number of seconds that the Project Conflicts dialog box can be idle before a prompt to continue working appears.

In the user interface, on the General tab on the Options dialog box, click Create projects > On an ArcGIS Enterprise portal > Save changes to a portal project > Save cancellation messge appears after (seconds) to access the corresponding setting.

Learn more about project conflicts

Possible values are the following:

  • A positive integer representing seconds. The default value is 300.

The minimum value is 10 and the maximum value is 3000.

An example of this setting is shown below.

<PortalProject>
  <ConflictsDialogOpenTimerDuration isLocked="true">300</ConflictsDialogOpenTimerDuration>
</PortalProject>

ConflictsDialogWarningMessageTimerDuration

This setting specifies the number of seconds for which a prompt to continue working displays after it appears on an idle Project Conflicts dialog box.

In the user interface, on the General tab on the Options dialog box, click Create projects > On an ArcGIS Enterprise portal > Save changes to a portal project > Save cancellation messge remains visible for (seconds) to access the corresponding setting.

Learn more about project conflicts

Possible values are the following:

  • A positive integer representing seconds. The default value is 60.

The minimum value is 10 and the maximum value is 3000.

Note:

If the user clicks OK on the prompt to continue working, the Project Conflicts dialog box remains open and the timer resets. Otherwise, the Project Conflicts dialog box closes and a message that the save was canceled appears.

An example of this setting is shown below.

<PortalProject>
  <ConflictsDialogWarningMessageTimerDuration isLocked="true">60</ConflictsDialogWarningMessageTimerDuration>
</PortalProject>

SavePointsLocation

This setting specifies the path to the automatically saved copies of a portal project that are stored by default on each user's computer. These copies exist in addition to the local copy in the user's download location. They can be used to overwrite a portal project if it needs to be restored to an earlier state.

In the user interface, on the General tab on the Options dialog box, click Create projects > On an ArcGIS Enterprise portal > Save changes to a portal project > Location of saved local copies to access the corresponding setting.

Possible values are the following:

  • A valid folder path. The default value is %USERPROFILE%\AppData\Local\ESRI\ArcGISPro\PublishedProjects.

An example of this setting is shown below.

<PortalProject>
  <SavePointsLocation isLocked="true">\\dataserver2\TeamHome\ProjectSavePoints\%USERNAME%</SavePointsLocation>
</PortalProject>

SaveProProjectLimit

This setting specifies the number of automatically saved copies of a portal project that are stored. These copies exist in addition to the local copy in each user's download location.

In the user interface, on the General tab on the Options dialog box, click Create projects > On an ArcGIS Enterprise portal > Save changes to a portal project > Number of local copies to save to access the corresponding setting.

Learn more about saved local copies

Possible values are the following:

  • Zero or a positive integer representing the number of automatically saved copies. The default value is 3.

The minimum value is 0 and the maximum value is 50.

Note:

The value applies to each unique location specified in the SavePointsLocation setting. For example, if the value is 3 and the default SavePointsLocation path is used, each user has three saved copies of the project in their PublishedProjects folder. Each copy is a recent state of the project as saved by that user.

If a shared location is used, three copies are saved in total. These copies are the three most recent states of the project as saved by any user. In this situation, a user who needs to overwrite a portal project can access any of the three copies, regardless of which user saved them. The user's own saves may or may not be among the available copies.

An example of this setting is shown below.

<PortalProject>
  <SaveProProjectLimit isLocked="true">3</SaveProProjectLimit>
</PortalProject>