🔍 Note: The procedure described below is also documented in the help.txt file located at <WT_HOME>/codebase/com/colabsoftware

⚙️ Prerequisite: You must have a solid understanding of the PTC Windchill structure and configuration, as well as the fundamentals of Windchill customization, before performing the manual configuration steps.

⚠️ Important: Windchill must be stopped before performing the manual configuration steps.

Register the services

Run the following command to register the CoLab data utility and action filter

xconfmanager -i codebase/com/colabsoftware/ui/service.properties.xconf -p

To register the CoLab MVC builders, edit the file <WT_HOME>/codebase/config/mvc/custom.xml and add the following

<bean class="com.colabsoftware.ui.PartInfoBuilder"/>
<bean class="com.colabsoftware.ui.DefaultMiniInfoComponentBuilder"/>
<bean class="com.colabsoftware.ui.CadDocInfoBuilder"/>
<bean class="com.colabsoftware.ui.DocumentManagementInfoBuilder"/>

Register the CoLab actions

Run the following command to register the CoLab actions

xconfmanager --add com.ptc.netmarkets.util.misc.customActions=config/actions/CoLab-actions.xml -p

Add the CoLab actions to business objects.

The business object types supported by CoLab are WTPart, WTDocument, and EPMDocument.

Follow the steps below to locate, copy, and update the menu definition to include the CoLab actions for each supported type.

Locate the menu
1. Use the Action Model Report in Windchill to identify where the target menu (model) is defined — especially helpful if customizations exist.
2. If the menu has not been customized, refer to the default files in <WT_HOME>/codebase/config/actions:
  - EPMDocument:
    File UwgmCadx-actionmodels.xml
    Model epmdocuments details page actions
  - WTDocument:
    File DocumentManagement-actionmodels.xml
    Model docs row actions toolbar
  - WTPart:
    File PartClient-actionmodels.xml
    Model more parts actions
Copy the menu (if needed)
- Open the file found in step 1.
- Locate the desired <model> section.
- Copy that <model> block.
- Paste it into the following file: <WT_HOME>/codebase/config/actions/custom-actionModels.xml
Add the CoLab Actions
- Inside the pasted <model>, add:
```
<submodel name="openCoLabMenuModel"/>
<action name="shareForReview" type="object" />
```
  💡Tip: Add separator(s) to visually distinguish the CoLab action from other menu items.
```
<action name="separator" type="separator"/>
```
Save and Validate
- Save the file and confirm the XML is valid.

Add the multiple objects Share to CoLab action

If you want to share multiple objects at once, you can add the Share to CoLab action to the folder view.

Follow the same procedure as in Add the CoLab Actions to Business Objects to locate, copy, and update the menu definition.

Locate the Actions menu for folders
- The menu is defined by the model named folderbrowser_toolbar_actions
- If the menu has not been customized, it is located in:<WT_HOME>/codebase/config/actions/FolderManagement-actionModels.xml
Copy the menu (if needed)
- Open the file found in step 1.
- Locate the desired <model> section.
- Copy that <model> block.
- Paste it into the following file: <WT_HOME>/codebase/config/actions/custom-actionModels.xml
Inside the <model> section, add the following line to include the CoLab login option:
```
<action name="shareForReview" type="object" />
```

Add the CoLab Login/Log Out to the Quick Links menu

Follow the same procedure as in Add the CoLab Actions to Business Objects to locate, copy, and update the menu definition.

Locate the Quick Links menu.
- The Quick Links menu is defined by the model named header actions.
- If the menu is not customized, it is located in:<WT_HOME>/codebase/config/actions/navigation-actionModels.xml
Copy the menu (if needed)
- Open the file found in step 1.
- Locate the desired <model> section.
- Copy that <model> block.
- Paste it into the following file: <WT_HOME>/codebase/config/actions/custom-actionModels.xm
Inside the <model> section, add the following line to include the CoLab login option:
```
<action name="logIntoCoLab" type="object"/>
```

Add CoLab Actions to Profile Visibility Settings

To configure the visibility of the CoLab actions based on profile ownership, the file <WT_HOME>/codebase/roleaccessprefs.xml must to be customized.

💡Tip: Use the wtSafeArea

As per PTC’s supported customization practices, it is recommended to perform this customization within the wtSafeArea folder.

This approach ensures that your changes are preserved during Windchill upgrades and remain compliant with supported configuration guidelines.
The steps described below do not include the wtSafeArea portion.

For more information about the wtSafeArea folder, refer to Best Practices for Customizing Files Supplied by PTC.

In the file <WT_HOME>/codebase/roleaccessprefs.xm

locate the sections project, program, library, product. For each section where you want to manage the visibility of the Share to CoLab and Open in CoLab actions, add the following lines:
```
<uic name="shareForReview" defaultAll="true" />
<uic name="openCoLabMenuModel" defaultAll="true"/>
```

locate the global section and add:

<uic name="logIntoCoLab" enabled="true" defaultAll="true"/>

Note: In the snippets above, defaultAll="true" means these actions are visible by default.
To make them hidden by default, set defaultAll="false".

Restart Windchill and verify that the CoLab actions appear in the Set Action Visibility section of profiles.

Optional: Set the Action Display Names

The internal names of the actions appear in Windchill by default. If you prefer the names to match what end users see (as shown in the first screenshot), follow the steps below:

If the file <WT_HOME>/wtCustom/wt/util/resource/resourceCustomize.rbInfo doesn't exist, copy it from <WT_HOME>/src/wt/util/resource.

In the file <WT_HOME>/wtCustom/wt/util/resource/resourceCustomize.rbInfo add the following lines:

com.ptc.netmarkets.roleAccess.roleAccessResource/shareForReview.value=Share to CoLab
com.ptc.netmarkets.roleAccess.roleAccessResource/openCoLabMenuModel.value=Open in CoLab
com.ptc.netmarkets.roleAccess.roleAccessResource/logIntoCoLab.value=Log into CoLab

In a Windchill Shell, run the command
```
ant -f bin/tools.xml bundle_custom
```

Manual Post-Installation Steps for the Windchill Add-On