Skip to content

Using HCL DX APIs in HCL Volt MX Foundry

This topic explains how to integrate HCL DX APIs into HCL Volt MX Foundry using the new HCL DX Content Adapter, available starting with CF218. This adapter allows Volt MX users to consume WCM REST V2 endpoints through custom integration services, providing access to all available DX Experience API endpoints with predefined request and response schemas.

Prerequisites

To follow this guide, ensure you have:

  • An HCL DX environment with WCM REST V2 APIs
  • HCL Volt MX Foundry (SaaS or Helm deployment)
  • Access to the HCL Volt MX Marketplace
  • An OIDC-based Identity Provider configured for DX
  • Administrator access to WebSphere and Volt MX Foundry

Integrating HCL DX APIs

Refer to the following steps to integrate HCL DX APIs into HCL Volt MX Foundry using the Content Adapter.

  1. Import the HCL DX Content Adapter into Volt MX Foundry

    For SaaS deployments:

    1. Open the Volt MX Foundry UI.
    2. Click API Management > Custom Data Adapters > Marketplace

    3. Search for "HCL DX Content Adapter", and click Import.

      Refer to: How to Consume a Custom Data Adapter from Marketplace

    For Helm deployments:

    1. Download the adapter from the Marketplace.
    2. Go to API Management > Custom Data Adapters > Import

    3. Upload the adapter manually.

      alt text

      Note

      Ensure the adapter version matches your HCL DX deployment version.

  2. Prepare the HCL DX environment.

    1. Use an OIDC Identity Provider for authentication in DX.

    2. Update WCM REST V2 API settings:

      Warning

      The following integration steps require careful setup of HCL DX environments. This setup also affects WebDAV and syndication features, so exercise caution. The process will be refined in future releases.

      1. Log in to the WebSphere Integrated Solutions Console as an administrator.
      2. Navigate to Security > Global security > Web and SIP Security > Trust association > Interceptors > com.ibm.portal.auth.tai.HTTPBasicAuthTAI.
      3. In the urlWhiteList property, delete /wps/mycontenthandler* from the list of values. If /wps/mycontenthandler* is the only listed value in urlWhiteList, delete the property.
      4. Click Apply.
      5. Click Save at the top of the console messages.

    3. Restart WebSphere or all DX core pods.

    This enables Volt MX to authenticate against the same identity provider used by DX.

  3. Prepare the HCL Volt MX Foundry environment.

    In Volt MX Foundry, configure an OAuth 2.0 Identity Provider. Use the same identity provider used in DX to ensure seamless SSO and API authorization.

  4. Create an Integration Service using the DX Content Adapter.

    1. In Volt MX Foundry, go to Integration Services and click Create New.
    2. Choose the WCM V2 DX Content Adapter as the Service Type.
    3. Set the Server URL to your HCL DX environment. For example, https://<your DX hostname>/wps/mycontenthandler/wcmrest-v2/.
    4. Choose the OAuth Identity Provider configured earlier under Authentication.

    5. Click Save & Add Operation.

      alt text

  5. Add and test operations.

    1. Click Add Operation to select available endpoints from WCM REST V2.

    2. Configure request parameters and click Save and Fetch response to test.

      Test Operation

    3. Log in using your identity provider credentials.

    4. Confirm the response returns valid data.

You now have access to DX Experience APIs within Volt MX through the custom content/data adapter integration.

Support

Support for this feature is not available in the HCL Support Center. For questions and issues, reach out either in the DXers - The HCL DX User Group on Discord, the HCL DX forum or in the Volt MX Marketplace Forum.

HCLSoftware U learning materials

For an introduction and a demo on how to integrate DX with HCL Volt MX as a business user, go to DX Integration with HCL Volt MX for Business Users. To try it out yourself, refer to DX Integration with HCL Volt MX for Business Users Lab.

For an introduction and a demo on how to integrate DX with HCL Volt MX as a developer, go to DX Integration with HCL Volt MX for Developers. To try it out yourself, refer to DX Integration with HCL Volt MX for Developers Lab.

You can also use the dedicated course HCL Volt MX Integration with HCL DX. This course explains the benefits of integrating HCL Volt MX with HCL DX and provides integration guidance for business users, developers, and administrators.

Related information