Upgrade Guide CX5.9.0 to CX5.10.0

Before upgrading, ensure that the system is idle, i.e, all agents are logged out of 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.

  1. Update Helm repo

    helm repo update expertflow
    
  2. Clone the CX repository on the target server

    Bash
    # Create CX-5.10.0 directory from root
    mkdir CX-5.10.0
    # Navigate to CX-5.10.0
    cd CX-5.10.0
    # Clone the CX-5.10.0 branch of the cim-solution repository
    git clone -b CX-5.10.0 https://efcx:RecRpsuH34yqp56YRFUb@gitlab.expertflow.com/cim/cim-solution.git $HOME/CX-5.10.0
    # Navigate to the current release /kubernetes
    cd <current-release>/kubernetes
    
  3. Deploy Artemis
    a. Run as Helm-based

    # Update Artemis tag on ef-artemis-custom-values.yaml (your file for custom values.yaml)
      Artemis tag: 2.42.0-activemq-artemis-5-10-0
    helm upgrade --install=true  --namespace=ef-external --values=helm-values/ef-activemq-custom-values.yaml activemq expertflow/artemis --version 5.10.0 
    

b. Run as a system service.

  1. # Copy the attached Artemis Auth Plugin JAR file
    Copy from 5.10.0/kubernetes/pre-deployment/activemq-artemis/artifacts/plugins/ef-auth-plugin-1.0-SNAPSHOT.jar to ./pre-deployment/activemq-artemis/artifacts/plugins/
    
    Copy from 5.10.0/kubernetes/pre-deployment/activemq-artemis/artifacts/plugins/ef-auth-plugin-1.0-SNAPSHOT.jar to /opt/artemis/lib
    
    ####### restart artemis
    sudo systemctl daemon-reload
    sudo systemctl restart artemis
    
  2. Deploy the AgentDesk Helm chart

    # Copy the unified agent translation directory to the current release
    Copy from 5.10.0/kubernetes/pre-deployment/app-translations/unified-agent/i18n/   To ./pre-deployment/app-translations/unified-agent
    
    # Run script from <kubernetes> diectory, to update the translations
      chmod +x scripts/upload_agent_desk_translations.sh
      ./scripts/upload_agent_desk_translations.sh
    
    # 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.10.0
    
  3. 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.10.0
    
  4. 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.10.0
    
  5. 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.10.0
    
  6. Deploy the MTT Helm chart

    # IF USING DEFAULT FLOWS:
      Uninstall Conversation Studio, and delete PVC pvc and PV, and then deploy the   MTT-single chart
    
      helm uninstall -n <tenant-namespace> <MTT-single-chart name>
      kubectl delete -n <tenant-namespace> <pvc-conversation-studio> 
      kubectl delete -n <tenant-namespace> <pv-conversation-studio> 
      
    # IF USING CUSTOM FLOWS:
      Open Campaign Studio and add a new flow using the init node and plain message node; the complete guide is attached below in the Configurations Section.
    
        
    # 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.10.0
    
  7. Deploy Agent Co-Pilot

    #  Deploy the new chart version using the helm-values/cx-agent-co-pilot-custom-values.yaml
       helm upgrade --install expertflow-ai  --namespace expertflow  --create-namespace --values helm-values/cx-agent-co-pilot-custom-values.yaml  expertflow/expertflow-ai --version 5.10.0
    
  8. Metabase Survey Report

    # Clone the repo
      git clone -b 5.10.0 https://efcx:RecRpsuH34yqp56YRFUb@gitlab.expertflow.com/cim/cim-solution.git 5.10.0
      
    # Copy the Reports Folder
      Copy 5.10.0/kubernetes/external/metabase-reports/metabase_reporting_update_tool/patch_form_detail_skipped_answer.py   
      To <current-active-directory>/external/metabase-reports/metabase_reporting_update_tool/
      
      Copy 5.10.0/kubernetes/external/metabase-reports/metabase_reporting_update_tool/survey/  
      To <current-active-directory>/external/metabase-reports/metabase_reporting_update_tool/
      
    # Run the following command to import the new reports
      python3 metabase_import.py https://<Metabase-FQDN>/metabase/api/ <admin-email> <admin-password> <metabase-db-display-name>  survey <collection-name-on-metabase>
    

Configurations:

Configuration guide for Campaign Unsubscribe Flow in Conversation Studio