5.14.0 5.13.0 5.12.0 5.11.0 5.10.0 5.9.0 5.8.0 5.7.0 5.6.0 5.5.0 5.4.0 5.3.0 5.2.0 5.1.0 5.0 4.10 4.9 4.8 4.7 4.6 4.5.3 4.5.2 4.5.1 4.5 4.4 4.3
5.14.0 5.13.0 5.12.0 5.11.0 5.10.0 5.9.0 5.8.0 5.7.0 5.6.0 5.5.0 5.4.0 5.3.0 5.2.0 5.1.0 5.0 4.10 4.9 4.8 4.7 4.6 4.5.3 4.5.2 4.5.1 4.5 4.4 4.3

Upgrade Guide CX5.13.0 to CX5.14.0

Before upgrading, ensure that the system is idle, i.e, all agents are logged out of the AgentDesk.
Flush Redis before upgrading

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. Add and Update Helm repo

    helm repo add cim-solution https://gitlab.expertflow.com/api/v4/projects/471/packages/helm/stable --username efcx --password w4eYTsMuHqLbq5lkFLDI4G86MQp1OjU0CA.01.0y023xsty
    helm repo update cim-solution
    
  2. Clone the CX repository on the target server

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

CX Configurations Migration

Helm-to-Admin settings migration

Run this once per CX cluster after the upgrade. The script reads kubernetes/helm-values, loads tenants from Mongo, and writes Agent Desk, Routing Engine, Bot Framework, Customer Widget, and File Engine settings for each tenant.

  1. Copy the script folder onto the CX host

    Copy the migrate-helm-vars-to-admin folder into <current-working-dir>/kubernetes/scripts/.

    cp -r 5.14.0/kubernetes/scripts/migrate-helm-vars-to-admin/ <current-working-dir>/kubernetes/scripts/
    
  2. Run the script

    On the CX host, run:

    chmod +x scripts/migrate-helm-vars-to-admin/migrate.sh
    ./scripts/migrate-helm-vars-to-admin/migrate.sh
    
  3. Verify the migration output

    Tenants are loaded from Mongo cim-tenant.tenants. Do not pass a tenant list.

    You should see output similar to:

    [1/3] Resolving defaults + helm-values overrides
    [2/3] Preparing Mongo tools pod
    [3/3] Loading tenants from Mongo and applying collections
    Tenants from Mongo: ai-02, loadtest02, ...
    ai-02 agentdesksettings merged
    ai-02 routingEngineConfig upserted
    ai-02 botFrameworkConfig upserted
    ai-02 webWidgetSettings upserted
    ai-02 fileEngineSettings upserted
    [SUCCESS] Migration completed for all tenants found in cim-tenant.
    

Note: The migration is safe to re-run.

  1. Update Application Gateway (APISIX)

    # Update the apisix-custom-values.yaml file 
    # Make sure to save any customisation and add it once the apisix-custom-values.yaml is updated.
      helm show values cim-solution/apisix --version 5.14.1 > helm-values/apisix-custom-values.yaml
      helm upgrade --install --namespace ef-external --values helm-values/apisix-custom-values.yaml apisix cim-solution/apisix --version 5.14.1
    
  2. Deploy Artemis

    1. Run as Helm-based

      # Update Artemis tag on ef-artemis-custom-values.yaml
        helm upgrade --install=true  --namespace=ef-external --values=helm-values/ef-activemq-custom-values.yaml activemq cim-solution/artemis --version 5.14.0
      
    2. Run as a system service.

      # Stop the broker:
      systemctl stop artemis
      
      # Copy in the new jar from cim-solution:
        cp 5.14.0/kubernetes/pre-deployment/activemq-artemis/artifacts/plugins/ef-auth-plugin-1.0-SNAPSHOT.jar  /opt/artemis/lib
      
      # Start the broker and check the plugin loaded:
       systemctl start artemis
       journalctl -u artemis -n 100 | grep -i "Topic Authorization Plugin"
      
      # You should see Topic Authorization Plugin Initialized.
      
  3. Deploy the AgentDesk Helm chart

    SQL
    # Copy the unified agent translation directory to the current release
    Copy from 5.14.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 cim-solution/agent-desk --version 5.14.0
    
  4. 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 cim-solution/campaigns --version 5.14.0
    
  5. 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 cim-solution/channels --version 5.14.0
    

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

In participant role change flow, we have handled the case of the chats for the channels eg facebook, instagram and email, if agent ends the chat (primary), by default we should close the conversation.

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 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 <tenant-namespace> statefulset <tenantname>-conversation-studio

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

kubectl delete -n <tenant-namespace> pvc conversation-studio-flow-vol-<tenantname>-conversation-studio-0
  1. Deploy the Core Helm chart

    # Copy the file
    Copy 5.14.0/kubernetes/pre-deployment/conversation-manager/graphql/graphql-mongodb-rules.json to ./pre-deployment/conversation-manager/graphql/
    
    # Delete and recreate the conversation-manager-graphql-mongodb-rules ConfigMap
    kubectl delete configmap -n expertflow conversation-manager-graphql-mongodb-rules
    
    kubectl create configmap -n expertflow conversation-manager-graphql-mongodb-rules --from-file=pre-deployment/conversation-manager/graphql/graphql-mongodb-rules.json
    
    # 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 cim-solution/cx --version 5.14.0
    
  2. 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  cim-solution/MTT-single --version 5.14.0
    
  3. Deploy Agent Co-Pilot

    # copy configmap file in your working dir 
    copy 5.14.0/kubernetes/pre-deployment/expertflow-ai/llm-configmap.yaml to  ./pre-deployment/expertflow-ai/
    
    # Delete LLM ConfigMap:
    kubectl -n expertflow delete -f pre-deployment/expertflow-ai/llm-configmap.yaml
    
    Apply LLM ConfigMap:
    kubectl -n expertflow apply -f pre-deployment/expertflow-ai/llm-configmap.yaml
    
    # 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  cim-solution/expertflow-ai --version 5.14.0
    
  4. Deploy the CiscoSyncService Helm Chart

    # Deploy the new chart version using the helm-values/cx-ciscosyncservice-custom-values.yaml
      helm upgrade --install --namespace expertflow  --set global.efCxReleaseName="ef-cx"  cisco-sync-service  --values helm-values/cx-ciscosyncservice-custom-values.yaml cim-solution/cisco-sync-service --version 5.14.0
    
  5. Deploy the Cisco Connector

    # Deploy the new chart version using the helm-values/cx-ciscoConnector-custom-values.yaml
    
      helm upgrade --install --set global.efCxReleaseName="ef-cx" cisco-connector --namespace expertflow --values helm-values/cx-ciscoConnector-custom-values.yaml  cim-solution/cisco-connector --version 5.14.0
    
  6. Deploy the WFM Helm Chart

    # Deploy the new chart version using the helm-values/ef-wfm-custom-values.yaml
    
      helm upgrade --install --namespace expertflow --values helm-values/ef-wfm-custom-values.yaml wfm cim-solution/WFM --version 5.14.0
    
  7. Deploy the Survey and Mysql Reports

    1. Clone the Repo

      # Clone the repo
        git clone -b 5.14.0 https://efcx:w4eYTsMuHqLbq5lkFLDI4G86MQp1OjU0CA.01.0y023xsty@gitlab.expertflow.com/cim/cim-solution.git  5.14.0
      
    2. Survey Reports

      # Copy 5.14.0/kubernetes/external/metabase-reports/metabase_reporting_update_tool/survey/
       To <current-active-directory>/external/metabase-reports/metabase_reporting_update_tool/
      cd <current-active-directory>/external/metabase-reports/metabase_reporting_update_tool/
      python3 metabase_import.py https://FQDN/metabase/api/ "email" "password" "database" "survey" "Collection Name"
      
    3. Mysql Reports

      # Copy 5.14.0/kubernetes/external/metabase reports/metabase_reporting_update_tool/mysql/
       To <current-active-directory>/external/metabase-reports/metabase_reporting_update_tool/
      cd <current-active-directory>/external/metabase-reports/metabase_reporting_update_tool/
      python3 metabase_import.py https://FQDN/metabase/api/ "email" "password" "database" mysql "Collection Name"
      

16. CX voice configuration guide


Configurations:

Update Keycloak Permissions
For existing tenants in Keycloak:

After importing the realm file, delete the Keycloak pod; sometimes Keycloak does not apply the changes.

  • Import this file under realm -->clients-->cim-->authorization 5.14.1-authz-config.json

  • Configuration guide

  • Add the FILE-ENGINE-PUBLIC-URL string2000 attribute under Channel Provider in Unified Admin, and set its value in Channel Connector to the tenant's public File Engine URL (https://iac01.expertflow.com/file-engine) for MS Exchange, Facebook, Email, and Instagram channels in Unified Admin

  • Expose nodePorts for CX services (required only if CX VOICE is deployed)
    Use the following guide to expose the nodePorts for CX services.