Home CMS Documentation Home CMS 10 DITA Processing Pipeline in Ingeniux CMS Troubleshooting DITA Collections DITA Preview Issues DITA Preview Log Errors

DITA Preview Log Entries Flag Errors

Condition

When users execute DITA Preview on a DITA asset via the DITA Preview or XML tab, the system generates DITA preview log entry errors.

DITA-OT Log Errors

Users may see these errors in the Log screen of the DITA Preview or XML tab, or they may see these errors in the preview log entry via Publishing Monitor > DITA Logs.

Note

In some scenarios, the preview log contains errors, but the Has Errors column does not flag those errors in Publishing Monitor > DITA Logs. The Has Errors column only indicates errors when the preview transformation process encounters a fatal error that halts the transformation process. If the Has Errors column indicates no conflicts, the log may still contain errors and warnings that did not halt the DITA-OT process.

***Troubleshooting DITA Preview Errors***

Cause

A spectrum of issues can cause the DITA-OT transformation process to generate DITA preview log entry errors. These issues can vary depending on factors involved. Keep in mind that these steps provide general guidelines and direction for pinpointing and resolving a wide range of issues that may cause DITA log entry errors.

Error Issue Diagnosis

Administrators can double-check the DITA publishing pipeline setup and run debug mode. Users with asset editing permissions can execute DITA preview, view the results, and review log and temp entries.

Identify the issue that causes the DITA publish log errors.

To diagnose the issue:

Double-check your DITA publishing pipeline setup.
Ensure the appropriate settings were in place when you executed the DITA preview.
See the DITA Publishing Pipeline Troubleshoot Checklist to double check your DITA administration settings and DITA publishing settings.
Run debug mode to include debugging details in the next DITA preview log.
See Running DITA Debug Mode for details.
Execute the DITA preview in the DITA Preview or XML tab, and check the DITA log to see if you run into the same previously experienced errors.
These errors may provide details about where the conflict resides and what the conflict entails.
See Checking DITA Preview Logs for Errors for details.
Check the DITA Preview or XML tab to review the output results.
See Checking DITA Preview Output for details.
Note
If the DITA preview logs indicate the DITA-OT transformation process failed in the Has Errors column, then skip this step.
Review the DITA temp folder for discrepancies within the temporary files that may relate to the issue.
See Checking DITA Temp Folders for details.
Interpret the log entry errors to determine what the conflicts entail.
See Interpreting DITA Log Errors for details.

Address Error Issues

Administrators can modify the DITA publishing pipeline setup and settings related to the DITA-OT. Users with asset editing permissions can resolve conflicts with DITA asset content and their dependencies, and they can modify settings applied at DITA preview time.

Use the information you gathered from troubleshooting to resolve DITA log entry errors.

The following list provides potential solutions to address your issue. Keep in mind that you may uncover alternative solutions not provided in this list.

If your issue relates to the DITA publishing pipeline setup, then adjust your setup settings as needed.
If your issue relates to a dependency error, where you can resolve the issue by restoring a missing file or by modifying the dependency reference in your DITA asset content, then apply fixes to the affected DITA assets as needed.
If your issue relates to a DITA specification validation error, where you can resolve the issue by making changes to your DITA asset content, then check out the affected DITA assets and apply fixes as needed.
If your issue relates to DITA-OT output formats, where you can resolve the issue by changing the normalized DITA output format, then choose another normalization output.
Note
The DITA-OT provides only one normalized DITA output format per version. You may need to provide your own custom normalization output plugin that resolves the issue.
If your issue relates to DITA-OT parameters, where you can resolve the issue by changing parameter settings, then modify parameters for the CMS DITA-OT as needed.
If your issue relates to the DITA-OT version, then do one of the following:
- Install a different DITA-OT version that better suits your organization's needs than the currently installed version.
- Install a custom DITA-OT engine that suits your organization's needs.
- If your issue is an unresolved DITA-OT bug, report the issue via Github: DITA-OT Issues.
If your issue relates to something else, or if the solutions above do not suffice, then contact Ingeniux Support.

After implementing your solution, preview the DITA asset again, and then review the DITA logs to see if the DITA preview logs contain errors. If issues persist, try another solution, or contact Ingeniux Support.

DITA Preview Log Entries Flag Errors

Table of Contents Release Notes Search

Table of Contents