...
- Download the deployment script deploy-wallboard.sh and place it in the
/root
directory. This script will:- delete the wallboard directory in the present working directory if it exists.
- clone the wallboard repository from gitlab in the present working directory.
To execute the script, give it the execute permissions and execute it.
# chmod +x deploy-wallboard.sh
# ./deploy-wallboard.sh
- Create two databases in your DB server corresponding to the wallboard and umm. This step is only required if you're using your own DB server/cluster. If you're using the built-in MSSQL database server, you don't need to do anything.
Update environment variables in the following files inside
/root/wallboard/docker/environment_variables
folder.common-variables.env
Name Description Do not change the default values for non-HA deployment OR if you want to use the built-in database. For HA, use SQL server cluster settings instead of the defaults. If you want to use your own MSSQL instance anyway, update the following variables accordingly. DB_URL
Wallboard 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
DB_USER
database user DB_PASSWORD
database password DB_DRIVER
JDBC driver e.g., net.sourceforge.jtds.jdbc.Driver DB_DIALECT
Database dialect e.g., org.hibernate.dialect.SQLServer2008Dialect CISCO_TYPE
The cisco type of solution .It is either "uccx" or "ucce" SSO_ENABLED
Single sign on facility, its value is either "true" or "false" umm-variables.env
ADMINName Description Do not change the default values for non-HA deployment OR if you want to use the built-in database. For HA, use SQL server cluster settings instead of the defaults. If you want to use your own MSSQL instance anyway, update the following variables accordingly. DB_URL
UMM 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
DB_USER
database user DB_PASS
database password DB_DRIVER
JDBC driver e.g., net.sourceforge.jtds.jdbc.Driver DB_DIALECT
Database dialect e.g., org.hibernate.dialect.SQLServer2008Dialect REDIRECT_BASE_URL
Callback URL for Wallboard.. The format would be: https://wallboard-ip/callback IDS1_URL
Provide the base URI of UCCE/UCCX node. The format would be: https://<fully qualified hostname of UCCX publisher node>:8553 IDS2_URL
If UCCE/UCCX is deployed in High Availability mode, provide the base URI of the second node. The format would be: https://<fully qualified hostname of UCCX Subscriber node>:8553 IDS_CLIENT_ID
Register supervisor tools application in IDS to get client ID by following the steps here. Example:
973a8f41be45426510c971ce41b6feae8d71bc22UMM_BASE_URL
UMM base URL. It should be: https://IP:umm-port Change the following variables as per your environment PRIM_FINESSE_IP
Primary Finesse URL including port (if not 80 or 443)
For example:
SEC_FINESSE_IP
Secondary Finesse URL including port (if not 80 or 443)
For example:
FINESSE_USER
Finesse administrator user FINESSE_PASS
Finesse administrator password
PASSThe password of the admin userSSO_
ENABLED
The single sign-on facility, its value is either "true" or "false" synchronizer-variables.env
Name Description CC_TYPE
Decides whether Cisco contact center is UCCX or UCCE
Holds string "UCCX" for UCCX and "UCCE" for UCCE. Default is UCCX
REDUNDANT_DEPLOYMENT
Decides if synchronizer deployment is redundant. Set it to "true". Holds strings "true" or "false". Default is false INSTANCE_NAME
Used for differentiation of instances when deployed redundant, could be any string. It should be different on both machines. SYNC_AGENTS
To enable Agent sync set it to "true", default is true SYNC_AGENTS_STATS
Enables/disables agents stats sync, default is true SYNC_AGENTS_EMAIL_STATS
Enables/disables agent email stats, default is false SYNC_QUEUES_STATS
Enables/disables queue stats, default is true SYNC_QUEUES
Enables/disables queues/skillgroups in case of UCCE, default is true Following variables are used when CC_TYPE = "UCCX" UCCX_PUB_IP
Primary UCCX IP UCCX_PUB_USERNAME
Primary UCCX admin username UCCX_PUB_PASSWORD
Primary UCCX admin password UCCX_SUB_USERNAME
Secondary UCCX admin username UCCX_SUB_PASSWORD
Secondary UCCX admin password UCCX_PUB_DB_PASSWORD
Primary UCCX database reporting user (hruser) password UCCX_SUB_DB_PASSWORD
Secondary UCCX database reporting user (hruser) password UCCX_REAL_TIME_PORT
UCCX real-time APIs port, default is 9080 SYNC_SKILLS
Enables/disables UCCX skills sync, default is false SYNC_SUPERVISORS
Enables/disables UCCX supervisors sync, default is false Following variables are used when CC_TYPE = "UCCE" CCE_DB_URL
UCCE awdb database URL
jdbc:jtds:sqlserver://192.168.1.87:1433/ucce_awdb
CCE_DB_USER
CCE database user CCE_DB_PASSWORD
CCE database password TZ The timezone of UCCE e.g. Asia/Karachi
- The following configuration must be done at UCCX. This will allow the UCCX System to write real-time data to tables that Synchronizer uses to fetch for gadgets. This step is not needed for UCCE deployments.
- Go to Tools > “Real-Time Snapshot Config” on UCCX Administration UI.
- Enable all three checkboxes
- Select “5” from dropdown against “Data Writing Interval”
- Provide the IP addresses of the machine where Synchronizer will run (comma separated IPs in case of HA, otherwise only one IP) separated by commas in the field against “Server Name” under the "Wallboard System".
- Click on the update button.
- Get domain/CA signed SSL certificates for wallboard FQDN/CN and place the files in
/root/wallboard/docker/certificates
folder. The file names should beserver.crt
andserver.key
. - Update the translation files inside
/root/wallboard/docker/translations
folder for multilingual UI. The file names in the translation folder should remain unchanged. Having environment configurations done, copy the wallboard directory on the second machine in
/root
directory using the following command. (Only for HA deployment)Code Block # scp -r /root/wallboard root@<machine-ip>:/root/
- Having copied the wallboard directory to the second machine, got to /root/wallboard/docker/environment-variables and update the INSTANCE_NAME variable in synchronizer-variables.env. Set it to any value other than the value that is set in the first machine. It will differentiate the two VMs as only one synchronizer service will be active. If one goes down, the other starts synchronizing data from UCCE/UCCX. (Only for HA deployment)
Execute the following commands inside /root/wallboard directory on both machines (if in HA, otherwise on the only machine in the cluster).
# chmod 755 install.sh
# ./install.sh
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.
# docker ps
...