Deployment Guide

Generic Connector Configuration

Connector Configuration Parameters

The following are the CUCM configurations that can be set in the env file.

Deployment Steps

1. Run the following command to create a network

   // For docker based deplyment
   docker network create appnet
   
   // For podman based deployment
   podman network create appnet
   

   1. In case of if podman network creation fails and user sees following error

      

   2. In that case user needs to configure a subnet pool, run following command to do so or you can refer to the official podman documentation .

      podman network create \
        --subnet 10.88.0.0/16 \
        --gateway 10.88.0.1 \
        appnet
      
      

2. Download the deploy.sh file from here.

3. Place deploy.sh file inside some folder eg. Jtapi_Connector.

4. Run the following commands to start the procedure.

   Commands to execute deploy.sh file

   cd /root/Jtapi_Connector
   bash deploy.sh
   

   

5. A cloned folder 'cucm_connector_deployment' can be seen on the command ls. 

6. Go into the cloned folder, where two folders can be seen.

   

7. Run the following set of commands to install ActiveMQ.

   cd Stand_alone_Active_MQ
   

8. Create ssl self sigined certs (broker.ts and broker.ks) if not provided by the customer. Run the following command

   // Genrate Keystore
   keytool -genkeypair \
     -alias broker \
     -keyalg RSA \
     -keysize 2048 \
     -validity 365 \
     -keystore broker.ks \
     -storepass password \
     -dname "CN=10.192.9.35"
   
   // Export Certificate
   keytool -exportcert \
     -alias broker \
     -keystore broker.ks \
     -storepass password \
     -file broker.crt
   
   // Create Trust Store
   keytool -importcert \
     -alias broker \
     -file broker.crt \
     -keystore broker.ts \
     -storepass password \
     -noprompt
   
   

9. Now edit activemq.xml file available on the same path and update the passwords

   

10. If you are using podman deployment, then do this step else skip

    1. Edit docker-compose file and update the volumes as follow (add :Z at the end)

11. 

    Now run following command to install activemq

    // Docker
    docker-compose up -d
    
    // Podman
    podman-compose up -d
    

12. After above command user can access admin console on a browser to confirm its availability.
    http://machine_ip:8161/admin/queues.jsp

    

13. After amq installation, go back to the main repo directory 'cucm_connector_deployment'. And go into the connector folder 'Connector_Compose_Env'.

    

14. You can see the files like this.

    

15. Edit the env file and add the required configurations as explained here!

16. After adding configurations, run the following commands to install connector application:

    docker-compose up -d
    

17. After successful execution of step 13, run the following command to check if the container is up and running!

    docker container ps -a
    

    

ActiveMQ Configuration (Redundant Deployment Only)

ActiveMQ “Config” button opens the ActiveMQ configuration file %ACTIVEMQ%/conf/activemq.xml in your default text editor (e.g. notepad). 

Configuring Network of Brokers 

Settings for a network of brokers are mandatory for redundant deployment only. These configurations should however be done on one side only. 

ActiveMQ brokers should be configured to run as a network of brokers to communicate with each other both for Active-Active and Active-Passive deployment models.

1. Edit the ActiveMQ Network brokers in activemq.xml file

In activemq.xml, the “Network of Broker” configuration please add the following configuration mentioned in the screenshot below. There are 2 instances of <networkConnector> (i) for Queues, (ii) for topics, where you need to set the value of the URI parameter specifying other broker’s (site-B) address. 

If the above-commented configurations are not available in activemq.xml file then copy following and add it inside <broker> tag.

Configurations

<networkConnectors>
	<networkConnector
    	name="T:broker1->broker2"
        uri="static:(tcp://192.168.2.162:61616)"
        duplex="true"
        decreaseNetworkConsumerPriority="true"
        networkTTL="2"
        dynamicOnly="true">
        <excludedDestinations>
        	<queue physicalName=">" />
        </excludedDestinations>

    </networkConnector>

    <networkConnector
    	name="Q:broker1->broker2"
        uri="static:(tcp://192.168.2.162:61616)"
        duplex="true"
        decreaseNetworkConsumerPriority="true"
        networkTTL="2"
        dynamicOnly="true">
        <excludedDestinations>
        	<topic physicalName=">" />
        </excludedDestinations>
    </networkConnector>
</networkConnectors>

Run the following commands to restart the Service

docker-compose down
docker-compose up -d

The URI on site-A should point to site-B URI “static:(tcp://SITE-B:PORT)” to configure it in network bridge mode. 

For more information about configuring a network of brokers, see this article.

Frontend CUCM Docker/Podman Based Deployment Guide

CUCM Frontend Docker/Podman Based Deployment Guide

This document provides instructions for the automated deployment of the CUCM Frontend application using Podman and Nginx on RHEL 9.

1. Prepare the Environment

First, create a dedicated directory to house the deployment script and any certificate files.

mkdir -p ~/cucm-frontend-docker
cd ~/cucm-fro0ntend-docker

2. Download the Deployment Script

Download the deploy_frontend.sh file and place it inside cucm-frontend-docker folder.

3. Provide Authentic SSL Certificates (Optional)

If you have CA-signed certificates, place them in the same directory . The script will automatically detect and use them if they follow this naming convention:

File Type	Required Name	Description
Certificate	customer_cert.pem	Your public certificate (and intermediate chain)
Private Key	customer_key.pem	Your private key file

4. Execute Deployment

Run the following commands to ensure the file format is correct and to begin the installation.

# Remove hidden Windows characters and set permissions
sed -i 's/\r$//' deploy_frontend.sh
chmod +x deploy_frontend.sh

# Run the deployment
sudo ./deploy_frontend.sh

5. Verification

Once the script completes, you should see the message: "BOOM! Deployment Successful".

• Access URL: https://<YOUR_SERVER_IP>:8443

• Security Note: If using self-signed certificates (default), you must click "Advanced -> Proceed" in your browser to bypass the privacy warning.

6. Updating Frontend Configuration

1. open deploy_frontend.sh file and locate Section 5 (CREATE APP CONFIG) inside the script, update the values and save it.

	Property Name	Value	Description
1	amqUrl1	ws://<server-ip/FQDN>:61615/stomp or wss://<activemq-server-ip>:61615/stomp	For communicating with CUCM Connector. For Http use ws and for Https use wss.
2	amqUrl2	ws://<activemq-server-ip>:61615/stomp or wss://<activemq-server-ip>:61615/stomp	For communicating with CUCM Connector. For Http use ws and for Https use wss.
3	powered_by	true/false	System variable should always remain True
4	crm	0/1	A possible value for this key would be 0 or 1 0= When web CTI is deployed as a standalone project without any CRM Integration  1= When Web CTI is deployed with some CRM, The CRM can be any. If the value for this property is 1, then the crmFilePath variable must be set
5	crmFilepath	The predefined path of the CRM file	To make this property work, the above property CRM must be set 1 . Value for this property depends on the CRM you are using.  Possible values are  Value =  new_Salesforce.js

2. Run this command

   sudo ./deploy_frontend.sh
   

Integration with Salesforce

Step 1: Configure CTI Adapter URL

The user must have administrator rights in Salesforce.

1. Download callCenterDefinition.xml .

2. From Setup on Salesforce, in the Quick Find box, enter Call Centers, then select Call Centers.

3. On the next page, press Continue.

4. Click on Import on the next page.

5. Upload the callCenterDefinition.xml file and click on import.

6. On the next page, you can see the general information about the call center and you can edit it by clicking the Edit option.

7. Once you click on Edit option, on the next page all the fields will be filled with the data in callCenterDefinition file.

8. Change the Adapter URL with the URL on which CUCM Connector is running.

Step 2: Assign Users to call center

1. Open Call Center with the name “ExpertflowCTI“.

2. At the bottom you’ll find the “Manage call center users” option. If you can’t find manage “Manage call center users”, then first save the call center and then look for the same option.

3. Click this option and on the next page click “Add more users”, select desired user(s), and then click “Add to call center”.

Step 3: Create and configure a lightning app

1. From Setup, in the Quick Find box enter App Manager.

2. Open the app manager, click “New Lightning App” from the top right corner.

3. Enter the name of the app and developer, other options are not mandatory but if you want you can choose according to your preferences and select next.

4. Go with the default options and click next.

5. Click “Add Utility Items”, type “Open CTI softphone” and add the softphone to your app by clicking it. Set panel height to 500 and width to 400 and click next.

6. On the next screen, add accounts, contacts, leads and tasks from available items.

7. Last but not least select all profiles and add them. After adding them click “Save & Finish”

Login agent

1. Open your application from the top left 9-dotted pattern icon, adjacent to “Setup”. If you can’t find it, search using the name you used while creating an application.

2. Once opened, Maximize Softphone by click on “Icon” from the bottom left corner, enter extension, and press register button.