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.
Document Conversion Services
Document Conversion Services are used when you work with HCL Web Content Manager authoring, previewing, and search.
Enable Apache Tika for DX Search
Apache Tika for DX Search is supported and can be enabled in the Digital Experience 95 Cumulative Fix and Container CF205 release.

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.
    - 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.
      - Configure Document Conversion Services
        Learn how to configure the Document Conversion Services in HCL Portal. A knowledge of these prerequisites steps can assist you in preventing, identifying, and correcting problems that are related to Document Conversion Services.
      - Supported operating systems for document conversion services
        Some operating systems support running the DCS locally while others do not. The following table lists the operating systems and versions that support running the document conversion services. On operating systems that do not support running the DCS locally, document conversion must be done on a remote IBM WebSphere Application Server that supports document conversion services.
      - Setting up file type definitions to enable Document Conversion Services
        Set up file definition types to ensure that document conversions works for the Microsoft Office and OpenOffice file types.
      - Creating a backup of DCS files
        Document Conversion Services components in HCL Digital Experience software will be updated and replaced in 2022 in a subsequent HCL DX CF release. HCL Digital Experience will remove the third-party component, which is supplied by Oracle, that provides these capabilities and replace them with HCL supported functions. After that point, HCL Digital Experience v8.5, v9, and v9.5 CF releases will include the newer HCL supported component. Refer to the following HCL Digital Experience support Knowledge Article: Replacement of Document Conversion Services component in HCL Digital Experience software for additional information.
      - Using Document Conversion Services with Stellent
        For Linux and Solaris, when using Stellent version 8.1.0 and later, the X-server dependency has been removed.
      - Disable Oracle DCS
        Oracle DCS is disabled in the Digital Experience 95 Cumulative Fix and Container CF205 release.
      - Enable Apache Tika for DX Search
        Apache Tika for DX Search is supported and can be enabled in the Digital Experience 95 Cumulative Fix and Container CF205 release.
      - Configuring a remote Document Conversion Service
        To balance processing power, you can run document conversion services on a remote IBM WebSphere Application Server that supports document conversion services. Enabling the delegation of document conversion services to a remote server requires steps on both HCL Digital Experience and the remote server.
      - Files conversion supported by DCS
        View a list of file types that are supported by DCS for conversion.
    - 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.

Enable Apache Tika for DX Search

Apache Tika for DX Search is supported and can be enabled in the Digital Experience 95 Cumulative Fix and Container CF205 release.

Beginning with Digital Experience 95 CF205 release, Oracle DCS for DX Search Document Conversion Service is replaced with Apache Tika. Because of this change, when you upgrade to CF205, you must take a note of the DCS files backup scenarios:

If you are upgrading from CF202 or later, Oracle DCS files will be automatically backed up to your Digital Experience profile location and you can continue to utilize Oracle DCS for Search.
If you are upgrading from CF201 or earlier, you must manually back up your existing Oracle DCS files.

Don't have the backup of the Stellant files: Do not set the configureTika flag to false or run the manual tasks if you do not have the backup of the Oracle DCS files in your DX environment.

If you want to continue using the Oracle DCS for DX Search with Digital Experience CF205 or later upgrade, ensure that configureTika=false is configured in wkplc.properties before running the applyCF.sh|bat command or pass -DconfigureTika=false in the command line when running the applyCF.sh|bat command.

Enabling Tika manually

You can enable Tika manually anytime. For example, when you ran applyCF without setting the configureTika flag to false or if you enabled Oracle DCS for DX search but later on decide to use Tika, you can manually re-enable by performing the following steps:

Run the following ConfigEngine task:

ConfigEngine.sh|bat update-dcs-to-tika-search

Restart the WebSphere_Portal server:

./stopServer.sh|bat WebSphere_Portal -user <WAS ADMIN USER> -password <WAS ADMIN USER PASSWORD>

./startServer.sh|bat WebSphere_Portal

Disabling Tika manually

If after enabling Tika for DX Search, you prefer to use Oracle DCS, you can manually disable Tika for Search by running the following steps:

Run the following ConfigEngine task:
```
ConfigEngine.sh|bat update-dcs-to-stellent-search
```

Restart the WebSphere_Portal server:

./stopServer.sh|bat WebSphere_Portal -user <WAS ADMIN USER> -password <WAS ADMIN USER PASSWORD>

./startServer.sh|bat WebSphere_Portal