How do I get a log file for debugging the DITA CMS?

You need to launch the DITA CMS in debugging mode so you can obtain the log files. Once you start the DITA CMS in debugging mode, a log file called DITA_CMS.log will be created in your workspace folder.

Symptom

An issue is occurring in the DITA CMS and you want to review the log files so you can diagnose the problem.

Problem

The DITA CMS is not configured to output the debug log file by default.

Solution

You need to configure DITA CMS to launch in debugging mode so you can access the debug log file.

Configuring debug mode on a local installation

To launch the DITA CMS in debugging mode:

  1. Right-click the shortcut for the DITA CMS and click Properties.
  2. In the Target field, type -debug to the end of the Target statement. For example:
  3. Click Apply.
  4. Click OK.

The next time that you start the DITA CMS, a log file called DITA_CMS.log will be created in your workspace folder.

The file continues to log events until it hits its maximum size. Each time the maximum size is reached, the log events are saved into a file called DITA_CMS.log.[count] where [count] is replaced by a number in ascending order each time a new file is created. For example, the first time it reaches its maximum size, a new file called DITA_CMS.log.1. is created. When the maximum size is reached again, then another file is created, called DITA_CMS.log.2 and so on.

Configuring debug mode on Citrix

To launch the DITA CMS in debugging mode:

  1. Open the Run dialog (click the Windows logo key + R).
  2. In the Open box, type the path to your workspace. To find the path to your workspace, follow the FAQ called How can I get all the Eclipse installation and configuration details for the DITA CMS? to obtain the configuration details of your DITA CMS Eclipse Client and copy the path following the -data parameter.
  3. In that location create an empty text file and name it debug.txt.
  4. Close your DITA CMS Eclipse Client.
  5. Restart your DITA CMS Eclipse Client.
  6. Click a key when the instruction “press any key to continue” appears in the command prompt window. Do not close the command prompt window.
  7. When the DITA CMS opens, reproduce your issue so the information is captured in the log.