Test performance for ArcGIS Pro using the Performance Assessment Tool (PAT)

Summary

Introduction

The ArcGIS Pro Performance Assessment Tool (PAT) is a set of tests that assesses a computer's ability to run key ArcGIS Pro workflows. It can be used it to investigate a perceived performance issue. It can also be used to do the following:

• View metrics for ArcGIS Pro startup times, as well as loading times for maps and bookmarks.
• View metrics for rendering layers in the map to assess GPU performance.
• Run custom scripts to assess performance using your maps and data.

Procedure

Execution Requirements

For the Performance Assessment tool to run successfully, the following are required:

• ArcGIS Pro, version 2.7 or newer
  • ProPAT executes on Windows 8.x, 10, 11, and Windows Server. Non-English locales should enable English (US) regional settings for correct execution.
• The “ProPAT_and_PerfTools_vN.zip”, available to download, contain the following:
  • The PAT test collection
  • The ArcGIS Pro PerfTools Add-In (required for test execution if not already installed on the machine)
• A physical machine or a non-application virtualized virtual machine. On shared environments such as Windows Server or a VDI solution, place the PAT installation folder in Installation steps 1 and 2 below into a non-shared location on the file system for each user account that are executing the tests. This is typically the “My Documents” folder for each user. Application-virtualized virtual machines (such as Citrix XenApp) are not supported with PAT. For questions on the configuration or if this applies, please work with a system administrator.
• An administrator-level account to access the machine and execute the tests.

Installation

1. Following download, extract the .zip file to the location of choice on the machine to be tested.
   1. The path length of the location where the ProPAT_and_PerfTools_vN folder are placed must not exceed 89 characters for tests to perform as expected.
   2. PAT can be extracted to a UNC path for testing. When run, the tool creates a mapped network drive using the first available letter starting from Z: and moving backwards. For example, if you already have Z: mapped on the machine, the tool will map to Y:, and so on. To remove the drive after testing, see the Cleanup and Uninstallation section.
   3. It is important to note that testing across a network can increase execution times. If the Benchmark Execution Times posted in the About the Tests section are not met, copy the ProPAT_and_PerfTools_vN folder to the local machine (C:) and re-run the tests. The difference in execution times can be attributed to network latency. For more information, see Application, project, and data location tips.
2. If the PerfTools Add-In is not already installed, or if a previous version of PerfTools/PAT has already installed and used:
   1. Open ..\ProPAT_and_PerfTools_vN\Setup PerfTools Build 280 for Pro 2.x and 3.x.
   2. Open the subfolder appropriate for the version of Pro being run (“forPro2.7.x-2.9.x”, “forPro3.0.x-3.2.x” or “forPro3.3.x+”).
   3. Double-click PerfTools.esriAddinX to install the PerfTools Add-In.
   4. A dialog appears to confirm the Add-In file installation. Select Install Add-In.
   5. Manually launch ArcGIS Pro to perform post-install initialization of PerfTools.
      1. Open ArcGIS Pro.
      2. Click Settings.
      3. Click Add-In Manager.
      4. Click the Options tab.
      5. Add the folder containing the PerfTools add-in.
   6. Close ArcGIS Pro.

About the Tests

PAT is a collection of test scripts and data that executes at three levels:

Running the Tests

• Notes:
  • During test execution, refrain from using the machine and manually closing any command windows. Upon successful completion, all windows will automatically close.
  • When running any of the .cmd files below for the first time, you may encounter a Windows SmartScreen alert. It is safe to proceed by clicking More Info and then the Run Anyway button.

1. Close all applications that are running on the machine (for example Outlook, Teams, etc.).
2. Double-click the appropriate RUNME file. For example:
   1. RUNME_Level1Tests.cmd runs the Level 1 tests
   2. RUNME_Level2Tests.cmd runs the Level 2 tests
   3. RUNME_Level3Tests.cmd runs the Level 3 tests
      • Level 3 tests require a Spatial Analyst license.
   4. RUNME_AllLevelTestsAndMakeCSV.cmd runs all Level 1, 2, and 3 tests and compiles the results in a CSV file. This is intended for unattended execution and compilation of test results.

Viewing Test Results

Following test completion, both summary and detailed logs will be placed in ..\ProPAT_and_PerfTools_vN\ProPAT\TestResults. A date/timestamped folder will be created for every test run, in the format “LevelN_MMM-DD-YYYY_HHMMSS__RANDOMID”. (The RANDOMID is assigned as a convenience to allow multiple machines to execute PAT simultaneously as a scheduled task and merge results folders later)

Within this folder, summary logs (named “SUMMARY_LevelN.log”) contain the total elapsed time in minutes for the test run. The Benchmark Execution Times above correspond to the SUMMARY Total Elapsed Time. Should you wish to view detailed logs for each of the individual tests, they are also available at the same location.

Contents of SUMMARY_AllLevels.csv

When running RUNME_AllLevelTestsAndMakeCSV.cmd, a CSV file is created in the results folder named SUMMARY_AllLevels.csv. This file contains the following information:

Seeing results that appear to be slow? We’ve compiled a comprehensive set of guidelines and next steps in the online document: Troubleshooting Performance Issues in ArcGIS Pro

Cleanup and Uninstallation

If you ran PAT from a UNC location and wish to disconnect the mapped network drive resulting from the tests:

1. In File Explorer, go to This PC and find the mapped drive under Network locations.
2. Right-click the mapped network drive > Disconnect.

Should you wish to remove the Performance Assessment Tool, please:

1. Delete the “ProPAT_and_PerfTools_vN” folder. This removes all tests and test results from your machine.
2. Optionally, remove the PerfTools Add-In from ArcGIS Pro:
   1. Close any open ArcGIS Pro sessions.
   2. Remove %USERPROFILE%\Documents\ArcGIS\AddIns\ArcGISPro\PerfTools
   3. Re-launch ArcGIS Pro.

If users experience issues or unexpected output while using the PAT, refer back to step 2e of Installation to ensure ArcGIS Pro is properly configured for the PerfTools add-in, even if it is installed.

Note:
While PAT may be used to investigate perceived performance issues with the help of Esri Technical Support, PAT itself is not supported by Technical Support; any questions or feedback regarding PAT should be forwarded to perfqatools@esri.com.