Home
HCL Digital Experience Product Documentation
Welcome to the product documentation for HCL Digital Experience. Find information about how to install, configure, maintain, and use HCL Web Content Manager and HCL Portal Server, Enable, and Extend solutions.
HCL Digital Experience 8.5
Learn how to install, configure, troubleshoot, maintain, and use Version 8.5 of HCL Web Content Manager and HCL Portal Server, Enable, and Extend.
Troubleshooting
This section helps you resolve problems, use diagnostic tools and tracing to capture HCL Digital Experience system errors.
Logging and tracing
If you are experiencing a problem, you might want to enable tracing and then re-create the problem to capture more log information.

HCL Digital Experience Product Documentation
Welcome to the product documentation for HCL Digital Experience. Find information about how to install, configure, maintain, and use HCL Web Content Manager and HCL Portal Server, Enable, and Extend solutions.
- HCL Digital Experience 9.5
- HCL Digital Experience 9.5 [Legacy Content]
- HCL Digital Experience 9.0
  Learn how to install, configure, troubleshoot, maintain, and use Version 9.0 of HCL Web Content Manager and HCL Portal Server, Enable, and Extend.
- HCL Digital Experience 8.5
  Learn how to install, configure, troubleshoot, maintain, and use Version 8.5 of HCL Web Content Manager and HCL Portal Server, Enable, and Extend.
  - Overview
    HCL Digital Experience (formerly IBM WebSphere Portal and IBM Web Content Manager) empowers you to create, manage, and deliver engaging omnichannel digital experiences to virtually all audiences with responsive content, targeted offers, seamlessly integrated applications, and consistent branding across channels (web, mobile. and hybrid mobile/web applications and more).
  - Roadmaps to deploy your system
    Review the roadmaps to understand the common deployment, configuration, migration, and integration patterns.
  - Roadmaps to create your website
    Review the roadmaps to understand how to create your website.
  - Online Help
    This Online Help is made available in the HCL Digital Experience Help Center for quick references on how to install, configure, maintain, and use HCL Digital Experience.
  - Installing
    HCL Digital Experience provides flexible deployment options that range from proof-of-concept where you can examine and test functionality to a highly available and scalable production environment. Review the planning information to learn more about hardware and software requirements, high availability, scalability, supported topologies, and much more. Select your operating system and then select the installation pattern that most reflects your business needs.
  - Configuring
    Run the following tasks after you install and deploy HCL Digital Experience. They address tasks that are typically run one time and have a global effect. Some configuration changes are made more frequently or do not have a global effect. These tasks are addressed in the Administering section.
  - Backup and restore
    Backup and recovery of data files and databases is an essential operation for any business system, particularly for data and applications that run in production environments. Create and follow a plan for backing up and recovering data on all tiers of your HCL Digital Experience deployment. IBM Installation Manager must also be included in backup and recovery planning. If you back up the HCL Portal file structure and then install a fix pack, your HCL Digital Experience and IBM Installation Manager become out of sync after you restore the HCL Portal file system. This condition is not recoverable.
  - Migrating
    Successful migration requires significant planning and preparation, understanding the tools that are involved, and careful execution of the appropriate steps in the order provided.
  - Integrating
    Integrate HCL Digital Experience with software such as HCL Sametime to enable your users to collaborate more easily. You can also use the unified task list portlet to integrate HCL with your backend business process software, such as IBM Process Server.
  - Administering
    Use the administration tools that are provided with the portal to do various day-to-day administration tasks. There are two methods for editing portal setup: using the administration portlets or the XML configuration interface. The administration portlets are a convenient way to make real-time updates to the portal's configuration. While the XML configuration interface is suited to more advanced administration, including batch processing of updates.
  - Securing
    Security tasks include setting up property extension databases and custom user repositories, configuring and activating SSL, and configuring authentication. In addition, tasks such as activating Federal Information Processing Standards (FIPS) and NIST SP800-131a security modules and configuring external security managers such as Security Access Manager might be required to secure your portal environment.
  - Monitoring
    HCL Portal includes tools and features to help you monitor the portal site.
  - Setting up a website
    Setting up a website includes, creating pages, adding navigation, setting up search, and adding content to the site. Themes are used to customize the portal's look-and-feel. Out-of-the-box templates and the site wizard can help you set up your portal site faster. You can add wikis and blogs to your site and let users tag and rate content on your site.
  - Staging to production
    During portal solution development, the solution is initially developed, tested, and refined on one server or a limited number of servers. The solution is deployed later on live systems, referred to as the production environment. The process of moving the solution from the development environment to the production environment is called staging.
  - Developing
    This section includes developer documentation on extending applications and development assets for HCL Portal and HCL Web Content Manager.
  - Troubleshooting
    This section helps you resolve problems, use diagnostic tools and tracing to capture HCL Digital Experience system errors.
    - Tools for troubleshooting and diagnostics
      A number of tools and resources are available to help you troubleshoot issues and resolve problems while using HCL Digital Experience.
    - Logging and tracing
      If you are experiencing a problem, you might want to enable tracing and then re-create the problem to capture more log information.
      - Installation and migration log
        Learn about the different log files that HCL Digital Experience provides to help administrators identify and correct problems with installation and migration.
      - HCL Digital Experience runtime logs
        If tracing is enabled, HCL Digital Experience generates a log file during run time that contains messages and trace information.
      - Verbose garbage collection in Java Virtual Machine (JVM) logs
        Verbose garbage collection (verbosegc) logging is often required when tuning and debugging many issues, and has negligible impact on system performance.
      - WebSphere Application Server tracing and log files
        Use WebSphere Application Server log files and tracing to troubleshoot problems with HCL Portal.
      - Configuration Wizard log files
        The Configuration Wizard generates log files each time you run it. The log file can help you to debug problems.
      - Enabling Virtual Member Manager tracing files
        Enable WebSphere Application Server trace facilities to create trace information for Virtual Member Manager.
      - System event logging
        The system event logging facility of HCL Digital Experience enables the recording of information about the operation of HCL Digital Experience.
      - Web Content Manager tracing files
        Enable the use of WebSphere Application Server trace facilities to create trace information for Web Content Manager. This tracing can be enabled either permanently or for just the current HCL Digital Experience session.
      - Logging and tracing for HCL Digital Experience Containers and new services
        The following table outlines the tracing options that can be used to capture logging and tracing for HCL Digital Experience (DX) 9.5 container based services with container update CF_181 and later releases.
      - Logging and tracing client side rendering
        Learn the how to enable client side logging and tracing of your HCL Digital Experience pages.
    - Troubleshooting the Configuration Wizard
      The Configuration Wizard provides tools for troubleshooting HCL Digital Experience errors, such as logs, step commands, and reset options.
    - Error message codes
      Each message code consists of a product identifier, component identifier, a unique number, and a message type identifier. The product identifier is EJP and there are many components. There are three message types: error, information, and warning.
    - HCL Web Content Manager Support Tools
      Use the HCL Web Content Manager (WCM) Support Tools portlet to investigate and analyze information related to the WCM Java Content Repository (JCR) nodes.
  - Reference
    View information that can help you use the Digital Experience Help Center including directory conventions, terms of use, trademarks, a glossary, and more.
  - Glossary
    This glossary includes terms and definitions for HCL Digital Experience.
  - Content Template Catalog 4.4
    The Content Template (CTC) is a set of templates that accelerate the process of building a website.

Logging and tracing | HCL Digital Experience

If you are experiencing a problem, you might want to enable tracing and then re-create the problem to capture more log information.

Refer to the MustGather data collection lists used in troubleshooting various problems in HCL Portal and HCL Web Content Manager. Collecting MustGather data early, even before you open a PMR, helps HCL Software Support quickly determine whether:

Symptoms match known problems (rediscovery).
A non-defect problem can be identified and resolved.
A defect identifies a workaround to reduce severity.
Locating the root cause can speed development of a code fix.

You can enable logging and tracing for software that is included with HCL Digital Experience. Enabling tracing makes log output more verbose. For example, you can enable tracing within WebSphere® Application Server to obtain information about application servers and other processes.

You can use the information gathered to help solve your own problems or to report an issue to HCL Software Support.

Links to important HCL Digital Experience tracing questions

How do I turn on HCL Digital Experience trace logging?: See Trace logging for information.

What are the different trace settings and where are they logged?: See Portal runtime logs for information.

How do I change the location of my logs?: See Changing the log file name and location for information.