Home
HCL Digital Experience 9.5 [Legacy content]
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.
HCL Web Content Manager
Set up a content server by installing HCL Web Content Manager in various deployments to provide robust and flexible environments for web content development and delivery. After you install the content server, more configuration steps must be completed according to the role that the server plays in your web content environment.
Configuring a web content authoring environment
Set up the authoring environment by installing the authoring portlet and enabling other features that are required to support the authoring environment.
Setting up support for federated documents
Before you can access metadata from federated documents, you need to configure access to the remote servers that contain the documents and specify information about the feeds or service documents that are used to retrieve the documents. You can also tune the cache settings that are used with the federated documents feature.
Cache tuning for federated documents
The federated documents feature uses the document list cache, the document data cache, and the feed type cache to manage information about the list of documents, the document data, and the types of feeds a server provides.

HCL Digital Experience 9.5 [Legacy content]
- Overview
  HCL Digital Experience provides a single access point to web content and applications, while it delivers differentiated, personalized experiences for each user across multiple touchpoints, such as web, mobile, hybrid mobile/web applications, and more.
- Supported migration paths
  Migration is supported between equivalent HCL Digital Experience offerings.
- Supported installation and upgrade paths
  Installation and upgrade is supported between equivalent HCL Digital Experience offerings.
- Getting the software
  New and existing users need to register at the HCL Software License Portal and download their entitled HCL Digital Experience package(s).
- Creating your website
  Review the following topics to understand how to create your website using the latest HCL Digital Experience.
- Installing HCL Digital Experience
  Review the planning information on HCL Digital Experience, then select your operating system and 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.
  - Configuration Wizard
    Use the Configuration Wizard to set up stand-alone servers and new deployments, create clusters, migrate and update to new versions, and add new capabilities to existing deployments.
  - Setting up a stand-alone server
    Use the Configuration Wizard to set up a stand-alone server. A stand-alone server is useful for different environments, such as a content authoring environment, test environment, and more.
  - Setting up a cluster
    Use the Configuration Wizard to set up either a dynamic or static horizontal cluster.
  - Tune your environment
    HCL Digital Experience is not tuned for a production environment by default. Complete the steps in the Performance Tuning Guide to optimize performance.
  - Web servers
    HCL Digital Experience uses the internal HTTP transport within IBM WebSphere Application Server to handle requests. However, because WebSphere Application Server also supports the use of an external web server, you can access HCL Portal from your web server. You can use a local web server on the same server as HCL Portal or you can use a remote web server on a different server. A remote web server is typical for a production environment or other high-traffic configuration and is also typically placed in DMZ outside a firewall to protect portal ports.
  - HCL Portal
    First, finish your HCL Digital Experience deployment with the Configuration Wizard. Then, you can configure your environment further. For example, you can tune your servers to improve performance. You can change the default context root.
  - HCL Web Content Manager
    Set up a content server by installing HCL Web Content Manager in various deployments to provide robust and flexible environments for web content development and delivery. After you install the content server, more configuration steps must be completed according to the role that the server plays in your web content environment.
    - Configuring a web content authoring environment
      Set up the authoring environment by installing the authoring portlet and enabling other features that are required to support the authoring environment.
      - How to install the authoring portlet
        Pages that include the Web Content Manager authoring portlet and the local rendering portlet are created when you install HCL Portal. You run the authoring portlet configuration task only if you have previously uninstalled your authoring or local rendering portlets. The authoring portlet configuration task automatically creates Web Content Manager pages and installs the authoring portlet and local rendering portlets.
      - Further authoring portlet configuration options
        Further authoring portlet configuration options can be specified by using the portlet administration view.
      - Web content authoring options
        You can tailor the authoring behavior of your web content environment by changing configuration settings such as workflow, profiling, and version control.
      - Rich text editor toolbar configuration options
        Run these configuration tasks to change the configuration of the rich text editor toolbar.
      - How to configure authoring portlet search
        You can change the configuration of the authoring portlet to change how search works.
      - Importing large files and images
        Because importing large files into HCL Web Content Manager can have a negative impact on performance, you can adjust several settings to ensure better performance when importing files.
      - Increase timeouts to prevent save errors
        If users are experiencing timeout errors when they try to save items, you can increase the total transaction lifetime timeout setting of your HCL Portal server.
      - Configuring remote server access for links
        Before you can add links to files and documents that are stored in remote content management systems into web content elements, you must configure your server with information about the remote system and the settings that are used to handle communication with the system.
      - Setting up support for federated documents
        Before you can access metadata from federated documents, you need to configure access to the remote servers that contain the documents and specify information about the feeds or service documents that are used to retrieve the documents. You can also tune the cache settings that are used with the federated documents feature.
        Configuring access to remote systems for federated documents
        To retrieve metadata information for documents on remote content management systems, configure the federated documents feature with information about the remote system and the settings that are used to handle communication with the system.
        Configuring the federated documents feature
        Configure the federated documents feature to specify information about the source servers for the documents that are available to users.
        Cache tuning for federated documents
        The federated documents feature uses the document list cache, the document data cache, and the feed type cache to manage information about the list of documents, the document data, and the types of feeds a server provides.
    - How to configure a web content staging environment
      Configure the staging environment to emulate the web content delivery environment and allow for testing before deployment.
    - Configuring a web content delivery environment
      Set up your delivery environment by installing web content viewers and enabling any other required features.
    - Reserved authoring portlet
      When you use the web content viewer or web content pages, some scenarios involve web content authoring tasks that are accomplished with authoring tools components. Authoring tasks are run through a special instance of the authoring portlet that is reserved specifically for these tasks and is installed on page that is hidden from the page navigation available to typical users.
    - Further configuration options
      These configuration options are available to address installation requirements for other deployment scenarios.
    - Configuring managed pages
      When you create a new installation of HCL Digital Experience 8.5, managed pages are enabled by default. However, you can also manually disable and enable the feature as needed.
    - Managing tagging and rating for web content
      When you use tagging and rating with web content, the web content viewer provides extra scope options for the filtering of tagging and rating results. Because changes in the web content system can affect the accuracy of the tagging and rating information that is used by the portal, it is important to keep the scope information up to date by synchronizing the scopes regularly.
    - Overview of a multilingual site
    - Installing the multilingual extensions
      The multilingual solution consists of a set of extensions to Web Content Manager that can be used to manage the authoring, workflow, and configuration of your multilingual system.
  - Syndication
    Use syndication to replicate web content library data from one server to another server. Syndication is based on a syndicator and subscriber relationship. The syndicator has the current data. The subscriber received the current data from the syndicator.
  - Database Management Systems
    Configure the connection between HCL Digital Experience and your database management system. The Database Transfer configuration option in the Configuration Wizard assigns users and permissions, creates databases, obtains support for database collation, and transfers your database.
  - User registry
    User information is stored in your user registry. You can enable LDAP referrals, configure HCL Digital Experience to use dynamic groups, update your user registry, or delete your user registry configurations.
  - Search
    You use Digital Experience Portal Search to search for text that is displayed in websites that are created by HCL Web Content Manager and additional web sources integrated to your Digital Experience platform.
  - Document Conversion Services
    Document Conversion Services are used when you work with HCL Web Content Manager authoring, previewing, and search.
  - Setting up a remote spell checker
    Using a local spell checker is not supported. You cannot run spell checker on 64-bit systems. Instead, you must install and configure spell checker on a remote application server and access that server from the local HCL Portal server.
  - HCL Connections
    HCL Connections portlets give the HCL Digital Experience users access to more collaboration and social networking features such as activities, blogs, and bookmarks.
  - Reference: Configuration properties
    For your convenience, the properties files that are used to configure HCL Digital Experience are included in the product documentation. Information that is specified in the properties files is used to configure databases, LDAP integration, security, including external security managers, and more.
- 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 HCL Digital Experience to do various day-to-day administration tasks.
- 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.
- Docker and Containerization
  Find topic information about Docker and Containerization for HCL Digital Experience.
- Practitioner Studio
  Practitioner Studio is a newly designed user experience for HCL Digital Experience. Please see the following pages to understand how the new navigation is organized.
- HCL Experience API
  This shows developers how to provision, configure, and use the HCL Experience API with the HCL Digital Experience 9.5 platform.
- HCL Content Composer
  The HCL Content Composer delivers simplified processes for creating and managing Digital Experience site content.
- HCL Digital Asset Management
  HCL Digital Asset Management (DAM) adds a central platform to store and include rich media assets in Digital Experience site content to present engaging, consistently branded experiences across digital channels.
- The Woodburn Studio demo site
  The Woodburn Studio is a website that demonstrates the use of some of the popular HCL Digital Experience features.
- Reference
  View information that can help you use our product documentation including terms of use, trademarks, and more.

Cache tuning for federated documents | HCL Digital Experience

The federated documents feature uses the document list cache, the document data cache, and the feed type cache to manage information about the list of documents, the document data, and the types of feeds a server provides.

The document list cache contains the list of document identifiers that are contained in the rule selection result of a specific user and a specific selection rule. The cache is activated by default with a default cache entry lifetime of 10 minutes.
The document data cache contains the metadata of a specific document. The cache is activated by default with a default cache entry lifetime of 10 minutes.
The feed type cache contains the type of feed for a feed URL. The feed type can be Document Services, CMIS, or ATOM. The cache is activated by default with a default cache entry lifetime of 24 hours.

To tune these caches, you can configure the Cache Manager Service (WP CacheManagerService) in the WebSphere® Integrated Solutions Console by using the following properties:

Document list cache: cacheinstance.com.ibm.pzn.wcm.ecm.DocumentListCache
Document data cache: cacheinstance.com.ibm.pzn.wcm.ecm.DocumentMetaDataCache
Feed type cache: cacheinstance.com.ibm.pzn.wcm.ecm.FeedTypeServerCache

Updates occurring on the remote content management system might not immediately be reflected on the portal side if there is a corresponding entry in the cache. The individual cache life time values determine the maximum time lag for corresponding updates.

Note:

The time lag for new documents to be visible and deleted documents to be removed depends on the lifetime value for the configured document list cache.
The time lag for updates in the metadata in a document (for example, changes to the document title) depends on the configured lifetime value for the document data cache.

The user-specific document list cache is explicitly invalidated each time the user logs in, so that the most current list of available document identifiers is available upon login.