Configuration Wizard | HCL Digital Experience
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.
In the Configuration Wizard, you answer questions about the environment that you are configuring. Based on your answers, the wizard prompts you for custom values that are needed to configure your environment. Finally, the wizard generates custom steps and scripts to set up your environment.
Video: HCL Portal - How to Access ConfigWizard
Configuration options in the Configuration Wizard
Using the following configuration options, you can configure the portal server that you are connected to in real time. You can also download scripts and instructions to run on other servers, create reusable scripts for common configuration patterns, and create scripts to compare to scripts created in previous releases.
- Database Transfer
- Select this option to transfer data from Apache Derby to any of the database types that are supported by
HCL Portal.
- This option is found in Set Up a Stand-alone Server and in Set Up a Cluster.
- Documentation resource: Database transfer
- Documentation resource: Troubleshooting: Database Transfer
- Enable Federated Security
- Add an LDAP user registry to the default federated repository
to store user account information for authorization.
- This option is found in Set Up a Stand-alone Server and in Set Up a Cluster.
- Documentation resource: Enable federated security
- Documentation resource: Troubleshooting: Enable federated security option
- Shorten Site URLs for Search Engine Optimization
- Use the Configuration Wizard to change or remove /wps/portal (context
root and default home values) to create shorter, human-readable URLs. Select an
option to remove navigational state information from site URLs.
- This option is found in Set Up a Stand-alone Server and Set Up a Cluster.
- Documentation resource: Configuration Wizard instructions: Modify site URLs for search engine optimization
Note: The Configuration Wizard is not used to shorten site URLs for Search Engine Optimization on Kubernetes platforms. Refer to the Customizing the HCL DX URL when deployed to container platforms topic for more information. - Create a Deployment Manager
- Create a deployment manager profile that is augmented
with HCL Portal resources.
- This option is found in Set Up a Cluster.
- Documentation resource: Create a deployment manager
- Documentation resource: Troubleshooting: Create a deployment manager
- Create a Cluster
- Use the Configuration Wizard to create the primary node
in your cluster.
- This option is found in Set Up a Cluster.
- Documentation resource: Create a cluster
- Documentation resource: Troubleshooting: Create a cluster option
- Create an Additional Cluster Node
- Use the Configuration Wizard to add nodes to a cluster.
- This option is found in Set Up a Cluster.
- Documentation resource: Create an additional cluster node
- Documentation resource: Troubleshooting: Create an additional cluster node
- Install and Uninstall Add-ons
- You can install add-on functionality to your HCL Portal with the solution installer through the Configuration
Wizard.
- This option is found in Add On New Capability.
- Documentation resource: Install and uninstall add-ons using the Configuration Wizard
- Migrate a Stand-alone Server
- Use the Configuration Wizard to migrate a
stand-alone server environment.
- This option is found in Migrate to a New Version.
- Documentation resource: Migrate a stand-alone server
- Documentation resource: Troubleshooting: Migrate a stand-alone server
- Migrate a Cluster Step 1: Migrate the Deployment Manager Profile
- Use the Configuration Wizard to migrate the deployment manager
profile for a cluster environment. These
steps must be completed before you start the migration of any nodes.
- This option is found in Migrate to a New Version.
- Documentation resource: Cluster: Migrate the deployment manager profile
- Documentation resource: Troubleshooting: Migrate the deployment manager profile for a cluster environment
- Migrate a Cluster Step 2: Migrate Node Profiles
- Use the Configuration Wizard to upgrade the node profiles for
a cluster environment. These
steps must be completed on all portal nodes in the cell before you
begin the next cluster migration step.
- This option is found in Migrate to a New Version.
- Documentation resource: Cluster: Migrate node profiles
- Documentation resource: Troubleshooting: Migrate node profiles for a cluster environment
- Migrate a Cluster Step 3: Upgrade Node Profiles
- Use the Configuration Wizard to upgrade the nodes profiles
for a cluster environment. Start
these steps only after you migrate node profiles on all portal nodes
in the cell.
- This option is found in Migrate to a New Version.
- Documentation resource: Cluster: Upgrade node profiles
- Documentation resource: Troubleshooting: Upgrade node profiles for a cluster environment
- Recycle a Managed HCL Digital Experience Cell
- Select this option to recycle the deployment manager and node
agents. This configuration option runs the action-cluster-recycle-dmgr task.
- This option is found in More Options.
- Remove the HCL Digital ExperienceProfile
- Use the Configuration Wizard to remove a portal
profile.
- This option is found in More Options.
- Documentation resource: Remove an HCL Portal profile
- Documentation resource: Troubleshooting: Remove an HCL Portal profile
Configuration Wizard and clusters
In clustered environments, you can use the Configuration Wizard from the primary node. You can use the scripts from the primary node on the other nodes. You do not need to deploy the Configuration Wizard to the deployment manager.
Configuration Wizard profile
The wizard has a unique profile, cw_profile, and administrator credentials.