Provision CX Contact

• Administrator

Learn how to provision CX Contact.

Related documentation:

• How Outbound works
• Suite-level guide
• All services
• CX Contact Release Notes

RSS:

• For private edition

Prerequisites

Before you begin to provision tenants in CX Contact, ensure the following prerequisites are met:

• Ensure CX Contact is deployed. See Deploy CX Contact.
• Ensure the tenant exists in the GWS environment. For example, on the local machine, enter:

  $ curl -u <user> <pass> https://<gauth-url>/environment/v3/environments

  Here's a sample output:

  

• Ensure the "cxc" Helm release is deployed (during installation of CX Contact). For example:

  

Tenant provisioning

To provision tenants, you'll use the same Helm Charts as you used when deploying CX Contact, adding one additional overriding values YAML file. You should still use the same base override values file (override_values.yaml) that you used when deploying CX Contact.

Important

The primary_host parameter represents the primary Configuration Server's domain name within the cluster. It's important that this parameter is configured correctly, as it must match the configServers.primaryAddress parameter in the GWS environment (see Prerequisites) to ensure the Helm Chart uses the existing environment and environment ID.

1. Prepare the provisioning_values.yaml file, as follows:

   

2. Validate the Helm Chart and values. Enter:

   $ helm template cxc ./cxcontact-<chart_version>.tgz -f override_values.yaml -f provisioning_values.yaml

3. Upgrade the existing CX Contact Helm deployment with provisioning using the values file that you've just prepared. Enter:

   $ helm upgrade cxc ./cxcontact-<chart_version>.tgz -f override_values.yaml -f provisioning_values.yaml

4. If you encounter errors, verify the input values, YAML files syntax, and your Kubernetes context.

Tip

As long as there are no changes to the override values, you can rerun the provisioning multiple times for the same tenant. It will not affect the CX Contact deployment or corrupt tenant's configuration.

Validate tenant provisioning

At the end of the installation, be sure to check the Helm Chart output. It will provide the status and other information about where to log in to the CX Contact UI. In addition to the standard CX Contact installation output you will see the following provisioning information:

Recommendations

Finally, note the following recommendations:

• In addition to the above validation, you can also use the OpenShift Management Console to view the provisioning pod logs.
• Use the OpenShift Administration Console to check the statuses of Events and Pods. The Pods should be up and running.
• Log in to the CX Contact UI using the URL from the Helm Chart output above and the provisioned tenant's Administrator credentials.
• Check the CX Contact About > Versions page, which contains the health statuses of the CX Contact components. They should all be green.
• Check CX Contact Analytics page, which should show your successful log in.
• Try to create a test Contact List. If you do it right, CX Contact will display a confirmation message that you were successful.