Boards for HCL Digital Experience (DX)¶
Prerequisites¶
- HCL DX environment
-
Environment to host Boards, either:
- Kubernetes cluster with
kubectl
installed & authenticated, or - Docker
- Kubernetes cluster with
Licence Key¶
Huddo Boards / Activities Plus is a free entitlement for HCL DX Customers, however it requires a licence key from https://store.huddo.com. For more details see here.
Steps¶
-
Setup WebSphere OAuth
-
Deploy Boards in either:
- Kubernetes or
- Docker
-
Configure SSO for Boards
-
Install & configure the Boards portlet
Integration options¶
The Boards API is the simplest way of extending Boards into your HCL DX environment.
To authenticate, you will need to use the user's API Token. This can be obtained on behalf of the user via SSO. Simply request the /user/auth/dx/<BASE64_HOSTNAME>/apitoken
endpoint from the Boards API from the client-side (browser) and include the DX session cookies. Based on your deployment architecture this can be achieved in two ways;
-
Same Domain
If your Boards API is deployed on the same domain as your DX server, you can simply request the API Token from the Boards API like this:
https://<DX_SERVER>/api-boards/user/auth/dx/<BASE64_HOSTNAME>/apitoken
-
Different Domain
If your DX server is not on the same domain as the Boards server, you will need to configure the DX proxy to pass the request through your DX server to the Boards server.
The URL will then look like this:
https://<DX_SERVER>/wps/proxy/https/<BOARDS_URL>/user/auth/dx/<BASE64_HOSTNAME>/apitoken
For example:
https://dx.company.com/wps/proxy/https/boards.api.huddo.com/user/auth/dx/ZHguY29tcGFueS5jb20=/apitoken