Skip to main content

Install the CoLab Integration for Teamcenter Rich Client and Server

Procedure to install the CoLab Rich Client and Server integrations for Siemens Teamcenter.

The CoLab integration for Siemens Teamcenter allows you to upload models directly to CoLab for design review and collaboration. Administrator or root permissions may be required depending on your Teamcenter installation and system configuration.

Prerequisites

Before installing the integrations, ensure that the following requirements are met.

Rich Client Integration

  • The user can access https://login.colabsoftware.com.

  • The user can run Teamcenter's genregxml.bat on Windows or genregxml.sh on Linux from the ./portal/registry directory. This requires local administrator or root access.

Server Integration

  • The Teamcenter server can access https://app.colabsoftware.com.

  • The temporary directory is accessible on the Teamcenter server.

  • The user can run the Teamcenter Environment Manager (TEM). This requires administrator or root privileges.

  • The user has access to at least one workspace in CoLab.

Preparation, download the installation files

The installation file is available to CoLab administrators, in Company & Admin > Integrations > Teamcenter Rich Client


### TODO complete #####

Install the CoLab Teamcenter Rich Client Integration

To install the CoLab integration for Teamcenter Rich Client:

  1. Ensure the Teamcenter Rich Client is not currently running.

  2. Navigate to the Teamcenter installation directory.

  3. Navigate to ./portal/plugin.

  4. Copy the downloaded com.colab.sharewithcolab_*.jar file to this directory.

  5. Navigate to the ./portal/registry directory and run genregxml.bat on Windows or genregxml.sh on Linux. No command-line arguments are required.

Running this command scans the plugin directory and registers the CoLab integration with Teamcenter.

Install the CoLab Teamcenter Server Integration

The CoLab Teamcenter Rich Client integration requires the corresponding Teamcenter server integration to also be installed.

To complete the server-side installation:

  1. Make sure the Teamcenter Pool Manager service is not running.

  2. Copy the CoLabTCServer_xx_yy_zz.zip file to any location on the Teamcenter server and extract it.

  3. Navigate to the Teamcenter server installation directory.

  4. Run TEM from .\install\tem.bat on Windows or ./install/tem.sh on Linux.

  5. Select Configuration Manager and click Next.

  6. Select Perform Maintenance on an Existing Configuration and click Next.

  7. Select Add/Remove Features.

  8. Browse to the previously extracted folder, navigate to c3colabtcintegration_ww_xx.yy.zz\tem_contributions, and select feature_c3colabtcintegration.xml.

  9. Click Next on the following two screens.

  10. Verify that the Database Template Summary displays the following information for the CoLab integration:

    • Template Name: colabtcintegration/Data Model

    • Template File: c3colabtcintegration_template.xml

  11. Click Next.

  12. Verify the information displayed on the Confirmation screen and click Next.

  13. Wait for the installation to complete.

  14. Start the Teamcenter Pool Manager service.

Configure proxy settings

If the Teamcenter server requires a proxy to access CoLab, set the TC_COLAB_CONFIG_PATH environment variable to the absolute path of a TOML configuration file.

[network]
http_proxy = "http_proxy_val_from_config_file"
https_proxy = "https_proxy_val_from_config_file"
no_proxy = "no_proxy_val_from_config_file"

The CoLab integration reads these values from the configuration file and sets the corresponding proxy environment variables for the running Teamcenter process.

Did this answer your question?