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.
Monitoring
HCL Portal includes tools and features to help you monitor the portal site.
Analyzing portal usage data
You can collect data about the usage of your portal and analyze them.
Analyzing user behavior by Active Site Analytics
You can collect data about user behavior in your portal and send that data to a service for analysis. For this purpose the portal provides Active Site Analytics (ASA).
Collecting analytics data
Before you can send data about user behavior in your portal to a service for analysis, you need to collect that data. See the following topics for information about how to do this.
Writing an aggregator for Active Site Analytics
You can write your own scripts to retrieve the data for Active Site Analytics from the portal themes and skins and connect to your analytics service provider. Such scripts are called aggregators.
How to identify and resolve problems with your aggregator
If your custom aggregator is not working correctly, perform the checks listed here.

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.
    - Portlet load monitoring for HCL Portal
      HCL Digital Experience now provides Portlet load monitoring. This can make your portal safer and more responsive.
    - Analyzing portal usage data
      You can collect data about the usage of your portal and analyze them.
      - Logging and analyzing server side site data
        HCL Digital Experience implements a logging function for your usage data. The portal writes usage records to a dedicated log file if site analysis logging is enabled. Multiple types of site analyzer loggers allow portal administrators to collect statistical data in various areas. The portal server manages the collection of data on its own, but from a business point of view you can also log custom details of business events. You can configure the portal for site analysis logging for the web content viewer.
      - Analyzing user behavior by Active Site Analytics
        You can collect data about user behavior in your portal and send that data to a service for analysis. For this purpose the portal provides Active Site Analytics (ASA).
        Collecting analytics data
        Before you can send data about user behavior in your portal to a service for analysis, you need to collect that data. See the following topics for information about how to do this.
        How Active Site Analytics data is represented in the portal
        The data for the analysis of user behavior is retrieved from markup embedded in the portal pages.
        Writing an aggregator for Active Site Analytics
        You can write your own scripts to retrieve the data for Active Site Analytics from the portal themes and skins and connect to your analytics service provider. Such scripts are called aggregators.
        The Active Site Analytics Mediator SPI
        The portal provides a client side JavaScript SPI named Active Site Analytics Mediator SPI. You can use it to implement aggregators. The Active Site Analytics Mediator SPI allows aggregators to register callback functions; the portal framework calls these functions to notify the aggregator about DOM changes that can be relevant for Active Site Analytics.
        Guidelines for implementing an aggregator
        When you implement an aggregator by using the Active Site Analytics Mediator SPI, the following guidelines can be helpful.
        Aggregator patterns and samples
        The aggregator patterns and samples section provides common aggregator patterns and samples that you might want to adopt to implement your own aggregator.
        How to identify and resolve problems with your aggregator
        If your custom aggregator is not working correctly, perform the checks listed here.
        Adding an Active Site Analytics aggregator to a portal page
        Portal administrators can manage the aggregators. They can assign an aggregator to one or more portal labels or pages.
        Instrumenting a theme for Active Site Analytics
        The Tab menu - Page Builder Page Builder portal theme provided with HCL Digital Experience is prepared and suitable for use with Active Site Analytics. You can also enhance the other portal themes or create your own custom theme to use the Active Site Analytics functionality.
        Configuring an aggregator at run time
        If you want to configure the behavior of an aggregator at run time, you can pass additional meta data values to the aggregator.
        Displaying overlay analytics reports
        You can use Active Site Analytics to show graphical statistics reports about individual portal resources, such as pages or portlets. These reports are called Active Site Analytics overlay reports.
        Analytics tags and site promotions
        To obtain further analytics information from your portal, you can use analytics tags for your portal resources. You can also use analytics tags for site promotions.
    - Auditing
      HCL Digital Experience includes an auditing function that allows users to log certain events and their originators in to a separate log file. This file can then be used to track administrative activities.
  - 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.
  - 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.

How to identify and resolve problems with your aggregator | HCL Digital Experience

If your custom aggregator is not working correctly, perform the checks listed here.

Verify that the HTML markup of the portal page contains the microformats that the aggregator expects.
Verify that the tagging method that is used in the themes, skins, and portlets matches the expected behavior of the aggregator. For example, the Page Builder theme shipped with the portal tags all metadata with CSS classes whose names start with an asa prefix.
If you use the SiteAnalyticsMediator API and your aggregator is not notified about DOM changes as expected, you can enable client side tracing by using the resource environment provider WP CommonComponentConfigService. Set the following two configuration properties:
```
cc.isDebug=true
cc.traceConfig=["com.ibm.wps.analytics.*"]
```
After you have done this, save your changes and restart the portal server.
To review what occurs in the server side aggregator inclusion code, specify the trace com.ibm.wps.theme.extensions.*=debug .

Remember that aggregators are regular JavaScript files. Consequently, you can also use all JavaScript debugging tools and browser developer tools for debugging an aggregator.