Troubleshooting ArcMap / ArcGIS Integration

Product(s): WaterGEMS, SewerGEMS, HAMMER
Version(s): CONNECT Edition, V8i
Area: Installation

Problem

The menus / toolbars for WaterGEMS, SewerGEMS, or HAMMER are not showing while in ArcMap, even though compatible versions are being used.

Or, various other problems are occurring when trying to work with a model 

Note: if you're able to use the menus but are experiencing other problems with your project when using the ArcMap integrated mode, in most cases the culprit is the geodatabase (.MDB). Try deleting this file and reopening your project (and save a new .MDB to the same location). You can locate the geodatabase by looking at the "source" path in the properties of one of the element layers in the Table of Contents.

Solution - toolbars appear but other problems occur

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. If the model has never worked properly, use the search bar above to search for the specific symptom, to locate a separate article to address the issue.

If the model was working and has stopped working, in most cases the culprit is the geodatabase (.MDB). Try deleting this file and reopening your project (and save a new .MDB to the same location). You can locate the geodatabase by looking at the "source" path in the properties of one of the element layers in the Table of Contents. Ensure that ArcMap and the OpenFlows product are closed first before deleting this file.

See also: How does the intermediate geodatabase (.mdb) file function with ArcMap integration?

If the problem is model-specific such as severe performance issues, hanging, crashes when using an edit session or using element control, the problem may be related to the MXD file. For example if there are too many, complex layers added, this can severely slow down performance and potentially cause a crash. To check if this is the case, try starting a new MXD (Map) and re-add the hydraulic model. Then, add layers one by one, testing performance between. 

If this does not help and the problem occurs for all models (or ArcMap won't open properly), see the numbered items further below under the "machine-specific..." section.

Solution - toolbars not showing

In ArcMap, right-click in the gray area at the top-right corner. You should see several entries for the Bentley Product (WaterGEMS, SewerGEMS, or HAMMER) available to add as toolbars. At a minimum, make sure the "layout toolbar" is selected. 

If you do not see the menus or if some of them are missing, see the steps below, which should help with the issue. 

Note: If you are using ArcGIS 10.3 please make sure to follow these instructions in order to achieve full integration.

Machine-specific issue troubleshooting

The following numbered items can potentially address issues that occur on a particular computer for all models. For model-specific issues, see the section further above.

1) Compatible Versions

First, make sure the version of WaterGEMS, HAMMER or SewerGEMS you have is compatible with ArcGIS. A compatibility chart can be found at the following link: Platform Compatibility

2) Reintegrate

If you are working with compatible versions, there may be an issue with the program installation or the integration. First, with ArcMap and WaterGEMS/HAMMER/SewerGEMS closed, run the "Integrate..." shortcut within the WaterGEMS/HAMMER/SewerGEMS start menu folder and try again. Note that you may need to have elevated permissions (such as Administrator privileges) in order to successfully use this Integrator tool. If you encounter a problem running the Integrator tool, try right clicking the shortcut > Properties > Compatibility and check the box for "Run this program as administrator."

Related to this, you can also go to "C:\Programs Files (x86)\Bentley\(product name)\Haestad.Integrator.exe". Then right-click on this file and choose "Run as Administrator". Make sure that you do this from a user account that has full administrative rights, and make sure the product and ArcGIS are closed. When this is completed use the steps in the video again to locate the toolbars.

3) Repair the OpenFlows Product and ArcMap Installation

If that doesn't help, go to Control Panel and choose Programs and Features. Find Bentley WaterGEMS/HAMMER/SewerGEMS in the list, highlight it, and select Repair. This will reinstall key components and rerun the integration tool. Once this is completely, you may need to restart your computer. When this is completed use the steps in the video again to locate the toolbars. If this does not help, try running the "Repair" option on ArcMap as well.

4) Clean Reinstallation of the OpenFlows product

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 (Ex: "SewerGEMS for ArcMap").

5) Replace Arcmap.exe.config File

In some cases, a corruption in the ArcGIS.exe.Config file may occur and prevent successful integration. In that case you should try the following:

a) Backup the ArcGIS.exe.Config file on the user's system, which is located at path similar to this: "C:\Program Files (x86)\ArcGIS\Desktop10.4\bin".

b) Replace the ArcMap.Exe.Config file with this one

c) Rerun the integrator shortcut to integrate the product.

6) Reinstall or Upgrade ArcMap

In some cases, it has been seen that a corruption to some ArcMap components prevents successful Integration. In these case, you will need to reinstall ArcMap or upgrade to a later version to repair those components. After doing this, run the "Integrate ..." shortcut again per step 3 above.

7) Disable Interfering Antivirus or AntiMalware

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 (Ex: "SewerGEMS for ArcMap").

8) Manually Register

There may be specific security permissions on the machine that are preventing the file OpenFlows.Integrator.exe from automatically registering the .dll files properly.

The .dll files can be manually registered using the following steps.

1. Download the file "RegisterExtension.zip".
2. Unzip and rename the file to "RegisterExtension.bat" (remove the .txt).
3. Open the file in Notepad and make sure the path to "ESRIRegASM.exe" is correct (on line 3). The batch file is set to use the default path during the ArcGIS installation which is “C:\Program Files (x86)\Common Files\ArcGIS\bin\”. If ArcGIS was installed using a different directory, then this will need to be edited.
4. Copy the file to the Bentley Hydraulics and Hydrology installation location (i.e. C:\Program Files (x86)\Bentley\<ProductName>\).
5. Open the Command prompt as an administrator and run the batch file from there. To do this search Windows for "cmd" and "Command Prompt" should display. Right-click on that and select "Run as Administrator".
6. Once the batch file is run, it will register all the required .dll files and then display a message box indicating if the  registration is successful or not.
 
If all of the .dll files are registered successfully, then there is something else wrong on the machine which is causing the application not to load and it needs further investigation. The following steps will help determine what is preventing the integration.

9) Collect Crash Dump and Configuration Files

1. Open the icon for the Bentley Hydraulics and Hydrology product integrated with ArcMap.
2. Open the Task Manager
3. Select the Processes tab
4. Right-click on the crashed process
5. Select Create Dump File
6. Copy the files "OpenFlows.watergems.arcgis.ecfg" and "OpenFlows.watergems.arcgis.ui.ecfg" from the location “C:\Program Files (x86)\Common Files\ArcGIS\Desktop10.5\Configuration\CATID”.
7. Submit a help request to Bentley Technical Support by posting to the forum or by creating a service request using the CONNECTION Center.
8. Provide the Crash Dump file and the two .ecfg files.

See Also

WaterGEMS for ArcGIS FAQ

SewerGEMS for ArcGIS FAQ

Recommended
Related