Skip to main content
Skip table of contents

CX Upgrade Guide CX-4.4.9 to CX-4.5.1

Download New Release

  1. Clone the new CX-4.5.1 release

    CODE 
    git clone -b CX-4.5.1 https://efcx:RecRpsuH34yqp56YRFUb@gitlab.expertflow.com/cim/cim-solution.git

  2. Navigate to the cim-solution/kubernetes folder in the newly cloned release

    CODE 
    cd cim-solution/kubernetes

Stop all core components.

CODE 
# Navigate to the following folder of the existing release i.e. CX-4.4-x
cd cim-solution/kubernetes
kubectl delete -f cim/Deployments
kubectl delete -f cim/StatefulSet/ef-amq-statefulset.yaml

update Active MQ Deployment

CODE 
# Navigate to the following folder of the existing release i.e. CX-4.4-x
cd cim-solution/kubernetes

1)open StatefulSet/ef-amq-statefulset.yaml
Add the following ConfigMaps variable under env section

           - name: ACTIVEMQ_OPTS_MEMORY
             value: "-Xms512M -Xmx4G"
           - name: MAX_CONNECTIONS
             value: "5000"
2)Change the image tag            
image: gitimages.expertflow.com/general/activemq-k8s:5.17.1-alpine-zulu-K8s-4.5.1_f-CIM-14085-4.5.1_f-CIM-14085


and for HA cim/StatefulSet/ef-amq-statefulset-ha.yaml
1)Change the image tag
  image: gitimages.expertflow.com/general/activemq-k8s:5.17.1-alpine-zulu-K8s-4.5_f-CIM-15344-CX_4.5.1
CODE 
# Update Common enviroment Configmap

1) Open cim/ConfigMaps/ef-common-environment.yaml add the following variables

  DEFAULT_ROOM_NAME: CC
  DEFAULT_ROOM_DESCRIPTION: Contact Center Room
  DEFAULT_ROOM_LABEL: CC
  ROOM_IS_USER_ID: "false"
  TZ: UTC

# Update Agent Manager Configmap

Open cim/ConfigMaps/ef-agent-manager-configmap.yaml add the following variable.
   
   FINESSE_URL: https://uccx12-5p.ucce.ipcc:8445
 
# Update Conversation manager Configmap 

1)Open cim/ConfigMaps/ef-conversation-manager-configmap.yaml add the following variables
   UNIFIED_ADMIN_URL: http://ef-unified-admin-svc:3000

# Update Customer ConfigMap
1) open cim/ConfigMaps/ef-customer widget-configmap.yaml add the following variables
  
  AUTHENTICATOR_URL: https://cim.expertflow.com/secure-link
  ENABLE_LOGO: "false"
  ADDITIONAL_PANEL: "true"
  
# Update Scheduled Activities Configmap

1) open  cim/ConfigMaps/ef-scheduled-activities-configmap.yaml

Remove following varibales
  
  DB_DIALECT: org.hibernate.dialect.PostgreSQLDialect
  DB_PASSWORD: Expertflow123
  DB_URL: jdbc:postgresql://ef-postgresql.ef-external.svc.cluster.local:5432/scheduler
  DB_USERNAME: sa

Add following varibales 
  
  CACHED_OUTBOUND_MESSAGE_EXPIRY_IN_SECONDS: "86400"
  COUNT_OF_WEBHOOK_NOTIFICATION_RETRY_ATTEMPTS: "5"
  WEBHOOK_NOTIFICATION_RETRY_TIMEOUT_IN_SECONDS: "1800"

# Update State event logger Configmap

1) open ef-state-events-logger-configmap.yaml and change the value of following variable

 TOPIC_NAME: VirtualTopic.STATE_CHANNEL

# Update Unified agent Configmap

1) Open cim/ConfigMaps/ef-unified-agent-configmap.yaml and add the following variables

  isCrmEventsEnabled: "false"
  SECURE_LINK_URL: https://devops.ef.com/secure-link
  finesseURLForAgent: https://122.129.75.138:8445
  ENABLE_SECURE_LINK: "false"
  Enable_Voice_Events_For_CRM: "false"
  IS_FINESSE_HA_ENABLED: "false"
  SECONDARY_FINESSE_URL: https://finesse12-5.ucce.ipcc:8445
  CISCO_SERVICE_IDENTIFIER: "0000"

Update following Deployment

CODE 
# Update 360 Connector Deployment

1)Open cim/Deployments/ef-360-connector-deployment.yaml

             - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
                  
2)Change the image tag
   image: gitimages.expertflow.com/cim/360-connector:4.5

# Update Agent Manager Deployment

1) Open cim/Deployments/ef-agent-manager-deployment.yaml Add following parameters under evn section.
            - name: FINESSE_URL
              valueFrom:
                configMapKeyRef:
                  key: FINESSE_URL
                  name: ef-agent-manager-cm
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm                  

3) Change the image 
   tag : gitimages.expertflow.com/cim/agent-manager:4.5_f-CIM-14086


# Update Bot framework Deployment
1)Open cim/Deployments/ef-bot-framework-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
                  
2)Change the image tag
   image: gitimages.expertflow.com/cim/bot-framework:4.5.1_f-CIM-14085                  

# Update CCM Deployment
1)Open cim/Deployments/ef-ccm-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
                  
2)Change the image tag
   image: gitimages.expertflow.com/cim/customer-channel-manager:4.5.1_f-CIM-14085

# Update CIM CUSTOMER Deployment
1)Open cim/Deployments/ef-cim-customer-configmap.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
2)Change the image tag

image: gitimages.expertflow.com/cim/cim-backend:4.4

# Update Conversation manager Deployment

1)Open cim/Deployments/ef-conversation-manager-deployment.yaml

#add this line name: variables-common-env-cm  under "wait-for" initcontainer             
      initContainers:      
      containers:
        - envFrom:
            - configMapRef:
                 name: variables-common-env-cm
2)Change the image tag of initcontainer
   image: gitimages.expertflow.com/cim/conversation-controller:4.5.1-CIM-14085
   
3)Change the image tag of Main container
image: gitimages.expertflow.com/cim/conversation-manager/build:4.5.1_b-CIM-15064-ff0e8e06704c7a1c51dac8f81eb5d072b568c059



# Update Customer widget Deployment

1)Open cim/Deployments/ef-customer-widget-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
            - name: AUTHENTICATOR_URL
              valueFrom:
                configMapKeyRef:
                  key: AUTHENTICATOR_URL
                  name: ef-customer-widget-cm
            - name: ENABLE_LOGO
              valueFrom:
                configMapKeyRef:
                  key: ENABLE_LOGO
                  name: ef-customer-widget-cm
            - name: ADDITIONAL_PANEL
              valueFrom:
                configMapKeyRef:
                  key: ADDITIONAL_PANEL
                  name: ef-customer-widget-cm                  
                  
2)Change the image tag
   image: gitimages.expertflow.com/efpublic/customer-widget:4.5
   
# Update Facebook Connector Deployment
1)Open cim/Deployments/ef-facebook-connector-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
   image: gitimages.expertflow.com/cim/facebook-connector:4.5.1-SR1  
   
# Update file engine Deployment

1)Open cim/Deployments/ef-file-engine-deployment.yaml
    Change the image tag
   image: gitimages.expertflow.com/chat-solution/file-engine:4.5

# Update Historical reports Deployment
1)Open cim/Deployments/ef-historical-reports-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/cim/historical-reports-manager:4.5.1-SR2

# Update Instagram Connector Deployment
1)Open cim/Deployments/ef-instagram-connector-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/cim/instagram-connector:4.5

# Update Licence Manager Deployment
1)Open cim/Deployments/ef-licence-manager-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/license-mangement/license-manager:4.5

# Update Realtime reports Deployment
1)Open cim/Deployments/ef-realtime-reports-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/cim/realtime-reports-manager:4.5.1_f-CIM-14085

# Update Routing engine Deployment
1)Open cim/Deployments/ef-routing-engine-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/cim/media-routing-engine:4.5.1_f-CIM-14085

# Update Scheduled Activities

1)Open cim/Deployments/ef-scheduled-activities-deployment.yaml

Remove following varibales 
            - name: DB_PASSWORD
              valueFrom:
                configMapKeyRef:
                  key: DB_PASSWORD
                  name: ef-scheduled-activities-cm
            - name: DB_URL
              valueFrom:
                configMapKeyRef:
                  key: DB_URL
                  name: ef-scheduled-activities-cm
            - name: DB_USERNAME
              valueFrom:
                configMapKeyRef:
                  key: DB_USERNAME
                  name: ef-scheduled-activities-cm
            - name: DB_DIALECT
              valueFrom:
                configMapKeyRef:
                  key: DB_DIALECT
                  
                  
Add following varibales
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
            - name: REDIS_HOST
              valueFrom:
                configMapKeyRef:
                  key: REDIS_HOST
                  name: ef-connection-env-cm
            - name: REDIS_MAX_ACTIVE
              valueFrom:
                configMapKeyRef:
                  key: REDIS_MAX_ACTIVE
                  name: ef-connection-env-cm
            - name: REDIS_MAX_IDLE
              valueFrom:
                configMapKeyRef:
                  key: REDIS_MAX_IDLE
                  name: ef-connection-env-cm
            - name: REDIS_MAX_WAIT
              valueFrom:
                configMapKeyRef:
                  key: REDIS_MAX_WAIT
                  name: ef-connection-env-cm
            - name: REDIS_MIN_IDLE
              valueFrom:
                configMapKeyRef:
                  key: REDIS_MIN_IDLE
                  name: ef-connection-env-cm
            - name: REDIS_PASSWORD
              valueFrom:
                configMapKeyRef:
                  key: REDIS_PASSWORD
                  name: ef-connection-env-cm
            - name: REDIS_PORT
              valueFrom:
                configMapKeyRef:
                  key: REDIS_PORT
                  name: ef-connection-env-cm
            - name: REDIS_SSL_ENABLED
              valueFrom:
                configMapKeyRef:
                  key: REDIS_SSL_ENABLED
                  name: ef-connection-env-cm
            - name: REDIS_TIMEOUT
              valueFrom:
                configMapKeyRef:
                  key: REDIS_TIMEOUT
                  name: ef-connection-env-cm
            - name: REDIS_SENTINEL_ENABLE
              valueFrom:
                configMapKeyRef:
                  key: REDIS_SENTINEL_ENABLE
                  name: ef-connection-env-cm
            - name: REDIS_SENTINEL_MASTER
              valueFrom:
                configMapKeyRef:
                  key: REDIS_SENTINEL_MASTER
                  name: ef-connection-env-cm
            - name: REDIS_SENTINEL_NODES
              valueFrom:
                configMapKeyRef:
                  key: REDIS_SENTINEL_NODES
                  name: ef-connection-env-cm
            - name: REDIS_SENTINEL_PASSWORD
              valueFrom:
                configMapKeyRef:
                  key: REDIS_SENTINEL_PASSWORD
                  name: ef-connection-env-cm                  
            - name: CACHED_OUTBOUND_MESSAGE_EXPIRY_IN_SECONDS
              valueFrom:
                configMapKeyRef:
                  key: CACHED_OUTBOUND_MESSAGE_EXPIRY_IN_SECONDS
                  name: ef-scheduled-activities-cm
            - name: COUNT_OF_WEBHOOK_NOTIFICATION_RETRY_ATTEMPTS
              valueFrom:
                configMapKeyRef:
                  key: COUNT_OF_WEBHOOK_NOTIFICATION_RETRY_ATTEMPTS
                  name: ef-scheduled-activities-cm
            - name: WEBHOOK_NOTIFICATION_RETRY_TIMEOUT_IN_SECONDS
              valueFrom:
                configMapKeyRef:
                  key: WEBHOOK_NOTIFICATION_RETRY_TIMEOUT_IN_SECONDS
                  name: ef-scheduled-activities-cm                        
                  
2)Change the image tag
  image: gitimages.expertflow.com/campaign-manager/campaign-scheduler:4.5
  

# Update SMPP connector Deployment
1)Open cim/Deployments/ef-smpp-connector-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
 image: gitimages.expertflow.com/cti/hc_smpp_connector:4.5

# Update State event logger Deployment

1)Open cim/Deployments/ef-state-events-logger-deployment.yam
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/cim/state-events-logger/build:4.5.1_b-CIM-15144-82d8cf35759585eee519edaa6b4373134e5dea5f

# Update Team Announcement Deployment
1)Open cim/Deployments/ef-team-announcement-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm   

# Update Telegram connector Deployment
1)Open cim/Deployments/ef-telegram-connector-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/cim/telegram-connector/build:4.5.1_b-CIM-15144-15_07_2024-16_17_34

# Update twillio connector Deployment
1)Open cim/Deployments/ef-twilio-connector-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/cim/twilio-connector:4.5
  
# Update Unified admin Deployment
1)Open cim/Deployments/ef-unified-admin-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/cim/unified-admin:4.5


# Update Unified agent Deployment

1)Open cim/Deployments/ef-unified-agent-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
            - name: isCrmEventsEnabled
              valueFrom:
                configMapKeyRef:
                  key: isCrmEventsEnabled
                  name: ef-unified-agent-cm
            - name: SECURE_LINK_URL
              valueFrom:
                configMapKeyRef:
                  key: SECURE_LINK_URL
                  name: ef-unified-agent-cm
            - name: finesseURLForAgent
              valueFrom:
                configMapKeyRef:
                  key: finesseURLForAgent
                  name: ef-unified-agent-cm
            - name: ENABLE_SECURE_LINK
              valueFrom:
                configMapKeyRef:
                  key: ENABLE_SECURE_LINK
                  name: ef-unified-agent-cm
            - name: Enable_Voice_Events_For_CRM
              valueFrom:
                configMapKeyRef:
                  key: Enable_Voice_Events_For_CRM
                  name: ef-unified-agent-cm
            - name: IS_FINESSE_HA_ENABLED
              valueFrom:
                configMapKeyRef:
                  key: IS_FINESSE_HA_ENABLED
                  name: ef-unified-agent-cm
            - name: SECONDARY_FINESSE_URL
              valueFrom:
                configMapKeyRef:
                  key: SECONDARY_FINESSE_URL
                  name: ef-unified-agent-cm
            - name: CISCO_SERVICE_IDENTIFIER
              valueFrom:
                configMapKeyRef:
                  key: CISCO_SERVICE_IDENTIFIER
                  name: ef-unified-agent-cm
                  
2) add volume following volume mount under volume mount section
         volumeMounts:
            - name: ef-crm-service
              mountPath: /usr/share/nginx/html/assets/cti/crm/
            - name: ef-canned-messages
              mountPath: /usr/share/nginx/html/assets/canned-messages/
      volumes:
         - name: ef-crm-service
           configMap:
             name: ef-crm-service-cm
         - name: ef-canned-messages
           configMap:
             name: ef-canned-messages-cm                                              
                  
3)Change the image tag
  image: gitimages.expertflow.com/cim/unified-agent:4.5.1_f-CIM-13418


# Update Viber connector Deployment
1)Open cim/Deployments/ef-viber-connector-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
Change the image tag
image: gitimages.expertflow.com/cim/viber-connector:4.5
  

# Update Web Channel Manager Deployment
1)Open cim/Deployments/ef-web-channel-manager-deployment.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm      
                  
2)Change the image tag
  image: gitimages.expertflow.com/cim/web-channel-manager:4.5

Update following Ingress

CODE 
# Update Web Channel Manager Ingress

#for nginx
1) Open cim/Ingresses/nginx/ef-scheduled-activities-Ingress.yaml
                port:
                  number: 8894
#for traefik
1) Ingresses/traefik/ef-scheduled-activities-Ingress.yaml
                port:
                  number: 8894

# Update twitter connector Ingress

#for nginx
1) open Ingresses/nginx/ef-scheduled-activities-Ingress.yaml  
  port:
    number: 8080     
#for traefik
2) open kubernetes/cim/Ingresses/traefik/ef-twitter-connector-Ingress.yaml                  

                port:
                  number: 8080

Update Grafana

CODE 
add the following lines under "dashboardsConfigMaps" section

  - configMapName: <configmap-map-name-supervisor-dashboard>
    folderName: default
    fileName: <file-name-supervisor-dashboard>

  - configMapName: <configmap-map-name-agent-dashboard>
    folderName: default
    fileName: <file-name-agent-dashboard>

Update RASA-X

CODE 
Change the image tag under the app section
tag: "4.5"

Copy the folder and replace in exact path of current release

CODE 
#Replace the AgentGadget.js 
Replace the file from following path new release 
kubernetes/post-deployment/3rdPartyResources/Finesse-gadget/AgentGadget.js

#Replace the "supervisor-dashboards" folder from following path
kubernetes/post-deployment/config/grafana/supervisor-dashboards

#Replace the "unified-agent" folder from following path
kubernetes/pre-deployment/app-translations/unified-agent

#Replace the "conversation-Controller" folder from following path
kubernetes/pre-deployment/conversation-Controller


#copy the folder "crm-service" from the following path
kubernetes/pre-deployment/crm-service

#Replace the "grafana" folder from following path
kubernetes/pre-deployment/grafana

Replace the  "licensemanager" folder from following path
kubernetes/pre-deployment/licensemanager

Replace the  "dbcreation" folder from following path
kubernetes/pre-deployment/reportingConnector/dbScripts/dbcreation

Replace the  "dbupdate" folder from following path
kubernetes/pre-deployment/reportingConnector/dbScripts/dbupdate

# Update reporting connector cron job
1)Open kubernetes/pre-deployment/reportingConnector/ef-reporting-connector-cron.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
Change the image tag
- image: gitimages.expertflow.com/cim/reporting-connector:4.5.1-SR2 



# Update reporting connector cron job
1)Open kubernetes/pre-deployment/team-announcement/ef-team-announcement-cronjob.yaml
            - name: TZ
              valueFrom:
                configMapKeyRef:
                  key: TZ
                  name: variables-common-env-cm
Change the image tag
- image: gitimages.expertflow.com/cim/reporting-connector:4.5.1-SR2


#Copy the "4.4-4.5_upgrade.js" folder from following path
kubernetes/scripts/mongo

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close