Portal runtime logs | HCL Digital Experience

If tracing is enabled, HCL Digital Experience generates a log file during run time that contains messages and trace information.

The default runtime log file is shown:
  • AIX® Linux Solaris: wp_profile_root/logs/HCL Portal and HCL Web Content Manager/trace.log
  • IBM® i (UserData): wp_profile_root/logs/HCL Portal and HCL Web Content Manager/trace.log
  • Windows: wp_profile_root\logs\HCL Portal and HCL Web Content Manager\trace.log
  • z/OS®: wp_profile_root/logs/HCL Portal and HCL Web Content Manager/trace.log
    Note: The default runtime log file is at the output location you specified as ras_trace_outputLocation in your IBM® WebSphere® Application Server for z/OS® installation. It can either be in the job log of the servant region, in a CTRACE data set, or in a file in HFS. For details, see Trace control settings.

See the topic on system event logging for details on how to configure logging and for information on the grammar of the "trace string" configuration key.

The following information describes trace loggers for particular situations and problem symptoms. Enabling the trace loggers can slow down HCL.

Note: If there are problems with portal administration portlets, the error is not caused by the portlet code itself, but by the underlying function for which the portlet provides the UI. Therefore, the portlet trace strings are not listed here. If there are issues with these portlets, provide the trace strings of the underlying function. If you need traces or logs for portlets, you can learn how to obtain them from support personnel.

Access Control

When to use
Enable this tracer if you want permissions for resources to be explained in detail, need to verify the correctness of a permission, or need to isolate a defect in access control.
Trace String
com.ibm.wps.ac.*=all
Additional comments

The traces are easier to evaluate while HCL usage is low.

Important: Enabling this logger creates large log files.

Authentication

Trace String
com.ibm.wps.services.puma.*=all:   
com.ibm.wps.puma.*=all:  
com.ibm.wps.auth.*=all: 
com.ibm.wps.sso.*=all: 
com.ibm.wps.um.*=all: 
com.ibm.wps.services.authentication.*=all

Command

When to use
Use to turn on all command trace loggers.
Trace String
com.ibm.wps.commands.*=all

Layout Model

When to use
Enable these messages if you want to get more information on how pages are constructed, need to verify page lists that are displayed on HCL for correctness, or need to isolate an error in the HCL aggregation component.
Trace String
com.ibm.wps.model.*=all: 
com.ibm.wps.composition.*=all
Additional comments

The traces are easier to evaluate while HCL usage is low.

Important: Enabling this logger creates large log files.

Credential Vault

Trace String
com.ibm.wps.sso.credentialvault.*=all:   
com.ibm.wps.command.credentialvault.*=all:   
com.ibm.wps.portletservice.credentialvault.*=all:  
com.ibm.wps.services.credentialvault.*=all:  
com.ibm.portal.portlet.service.credentialvault.*=all

Database

When to use
Deals with generated SQL statements and the internal flow in the HCL database layer.
Trace String
com.ibm.wps.datastore.*=all:   
com.ibm.wps.services.datastore.*=all
Additional comments
Important: Enabling this logger creates large log files.

Engine

When to use
Use to enable all engine trace loggers.
Trace string
com.ibm.wps.engine.*=all

General

Trace string
com.ibm.wps.*=all
Note: If you want to use general tracing but do not want render times to be displayed for such portlets, you must selectively disable tracing by using the following trace string:
com.ibm.wps.pe.PortletRenderTimeLoggingHelper=info

Mail Service

When to use
Use to diagnose problems with the Mail Service.
Trace string
com.ibm.wps.services.mail.*=all   

Mapping URLs

When to use
Use to diagnose problems with the user-defined mappings of URLs.
Trace string
com.ibm.wps.mappingurl.*=all:   
com.ibm.wps.command.mappingurl.*=all

Personalization

Trace string
com.ibm.websphere.personalization.*=all: 
com.ibm.dm.pzn.ui.*=all
Additional comments
When Personalization is installed outside of a HCL server, Personalization logs by using WebSphere® Application Server tracing with the same trace strings.

Portlet Container

Trace string
com.ibm.wps.pe.pc.*=all:   
org.apache.jetspeed.portlet.Portlet=all:  
javax.portlet.Portlet=all

Portlet Environment

Trace string
com.ibm.wps.pe.ext.*=all:   
com.ibm.wps.pe.factory.*=all:   
com.ibm.wps.pe.om.*=all:   
com.ibm.wps.pe.util.*=all

Portlet Load Monitoring

When to use
Use to diagnose problems with Portlet Load Monitoring (PLM).
Trace string
com.ibm.wps.pe.pc.waspc.plm.*=all:
com.ibm.wps.command.plm.*=all 

Deployment

Trace string
com.ibm.wps.pe.mgr.*=all:   
com.ibm.wps.services.deployment.*=all:   
com.ibm.wps.command.applications.*=all:   
com.ibm.wps.command.portlets.*=all

Portlets

When to use
Use to diagnose problems with portlets.
Trace string
com.ibm.wps.portlets.*=all:   
org.apache.jetspeed.portlet.PortletLog=all
Additional comments
Enables tracing for all portlets. Therefore, place the suspect portlet on a separate page for testing.

Scripting Interface

When to use
Use this trace string to diagnose problems with the Portal Scripting Interface, or with application interface scripting, and the execution of such scripts.
Trace string
com.ibm.wps.scripting.*=all
Additional comments
The traces are easier to evaluate while portal usage is low.
Note: Enabling this logger can create large log files fast.

Selfcare

When to use
Use to diagnose problems with user registration and profile editing.
Trace string
com.ibm.wps.services.puma.*=all:   
com.ibm.wps.puma.*=all:
com.ibm.wps.um.*=all 
Additional comments
Use this logger if there are errors in the sign-up, Edit My Profile, and the Manage Users and Groups portlets.

Services: EventBroker

Trace string
com.ibm.wps.services.registry.EventHandlerRegistry=all:   
com.ibm.wps.services.events.*=all

Services: Finder

When to use
Use for debugging the resolution of file names.
Trace string
com.ibm.wps.services.finder.*=all

Services: Loader

When to use
Use to trace the dynamic class loading that is done by this service.
Trace string
com.ibm.wps.services.ServiceManager=all

ServicesNaming

When to use
Use to debug the lookup of objects by the naming service.
Trace string
com.ibm.wps.services.naming.*=all

ServicesNavigator

When to use
Use to diagnose problems with parts of page aggregation and display.
Trace string
com.ibm.wps.services.navigator.*=all

ServicesRegistry

When to use
Use to view the policies of the internal portlet object caching and watch it reload its content.
Trace string
com.ibm.wps.services.registry.*=all

Services

When to use
Use for turning on tracing for all services.
Trace string
com.ibm.wps.services.*=all

SSO

When to use
Use to turn on all SSO tracer loggers.
Trace string
com.ibm.wps.sso.*=all
Additional comments
Use this logger if errors occur when you use the Security Vault task on the Security page of the Administration pages.

WSRP administration

When to use
Use to diagnose problems that occur during the administration of Web Services for Remote Portlets (WSRP) with HCL.
Trace string
com.ibm.wps.command.wsrp.*=all:  
com.ibm.wps.wsrp.cmd.*=all

WSRP Consumer

When to use
Use to diagnose problems that occur during the use of WSRP with HCL as a Consumer.
Trace string
com.ibm.wps.wsrp.consumer.*=all

WSRP Producer

When to use
Use to diagnose problems that occur during the use of WSRP with HCL as a Producer.
Trace string
com.ibm.wps.wsrp.producer.*=all 

XML configuration interface

When to use
Use to diagnose problems with the XML import/export of HCL configurations.
Trace string
com.ibm.wps.command.xml.*=all