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

CoLab offers two types of installers:

RPM package (*.rpm)
- Requires root-level permissions to install.
- Runs as a command-line utility with no graphical interface.
Shell script (*.sh)
- Can be used when root-level permissions are not available.
- Provides a graphical user interface (UI) for installation.

💡 Recommendation: The shell script installer is recommended for most users, as it simplifies the installation process and does not require elevated privileges.

Decrypt the installation file

The provided files are encrypted and signed using GnuPG. Regardless of the installer type selected, the downloaded file will have a .gpg extension (*.rpm.gpg or *.sh.gpg).

To decrypt the file, place the file where the current user has full permission (/tmp for instance) and use the following command in a terminal

gpg --output ColabWindchill_linux_xxxxx --decrypt ColabWindchill_linux_xxxxx.gpg

Stop Windchill

From a Windchill Shell

windchill stop

You are now ready to proceed with the installation.

Installation

⚠️ Note: It is recommended to install the add-on using the same Linux user account that was used to install Windchill. In the commands provided below, this account is represented as <wtadmin>.

Installation using the RPM package

RPM package installation requires root-level permissions. Make sure the Windchill Linux account you are using has sudo privileges before proceeding.

Open a Windchill Shell
Navigate to the directory containing the *.rpm file.
Run the following command:
```
sudo rpm -i ColabWindchill_linux_xxxxx.rpm --prefix=<WT_HOME>
```
Here, <WT_HOME> refers to the Windchill home directory.
If Windchill environment variables are configured, you can use $WT_HOME to specify the Windchill home directory.
Choose the installation mode:
- Automatic mode (y): 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).
- Custom (Manual) Mode (n): The installer only deploys the application files.
  This option is intended for advanced users familiar with the PTC Windchill structure and customization.
  To complete the setup, proceed to Manual Post-Installation Steps for the Windchill Add-On.
Restore file permissions:
Once the installation is complete, retore the Linux file permissions by running
```
sudo chown -R <wtadmin>:<wtadmin> <WT_HOME>
```

Installation using the Shell script

Open a terminal and navigate to the directory containing the *.sh file.

Run the following command:

./ColabWindchill_linux_xxxxx.sh

⚠️ Note: If you receive an elevation prompt during installation, it is recommended to cancel it. Continuing with elevated privileges will change file ownership, requiring you to restore file permissions at the end of the process.

This opens a installation wizard:

After accepting the license agreements, select the Windchill home directory.
If the installer does not automatically detect the correct location, click Browse to select it manually.

Choose the installation mode:

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).

Custom: The installer only deploys the application files.
This option is intended for advanced users familiar with the PTC Windchill structure and customization.
To complete the setup, proceed to Manual Post-Installation Steps for the Windchill Add-On.

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

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.

Installing the CoLab Add-in for PTC Windchill on Linux