Chapter 9 Troubleshooting

This chapter provides information on addressing any errors that occur.

If an error occurs, portlets provide information in two ways:

• Error messages tell you the nature of the problem and include a more details link that opens an error page with additional information to help you troubleshoot the error.

• Tracing tracks and logs what is happening behind the UI of your application.

Tracing

Tracing is one of the most effective ways to track what is happening behind the UI of your application. You can start and stop different levels of tracing, and view the tracing logs to help your team and our team resolve any application issues.

Tracing takes up memory and considerably slows application performance. You should not leave tracing running unless you are trying to narrow down a specific issue. You can stop and start portlet tracing and you can view the tracing logs. Tracing flags are enumerated in the WDK resource file TraceProp.properties located in /WEB-INF/classes/com/documentum/debug directory. This file contains all tracing flags that are defined in your application. If there is an unknown flag in this file, the Trace class initialization will generate a warning message but will continue.

You must enable tracing for the current session by opening the /wdk/tracing.jsp file and checking the box that enables tracing. You can enable tracing for all sessions by setting SESSIONENABLEDBYDEFAULT to true in /wdk/source/com/documentum/debug/TraceProp.properties file.

The following tracing flags can be used to trace portlets:

DISPATCHER

Traces the Component Dispatcher. The dispatcher is an internal Documentum tool that does not have any public tracing capabilities.

ENVIRONMENT

Traces current environment, properties file, environment class, environment creation, and environment-specific calls.

HTML_PAGE_PROCESSOR

Traces tags rewritten for portlets.

HOOK

Traces environment lookup, user name, and repository.

PUBLISHED_CONTENT

Web Publisher portlet specific flag used to trace searching in the Published Content portlet. If this flag is turned on it displays an error for invalid entries in the XML configuration file for example, invalid attribute name and invalid object type name. This flags helps determine why containers are not displaying in the portlet, and displays the DQL used to search the portlet for each container.

SEARCH

Web Publisher portlet specific flag used to trace searching in the Published Content and Submit Content portlets. If this flag is turned on it displays an error for invalid entries in the XML configuration file in which the search component is used for example, invalid object type name, or invalid attribute name.

VIRTUALJS

Traces HTTP request and response including response status 304 and 200.

WDK_API_TRACE

Traces the local path for multi-part HTML file upload.