Skip to main content

Installing the CoLab Active Workspace integration

Procedure to install the Colab integration for Teamcenter Active Workspace.

The Teamcenter Active Workspace CoLab integration supports Active Workspace 6.3, 2312, 2406, 2412, 2506 and 2512.

The installation file is available to CoLab administrators, in Company Settings > Integrations > Teamcenter Active Workspace > Download

Prerequisites

  • Active Workspace is installed and configured on the Teamcenter server

  • The Teamcenter server URL(s) are added to CoLab’s allowlist

  • The Teamcenter server URL(s) must use HTTPS (HTTP is not supported)

Installation & Configuration

Stop Teamcenter Services

Before continuing, stop the Teamcenter and Active Workspace services.

Add CoLab to the Content Security Policy (CSP)

ℹ️This configuration is required for Active Workspace 2512 and later versions only.

To ensure the integration can communicate properly, add CoLab domains to the Content Security Policy configuration.

Locate the gateway configuration file. The typical location is:

<TC_ROOT>\microservices\gateway\config.json

Open config.json and

  • in the the directive list security.cspPolicy.directives.connect-src add

    "https://*.colabsoftware.com",
    "https://colab-production-customers.s3-accelerate.amazonaws.com"

  • in the the directive list security.cspPolicy.directives.frame-src add

    "https://*.colabsoftware.com"

Example:

"connect-src": [
  ...
  "https://*.colabsoftware.com",
  "https://colab-production-customers.s3-accelerate.amazonaws.com"
],
"frame-src": [
  ...
  "https://*.colabsoftware.com"
]

Install and Register the Plugin

  1. Extract the contents of the extension zip file. This should contain a folder named aws63-colab-integration.

  2. Copy the aws63-colab-integration folder to: <TC_ROOT>/AWS2/STAGE/SRC

  3. Register the plugin in the kit.json configuration file.

    Typical location: <TC_ROOT>\aws2\stage\src\solution\kit.json

    Add the following entry to the "modules" list: "aws63-colab-integration"
    Example:

    "modules": [
      ...
      "aws63-colab-integration"
    ]

For more information, see Siemens' official documentation on Kits.

Build and Deploy

Run the awbuild script (awbuild.cmd on Windows or awbuild.sh on Linux) to compile, rebuild, and publish Teamcenter Active Workspace with the CoLab integration.

Typical location: <TC_ROOT>\aws2\stage\

Start Teamcenter Services

Restart the Teamcenter and Active Workspace services to apply the configuration changes and deploy the plugin.

  • Windows: Restart the Teamcenter Process Manager Service

  • Linux: Restart the Docker instance running the microservices, specifically the gateway service

After the services restart, refresh the Active Workspace web application. The CoLab integration loads in the right sidebar.

Did this answer your question?