Installation Steps

1. Extracting images on a machine with internet

Following steps need to be carried out on a machine with internet access and with inbound connections on port 9242 enabled. 

1. Install Docker and Docker Compose on the host operating system (must have git bash installed if it is a windows machine).

2. Download the deployment script deployment.sh and place it in any desired directory. This script will:

   1. delete the cim-deployment directory if it exists already.

   2. automatically pull the latest version of cim-deployment folder.

3. To execute the script, give it the execute permissions and execute it. 

   Code Block
   chmod 755 deployment.sh ./deployment.sh

   
   

4. Change to newly created directory with name cim-deployment. This directory contains all the required files for deployment.

5. Run the following command to pull all the images from the registry:

6. Wait for the script to complete the execution. This script should automatically download all the images on the machine.

   Code Block
   chmod 755 install.sh ./install.sh

   
   

7. Save all the images as tar balls by executing the following commands: 

   Code Block
   docker save gitlab.expertflow.com:9242/cim/cim-backend:13.0-rc1 > cim-backend.tar docker save gitlab.expertflow.com:9242/cim/cim-frontend:13.0.0-rc1 > cim-frontend.tar docker save gitlab.expertflow.com:9242/chat-solution/mysql:5.7 > mysql.tar docker save gitlab.expertflow.com:9242/chat-solution/mongodb:latest > mongo.tar

   
   

2. Copying and deploying the images to production machine (without internet)

1. Copy the cim-deployment folder to the production machine and cd in it.. 

2. Load all the images on the machine with the following commands:

   Code Block
   for file in *.tar; do docker load < $file; done

   
   

3. Open docker/environment-variables/cim-frontend-variables.env file and update the following variables according to the environment:

   Name	Description
   SERVER_URL	URL of the server where UMM is deployed. It should have the following format: https://st.ef.com:8443/umm

   
   

4. Having environment configurations done execute the following commands to run the application: 

   Code Block
   chmod 755 install.sh ./install.sh

   
   

5. Run the following command to ensure that all the components are up and running: 

   Code Block
   docker ps

   
   

3. Gadget Deployment

Open the CIMGagdet/InteractionHistoryGadget.js file and update the URL with your virtual-IP and port of umm service as per your deployment on line 60 as below:

1. Run FileZilla or any other FTP client and log in to finesse using following credentials 

   1. Host: IP of the finesse where gadget will be deployed

   2. Username: 3rdpartygadget 

   3. Password: ask the Finesse administrator for the password

   4. port: 22

2. Create a folder e.g. CIM into the files directory on finesse server and upload the specifications files on finesse server.

3. Repeat the same steps for deploying the gadget on the secondary Finesse server. 

4. Open cfadmin for your finesse using https://finesse.ip:8445/cfadmin, login and follow the steps below to add the supervisor tools gadget in your team:

1. Click on “Team Resources” tab on the top

2. Click on the team for which you want to add the gadget

3. Scroll down the “Desktop Layout XML” part at the bottom of the screen and locate <role>agent</role> and add the following line after the <gadgets> tab: 

   Code Block
   <gadget>/3rdpartygadget/files/<folder-name>/InteractionHistoryGadget.xml</gadget>

   
   

4. The following screenshot is depicting the steps mentioned above

Troubleshooting

Logs for each container are available in files as well as within docker daemon. To see the logs for any container on STDOUT, execute docker ps and get the id of the container. Use that id to see the logs using docker logs <container_id>.