Skip to main content

Capturing the logs from the CoLab Add-On for Windchill

Updated over a week ago

The Windchill CoLab Add-In supports versions 11, 12, and 13 of Windchill, up to version 13.1.

The procedure describes the steps to follow when investigating an error faced with the CoLab Add-on for Windchill.

This allows your system to capture information that may be useful for the support team while investigating.

Increase the verbosity

To enable logs for the CoLab add-in, you need to be a Windchill Site administrator.

  1. Browse > Site> Utilities > Server Status
    ​

  2. Click on Monitoring Tools
    ​

  3. Click on Log Levels
    ​

  4. Enable the Method Servers and Servlet Engines checkboxes.

  5. Type com.colabsoftware.log into the Logger field.

  6. Select DEBUG in the drop-down for Level.
    ​

  7. Click on Set

  8. (Optional) Validate the log level is set to DEBUG by selecting <any value> in Level and clicking on Get. The level should be changed to DEBUG.

Reproduce the issue

Reproduce the issue (or ask the end-user)

Please note the Windchill username and the exact time (with the time zone observed by the server).

Collect the logs

If you have access to the server file system

Copy the latest files, in <WT_HOME>/logs folder.
The most relevant files are:

  • the MethodServer logs (usually named as MethodServer-<timestamp>-log4j.log)

  • the ColabIntegration logs (usually named as ColabIntegrationLog.<n>.log)
    ​

If you do NOT have access to the server file system:

Select Log File Viewer in the Monitoring Tools
​

  1. Enable wt.logs.dir,

  2. write Metho.*|Colab.* in Filename Pattern,

  3. select Regular Expression,

  4. write 1 in Max field

  5. click OK


You should see a couple of files to download using Save link as that shows when right-click on each file.

You can share those files with the support team along with the Windchill username and the exact time in the time zone observed by the server.

Restore the log level to ERROR

Once you collected the logs, it is important to revert the log level to ERROR.

Back in Log Levels page,

  1. Type com.colabsoftware.log into the Logger field.

  2. Select DEBUG in the drop-down for Level.
    ​

  3. Click on Set.

Did this answer your question?