Skip to main content

Manually Install the CoLab Integration for Siemens NX

Step-by-step guide to manually install and configure the CoLab integration for Siemens NX.

The CoLab integration for Siemens NX supports versions 1980 to 2512.

When to Use Manual Installation

Use this method when:

  • Your organization manages Siemens NX configuration centrally.

  • You deploy software using IT tools or scripts.

  • The standard installer cannot be used.

Download the Integration

The integration package can be downloaded from CoLab:

  • Go to Company Settings → Integrations → Siemens NX (CoLab administrators only)

  • Or download it directly here

Extract the Package

To extract the files, run the following command:

msiexec /qn /a <path_to_installer> TARGETDIR=<target_folder_path>

Example:

msiexec /qn /a nx-integration-0-1-0.msi TARGETDIR=C:\temp\CoLabNXIntegration

💡 Tip: The /a option performs an administrative extraction and does not install the integration.

Once extracted, the integration files are located in 

<TARGETDIR>\PFiles64\CoLab NX Integration

The package contains two directories:

  • application — Integration files and runtime dependencies.

  • startup — NX ribbon, menu, and toolbar configuration files.

Move the CoLab NX Integration folder to its final location. This directory will be added to the file referenced by UGII_CUSTOM_DIRECTORY_FILE in the next step.

Configure Siemens NX

To configure NX to load the integration, add the integration directory to the file referenced by UGII_CUSTOM_DIRECTORY_FILE. By default, it is set to %UGII_BASE_DIR%\UGII\menus\custom_dirs.dat

💡 To check the value of UGII_CUSTOM_DIRECTORY_FILE, you can review the NX log file: File > Help > Log File

Add the root directory of the integration package (the directory containing the application and startup folders).

Proxy Server Configuration

If your organization uses a local proxy server to manage network traffic, you must configure the HTTPS_PROXY environment variable on your machine or within your NX startup script to allow the integration to connect.

Additional Configuration for U.S. Customers

If you are a U.S.-based customer, create a colab.properties file in the same directory as nx-integration.dll and add:

colab_nx_server=us_prod

Restart Siemens NX for the changes to take effect.

Verify the Installation

After installation:

  1. Open Siemens NX

  2. Verify that the CoLab command appears in the NX ribbon or menu
    ​

If the CoLab command is visible, the installation was successful.

⚠️ Some Siemens NX versions may display a compatibility warning when loading the CoLab integration.

*This warning can be safely ignored.

Troubleshooting

If the integration does not load:

  • Verify that the integration directory was added correctly to the file referenced by UGII_CUSTOM_DIRECTORY_FILE.

  • Ensure all files from the integration package were extracted.

  • Verify that the integration version supports your Siemens NX version.

Did this answer your question?