Versions Compared

Version Old Version 81 New Version Current
Changes made by

ef.confluence

ef.confluence

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
443/tcp
444/tcp
8088/tcp
5060/tcp (only for Cisco)
16386-32768/udp (only for Cisco)

# Additional port to open in case of High Avaliability (HA)
8500
8300
8301
8302
8303
8600/udp
1433

Installation Steps

  1. Please make sure that Solution Prerequisites are met for the desired deployment type. 

  2. Download the deployment script

    View file
    namedeployment.sh
     and place it in the user’s home or any desired directory. This script will:

    1. delete the recording-solution directory if it exists.

    2. clone the required files for deployment

  3. To execute the script, give it the execute permissions and execute it. This command will clone the skeleton project for the recording solution. the recording-solution directory contains all the required files for deployment.

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

  4. Refer to Section 2 at the end of the guide to proceed with the HA deployment.

  5. Follow step 5 to 8 for deployment with Cisco UCCX or UCCE in non-HA (non- High Availability) mode.

  6. Follow this guide to install and configure Freeswitch. The recording path should be /usr/share/freeswitch/cucmRecording

  7. Follow this guide to create an application user on CUCM for jtapi-connector.

  8. Open recording-solution/docker/config.env and update the environment variables given below.

Connection URL for ActiveMQ tcp://192.168.1.101:61616?broker.persistent=true&broker.schedulerSupport=true

Name

Description

1

VRS_URL

URL of a local machine. example, https: //192.168.1.101 *

2

LOCAL_MACHINE_IP

Local machine IP since it is a non-HA deployment. example 192.168.1.101 *

3

KC_HOSTNAME

Keycloak hostname where keycloak is hosted. e.g 192.168.1.101

4

TZ

Time Zone. e.g Asia/Karachi

5

FINESSE_URL

https: //uccx12-5p.ucce.ipcc:8445

6

DIRECTORY_PATH_TO_MONITOR

The path for archival process to monitor, it should be the same path where sessions are kept . e.g /usr/share/freeswitch/cucmRecording/sessions/

7

ARCHIVED_MEDIA_FILES_EXTENSION

mp4 [keep it same]

8

FILE_EXTENSION

wav [keep it same]

9

NO_OF_DAYS

No of days before which all the files will be archived. If set 2, then except for last 2 days from the date and time of service started or triggered all the files will be archived. 

10

SFTP_HOST

SFTP host IP for archival e.g 192.168.1.106

11

SFTP_PORT

22

12

SFTP_USERNAME

Username of the SFTP server e.g expertflow

13

SFTP_PASSWORD

SFTP password e.g Expertflow464

14

ARCHIVAL_JOB_INTERVAL

It is a duration that tells the service to trigger again. This value is in hours. For example, if set 24 the service would be triggered after 24 hrs to get the desired job done.

15

STEAM_DELETION_JOB_INTERVAL_HRS

Time in hours before which all the stream is to be deleted. e.g 24

16

RETRY_LIMIT

limit to retry in case the connection fails. e.g 2

17

ARCHIVAL_PROCESS_NODE

active

18

NO_OF_DEL_DAYS

No of days before which all the streams will be deleted. If set 2, then except for last 2 days from the date and time of service started or triggered all the files will be deleted. 

19

CISCO_TYPE

Either UCCE or UCCX

20

ACTIVEMQ_BROKER_URL

Connection URL to Consumer as a Broker e.gtcp://192.168.1.101:61616

21

ACTIVEMQ_URL

22

ACTIVEMQ_USER

UserName for the ActiveMQ service i.e admin

23

ACTIVEMQ_PASSWORD

Password for the ActiveMQ service i.e admin

24

CUCM_APPLICATION_USER_NAME

CUCM User's username that has been created in step 3.

2521

CUCM_APPLICATION_USER_PASSWORD

Password for the CUCM Application User.

2622

CUCM_IP

IP address where CUCM has been Deployed

2723

DEPLOYMENT_PROFILE

Profile that we want to use for backend “CISCO” or “EFCX“

Below Env variables are only for UCCX. However, these env variables will also be provided in case of UCCE (Do not comment it out in any case).

Name

Description

1

CCX_PRIMARY_IP

Primary UCCX IP address. e.g 192.168.1.33

2

CCX_SECONDARY_IP

Secondary UCCX IP e.g 192.168.1.33

3

CCX_ADMIN_USERNAME

CCX Admin username

4

CCX_ADMIN_PASSWORD

CCX Admin password

Below Env variables are only for UCCE.

Name

Description

1

UCCE_IP

UCCE IP

2

UCCE_DATABASE

UCCE awdb database name

3

UCCE_USERNAME

UCCE awdb database user’s username

4

UCCE_PASSWORD

UCCE awdb database user’s password

  1. Navigate to the recording solution directory and execute the following commands:

    Code Block
    chmod 755 install-cisco.sh
chmod 755 install-efcx.sh

#for UCCX and UCCE run
./install-cisco.sh

    Verify all the containers are up and healthy 

  2. Verify if the keycloak container is healthy (docker ps), if it is on restarting, kill  (docker kill keycloak) and remove (docker rm keycloak) the keycloak container then run ./install.sh. Wait for keycloak container to become healthy.

  3. Set up keycloak

  4. Once keycloak is set up for Cisco and for EFCX it is already setup, add the below environment variables accordingly in the recording-solution/docker/config.env file.

...

  1. To update the self-signed certificates for VRS, get the public authority or domain signed certificate .crt and .key files, name them server.crt and server.key, and replace the files in /recording-solution/config/certificates with these two new files. Names should be the same.

  2.  Run ./install-efcx.sh for EFCX Or run ./install-cisco.sh for Cisco UCCX and UCCE.

  3. Run the following command to ensure all the components are running. 

    Code Block
    # docker ps

  4. In case of Cisco go to https : //VRS-IP/#/login to access the application, whereas for EFCX go to https://VRS-IP:444/#/login.

  5. Configure the SIP trunk to enable CUCM to send SIP events to VRS for call recordings. Two sip trunks should be configured in case of HA. (Not for EFCX)

...

Section 2

Deployment for HA:

...

*Nginx service is running on port 443 in case of UCCX or UCCE, and for EFCX it is running on port 444.Requirements

  • Replay Server

  • Database with SqlServer

  • Two SIP Trunk (HA Mode)

  • Two VRS on separate VMs

  • EFCX Server

  • Docker and Docker compose

  • Git

Follow these steps:

  1. Ask IPCC team for the creation of rsync job and follow next two steps.

  2. Make sure mounting point of rsync is /var/vrs/recordings on all three VMs; two VRS, and a Replay Server.

  3. Grant full permission to this directory and any files or subdirectories created within it.

  4. Ask the IPCC team for the configuration of HA Sip-trunk and set priorities for one of the VM.

  5. Ask the IPCC team for the creation of Database (sqlserver). And add sqlcmd to the path.

  6. Navigate to data/scripts/ inside recording-solution directory.

  7. Run pwd command and copy the path of sqlserver.sql script

  8. Run the following command with correct credentials. It will initialize the database.

sqlcmd -S localhost -U sa -P <your_password> -d <database_name> -i /path/to/sqlserver.sql

  1. Follow this guide to create an application user on CUCM for jtapi-connector.

  2. Open recoding-solution/docker/config.env and set the environment variables.

Name

Description

1

VRS_URL

IP Address of Server at which solution is being deployed, https: //192.168.1.101 *

2

LOCAL_MACHINE_IP

Same IP Address as given in VRS_URL. example 192.168.1.101 *

3

KC_HOSTNAME

Keycloak hostname where keycloak is hosted. e.g 192.168.1.101, give FQDN in case of EFCX Keycloak

4

TZ

Time Zone. e.g Asia/Karachi

5

DEPLOYMENT_PROFILE

“CISCO“ as HA is only available for Cisco CC

6

PEER_ADDRESS

Address of the second VM wehre VRS is deployed

7

JTAPI_HA_MODE

Keep it true. As we are deploying high avaliability

8

SCREEN_RECORDING

Keep it true if you want to enable screen recording, otherwise false it

9

KEYCLOAK_URL

FQDN or URL of Keycloak

10

CISCO_TYPE

Either UCCE or UCCX

11

FINESSE_URL

FQDN or URL of Finesses e.g https: //uccx12-5p.ucce.ipcc:8445

12

DIRECTORY_PATH_TO_MONITOR

The path for archival process to monitor, it should be /var/vrs/recodings/cucmRecording/sessions/.

13

ARCHIVED_MEDIA_FILES_EXTENSION

mp4 [keep it same]

14

FILE_EXTENSION

wav [keep it same]

15

NO_OF_DAYS

No of days before which all the files will be archived. If set 2, then except for last 2 days from the date and time of service started or triggered all the files will be archived. 

16

SFTP_HOST

SFTP host IP for archival e.g 192.168.1.106

17

SFTP_PORT

22

18

SFTP_USERNAME

Username of the SFTP server e.g expertflow

19

SFTP_PASSWORD

SFTP password e.g Expertflow464

20

ARCHIVAL_JOB_INTERVAL

It is a duration that tells the service to trigger again. This value is in hours. For example, if set 24 the service would be triggered after 24 hrs to get the desired job done.

21

STEAM_DELETION_JOB_INTERVAL_HRS

Time in hours before which all the stream is to be deleted. e.g 24

22

RETRY_LIMIT

limit to retry in case the connection fails. e.g 2

23

ARCHIVAL_PROCESS_NODE

active

24

NO_OF_DEL_DAYS

No of days before which all the streams will be deleted. If set 2, then except for last 2 days from the date and time of service started or triggered all the files will be deleted. 

25

CUCM_APPLICATION_USER_NAME

CUCM User's username that has been created in step 3.

26

CUCM_APPLICATION_USER_PASSWORD

Password for the CUCM Application User.

27

CUCM_IP

IP address where CUCM has been Deployed

Below are the Env variables for UCCX. If CISCO_TYPE = UCCX set following environment variables

Name

Description

1

CCX_PRIMARY_IP

Primary UCCX IP address. e.g 192.168.1.33

2

CCX_SECONDARY_IP

Secondary UCCX IP e.g 192.168.1.33

3

CCX_ADMIN_USERNAME

CCX Admin username

4

CCX_ADMIN_PASSWORD

CCX Admin password

Below are the ENV varialbles for UCCE. If CISCO_TYPE is UCCE set following environment variables.

Name

Description

1

UCCE_IP

UCCE IP

2

UCCE_DATABASE

UCCE awdb database name

3

UCCE_USERNAME

UCCE awdb database user’s username

4

UCCE_PASSWORD

UCCE awdb database user’s password

  1. Continue Updating the config.env for the Database environment variables provided by IPCC team.

Name

Description

1

DB_DRIVER

Driver on which database is running i.e postgres , mysql or sqlserver driver

2

DB_ENGINE

Engine on which database is running i.e postgres or mysql

3

DB_HOST

Name or ip of the host on which database is active

4

DB_NAME

Name of the database

5

DB_USER

Username for database

6

DB_PASSWORD

Password for the database

7

DB_PORT

Port of the Database

  1. Update the keycloak variables

Names

1

KEYCLOAK_REALM_NAME

Realm name from keycloak

2

KEYCLOAK_CLIENT_ID

KeyCloak client id from keycloak

3

KEYCLOAK_CLIENT_SECRET

Add the client secret from keycloak

4

KEYCLOAK_PERMISSION_GROUP

AGENT_GROUP

5

KEYCLOAK_URL

FQDN of CX

6

EFCX_FQDN

FQDN of CX

8

VRS_URL

Url of VRS machine

9

LOCAL_MACHINE_IP

IP of the local machine

  1. Change the recording path and other variables as per your configuration.

Open docker-compose-cisco in docker/docker-compose-cisco

  1. Open recoding-solution/docker/docker-compose-cisco

  2. Inside docker-compose-cisco file, Uncomment the Consul Container and save the changes

Make sure in docker-compose-cisco consul <container_name: consul1> name must be different for both VMs.

  1. Open the freeswitch script record.lua located in the /usr/share/freeswitch/scripts and add the following recording path:

Code Block
recording_dir = "/var/vrs/recordings/cucmRecording/streams/"
mixedRecordingDir = "/var/vrs/recordings/cucmRecording/sessions/"

  1. Also change the IP address. Assign you local machine ip address url = "http://<IP-Address>:9900/mixapi",

  2. Give required permission to the r-synced directory

Since our VRS interacts with local storage, it reads and writes files on the local storage. Pemission to read and write is thus necessary for the VRS to work.

Assign full permission to the mounted directory for all group, users and others to read, write and execute the mounted directory. It can be done with umask.

  1. Now, run the install script. ./install-cisco.sh

  2. Since most of the configurations are same. Copy config.env to other VMs (Second Recorder and Replay) the same for the other VRS.

  3. Adjust consul container name.

  4. Add peer address accordingly

  5. run the ./install-cisco.sh on the second recorder machine

  6. run the ./install-replay.sh on replay server