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 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.
CP Configuration Service for tagging and rating
The CP Configuration Service provides the properties for tagging and rating.
Properties for the rating widget
View the properties for the rating widget.

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.
    - 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 provides a portal light mode which can improve portal startup time and reduce the 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 Portal and HCLWeb Content Manager Performance Tuning Guide which provides more information about caches for both HCL Portal and HCL 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.
        General properties for tagging and rating
        View the general properties for tagging and rating.
        Properties for the tag widget
        View the properties for the tag widget.
        Properties for the rating widget
        View the properties for the rating widget.
        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
      You can change the HCL Digital Experience ports values after installation if there are port conflicts with other cells on the system.
    - 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 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.

Properties for the rating widget | HCL Digital Experience

View the properties for the rating widget.

Note: The parameters listed here are specific to the inline rating widget that was introduced with HCL Portal Version 8.5. For information about the earlier widgets and their parameters, read the appropriate topics in the HCL Portal Version 8.0 product documentation.

com.ibm.wps.cp.rating.inline.customLabel

Use this property to specify a non-localized custom label to describe the displayed ratings. This property has no default.

com.ibm.wps.cp.rating.inline.numStars = (5)

Use this property to specify the number of stars or asterisks of which a rating consists. Specify a positive numeric value. The default value is 5. Do not specify a value larger than the value specified for the property com.ibm.wps.cp.rating.maxratingvalue in the WP CP configuration service for tagging and rating. For more information about this property, read General properties for tagging and rating.

com.ibm.wps.cp.rating.inline.privateRatingEnabled = (false)

Use this parameter to enable private rating. To enable private rating, set this parameter to true. The default value is false.

com.ibm.wps.cp.rating.inline.ratingScope = (COMMUNITY_PERSONAL_PUBLIC)

Use this property to specify the scope of ratings that you want to show in this inline widget. Specify one of the following values:

COMMUNITY_PERSONAL_PUBLIC|PERSONAL_PUBLIC|PERSONAL_PRIVATE

If you do not specify a value, the property defaults to COMMUNITY_PERSONAL_PUBLIC.

com.ibm.wps.cp.rating.inline.ratingDesc

Use this property to specify the rating description that you want to show in this rating widget. By default, this property is not part of the rating widget. If you add this property to the rating widget, the default value is ALL. Specify one of the following values:

RATING_VALUE: With this value, the rating description includes only the numerical rating value.
TOTAL_NO_RATING: With this value, the rating description includes only the total number of ratings assigned.
ALL: With this value, the rating description includes both the numerical rating value and the total number of ratings. This is the default value if you add the com.ibm.wps.cp.rating.inline.ratingDesc property to the rating widget.
NONE: If you do not specify a value, the rating description is not displayed at all.