Troubleshooting

This section includes detailed information on logs available to help you troubleshoot and also includes information on some of the problems you might encounter when installing CQ WCM.

Working with Logs

CQ WCM records detailed logs. After you unpack and start Quickstart, you can find logs in the following locations:

  • crx-quickstart/launchpad/logs

  • crx-quickstart/server/logs

  • crx-quickstart/logs

Activating the DEBUG Log Level

The default log level is INFO, that is, DEBUG messages are not logged.

To activate DEBUG log level, use the CRX explorer to set the /libs/sling/config/org.apache.sling.commons.log.LogManager/org.apache.sling.commons.log.level property to debug. Do not leave the log at the DEBUG log level longer than necessary, as it generates a lot of logs.

A line in the debug file usually starts with DEBUG, and then provides the log level, the installer action and the log message. For example:

DEBUG 3 WebApp Panel: WebApp successfully deployed

The log levels are as follows:

Table 13. Log Levels

0Fatal errorThe action has failed, and the installer cannot proceed.
1ErrorThe action has failed. The installation proceeds, but a part of CQ WCM was not installed correctly and will not work.
2WarningThe action has succeeded but encountered problems. CQ WCM may or may not work correctly.
3InformationThe action has succeeded.

Verbose Option Used for Troubleshooting

When you start CQ WCM, you can add the –v (verbose) option to the command line as in: java -jar cq-wcm-quickstart-<version>.jar -v.

Use the verbose option for troubleshooting as this option displays some of the Quickstart log output on the console.

Common Installation Issues

The following section describes some installation issues and their solutions.

Double-clicking the Quickstart jar does not have any effect or opens the jar file with another program (for example, archive manager)

This usually indicates a problem with the way your operating system's desktop environment is configured to open files with extension .jar. It may also indicate that you do not have Java installed, or that you are using an unsupported version of Java.

As jar files use the ubiquitous ZIP format, some of the archiving programs may automatically configure the desktop to open jar files as archive files.

To troubleshoot, do the following:

  • Double check that you have at least Java version 1.5 installed.

  • Try a context menu (usually right-mouse click) on the CQ WCM Quickstart, and select "Open With...."

  • Check if Java or Sun Java is listed, and try to run CQ WCM with it. If you have multiple Java versions installed, select the supported one.

    [Note]Note

    If you succeed with this step, and your operating systems offers an option to always use the selected program to run the .jar files, select it. Double-clicking should work from now on.

  • Sometimes reinstalling the supported Java version helps restore the correct association.

  • You can always run CRX using the command line or start/stop scripts as described earlier in this document.

My application running on CRX throws out-of-memory errors

CRX itself has a very low memory footprint. If the application running within CRX has bigger memory requirements or requests memory-heavy operations (for example, large transactions), the JVM instance where CRX runs needs to be started with appropriate memory settings. Use Java command options to define memory settings of the JVM (for example, java -Xmx512m -jar crx*.jar to set heapsize to 512MB).

[Note]Note

Specify the memory setting option while starting CQ WCM from the command line. The CQ WCM start/stop scripts or custom scripts for managing CQ WCM startup can also be modified to define the required memory settings.

The CQ WCM Welcome screen does not display in the browser after double-clicking CQ WCM Quickstart

In certain situations, the CQ WCM Welcome screens does not automatically display even though the repository itself is successfully running. This may depend on operating system setup, browser configuration, or similar factors.

The usual symptom is that the CQ WCM Quickstart window displays "CQ WCM starting up, waiting for server startup...." If that message displays for a relatively long time, enter the CQ WCM URL into the browser window manually, using the default 4502 port, or the port on which the instance is running: http://localhost:4502/.

Also, logs may reveal the reason for the browser not starting.

Sometimes, the CQ WCM Quickstart window has the message "CQ WCM running on http://localhost:port/" and the browser does not start automatically. In this case, click on the URL in the CQ WCM Quickstart window (it is a hyperlink) or manually enter the URL in the browser.

If everything else fails, check the logs to find out what has happened.