Upgrade Guide CX5.3.1 to CX5.4.0

Before upgrading, ensure that the system is idle, i.e, all agents are logged out from the AgentDesk.

Custom Configuration Strategy

For detailed guidelines on applying environment-specific configurations using custom values.yaml layering,

Refer to the CX Helm Chart Custom Configuration Strategy guide.

In this release, ActiveMQ Classic is being replaced by ActiveMQ Artemis

Update Helm repo
```
helm repo update expertflow
```

Clone the CX repository on the target server

# Create CX-5.4.0 directory from root
  mkdir CX-5.4.0
# Navigate to CX-5.4.0
  cd CX-5.4.0
# Clone the CX-5.4.0 branch of the cim-solution repository
  git clone -b CX-5.4.0 https://efcx:RecRpsuH34yqp56YRFUb@gitlab.expertflow.com/cim/cim-solution.git $HOME/CX-5.4.0
# Navigate to current release /kubernetes
  cd <current-release>/kubernetes

Update the Artemis

# Copy the new plugin jar to current directory <optional>
  CX-5.4.0/kubernetes/pre-deployment/activemq-artemis/artifacts/plugins/ef-auth-plugin-1.0-SNAPSHOT.jar to <current release>/pre-deployment/activemq-artemis/artifacts/plugins/
# copy the new plugin jar to the following directory on the VM /opt/artemis/lib
  CX-5.4.0/kubernetes/pre-deployment/activemq-artemis/artifacts/plugins/ef-auth-plugin-1.0-SNAPSHOT.jar to /opt/artemis/lib
# Restart the artemis service
  sudo systemctl restart artemis
# Check the status
  systemctl status artemis

Deploy the AgentDesk helm chart

# Deploy the new chart version using the helm-values/cx-agent-desk-custom-values.yaml
  helm upgrade --install --namespace expertflow --set global.efCxReleaseName="ef-cx"  cx-agent-desk  --debug --values helm-values/cx-agent-desk-custom-values.yaml expertflow/agent-desk --version 5.4.0

“Agent MRD Interrupted” Flow Modified in Conversation Studio
Note: Please take backup/export of your existing flow from conversation studio before any change

A new node for Agent MRD Interrupted flow has been added as part of the selecting different actions for Interrupted Conversations. This node supports the action to put a conversation on hold that has been interrupted. For more details on the Interrupted Conversations, please refer to its feature document.

If you are using custom flows for Conversation Studio:

Please add the flow changes manually. After deploying the Core helm chart, refer to the Conversation Studio default flows documentation (see the 'Agent MRD Interrupted' section—1st heading) and update your customized flow accordingly.

If you are using default flows for Conversation Studio (This will remove all existing flows, please only follow the below in case you are using default flows):

Execute the commands below before deploying the Core Helm chart.

a. Delete the Conversation Studio StatefulSet:

kubectl delete -n expertflow statefulset ef-cx-conversation-studio

b. Delete the existing Persistent Volume Claim (PVC) for Conversation Studio:

kubectl delete -n expertflow pvc conversation-studio-flow-vol-ef-cx-conversation-studio-0

Deploy the Core helm chart

# Deploy the new chart version using the helm-values/ef-cx-custom-values.yaml 
  helm upgrade --install --namespace expertflow --create-namespace   ef-cx  --debug --values helm-values/ef-cx-custom-values.yaml expertflow/cx --version 5.4.0

Deploy the Channels helm chart

# Deploy the new chart version using the helm-values/cx-channels-custom-values.yaml
  helm upgrade --install --namespace expertflow --set global.efCxReleaseName="ef-cx" --debug cx-channels --values helm-values/cx-channels-custom-values.yaml  expertflow/channels --version 5.4.0

Deploy the Campaigns helm chart

# Deploy the new chart version using the helm-values/cx-campaigns-custom-values.yaml
helm upgrade --install --namespace expertflow   --set global.efCxReleaseName="ef-cx"  cx-campaigns --debug --values helm-values/cx-campaigns-custom-values.yaml expertflow/campaigns --version 5.4.0

Deploy the MTT helm chart

# Deploy the new chart version using the helm-values/mtt-single-custom-values.yaml
helm upgrade --install --namespace <tenant-ns> --debug  <tenant-id> --values helm-values/mtt-single-custom-values.yaml  expertflow/MTT-single --version 5.4.0

Deploy the Reporting connector

# Deploy the reporting
  helm upgrade --install --namespace <tenant-namespace> --set global.efCxReleaseName="ef-cx"   cx-reporting --debug --values helm-values/cx-reporting-scheduler-custom-values.yaml  expertflow/reporting  --version 5.4.0

Deploy the ETL

# Edit the file helm-values/cx-transflux-custom-values.yaml in the transflux directory  and update the tag
image:
  repository: cim/cx-data-platform
  tag: 5.4.0
# Deploy the new chart 
  helm upgrade --install --namespace expertflow   --set global.efCxReleaseName="ef-cx"  cx-transflux --debug --values helm-values/cx-transflux-custom-values.yaml  expertflow/transflux --version 5.4.0

Update Voice Components using the following guide