Home
HCL Digital Experience 9.5 [Legacy content]
Administering
Use the administration tools that are provided with the HCL Digital Experience to do various day-to-day administration tasks.
Managing your cluster
After installing and configuring your clustered environment, you will need to manage the different parts of your cluster to ensure a highly available production environment.
Managing portlets in your cluster
Because all HCL Portal servers in the cluster share the same database, any node can be used to manage portlets. Cluster nodes can run when you are managing portlets. When you deploy a portlet, HCL Portal stores the portlet configuration data in the HCL Portal database. Then, HCL Portal forwards the portlet application's web module and associated configuration to the deployment manager. The deployment manager is responsible for pushing the web module to each node in the cluster.
Changing the authentication mode for portlet deployment
HCL Digital Experience provides two user authentication modes that the Portlet Deployment Manager can use to authenticate with the IBM WebSphere Application Server administrative services when security is enabled.

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.
- 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.
  - Roadmap: Syndication
    Syndication is the tool that is used to replicate data from a web content library on one server to a web content library on another server. The relationship between a syndicator and a subscriber can be either a one-way or two-way relationship.
  - Portal administration tools
    Learn about the different tools that you can use to administer your portal.
  - Web content administration tools
    HCL Web Content Manager includes tasks and tools to help maintain your content management system. For example, use the member fixer task to resolve renamed or deleted users and user groups. Use the workflow checker and updater tools to modify workflow security settings, reschedule pending actions, and add workflow to items. Web Content Manager also includes tools to assist with library and item management, and item and version history management.
  - Starting and stopping servers
    Various installation and configuration tasks require you to start and stop IBM WebSphere Application Server and the HCL Digital Experience application servers, deployment managers, and node agents.
  - Users and groups
    HCL Digital Experience offers you centralized administration of users and user groups, allowing you to better define users and manage user access rights. Users can register and manage their own account information, or an administrator can provision and manage users. Group memberships can be used to give the required permissions to access an object or perform a request.
  - Managing portlets, portlet applications, and iWidgets
    You must do some preparatory tasks before you make your portlets, portlet applications, or iWidgets available to your users by putting them on portal pages. This preparatory task includes installing, deploying, and configuring portlets, applications, and iWidgets.
  - Administering managed pages
    You can run advanced administration tasks for managed pages, such as generating URLs for projects or working with projects by using scripts, or working with vanity URLs.
  - Manage pages portlets
    Use Manage Pages to create, edit, activate, order, and delete pages and external web pages and labels.
  - Managing theme capabilities
    You can administer the theme module framework. This includes deploying resources that can be cached, configuring capability filters, and disabling the automatic prerequisite loading feature.
  - Managing community pages
    Community associations associate a portal page with a community in HCL Connections.
  - Managing your cluster
    After installing and configuring your clustered environment, you will need to manage the different parts of your cluster to ensure a highly available production environment.
    - Determining application sharing between clusters
      If applications are shared between clusters, there are maintenance implications. An application definition is cell-scoped, meaning that a single application can be used by any server running on any node within the cell. The relationship between an enterprise application and the server where it runs is called a mapping. For a cluster to run an instance of an application, the application must be mapped to that cluster. An application that is shared between multiple clusters has multiple mappings.
    - Managing portlets in your cluster
      Because all HCL Portal servers in the cluster share the same database, any node can be used to manage portlets. Cluster nodes can run when you are managing portlets. When you deploy a portlet, HCL Portal stores the portlet configuration data in the HCL Portal database. Then, HCL Portal forwards the portlet application's web module and associated configuration to the deployment manager. The deployment manager is responsible for pushing the web module to each node in the cluster.
      - Multiple cluster portlet deployment
        Although portlets are a type of enterprise application, portlet deployment is typically done through HCL Portal. If done directly to WebSphere Application Server, HCL Portal must be notified. HCL Portal maintains configuration information that is extracted from the portlet descriptor (portlet.xml) during portlet deployment.
      - Deploying portlets common across clusters
        You can deploy portlets as a standard EAR through the Deployment Manager and then notify each cluster. A predeployed application can only be updated by updating the EAR file in IBM WebSphere Application Server and subsequently updating the contained WAR file by using the XML configuration interface. Cross updates of a predeployed EAR file with a real WAR and vice versa are not possible. You can also install it as a standard portlet within one cluster, then map the underlying enterprise application to the other cluster and use the XML configuration interface to notify the other cluster members. For simplicity and ease of administration, common portlet applications should be administered as standard EARs first, so there is no need to remember which cluster owns the original deployment.
      - Changing the authentication mode for portlet deployment
        HCL Digital Experience provides two user authentication modes that the Portlet Deployment Manager can use to authenticate with the IBM WebSphere Application Server administrative services when security is enabled.
      - Deleting portlets common across clusters
        You can use the XMLAccess task to delete a portlet common across clusters. If the portlet was predeployed as a standard EAR, then each cluster must be first notified of the portlet removal before the EAR can be uninstalled. The administrator must use the XMLAccess application to import a <web-app> definition similar to the ones used in the previous two sections, except the action is to delete the definition instead of update it.
      - Multiple clusters: deploying portlets unique to a cluster
        You can deploy portlets that are unique to a multiple cluster environment using the Portal Administration User Interface or the XML Configuration Interface.
      - Updating portlets common across clusters
        You can use the Deployment Manager or the XML configuration interface to update portlets. If the portlet was predeployed as a standard EAR, then only the EAR needs to be updated through Deployment Manager and the results synchronized to every cluster to which this application is mapped. If a portlet configuration is being updated, for instance with new access control definitions or configuration parameter values, then the XML configuration interface must be used to update every cluster's configuration with this same information. In this case you would use an updated <web-app> element.
      - Applying updates to custom applications
        For customer-written portlet applications that are predeployed as standard EARs and then configured within each cluster using XMLAccess, use the same update procedure as used for portlet applications provided with HCL Digital Experience.
    - Managing replication in your cluster
      IBM WebSphere Application Server provides a replication service. This service transfers data, objects, or events among application servers. Data replication can be used to make data for session manager, dynamic cache, and stateful session beans available across many application servers in a cluster.
    - Managing Portal Scripting Interface in your cluster
      The Portal Scripting Interface enables the creation of administrative tasks that administrators can run from a command line. You must prepare your cluster to manage Portal Scripting Interface.
    - Managing Single sign-on settings in your cluster
      If you configured the nodes in your cluster to use single sign-on (SSO), you can change the SSO settings for the cluster.
    - Updating Personalization properties in a cluster
      HCL Digital Experience provides two property files that you can modify to customize the Portal Personalization feature. These files are not managed by the deployment manager, so if you make any changes to these files on a node in the cluster, those changes are not transferred to other nodes when you perform a synchronization of the cluster members.
  - Managing your site
    Earlier versions of HCL Digital Experience provided the Resource Manager portlet for performing site management. With Version 8.0 of HCL Portal and HCL Web Content Manager, this site management functionality has been replaced by the new functionality for managing pages.
  - Tagging and rating
    Get an overview of the administrative tasks related to tagging and rating.
  - Using WebDAV with HCL Portal
    HCL Digital Experience provides a Web-based Distributed Authoring and Versioning (WebDAV) implementation that individual services can use by plugging into. WebDAV is a set of extensions to the HTTP protocol that allows you to collaborate on editing and managing files on remote Web servers.
  - Virtual portals
    View information on how you can scope your HCL Portal to have multiple virtual portals.
  - Language support
    To reach as many users as possible, HCL Digital Experience supports different languages for different locations. For instance, a large, international corporation might address users in different countries or regions through multilingual Web sites. In this context the portal can concurrently serve portal views to large numbers of users, each in the user's preferred language.
  - WSRP services
    By using the Web Services for Remote Portlets (WSRP) standard. HCL Digital Experience can provide portlets, applications, and content as WSRP services.
  - Browser behavior and scenarios
    Browser behavior for the back button, bookmarks and history affect user interaction and cause unexpected results.
- 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.

Changing the authentication mode for portlet deployment

HCL Digital Experience provides two user authentication modes that the Portlet Deployment Manager can use to authenticate with the IBM WebSphere Application Server administrative services when security is enabled.

The authentication modes are specified by the use.admin.user property in Deployment Service. The following two methods are supported in both a standalone or clustered environment.

Single ID method (use.admin.user=true): This is the default mode. In this mode, HCL Portal impersonates the server ID (see https://www.hcltechsw.com/wps/portal/about/welcome for additional information) for WAR deployment requests.
Multiple ID method (use.admin.user=false): Use the login ID of the user who issued the WAR deployment request. In this mode, every user with portlet deployment access rights must be added to the WebSphere® Application Server Console User list with Administrator access rights. Alternatively, you can add the Group of Administrators to the WebSphere® Application Server Console Group with Administrator access rights.

The main difference between the two methods is that the single ID method uses a preset ID regardless of who you log in as while the multiple ID method uses the ID you logged in with but you cannot deploy a portlet unless your ID is added to the WebSphere® Application Server Console Group with Administrator access rights.