Solution Prerequisites

...

Software Requirements

Installation Steps

Internet should be available on the machine where the application is being installed and connections on port 9242 should be allowed in the network firewall to carry out the installation steps. Trailing # is not a part of the command.

Allow ports in the firewall

For internal communication of docker swarm, you'll need to allow the communication (both inbound and outbound) on the ports: 7575/tcp,7676/tcp , 8090/tcp, 8091/tcp and 7077/tcp.

To start the firewall on CentOS (if it isn't started already), execute the following commands. You'll have to execute these commands on all the cluster machines.: 

# systemctl enable firewalld
# systemctl start firewalld

To allow the ports on CentOS firewall, you can execute the following commands. You'll have to execute these commands on all the cluster machines.

...

Configure Log Rotation

Add the following lines in /etc/docker/daemon.json file (create the file if not there already) and restart the docker daemon using systemctl restart docker. Perform this step on all the machines in the cluster in case of HA deployment.

...

1. Download the deployment script ecm-deployment.sh and place it in any directory. This script will:
   1. delete the ecm-deployment directory in the present working directory if it exists.
   2. clone the ecm-deployment repository from gitlab in the present working directory.

2. To execute the script, give it the execute permissions and execute it. (on RHEL, run commands with sudo)

   Code Block
   language bash
   # chmod +x ecm-deployment.sh # ./ecm-deployment.sh

   Update environment variables  in the following files inside ecm-deployment/docker/environment_variables folder.

   environment-variables.env

   NameDescriptionDo not change the default values for non-HA deployment. For HA, use SQL server cluster settings instead of the defaults.DB_URL

   Database connection url

   For example:

   • jdbc:jtds:sqlserver://<MACHINE-IP or FQDN>:PORT/db_name
   • jdbc:jtds:sqlserver://<MACHINE-IP or FQDN>:PORT/db_name;instanceName=SomeInstance
   • jdbc:jtds:sqlserver://192.168.1.92:1433/ECM_DEV
   DB_USERdatabase userDB_PASSdatabase passwordDB_DRIVERJDBC driver e.g., net.sourceforge.jtds.jdbc.DriverDB_DIALECTDatabase dialect e.g., org.hibernate.dialect.SQLServer2008DialectChange the following variables for ECM servicesDATABASE_ENGINEsqlServerUCCX_HRDB_PASSWORDUCCX reporting user database password, only used of UCCX deploymentsSYNC_ENABLEDYESSYNC_INTERVAL

   Interval in minutes between every sync job, default is 5

   FEED_INTERVALInterval in minutes between every sync job, default is 1FETCH_DELAY2, do not change.OUTDATED_INTERVAL24, this is number of hours a contact is closed in ECM with Dangling status if it is not synced REDUNDANT_DEPLOYMENTDecides if synchronizer deployment is redundant. Set it to "true". Holds strings "true" or "false". Default is false INSTANCE_NAMEUsed for differentiation of instances when deployed redundant, could be any string. It should be different on both machines.UCCE_SHARED_PATH_DOMAINDialer import folder machine domainUCCE_SHARED_PATH_USERDialer import folder machine username

   
   

3. UCCE_SHARED_PATH_PASSWORDDialer import folder machine passwordUCCE_SHARED_PATH_IPDialer import folder machine IP

   Update these variables for ECM in the environment-variables.env file.

4. Update the following UMM environment variables in the same file.

   Name	Description
   Change the following variables as per your environment For UMM
   PRIM_FINESSE_IP	Primary Finesse URL including port (if not 80 or 443) For example: http://finesse10-5.com https://finesse12-0.com:8445
   SEC_FINESSE_IP	Secondary Finesse URL including port (if not 80 or 443) For example: http://finesse10-5.com https://finesse12-0.com:8445
   FINESSE_USER	Finesse administrator user
   FINESSE_PASS	Finesse administrator password
   UMM_DB_URL	UMM Database
   UMM_DB_DRIVER	UMM Database driver
   UMM_DB_DIALECT	UMM Database dialect
   UMM_DB_PASS	UMM Database password
   UMM_DB_USER	UMM Database username
   ADMIN_PASS	The password of the admin user
   SSO_ENABLED	it should be set to 'false' by default. No need to change this.
   SSL_TRUST_STORE_PATH	Path of the SSL truststore including the name. This truststore should include UCCX SSL certificates if Finesse APIs needed to access via HTTPS
   SSL_TRUST_STORE_PASSWORD	Truststore password

   Change the following variables for Frontend (ECM and UMM)

   SERVER_URL	Provide the URL of Umm : http://<machine_IP>:<PORT> For Example https://192.168.1.25:8443 In the case of HA, machine_IP should be the virtual IP of HA
   CISCO_TYPE	UCCE/UCCX (capital case without quotes)

   SOO_AUTO_LOGIN
   it should be set to 'false' by default. No need to change this.

   SUP_VERSION

   No need to change its default value

   .PCS_URL

   http://<MACHINE-IP or FQDN>:PORT

   For Example

   http://192.168.1

   .

   66:7676/PCSPCS_USERNAMEdatabase username
   PCS_PASSWORDdatabase password

   
   

5. Get domain/CA signed SSL certificates for ecm FQDN/CN and place the files in ecm-deployment/docker/certificates folder. The file names should be server.crt and server.key.

6. Copy the ecm-deployment directory to the second machine for HA. Execute below command 

   Code Block
   # scp -r ecm-deployment root@machine-ip:~/

   
   

7. Go to the second machine and update the environment variables where necessary like INSTANCE_NAME and SERVER_URL

   
   

   
   

8. Execute the following commands inside the ecm-deployment directory on both machines.

   Code Block
   language bash
   # chmod 755 install.sh # ./install.sh

   
   

9. Run the following command to ensure that all the components are up and running. The screenshot below shows a sample response for a standalone non-HA deployment. 

   Code Block
   language bash
   # docker ps

   
   

...

1. Browse to http://<MACHINE_IP or FQDN:UMM_Port>/umm in your browser (FQDN will be the domain name assigned to the IP/VIP). 
2. Click on the red warning icon on right, paste the license in the field and click save. 
   
   
   
   
   
3. Once license is added, go to httpto http://<MACHINE_IP or FQDN>/#/applicationSetting and applicationSetting and define application settings.

4. Restart the services after application settings are defined using below commands inside ecm-deployment directory

   Code Block
   docker-compose -f docker/docker-compose.yml down docker-compose -f docker/docker-compose.yml up -d

   
   

...