Troubleshooting MicroStation integration

Applies To 
Product(s): StormCAD, WaterGEMS, WaterCAD, SewerGEMS, SewerCAD, CivilStorm, HAMMER, PondPack
Version(s): CONNECT Edition, V8i
Environment:  MicroStation
Area:  Installation
Original Author: Scott Kampa, Bentley Technical Support Group


When attempting to use the MicroStation integrated version of an OpenFlows product (for example "StormCAD for MicroStation..." shortcut) an error is encountered, or the product menus do not display. 

An example of an error that may occur is "Variable pointing to SewerGEMS base installation directory has not been defined, exiting ..."


First, if possible, ensure that you are using the officially supported version of MicroStation for your OpenFlows product version. Older versions of MicroStation are generally supported, but upgrading is best if possible. Even if you're already using a compatible version, it is best to upgrade to the latest version of your OpenFlows product, in case the issue you're encountering has been fixed.

Note: Starting with CONNECT Edition Update 3.4 (version of SewerGEMS, CivilStorm, SewerCAD, and StormCAD and CONNECT Edition Update 3.5 of WaterGEMS, WaterCAD, and HAMMER, the OpenFlows products will now integrate with MicroStation CONNECT Edition. See: Platform Compatibility.

Troubleshooting integration with MicroStation CONNECT Edition

If you are using a compatible version, opening the "...for MicroStation" shortcut, with the WorkSpace is set to "OpenFlows" and the WorkSet is set to the product name and you do not see the menus, make sure that the OpenFlows product is select from the Workflows list in the upper left of the MicroStation dialog.

Note: MicroStation remembers the last item selected in the Workflows list. If you opened regular MicroStation CONNECT Edition between working with the OpenFlows integrated version, you may need to select the OpenFlows product from the list.

See this link for more information: OpenFlows product menus missing from Ribbon interface for MicroStation CONNECT Edition integration version.

If that doesn't help, try reintegrating the OpenFlows product and MicroStation. This is also necessary if you have upgraded to a new version of MicroStation after installing the OpenFlows product. To do this:

a) Make sure MicroStation and your OpenFlows product are closed and that you are signed into Windows with administrative permissions.
b) Delete the "...For MicroStation" shortcuts on your desktop and/or Start menu.
c) Run the "Integrate with AutoCAD, MicroStation..." application from the OpenFlows product's Start menu folder as an administrator (right-click the shortcut and choose "Run as administrator.") Be sure that the products are closed before doing this.
d) If this doesn't work, open Windows "Programs and Features", locate your OpenFlows product and choose "Repair.""

What if it still does not work?

If you are using a custom workspace with the OpenFlows integrated version, you will need to make sure that this is set up appropriately. See this link for details on how to set this up: Loading Hydraulics and Hydrology products into a custom MicroStation workspace.

You can also try a clean reinstallation of the OpenFlows product and/or MicroStation. The following link has information on this: How do I perform a clean uninstall and reinstall of the Hydraulics and Hydrology product?

Troubleshooting integration with MicroStation V8i

If you are still not seeing the "...for MicroStation" shortcut, the installation may have had a problem performing the 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: "StormCAD for AutoCAD...") In this case, try temporarily disabling any antivirus/antimalware/security software and reinstall.

If you are using a compatible version, opening the "...for MicroStation" shortcut, with the OpenFlows product selected as the User/Project, and you still do not see the menus (or encounter an error), try reintegrating:

a) Make sure MicroStation and your OpenFlows product are closed and that you are signed into Windows with administrative permissions.
b) Delete the "...For MicroStation" shortcuts on your desktop and/or Start menu.
c) Run the "Integrate with AutoCAD, MicroStation..." shortcut within the OpenFlows product's Start Menu folder as administrator (right click the shortcut and choose "run as administrator".) Be sure that the products are closed before doing this.
d) If this doesn't work, open Windows "Programs and Features", locate your OpenFlows product and choose "Repair"

What if it still does not work?

In order to troubleshoot MicroStation integration issues further, it is important to understand the steps that the OpenFlows product uses to integrate. By following this process, you should be able to resolve most problems with integration.

1) Shortcut and UCF file

The first step is initiated when you run the "...for MicroStation" shortcut. If you look at the properties of the shortcut (right click > properties > Shortcut tab) you will notice that the "Target" field has a "-wu<productname>" argument at the end. For example, for StormCAD for MicroStation, you will see "ustation.exe -wustormcad”. The "-wu tells MicroStation to load and use the "stormcad.ucf" (UCF - User Configuration File ) with the file name matching the name after "-wu", which is located in the users folder within MicroStation's current workspace. For example, "-wustormcad" tells it to look for and load "stormcad.ucf" and set the "User" (in the MicroStation manager) to "stormcad".

The default location of the MicroStation User workspace is:

C:\ProgramData\Bentley\MicroStation V8i (SELECTseries)\WorkSpace\Users\

If you have a custom workspace location, the Hydraulics and Hydrology product should automatically detect this during installation and place the file (such as stormcad.ucf) in the correct location, but there are circumstances where this may not happen, such as if MicroStation was installed after the Hydraulics and Hydrology product. So, it is important to check and confirm your Users workspace location. To do this, open plain MicroStation and open any design file using the standard settings in the MicroStation manager (keep the User and Project set to what you normally use). Click the Workspace menu and choose About Workspace. In the dialog that appears, note the path next to "User Configuration" at the top. This is the path to your Users workspace, which may be different from the default location noted above.

If the exact path to the "Users" and "Projects" part of your workspace is still not clear from this, you may need to check with your CAD/IT support to locate the correct place that stores the configurations that define these locations.

2) PCF file

Code in the UCF file (set by step 1) will set the "Project" to the same name (for example "stormcad") by pointing to a <productname>.PCF file in the "Examples" folder within the Projects folder in the MicroStation workspace. The default location is:

C:\ProgramData\Bentley\MicroStation V8i (SELECTseries)\WorkSpace\Projects\

For example, the Stormcad.ucf file loads the file \<Workspace>\Projects\Examples\Stormcad.PCF

Similar to step 1, if you have a custom workspace, you'll need to make sure that the <productname>.PCF file is located in an "Examples" folder within the workspace's Projects folder.

3) CFG file

Code in the PCF file (set by step 2) will load the respective product's CFG file, located in the /config/appl/ folder within the product's installation folder. For Example, StormCAD by default would be:

C:\Program Files (x86)\Bentley\StormCAD8\Config\appl)

The CFG file contains the code that loads all of the components that allow for the hydraulics and hydrology product integration to work. (MDL application, cells, etc.)

Here is a screenshot using CivilStorm as an example, showing how both the User and Project need to be set to the product name in order for the integration to work:

What if I'm encountering an error about a missing UCF file when trying to open the "...for MicroStation" shortcut"?

See below Support Solution. Basically you will need to place a copy of the UCF file into the Users folder in your current workspace location.

Missing UCF file error when opening "...for MicroStation" shortcut

What if I need to set a specific "User" or "Project" in the MicroStation manager that has my custom settings, standards, etc?

If you must select your own "User" and cannot keep it set to the Hydraulics and Hydrology product (such as "stormcad"), then you will need to follow some steps to load the Hydraulics and Hydrology product into your UCF file. See below Support Solution:

Loading Hydraulics and Hydrology products into a Custom MicroStation Workspace

What if I'm also using ProjectWise and still running into issues?

See below support solution:

What if I'm not able to see elements properly when in the MicroStation platform?

See: Elements are not visible in the MicroStation platform but are visible in standalone

If this doesn't help...

1) MicroStation's "msconfig.cfg" file can sometimes be changed from the default settings depending on how a system is setup. Reviewing that file may also help with finding the cause of an issue with the integration. The "msconfig.cfg" file can be found in the "Config" folder within the MicroStation installation folder. By default this is "C:\Program Files (x86)\Bentley\MicroStation V8i (SELECTseries)\MicroStation\config"

2) Check with your CAD manager or IT support as they may be more familiar with any custom workspace setup for MicroStation.

3) Consider if you need to use the MicroStation integrated version or if the Standalone version can do what you need. See below article:

CAD functionality in Standalone as an alternative to AutoCAD or MicroStation integration