Purpose
To provide installation prerequisites, system requirements and installation instructions of supervisor tools.
Solution Prerequisites
Hardware Sizing
The following lists the machine specifications for a maximum of 100 concurrent agents.
vCPU | vRAM | vDisk |
2 cores (2.60GHz, 2 processors) | 8 GB | 1x100 GB |
To support HA, the same specifications would be doubled for the two machines for a redundant deployment.
To get machine specifications for a larger agent volume and/or with other ExpertFlow products in a coresident deployment, please check here.
Software Requirements
The following software is required to be installed on the server.
We require the customer/partner to install the following software on the server.
OS Compatibility
Use any of the following OS. Both are compatible with the Supervisor Tools.
Item | Version |
CentOS Linux | 7.7.1908 (Core) updated to the latest packages (use Yum update) |
Red Hat Enterprise Linux | release 8.4 (Ootpa) |
Database Requirements
Item | Notes |
SQL Server 2019 Express/ Standard/ Enterprise | The customer or partner to install and make it accessible on the local system or LAN. To support High Availability, the partner/customer must set up MS SQL Server in a failover cluster mode. |
Docker Engine Requirements
Item | Notes |
Docker CE | Docker CE 18+ and docker-compose (in the case of CentOS |
Browser Compatibility
Item | Version | Notes |
Chrome | 120.x |
|
Firefox | Not Tested | The UI of some pages might not render properly in Firefox. |
Cisco Unified CC Compatibility
UCCX and UCCE have been tested without Single Sign-On (SSO).
Item | Version |
|---|---|
UCCX | 12.0, 12.5 |
UCCE | 12.6 |
Port Utilization
Type | Source Host | Source Port | Destination Host | Destination Port |
HTTP | Supervisor Tools web app | any | CCX-A, CCX-B | 80 |
HTTPS | Supervisor Tools web app | any | CCX-A, CCX-B | 443 |
TCP | Supervisor Tools web app | any | MS SQL Server | 1433 |
TCP | Supervisor Tools web app | any | MySQL | 3306 |
HTTP/S | Enterprise web user | any | Supervisor Tools web app | 8080 |
System Access Requirements
Integration with CCX
To synchronize changes with CCX, we need admin user for the Express Configuration APIs to read and write data on CCX.
Machine Access
Administrative privileges (root) on the machine are required to follow the deployment steps.
Database access rights
We require the following database and the privileged SQL user to connect to the EF application with its database. The application will create its tables and other schema objects itself after connection.
Create a wallboard application database with the name EFSupervisorTools.
Create an SQL Server User EFUser with a database role db_owner on the EFSupervisorTools database.
Time Synchronization Requirements
If , the system can produce unpredictable results. Therefore, EF Team Administration application and Cisco UCCX should have their time zone and date/time properly configured, according to the geographic region and must .
To configure the time zone, please see the instructions from the hardware or software manufacturer of the NTP server. The application servers should be synchronized. This synchronization should be maintained continuously and validated regularly. For security reasons, we recommend the Network Time Protocol (NTP) V 4.1+.
Installation
Place all files provided with the release in any folder (preferably /root) on all the machines where the application is being deployed.
Go to the folder where you copied all the tar files and load them in docker engine running following command (the command starts after $ sign):
$ for file in *.tar; do docker load < $file; done
Configurations
Application Configurations
Create new DBs in the MSSQL server with any names corresponding to all microservices in the eabc-compose.yml file. Update the configurations in the compose file (values under environment tag in each service). Details are given below:
Generic configurations in all services:
DB_URL | URL of the database for the microservice. For MSSQL: Example: |
DB_DRIVER | Database driver. For MSSQL: net.sourceforge.jtds.jdbc.Driver |
DB_DIALECT | Database dialect. For MSSQL: org.hibernate.dialect.SQLServer2008Dialect |
DB_USER | Database username which has full access on the configured DB |
DB_PASS | Database password corresponding to the above user |
TZ | Timezone configuration. Use the TZ database name for your region from the following URL: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List |
PRIM_IP | IP of the Primary machine in the HA cluster OR IP of the machine where application’s been deployed. Example: 192.168.1.76 |
SEC_IP | IP of the Secondary machine in the HA cluster. Use the same value as of PRIM_IP if not deployed in HA Example: 192.168.1.80 |
UMM-specific configurations:
In addition to the above configurations, the following additional configurations should also be set in UMM service in the compose file.
PROMPT_PORT | Port of Prompt microservice. Defaults to 8081 |
EABC_PORT | Port of EABC microservice. Defaults to 8082 |
TAM_PORT | Port of TAM microservice. Defaults to 8083 |
CIM_PORT | Port of CIM microservice (if deployed; Omit if not deployed). Defaults to 8084 |