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.
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.
Preparing your source environment
Before you begin the steps for migration, you must perform some critical tasks on your source environment, such as creating back ups, installing the latest cumulative fix and one of the two most recent fix packs, and disabling automatic synchronization if you are migrating a cluster. Review the topics in this section, and perform the required tasks to ensure that your source environment remains functional and the migration completes successfully.
Prepare UX Screen Flow Manager
If you are migrating from Version 8.0.0.1 with the UX Screen Flow Manager (UXFM) enabled, then you must remove the dialog definitions, and then uninstall UXFM before you migrate to Version 8.5. Before you remove the dialog definitions and uninstall UXFM, it is highly recommended that you export your dialog definitions, and when migration is complete, you can import your dialog definitions into your upgraded system. If you do not export your dialog definitions, then your data will be lost.
Removing UXFM dialog definitions
Remove the UX Screen Flow Manager (UXFM) dialog definitions before uninstalling UXFM. This is a required step before you uninstall UXFM.

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.
  - 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.
    - Overview
      Migration is the process of collecting configuration data and applications from an earlier installed version of HCL Digital Experience and merging them into a newer installed version. So that the new environment is identical to the earlier environment. For the z/OS® platform, the new version must be on the same server as the earlier version. Migration to a different (remote) server is not supported.
    - Planning for migration
      Completing a thorough plan before migrating to the latest version of HCL Digital Experience has a direct impact in the effort invested during the actual migration. Become familiar with the environment you are migrating to (target environment). Also, make sure that the environment you are migrating from (source environment) is up to date with fixes and meets the requirements for migration.
    - Preparing your source environment
      Before you begin the steps for migration, you must perform some critical tasks on your source environment, such as creating back ups, installing the latest cumulative fix and one of the two most recent fix packs, and disabling automatic synchronization if you are migrating a cluster. Review the topics in this section, and perform the required tasks to ensure that your source environment remains functional and the migration completes successfully.
      - Clean up your source profile
        During the migration, your source profile is exported. Basically, this export copies your profile to a back up folder. To speed up the process and prevent failures, delete or move unnecessary files from the profile folder.
      - Install fix packs on the source environment
        Periodically fix packs are released to integrate product code fixes. Between fix pack releases, there are interim fixes to ensure product reliability and stability. You must apply the latest cumulative fix to the source environment. The Recommended fixes link provides links to fix pack and interim fix downloads. There is also information about what is recommended and what is required.
      - Verifying property files
        Ensure that the existing portal environment is at the appropriate service level for migration.
      - Backing up the system
        Make sure that you have a current backup and recovery policy before you alter the source environment. Follow the instructions in the Backup and restore section to ensure that you cover all the affected assets.
      - Disabling automatic synchronization to protect your clustered source environment
        The target environment initially uses the same ports as the source environment. There are three important steps you must complete to ensure that the source and target environments do not become corrupted.
      - Verifying that WebSphere Application Server Trust Association Interceptor is enabled
        The automated migration of the HCL Portal profile requires that the Trust Association Interceptor (TAI) is enabled so that you can configure content in WebDAV during migration.
      - Preparing Web Content Manager content
        To migrate HCL Web Content Manager data, you must remove the locks on content and rename the content libraries.
      - Migrating search components
        The search components in your source portal might require preparation steps and then extra steps on the target portal.
      - Migrating from a 32-bit source environment to 64-bit target environment
        The 32-bit Portal installation is no longer supported in HCL Digital Experience 8.5. If you are migrating from a 32-bit source environment to a 64-bit Version 8.5 environment, you need to take extra steps to ensure that the WASPreMigration task completes successfully.
      - Prepare UX Screen Flow Manager
        If you are migrating from Version 8.0.0.1 with the UX Screen Flow Manager (UXFM) enabled, then you must remove the dialog definitions, and then uninstall UXFM before you migrate to Version 8.5. Before you remove the dialog definitions and uninstall UXFM, it is highly recommended that you export your dialog definitions, and when migration is complete, you can import your dialog definitions into your upgraded system. If you do not export your dialog definitions, then your data will be lost.
        Exporting UXFM dialog definitions
        Export and save your dialog definitions before you migrate to Version 8.5.
        Removing UXFM dialog definitions
        Remove the UX Screen Flow Manager (UXFM) dialog definitions before uninstalling UXFM. This is a required step before you uninstall UXFM.
        Uninstalling UX Screen Flow Manager
        If you are migrating from Portal 8.0.0.1 with the UX Screen Flow Manager (UXFM) enabled, then you must uninstall UXFM before migrating to Version 8.5.
      - Removing HCL Commerce integration
        If you have HCL Commerce integrated with HCL Digital Experience, you must remove HCL Commerce from your source portal profile before you begin migration.
      - Removing unsupported composite applications
        Composite applications are no longer supported. If you have a composite application in your system and you migrate to Version 8.5, the migration fails. Ensure that all composite applications are deleted before you start the migration. When you delete a composite application, you must also run the resource cleaner, otherwise pages can still exist in the database.
      - Removing obsolete portlets from virtual portal scripts
        Some portlets were deprecated or removed in this release. If you have references to deprecated or removed portlets in your virtual portal scripts, you must manually remove those references.
      - Distinguished names
        If you are using LDAP in your source environment, make sure that the wkplc.properties file is properly configured. You might have a configuration that is working, but it might not be supported after migration. Short distinguished names (DN) are not supported. Make sure that the properties files in your source environment are set with the fully qualified distinguished names.
      - Maximum open file descriptors for Unix-based platforms
        For Unix-based platforms, the default open file descriptor must be set to 200000 to allow the Configuration Wizard commands to run properly during migration.
      - Disabling wsadmin client debug
        If you use either IBM® WebSphere® Application Server Version 8.5.5.4 or WebSphere Application Server Version 8.5.5.5, disable the wsadmin client trace to avoid a failure.
    - Setting up the target environment
      The migration requires you to install the required Portal and WebSphere® binary installations. To prepare your target environment, ensure that you have applied the latest cumulative fix and the most recent fix pack before you start migration. In addition, create new copies of the source databases for the target environment to use, and prepare the target environment for any custom applications that have dependencies or any other tasks that need to be performed for remote or cluster migrations.
    - Migrate data using the configuration wizard
      For Version 8.5, data, applications, databases, property files, security settings, and configuration are migrated using the Configuration Wizard. Use the roadmaps for cluster and stand-alone environments to guide you through the process.
    - Next steps
      To complete migration, you must first perform several post-migration steps that depend on how Portal is being used. After completing the post-migration steps, review the Enabling new functionality section to take advantage of the new tools available in HCL Digital Experience 8.5. Enabling new functionality should not be started until all post-migration steps have been completed.
  - 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.

Removing UXFM dialog definitions | HCL Digital Experience

Remove the UX Screen Flow Manager (UXFM) dialog definitions before uninstalling UXFM. This is a required step before you uninstall UXFM.

Procedure

Save the following example of code as RemoveSampleCode.xml to use to remove your dialog definitions.

<?xml version="1.0" encoding="UTF-8"?>
<request type="update" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="PCM_1.0.xsd">

    <!-- remove all dialog definitions that are currently deployed -->
    <portal action="delete">
       <dialog-set>
            <dialog name="*" />
        </dialog-set>
    </portal>
</request>

Run the following task from the wp_profile_root/PortalServer/bin directory to remove your dialog definitions:
- AIX® HP-UX Linux™ Solaris: ./xmlaccess.sh -user userID -password password -url http://local_host:local_port/wps/config -in RemoveSampleCode.xml -out delete.xml
- IBM® i: xmlaccess.sh -user userID -password password -url http://local_host:local_port/wps/config -in RemoveSampleCode.xml -out delete.xml
- Windows™: xmlaccess.bat -user userID -password password -url http://local_host:local_port/wps/config -in RemoveSampleCode.xml -out delete.xml
- z/OS®: ./xmlaccess.sh -user userID -password password -url http://local_host:local_port/wps/config -in RemoveSampleCode.xml -out delete.xml