Skip to content

Pre-requisites

HCL DXClient

HCL DXClient is required for deployments. Follow the online guide on how to install HCL DXClient. Please note that the DX and/or DXClient link provided here may be superseded, you may use a newer version if available.

Please use the latest or at least the CF207 build of the DXClient Docker image. The DXClient in CF206 and later versions do not have the full functionality to support the sample codes in these tutorials. In some cases, the latest DXClient will still work with older DX Core versions.

If you have replaced the default context root of your DX installation, you should update the config.json file of your DXClient accordingly.

    "dxContextRoot": "/wps",
    "contenthandlerPath": "/wps/mycontenthandler",
    "xmlConfigPath": "/wps/config",

Node JS and NPM

Install a Long Term Support (LTS) version of Node.js.

Java Runtime Engine

Java Runtime Engine with a Long Term Support (LTS) version is needed to be able to run the Gradle wrapper in the DX Module projects. Java version 17 is recommended.

Script Application Placeholder

Add the 'Script Application Library' to the list of visible libraries in your DX Library Explorer. Follow the series of links via the Web Content menu: Preferences -> Edit Shared Settings. Don't forget to click on the OK button.
Web Content Edit Shared Settings Library Selection Script Application Library

Clone The Portal 8.5 Theme to form a Test Theme

The Portal 8.5 Theme is part of the HCL DX releases starting CF205. This theme has some out-of-the-box DX Modules to support ReactJS ScriptApps and will help out in basic deployments. There's no assurance that the steps detailed in this tutorial will work with versions prior to CF205, but you may try cloning an existing theme and then build and deploy your own DX Modules following these steps.

Copy the Portal 8.5 theme. Copy Theme Assign a name for the theme. Assign Name Status Click the Done button. Done Button

For Quick Build and Deploy, Use Out-Of-the-Box React Modules In your DX Theme

Skip this part if you're bundling and deploying your own shared libraries as a DX Module.

Out-of-the-box React modules is only available in HCL DX for release build starting CF205. You will not be able to do basic deployments for release builds prior to CF205, you will have to build your own DX Modules as part of the optimized builds procedure.

For standalone ScriptApps, make sure that the React modules that are delivered with DX images are included in the site's DX Theme profile. They are pre-configured only in the profile_deferred_react.json of the Portal 8.5 Theme. You will need to copy the module IDs over if you'll be using another DX Theme and profile combination.

  • "wp_react_16_10_2",
  • "wp_react_dom_16_10_2",
  • "wp_react_router_dom_512"

Select Theme Select Themes from the Practitioner Studio Menu.

Select Edit Theme Click Edit theme.

Edit the configured Module IDs in the theme profile