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.
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.
Updating your user registry
After you deploy HCL Digital Experience, you can adjustment your federated user repository configurations. You can update these configurations to achieve the correct user registry configuration.
Updating an entity type
After you add your user registry, you can update a single entity type with the value of the default parent. For example, if you delete a repository, you must update the entity type if it points to the deleted repository.

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.
    - 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.
      - Enable federated security
        You can use the Configuration Wizard to configure HCL Portal to use a federated LDAP for security. Use the following information to get familiar with the information you must provide in the wizard and the configuration procedure that it generates.
      - Adding more attributes to VMM
        After you install HCL Digital Experience and configuring your LDAP user registries, you must adapt the attribute configuration to match the configured LDAP servers and your business needs. However, do not complete these steps if you configured only a database user registry or the default federated file-based repository for out-of-box installations.
      - Enabling application groups
        You can define user groups within the database user registry with members (users or groups) contained in the federated LDAP user registry you configured with application groups. The benefit of application groups is that you can create groups that are only used in HCL Digital Experience.
      - Advanced group configurations
        It is possible to use HCL Digital Experience ConfigEngine helper tasks to set up advanced Virtual Member Manager (VMM) group configurations. Specifically, it is possible to configure VMM to understand and use the "Group membership attribute" that many directories support.
      - Adding a database user registry
        Add a database user registry to the default federated repository to store user account information for authentication and authorization. You can add multiple database user registries to the default federated repository although you can add only one database user registry at a time.
      - Adding realm support
        A realm is a group of users from one or more user registries that form a coherent group within HCL Digital Experience. Realms allow flexible user management with various configuration options. A realm must be mapped to a Virtual Portal to allow the defined users to log in to the Virtual Portal. When you configure realm support, complete these steps for each base entry that exists in your LDAP and database user registry to create multiple realm support.
      - Updating your user registry
        After you deploy HCL Digital Experience, you can adjustment your federated user repository configurations. You can update these configurations to achieve the correct user registry configuration.
        Updating the context pool configuration
        After you configure your LDAP user registry, you can adjust the number of context instances that the context pool concurrently maintains to improve performance.
        Creating the entity type
        If an entity type exists within HCL Digital Experience but not within your LDAP user registry, create the entity type within your LDAP user registry. Then, add the relative distinguished name (RDN) to the entity type to map it between HCL Portal and your LDAP user registry.
        Changing from a stand-alone repository to a federated repository
        If you originally configured a stand-alone LDAP user registry but require a robust security configuration, you can change to the federated user repository.
        Restoring the VMM setup with a federated file repository
        If your business changes or your user registry configuration is inoperable, run the wp-restore-default-repository-configuration task to restore the default VMM setup with a federated file repository. Then, reconfigure your user registry. The task deletes all existing repositories, creates a realm, and configures a file repository in VMM. The task also creates a user and group, which is set to the HCL Digital Experience administrator.
        Updating an entity type
        After you add your user registry, you can update a single entity type with the value of the default parent. For example, if you delete a repository, you must update the entity type if it points to the deleted repository.
        Updating the base entry
        After you create your base entries, you can update the distinguished name (DN) in the repository that uniquely identifies the base entry name. This task applies only to federated repository configurations. This task does not update the base DN entry if you use a stand-alone repository.
        Updating the database user registry
        After you create and use the database user registry, you can update the database user ID, password, and where the data is stored. This task does not change the DN structure that is stored in the database repository.
        Updating a group member
        After you create your LDAP user registry, you might find that your group member is not correct. You can update the group member in your LDAP user registry configuration.
        Updating the federated LDAP user registry
        After you create and use the LDAP user registry in the default federated repository, you might find that your LDAP user registry is not working correctly. You can update the LDAP user registry and make the necessary changes. For example, you can change your LDAP Bind password.
        Updating the realm configuration
        After you create and use the realm in the default federated repository, you might find that your realm configuration is not working correctly. You can update the realm configurations and make the necessary changes.
        Configuring a property extension database
        A property extension database stores attributes that the LDAP directory does not or cannot store, but that you want to include in your portal user registry. This situation often occurs when you are using an LDAP directory that does not allow schema extensions for new attributes to support portal applications. When you configure a property extension database, you effectively extend the user registry to make new attributes available as part of your portal user profile. However, it is preferable to store all user attributes in the main user registry. Complete this task only if you cannot add attributes to your LDAP directory.
      - Deleting your user registry configurations
        After you deploy HCL Digital Experience, you might not require some of the LDAP entity types, realms, realm base entries, or repositories that you created. You can delete these configurations to achieve the correct user registry configuration.
      - Setting limits on searches for users and groups
        Searching for users or groups is a time consuming task. A search may time out or return more results than the system can handle or the user may expect. To prevent this behavior, you can set limits on searches for users or groups.
      - LDAP search filter expressions
        The rules for rule-based user groups are based on the LDAP search filter syntax.
    - 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.

Updating an entity type | HCL Digital Experience

After you add your user registry, you can update a single entity type with the value of the default parent. For example, if you delete a repository, you must update the entity type if it points to the deleted repository.

Before you begin

In a stand-alone server environment, you can complete the following task when the servers are either stopped or started. In a clustered environment, start the deployment manager and node agent. Then, verify that they are able to synchronize.

Procedure

Open a UNIX System Services (z/OS UNIX System Services) command prompt.
Note: If you are instructed to open a properties file, they are ASCII files. Open them with the appropriate tool.
Go to the wp_profile_root/ConfigEngine/properties directory.
Open the wkplc.properties file with a text editor.
Enter a value for the following parameters under the VMM supported entity types configuration heading:
Note: Go to the properties file for specific information about the parameters.
- entityTypeName
- defaultParent
- rdnProperties
Save your changes to the wkplc.properties file.
Open a command prompt.
Change to the wp_profile_root/ConfigEngine directory.
Run the following task to delete the old entity types before you add the RDN attribute as the only entry in the RDN list:
- AIX® HP-UX Linux™ Solaris: ./ConfigEngine.sh wp-set-entitytype -DWasPassword=password
- IBM® i: ConfigEngine.sh wp-set-entitytype -DWasPassword=password
- Windows™: ConfigEngine.bat wp-set-entitytype -DWasPassword=password
- z/OS®: ./ConfigEngine.sh wp-set-entitytype -DWasPassword=password
Run the following task to add an entity type to the existing list:
- AIX® HP-UX Linux™ Solaris: ./ConfigEngine.sh wp-update-entitytype -DWasPassword=password
- IBM® i: ConfigEngine.sh wp-update-entitytype -DWasPassword=password
- Windows™: ConfigEngine.bat wp-update-entitytype -DWasPassword=password
- z/OS®: ./ConfigEngine.sh wp-update-entitytype -DWasPassword=password
Stop and restart the appropriate servers to propagate the changes. For instructions, go to Starting and stopping servers, deployment managers, and node agents.