Skip to main content

Installing the CoLab Add-in for PTC Windchill on Windows

This article describes the procedure to install the CoLab add-in for PTC Windchill on Windows Server.

Updated over a week ago

The Windchill CoLab Add-In is compatible with PTC Windchill PDMLink version 11 up to 13.1.

Preparation

Download the installation file

The installation file is available to CoLab administrators, in Company Settings > Integrations > Windchill > Download

Stop Windchill

If Windchill is configured as a Windows service, stop it from the Services window.

Otherwise, open a Windchill Shell and run the following command:

windchill stop

You are now ready to proceed with the installation.

Installation

Run the installation file.

(Optional) If prompt, select the Java runtime used by Windchill using Locate button

Click Next

Check “I accept the terms in the License Agreement” and click Next

Enter the path of <WT_HOME> if not automatically populated and click on Install

Select the Installation Type

  • Automatic: Automatically installs the add-in and resolves any potential conflicts with existing Windchill customizations.
    The CoLab actions will be added to WTPart, WTDocument, EPMDocument, and Folder (for multi-object actions).

and click Next.
​

​Automatic

You will be prompted to start Windchill. Select Yes to start it immediately, or No to skip this step, and then click Next.

The installation is now complete. You can review the installation log by clicking the Installation Log button.

Click Finish to complete the installation process.

Custom

Select No and click Next

Select No and click Next

The installation completes

The installer has only deployed the application files. To complete the setup, proceed to Manual Post-Installation Steps for the Windchill Add-On.

Note for USA customers

To configure Windchill to connect to the USA CoLab servers, set the following property in the file: <WT_HOME>/codebase/com/colabsoftware/colab.properties

server=PROD_US

This change requires a Windchill restart to take effect.

Update, Repair, and Uninstall

To update, repair, or uninstall the CoLab/Windchill add-in:

  1. Run the installation file.

    🔍 Note: The installer automatically detects any Windchill application instance(s) where the add-in is currently installed.

  2. Select the instance you want to update, repair, or uninstall.

  3. Choose the desired action:

    • Repair: Restores the add-in by replacing existing files and adding any missing ones.

    • Update: Replaces the installed version with the one provided by the installer.

      Update will not be available if the installer corresponds to the same version already installed.

    • Uninstall: Removes the add-in from the selected Windchill application instance.

  4. Click Next to proceed.

Did this answer your question?