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 minimum value is 1 and the maximum value is 999.

Note:

The default value is 5. If isLocked="false", the default value is used until the user sets a different value.

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. When it is set to 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. This setting does not have a corresponding user interface setting.

Possible values are the following:

  • true
  • false (default)

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 path is <user_profile>\Documents\ArcGIS\Projects.

Note:

If isLocked="false" and a path is specified, the path appears as a suggestion in the input box until the user enters a path.

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

Note:

By default, the home folder is the folder in which the project file is stored. If different values are set for the home folder and the project location, the default geodatabase and toolbox are stored in the home folder location (unless there are custom geodatabase and toolbox settings), and the project file is stored in the project location.

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
Note:

The default option is to create a default geodatabase for each project. If isLocked="false" and a path is specified, the path appears as a suggestion in the input box until the user enters a path.

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)
Note:

The default option is to create a default toolbox (.atbx) for each project. If isLocked="false" and a path is specified, the path appears as a suggestion in the input box until the user enters a path.

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 path is <user_profile>\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.

Note:

If isLocked="false" and a path is specified, the path appears as a suggestion in the input box until the user enters a path.

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

Note:

If isLocked="false" and a path is specified, the path appears as a suggestion in the input box until the user enters a path.

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 a toolbox (.atbx). Other toolboxes are not allowed.

Note:

If isLocked="false" and a path is specified, the path appears as a suggestion in the input box until the user enters a path.

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. This setting does not have a corresponding user interface setting.

Learn more about project conflicts

Possible values are the following:

  • A positive integer. The default value is 300.

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. This setting does not have a corresponding user interface setting.

Learn more about project conflicts

Possible values are the following:

  • A positive integer. The default value is 60.

Note:

If the user clicks OK on the prompt to continue working, the Project Conflicts dialog box remains open and its 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. This setting does not have a corresponding user interface setting.

Possible values are the following:

  • A valid folder path. The default path is <user_profile>\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. This setting does not have a corresponding user interface setting.

Possible values are the following:

  • A positive integer or zero. The default value is 3.

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>