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.
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 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.
Configuring portal behavior
Configure various options related to your portal.
Setting service configuration properties
HCL Digital Experience comprises a framework of services to accommodate the different scenarios that portals need to address. Services are available for both HCL Portal and HCL Web Content Manager. You can configure some of these services.
Portal service configuration
HCL Portal comprises a framework of configuration services to accommodate the different scenarios that portals of today need to address. You can configure some of these services.

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.
    - 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.
      - Configuring portal behavior
        Configure various options related to your portal.
        Setting the language of the portal
        Specify the default language in which the portal appears with the Global Settings portlet.
        Renaming the HTTP session cookie
        The Java Servlet API up to Version 2.5 states that the session identification cookie must be named JSESSIONID. WebSphere Application Server Version 8 supports the Java Servlet API 3.0 that offers applications the option to rename the JSESSIONID cookie name. Therefore HCL Portal 8.5 also supports this option.
        Customizing the home page login URL with the Page Builder theme
        In the Page Builder theme the login link points to a protected URL to the home page of the default portal installation. If you remove this page, or if you want your users to be directed to a different page after login, modify the theme by the following procedure.
        Using portal light mode
        HCL Portal now provides a portal light mode which can improve portal startup time and reduce memory consumption in production environments.
        Creating or editing a custom unique name
        You can create a new custom unique name for a portal resource or update an existing custom unique name.
        Setting the portal entry page
        Use the Global Settings portlet to specify the page that a user sees when the user logs in to HCL Digital Experience.
        Configuring your time settings
        Some applications, like Calendar, are capable of adapting to the time zone settings of a user.
        Setting the search engine that opens when users select Find
        Specify the search engine that is used when users click Find with the Global Settings portlet.
        Configuring how to handle portlets that a user is not authorized to view
        Specify how you want the portal to display portlets that a user is not authorized to view with the Global Settings portlet.
        Configuring user session persistence
        With the persistent session state feature, portal users can resume and continue a previously interrupted working session at the same state where they ended the session. When the user logs out or the session times out, the portal stores the current navigational state into the database. As a portal administrator, you can give users the option to resume the navigational state of their last session when they log in again. When the user chooses to resume the last session, the navigational state that is stored previously is restored, and the user can continue working where the user stopped before.
        Configuring dynamic fragment cache
        Dynamic fragment cache (also known as servlet caching) is a component of WebSphere Application Server that provides content caching. You configure and enable dynamic fragment cache by using the WebSphere Integrated Solutions Console.
        Configuring portlet filtering
        A portlet filter enables the administrator of a portal to intercept and modify the output of a portlet before it is aggregated to the entire portal page. This way you can support different languages and markups other than those for which the portlet was originally designed. You can use portlet filters also for adding additional information to the portlet output, for example, a copyright statement, deleting unimportant or restricted content, and for parsing destructive JavaScript.
        Configuring authentication filters
        The portal authentication filters are a set of plug-in points. You can use them to intercept or extend the portal login, logout, session timeout, and request processing by custom code, for example to redirect users to a specific URL.
        Caching
        Caching affects the performance of your HCL Digital Experience environment. Learn about some simple ways to improve the caching performance. After you have reviewed this content, you should also review the HCL Digital Experience Performance Tuning Guide which provides more information about caches for both HCL Portal and Web Content Manager.
        URL mapping
        URL mappings were deprecated starting with HCL Portal Version 8.5. Instead, you can now use friendly URLs or Vanity URLs as an alternative to URL mapping.
        HTTP proxy configuration
        Some portlets use HCL Portal resources to support HTTP proxy. Loading and caching remote URLs (such as RSS streams or HTML files) is done in the portal by the URL Manager service. If you specify an HTTP proxy in the configuration of the service, all remote requests are loaded using this HTTP proxy. This feature enables servers behind a firewall with no direct access to the Internet to load external data, such as news or stock information.
        Delayed cleanup of deleted portal pages
        Get an overview of the cleanup service for portal pages and their dependent resources.
        Deleting orphaned data
        You use the SLCheckerTool to delete orphaned data in the database.
        Setting service configuration properties
        HCL Digital Experience comprises a framework of services to accommodate the different scenarios that portals need to address. Services are available for both HCL Portal and HCL Web Content Manager. You can configure some of these services.
        Overview of configuration services
        Get an overview of the HCL Portal configuration services available for the portal.
        Portal service configuration
        HCL Portal comprises a framework of configuration services to accommodate the different scenarios that portals of today need to address. You can configure some of these services.
        Administrator Unique Names Mapping Service
        Administration portlets and themes create URL links to other administration portlets and pages. If these links were hardcoded, they would no longer be usable if you changed the unique names of these pages. Therefore a service for obtaining those unique names is provided in the portal Administrator Unique Names Mapping Service. This service contains properties with key-value pairs that map internal keys to the actual unique names that are assigned to the referenced pages.
        Cache Manager Service
        The portal Cache Manager Service is responsible for managing the different caches that are used in HCL Portal.
        Common Component Configuration Service
        You can use the Common Component Configuration service to configure the behavior of the common components framework, the enabler widget container, and the client-side APIs.
        Configuration Service
        The portal Configuration Service is responsible for collecting the most essential configuration data of the HCL Digital Experience engine.
        CP Configuration Service for tagging and rating
        The CP Configuration Service provides the properties for tagging and rating.
        Content Access Service
        Portlets can access content from remote systems that are located on the other side of a firewall by invoking the portal Content Access Service. If you configure properties of the Content Access Service, these settings applies only to the portlets that call this service.
        Data Store Service
        HCL Portal uses a database to store configuration data for pages, clients, markup, and all other resources. The Data Store Service is responsible for managing the data source of the portal as configured while installing HCL Portal.
        Deployment Service
        The portal Deployment Service provides services for accessing the configuration properties that are required for the portlet deployment. The portlet deployment component is responsible for the integration of portlets into the portal. It handles the correct deployment of portlet applications and their WAR files into HCL Portal and WebSphere Application Server. It uses the WebSphere Application Server management services for the physical deployment and management of WAR files in the WebSphere Application Server. Management of WAR files includes installing, removing, redeploying, starting, and stopping portlet applications.
        HTTP Client Service
        Several components of the portal need to open HTTP or HTTPs connections to other resources. The portal HTTP Client Service provides a central point for configuration properties to these outbound connections. You can set global properties for the SSL configuration and proxy server usage.
        Live Object Service
        You can use the Live Object configuration service to configure the behavior of the live object framework.
        Loader Service
        The portal Loader Service is responsible for dynamically loading class files. The service does so by looking up a given class name in different packages. Upon loading the respective class file, an instance of that class is returned.
        Localizer Service
        The portal Localizer Service provides access to the configured default locale and the system default locale. It also provides a list of supported bidirectional languages. Giving the system default locale is necessary because Locale.getDefault() is set to the default.
        Mail Service
        The portal Mail Service allows you to configure the properties that are used by the feature Enable sending email to new members for composite application communities.
        Model WebDAV Service
        The WP Model WebDAV configuration service provides parameters that the portal uses during theme creation. Changing the values for these parameters only affects future theme instances, but leaves existing theme instances unchanged.
        Navigator Service
        The portal Navigator Service allows you to specify a number of settings; among these are properties for cache scope and cache expiration. Depending on your configuration, you might be able improve your performance by modifying these properties.
        Portal Security Services
        HCL Portal provides several configuration services for authentication, Portal Access Control, and Portal User Management (PUMA).
        Portlet Container Service
        The portal Portlet Container service provides properties for portlet filtering.
        Project Identification Service
        The Project Identification Service provides access to the identifier for a currently selected project in HCL Web Content Manager. Projects enable you to make changes to a set of items and publish those changes at the same time.
        Registry Service
        The portal Registry Service loads and caches a few objects that are regularly accessed in the engine. This service improves performance. However, the trade-off is that the cached objects can be stale compared to their database counterparts. This service applies particularly in a cluster environment.
        State Manager Service
        The portal State Manager Service is the access point for managing the navigational state of the portal. The navigational state represents the current view of portal resources as displayed to a user.
        Virtual Portal Configuration Service
        The Virtual Portal configuration service (WP VirtualPortalConfigService) enables you to specify properties for the default virtual portal and for specific virtual portals. Refer to the Property names section for details about the portal settings this configuration supports.
        Web Content Manager service configuration
        Configuration services for HCL Web Content Manager contain settings for the general operation of the web content system, including settings for messaging, pre-rendering, and searching.
      - Changing ports
        One can change the HCL Digital Experience port numbers assigned to DX Portal Server after installation.
      - Changing your site URL
        You can change your site URL during and after installation to create URLs that are more reflective of your site and easier to remember. If you entered a different value for the context root during installation, there are additional steps that must be performed to implement the new context root value in your site URL. If you decide to change your site URL after installation, you can use the Configuration Wizard to remove the context root and default home values (/wps/portal) from your site URL or to change these values. You can also use the Configuration Wizard to remove or add navigational state information to your URL.
      - Changing the portal URI after an installation
        You can change the default portal Uniform Resource Identifier (URI) any time after you install HCL Digital Experience. Some applications have a fixed context root that cannot be changed.
      - 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.
      - Create an HCL Portal profile
        During the installation process, the IBM Installation Manager creates the HCL Portal profile. If you are on HCL Portal Version 8.5 without a Combined Cumulative Fix applied, then you can use this option in the Configuration Wizard to create an additional profile.
      - Remove an HCL Portal profile
        Use the Configuration Wizard to remove a portal profile.
      - Managing your HCL Portal environment
        After you install HCL Digital Experience, you can use the IBM Installation Manager function to manage your environment. The Installation Manager function consists of updating and modifying the environment. You can also uninstall or roll back the modifications you made to your environment.
      - Setting up and maintaining a portal farm
        The term "farm" refers to a series of identically configured, stand-alone server instances. The stand-alone servers allow the farm to be increased or decreased without having to worry about complex cluster configurations or inter-server awareness. Server farms offer a simple way to build and maintain a highly scalable, highly available server environment. Creating the farm requires an established content subscriber, two or more installed instances of HCL Digital Experience, and a configured web server for load balancing. The farm documentation covers only the HTTP server plug-in. However, you can use any supported web server.
      - Configuring the IBM License Metric Tool | HCL Digital Experience
        IBM License Metric Tool monitors license compliance. It recognizes and monitors what product offerings and their versions, releases, and fix packs are installed and used on the system. It measures the processor value units (PVU) available to and used by these assets. The tool ensures compliance with IBM® subcapacity licensing requirements and to demonstrate good IT governance. Information about installed software is collected from monitored computers by an agent that can be deployed on a range of operating systems. It is stored on a central server in a DB2® database and can be accessed through pre-configured reports that are available from a web user interface.
      - Upgrading your existing product offering
        After your initial HCL Digital Experience installation, you can purchase a license for an upgraded product offering.
    - 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.
    - 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 Portal Search to search for text that is displayed in websites that are created by HCL Web Content Manager.
    - 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 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.
  - 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.

Portal service configuration | HCL Digital Experience

HCL Portal comprises a framework of configuration services to accommodate the different scenarios that portals of today need to address. You can configure some of these services.

The configuration for each service is stored in and accessible for configuration through the WebSphere® Integrated Solutions Console. In the WebSphere® Integrated Solutions Console, the portal configuration services are spelled as one word, for some services abbreviated, and preceded by the letters WP. Example: In the WebSphere® Integrated Solutions Console, the portal Configuration Service is listed as WP ConfigService. For more information about how to set properties see the topic about Setting service configuration properties.

Notes:

The following topics describe the services that can be of interest to the portal administrator. Services that are not described in the following are purely for portal internal usage. Do not modify them in any way.
The following topics describe the portal services and their configuration properties. In these lists, the values given in parentheses are the default values. Properties given with a value of <none> have no default values.
You configure the portal configuration services in the WebSphere® Integrated Solutions Console. You cannot set the service configuration properties by simply changing the property value in the properties file and restarting the portal.
For details about how to export a configuration from an existing portal and import it to another portal, refer to the documentation about the portal XML configuration interface.