Troubleshooting ArcGIS Pro Integration


Product(s): WaterGEMS, SewerGEMS
Version(s): 10.03.02.75 and higher (WaterGEMS), 10.03.03.44 and higher (SewerGEMS)
Area: Integration

Background

This article provides common troubleshooting steps when encountering issues integrating WaterGEMS or SewerGEMS with ArcGIS Pro. For example:

Attention! We have seen an issue where users who are running ArcGIS Pro 3.2.0 were unable to type certain characters when attempting to rename a scenario.  The characters A, B, b, C, c, D, nor O would be allowed to be used to rename a scenario.  We noticed that these are the ArcGIS Pro Keyboard Shortcut keys.  After updating ArcGIS Pro Patch 2 (making the version 3.2.2) the issue was fixed.

Note: if you are using ArcMap, please see: Troubleshooting ArcMap Integration

1) Check version compatibility

First, ensure that you are using a compatible version of ArcGIS Pro for the version of WaterGEMS or SewerGEMS that you are running. You can check your version by opening the Standalone version (for example the shortcut that just says "WaterGEMS") and going to File > Help > About. The version number will be shown in the lower-left corner. Your ArcGIS Pro version can be found in the ArcGIS Pro "about" window or in the Windows "Programs and Features" list.

For information on compatible versions, see:

For information on upgrading, see: Downloading OpenFlows Software

2) Re-run the integrator

Ensure that ArcMap, WaterGEMS and SewerGEMS are closed, then locate and run the "Integrate WaterGEMS with..." or "Integrate SewerGEMS with..." shortcut found in the WaterGEMS or SewerGEMS Start menu folder. It is recommended that you run this tool as Administrator by right clicking on the shortcut and choosing "Run as Administrator". (administrative permissions required)

Note: re-running the integrator is required after upgrading your ArcGIS version (assuming it is still a compatible version).

3) Delete the assembly cache

Another common cause of problems in ArcGIS Pro is the assembly cache. To locate the folder, open File Explorer and paste the following into the address bar and press enter

%UserProfile%\AppData\Local\ESRI\ArcGISPro\AssemblyCache

Within this folder you will find another folder with the following name:

Delete the folder and then re-open the "...for ArcGIS Pro" shortcut.

Note:  If the above folder does not exist, it means ArcGIS Pro failed to extract the files from the WaterGISPro.proConfigX file which is located in the following folder depending on your version (replace "WaterGEMS" with "SewerGEMS" if you are using SewerGEMS):

This should work when you see the WaterGEMS/SewerGEMS splash screen displayed when opening the shortcut. If you see the regular ArcGIS Pro splash screen, then WaterGEMS/SewerGEMS is not being loaded.

If after trying to run it and it still doesn't load, you can try the following:

  1. Browse to and open the cache folder (the names listed above)
  2. Browse to the installation folder for WaterGEMS or SewerGEMS, open the x64 subfolder, and open the file called WaterGIS Pro.proConfigX file in WinZip or 7zip.
  3. Browse into the root of the Installation folder
  4. Extract all files in that location into the cache folder manually and overwrite any existing files.
  5. Close the proConfigX file
  6. Try re-running the "...for ArcGIS Pro" shortcut.

4) Check the Add-in Security setting

Open ArcGIS Pro.  At the bottom-left, click on Settings.  Along the left side, click on Add-In Manager.

Go to the options tab.  Look at the setting below the Add Folder button.

If it is set to "Load only Esri provided Add-Ins (Most Secure)".  WaterGEMS for ArcGIS Pro will not load.  Make sure it is set to "Load all Add-Ins without restrictions (least secure)" then it should load.

Note: In at least one case the radio button was set on the "Least Secure" setting and the user had to select the "Most Secure" setting and then go back to the "Least Secure" setting to make it work.

5) Delete Intermediate Geodatabase

If your menus/toolbars are appearing but you're experiencing other problems while working on the model in ArcMap integrated mode, there are a number of possible reasons. One possibility is that the intermediate geodatabase (.GDB)has become corrupted. This file acts as a "middle man" between ArcGIS Pro and the OpenFlows product. If the model was working and has stopped working, in most cases the culprit is the geodatabase. Try deleting this file and reopening your project. Ensure that ArcMap and the OpenFlows product are closed first before deleting this file. See more here: How does the intermediate geodatabase (.MDB or .GDB) file function with ArcMap and ArcGIS Pro integration?

6) Repair the Installation

If the above does not help, try repairing the installation:

  1. Ensure ArcGIS Pro is closed
  2. Delete the WaterGISPro.proConfigX file on the user's system, which is located at installation folder .
  3. Open the Windows "Programs and Features" (within control panel), locate WaterGEMS / SewerGEMS, click and choose to uninstall but then select the "Repair" option.
  4. Allow the process to complete, then try running the integrator shortcut again, then open the "...for ArcGIS Pro" shortcut.

7) Clean Reinstallation

If it doesn't work, try a clean reinstallation of the program using these instructions. When you reinstall, the integration should happen automatically. *Note that you need full administrative rights to install the program correctly.

During the process of reinstalling, please be sure to temporarily disable antivirus/security software as they have been known to interfere and block the scripting action executed by the installation routine which performs the integration. Starting with CONNECT Edition Update 3 (10.03.XX.XX+) if the integration step fails due to the script being blocked, it will skip that part and you will not see new integrated-version icons on your desktop/start menu.

8) Disable Interfering Antivirus or other Security software

Try temporarily disabling any antivirus/antimalware/security software (or try the integration in Safe Mode) to make sure it is not interfering with the integration process, then repeat option 2. Check any antivirus/antimalware logs to see if any false positives occurs and quarantined files needed for integration.

Starting with CONNECT Edition Update 3 (10.03.XX.XX) if the integration step (during installation) fails due to the script being blocked, it will skip that part and you will not see new integrated-version icons on your desktop/start menu.

You may need to re-reun the Integrator after doing this.

9) Check for SofTrack interference

In at least one instance, the third party license controlling software called "SofTrack" has been known to interfere with ArcGIS Pro integration. First, try stopping SofTrack and test if the issue is resolved. If so, adjust the SofTrack whitelist or contact SofTrack for help.

10) Check ArcGIS Pro editing options

If you encounter an error when trying to load your hydraulic model, such as "Edit operation failed... editing in the application is not enabled", you may need to adjust your ArcGIS Pro editing options.

Still need help? Collect Configuration Files, Logs and/or memory dump for investigation

For general issues, retrieve the config file and integration log.

If the issue is related to a crash or other malfunction and ArcGIS Pro remains open, collect a memory dump file:

1. Open the icon for the OpenFlows product integrated with ArcGIS Pro.
2. Open the Windows Task Manager
3. Select the Processes tab
4. Right-click on the ArcGIS Pro executable file
5. Select Create Dump File (consider compressing into a ZIP file)

Provide these files to Technical Support for further help.

Or... consider using Standalone

WaterGEMS and SewerGEMS do not require ArcGIS Pro to operate. A "standalone" version is always available and you can work on an existing model even if it was created in ArcGIS Pro integrated mode. This is the shortcut called "WaterGEMS or "SewerGEMS" in the respective Start menu folder.

The Standalone version can work with GIS files as well. For example you can import Shapefiles in ModelBuilder to convert to model elements, and you can display a number of different types of background layers.

See Also

Troubleshooting ArcMap Integration

WaterGEMS for ArcGIS Pro and WaterGEMS for ArcMap FAQs

How does the intermediate geodatabase (.MDB or .GDB) file function with ArcMap and ArcGIS Pro integration?