Release 1.1.2 just released, this release supports the following real time reports:
For details, please reference the support web page.
Release 1.3.3 just released, this release supports ACD and DTMF functions. Moreover, a pass through prefix can be defined so ScreenPop will pass the number directly to PBX without any manipulation. The new UI of calltoui is updated as follow:
I use Microsoft Access MDB file to store program configurations for my tools. Recently some users told me some of my tools start up abnormal because configuration data could not read from the MDB file. I installed a testing Windows 2003 R2 server and applied the latest patches, found that the problem can be easily simulated. I recreated such MDB file from a workable one and the problem was gone immediately, it seemed something wrong that I could not explain. I recreated the relevant MDB file for my tools and updated the file in SourceForge, please download the file if you also encountered this problem.
Introduction
The clintSVR is a gateway program for the access of Avaya CMS real time and historical reports. It uses a tool called CLINT to retrieve the real time and historical data from Avaya CMS and provides API(s) for you to do application development. Applications such as wallboard and agent map software can be implemented on top of clintSVR. The clintSVR retrieves CMS real time and historical reports at an interval that specified by you, it stores the data in memory and allows multiple access by different programs via REST query API, WebSocket, OCX and C/C++ interfaces. The data is presented in XML / JSON format and the following interfaces and reports are supported:
See Also: bcmsSVR/BCMS Real Time and Historical Report Data
See Also: Call Analytics
Avaya CMS License Requirement
Prerequisite
Preparation and Password Encryption
Testing using Docker Image
Please follow this guide to test ClintSVR using Docker Container.
Testing using OVA File
Please contact us for a latest version of OVA image. After deploying the OVA file, please modify the following for your own environment.
The username and password of the OVA VM is
64 bit Windows System
Installation
Add Reports
Uninstallation
RedHat/CentOS 7.x Installation Procedure
sed -i 's/\(^SELINUX=\).*/\SELINUX=disabled/' /etc/selinux/config
systemctl disable firewalld
systemctl stop firewalld
reboot
sudo rpm -Uvh https://dev.mysql.com/get/mysql80-community-release-el7-1.noarch.rpm
sudo yum --enablerepo=mysql80-community install mysql-community-server
sudo service mysqld start
grep "A temporary password" /var/log/mysqld.log
mysql_secure_installation
yum install telnet ntp
yum install libssh2 mysql-connector-odbc unixODBC
systemctl enable mysqld
systemctl start mysqld
systemctl enable ntpd
systemctl start ntpd
mysql -u root -p
> create database clintsvr;
> create database clintrtdb;
> create user 'tcpgate'@'localhost' identified by 'P@ssw0rd';
> grant all on clintsvr.* to 'tcpgate'@'localhost';
> grant all on clintrtdb.* to 'tcpgate'@'localhost';
> flush privileges;
> quit
mysql -h localhost -u tcpgate -p clintsvr < clintsvr.sql
mysql -h localhost -u tcpgate -p clintrtdb < clintrtdb.sql
useradd clintsvr
mkdir /usr/local/clintsvr
cp clintSVR64 /usr/local/clintsvr
chmod +x /usr/local/clintsvr/clintSVR64
chown -R clintsvr.clintsvr /usr/local/clintsvr
mkdir -p /var/log/clintsvr
chown -R clintsvr.clintsvr /var/log/clintsvr
echo "rm /tmp/clintsvr.log" >> /etc/rc.local
echo "su clintsvr -c '/usr/local/clintsvr/clintSVR64 -u tcpgate -p 40UIt9O3PqtwsSn+Wx6pig=='" >> /etc/rc.local
chmod +x /etc/rc.local
Ubuntu 14.04 Installation Guide
sudo apt-get install mysql-server mysql-client
sudo apt-get install libmyodbc unixodbc unixodbc-bin
sudo apt-get install libssh2-1 libssh-4 openssl unrar
mysql -u root -p
create database clintsvr;
create user 'tcpgate'@'localhost' identified by 'tcpgate';
grant all on clintsvr.* to 'tcpgate'@'localhost';
flush privileges;
quit
mysql -h localhost -u tcpgate -p clintsvr < clintsvr.sql
sudo odbcinst -i -d -f /etc/odbcinst.ini
sudo odbcinst -i -s -l -f /etc/odbc.ini
sudo useradd clintsvr
sudo mkdir /usr/local/clintsvr
sudo cp clintSVR /usr/local/clintsvr
sudo chmod +x /usr/local/clintsvr/clintSVR
sudo chown -R clintsvr.clintsvr /usr/local/clintsvr
sudo mkdir -p /var/log/clintsvr
sudo chown -R clintsvr.clintsvr /var/log/clintsvr
rm -f /tmp/clintsvr.log
su clintsvr -c '/usr/local/clintsvr/clintSVR'
Ubuntu 16.04 Installation Notes
Ubuntu 18.04 Installation Notes
Dictionary
REST Query API
Logging real time data to Database
mysql -u root -p
> create database clintrtdb;
> create user 'tcpgate'@'localhost' identified by 'tcpgate';
> grant all on clintrtdb.* to 'tcpgate'@'localhost';
> grant all on clintrtdb.* to 'tcpgate'@'%';
> flush privileges;
> quit
mysql -h localhost -u tcpgate -p clintrtdb < clintrtdb.sql
[CLINTRTDBCFG]
MySQL connection to clintRTDB
Driver = MySQL
Server = localhost
Port = 3306
Database = clintrtdb
WebSocket Interface
C++ API Interface
//
// clintApp.cpp
//
#include "clint.h"
#include <string>
#include <vector>
#include <iostream>
using namespace std;
int main(int argc, char** argv)
{
CLINT_HANDLE handle;
CLINTLogin_t login;
CLINTSplitSkillStatus_t splitSkillStatus;
CLINTSplitSkillReport_t splitSkillReport;
CLINTSplitSkillCallProfile_t splitSkillCallProfile;
CLINTSplitSkillTopAgent_t splitSkillTopAgent;
CLINTSplitSkillTopAgentStatus_t splitSkillTopAgentStatus;
CLINTAgentReport_t agentReport;
CLINTAgentGroup_t agentGroup;
CLINTVDNReport_t vdnReport;
CLINTVDNSkillPreference_t vdnSkillPreference;
CLINTVDNCallProfile_t vdnCallProfile;
CLINTQueueAgentStatus_t queueAgentStatus;
CLINTQueueTopAgentStatus_t queueTopAgentStatus;
CLINTQueueAgentSummary_t queueAgentSummary;
CLINTTrunkGroupReport_t trunkGroupReport;
CLINTEventCountSummary_t eventCountSummary;
CLINTCustomRTA_t customRTA;
CLINTDeviceRTA_t deviceRTA;
CLINTAgentRTA_t agentRTA;
CLINTHisTrunkGroupBusyHour_t tgBusyHour;
CLINTHisSplitSkillSummaryInterval_t spskSummaryInterval;
CLINTHisVDNInterval_t vdnInterval;
unsigned int bufferSize;
memset(&login, 0x00, sizeof(CLINTLogin_t));
strcpy(login.username, "app");
strcpy(login.passwd, "app");
if (ClintLogin(&handle, "127.0.0.1", 5050, &login)==CLINTRC_SUCC) {
// Event Count Summary
memset(&eventCountSummary, 0x00, sizeof(CLINTEventCountSummary_t));
eventCountSummary.acd = 2;
strcpy(eventCountSummary.skill, "541");
if (ClintEventCountSummary(handle, &eventCountSummary, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// Trnk Group Report
memset(&trunkGroupReport, 0x00, sizeof(CLINTTrunkGroupReport_t));
trunkGroupReport.acd = 2;
strcpy(trunkGroupReport.trunkGroup, "34");
if (ClintTrunkGroupReport(handle, &trunkGroupReport, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// Split Skill Status
memset(&splitSkillStatus, 0x00, sizeof(CLINTSplitSkillStatus_t));
splitSkillStatus.acd = 2;
strcpy(splitSkillStatus.skill, "514");
if (ClintSplitSkillStatus(handle, &splitSkillStatus, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// Split Skill Report
memset(&splitSkillReport, 0x00, sizeof(CLINTSplitSkillReport_t));
splitSkillReport.acd = 2;
strcpy(splitSkillReport.skills, "514;541");
if (ClintSplitSkillReport(handle, &splitSkillReport, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// Split Skill Call Profile
memset(&splitSkillCallProfile, 0x00, sizeof(CLINTSplitSkillCallProfile_t));
splitSkillCallProfile.acd = 2;
strcpy(splitSkillCallProfile.skill, "541");
if (ClintSplitSkillCallProfile(handle, &splitSkillCallProfile, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// Split Skill Top Agent
memset(&splitSkillTopAgent, 0x00, sizeof(CLINTSplitSkillTopAgent_t));
splitSkillTopAgent.acd = 2;
strcpy(splitSkillTopAgent.skills, "541;514");
if (ClintSplitSkillTopAgent(handle, &splitSkillTopAgent, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// Split Skill Top Agent
memset(&splitSkillTopAgentStatus, 0x00, sizeof(CLINTSplitSkillTopAgentStatus_t));
splitSkillTopAgentStatus.acd = 2;
strcpy(splitSkillTopAgentStatus.skill, "541");
if (ClintSplitSkillTopAgentStatus(handle, &splitSkillTopAgentStatus, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// Agent Report
memset(&agentReport, 0x00, sizeof(CLINTAgentReport_t));
agentReport.acd = 2;
strcpy(agentReport.skill, "514");
if (ClintAgentReport(handle, &agentReport, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// Agent Group
memset(&agentGroup, 0x00, sizeof(CLINTAgentGroup_t));
agentGroup.acd = 3;
strcpy(agentGroup.groupName, "Apple");
if (ClintAgentGroup(handle, &agentGroup, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// VDN report
memset(&vdnReport, 0x00, sizeof(CLINTVDNReport_t));
vdnReport.acd = 3;
strcpy(vdnReport.vdns, "25512;25513");
if (ClintVDNReport(handle, &vdnReport, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// VDN Skill Preference
memset(&vdnSkillPreference, 0x00, sizeof(CLINTVDNSkillPreference_t));
vdnSkillPreference.acd = 3;
strcpy(vdnSkillPreference.vdns, "25512;25513");
if (ClintVDNSkillPreference(handle, &vdnSkillPreference, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// VDN Call Profile
memset(&vdnCallProfile, 0x00, sizeof(CLINTVDNCallProfile_t));
vdnCallProfile.acd = 3;
strcpy(vdnCallProfile.vdn, "25512");
if (ClintVDNCallProfile(handle, &vdnCallProfile, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// QueueAgentStatus
memset(&queueAgentStatus, 0x00, sizeof(CLINTQueueAgentStatus_t));
queueAgentStatus.acd = 2;
strcpy(queueAgentStatus.skill, "541");
if (ClintQueueAgentStatus(handle, &queueAgentStatus, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// QueueTopAgentStatus
memset(&queueTopAgentStatus, 0x00, sizeof(CLINTQueueTopAgentStatus_t));
queueTopAgentStatus.acd = 2;
strcpy(queueTopAgentStatus.skill, "541");
if (ClintQueueTopAgentStatus(handle, &queueTopAgentStatus, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// QueueAgentSummary
memset(&queueAgentSummary, 0x00, sizeof(CLINTQueueAgentSummary_t));
queueAgentSummary.acd = 2;
strcpy(queueAgentSummary.skill, "541");
if (ClintQueueAgentSummary(handle, &queueAgentSummary, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// customRTA
memset(&customRTA, 0x00, sizeof(CLINTCustomRTA_t));
customRTA.acd = 2;
strcpy(customRTA.skills, "1-999;1000-2000");
if (ClintCustomRTA(handle, &customRTA, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// deviceRTA
memset(&deviceRTA, 0x00, sizeof(CLINTDeviceRTA_t));
deviceRTA.acd = 2;
strcpy(deviceRTA.deviceID, "69948");
if (ClintDeviceRTA(handle, &deviceRTA, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// agentRTA
memset(&agentRTA, 0x00, sizeof(CLINTAgentRTA_t));
agentRTA.acd = 2;
strcpy(agentRTA.agentID, "51170");
if (ClintAgentRTA(handle, &agentRTA, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// historical trunk group busy
memset(&tgBusyHour, 0x00, sizeof(CLINTHisTrunkGroupBusyHour_t));
tgBusyHour.acd = 2;
strcpy(tgBusyHour.tgs, "26;27");
strcpy(tgBusyHour.date, "yesterday");
if (ClintHisTrunkGroupBusyHour(handle, &tgBusyHour, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// historical split skill summary interval
memset(&spskSummaryInterval, 0x00, sizeof(CLINTHisSplitSkillSummaryInterval_t));
spskSummaryInterval.acd = 2;
strcpy(spskSummaryInterval.skill, "541");
strcpy(spskSummaryInterval.date, "yesterday");
if (ClintHisSplitSkillSummaryInterval(handle, &spskSummaryInterval, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
// historical vdn interval
memset(&vdnInterval, 0x00, sizeof(CLINTHisVDNInterval_t));
vdnInterval.acd = 2;
strcpy(vdnInterval.vdn, "45712");
strcpy(vdnInterval.date, "today");
if (ClintHisVDNInterval(handle, &vdnInterval, &bufferSize)==CLINTRC_SUCC) {
vector<unsigned char> buffer(bufferSize);
if (ClintGetResultXML(handle, &buffer[0], bufferSize)==CLINTRC_SUCC) {
cout << &buffer[0] << endl;
}
}
ClintLogout(handle);
}
return 0;
}
XMPP Connection
Splunk Connection
Splunk Integration using HTTP Event Collector
System Notification Email
Know Problem
Support and License
AstLogger 1.3.6 just released. This release has a some enhancements and bug fixings:
24 September 2013 AvayaCDR 1.3.2 just released, it fixed some bugs in the sftp module. Blacklist country code can be defined using the + sign. For details, please reference the AvayaCDR web page. Thanks Brian Norrgard, you helped me to identify the sftp user authentication problem.
15 September 2013 AvayaCDR 1.3.1 just released, it supports scanning of blacklisted number or country code from CDR data and sends alert email to administrator. It is easier for administrator to find out unauthorized dialing when it happened. Enjoy! For details, please reference the AvayaCDR web page.
Introduction
27 Feb 2015, ScreenPop 1.4.0 just released. This release supports WebSocket interface which enables the call control integration with web browser directly. We can develop JQuery softphone using this WebSocket interface.
2 Aug 2014, ScreenPop 1.3.7 just released. This release supports sending and retrieval of user data by provided DLL and fixed some bugs in acd login and acd auto answer features.
5 Feb 2014, ScreenPop 1.3.6 just released. This release provides OCX control for CTI application development, both call control and event notification are supported. Moreover, a data server called uuiSVR.exe is provided for passing of user data between applications. An API to query user’s extension is also provided.
3 January 2014, ScreenPop 1.3.5 just released. This release supports license management via a license server. Moreover, it supports Alternate call control and auto answer for one-x communicator when one-x has ACD logon.
16 Dec 2013, ScreenPop 1.3.4 just released. This release supports passing AGENTID to web application. Moreover, web application can perform call controls using CGI interface.
19 Nov 2013, 1.3.3 just released, this release supports ACD and DTMF functions. Moreover, a pass through prefix can be defined so ScreenPop will pass the number directly to PBX without any manipulation. The UI of calltoui is updated as follow:
8 Jul 2013, 1.3.0 is released, this release supports callto with user interface and additional call controls such as hold, retrieve, answer, hangup, consultation, reconnect, transfer and conference. The user interface looks like this
17 Jun 2013, 1.2.0 is released, this release supports callto protocol so you can make call directly from web page. I reference this page and thanks WaiHung for the direction.
Background of ScreenPop
I attended OTRS training last week. OTRS is a ticketing system which is very useful for IT Service Desk. I think it would be very useful if the OTRS phone ticket can be created and popped up automatically with customer information when a call comes in, it will save a lot of time for Service Desk especially the time for searching customer information. It triggers me to implement this ScreenPop application. The ScreenPop application is a Windows service which is installed in agent’s PC, it monitors agent’s extension and do the screen pop when there is incoming call. The software supports screen pop of web application, of course telephony data such as CLI, DNIS, UCID, SPLIT and UED can be passed to the web application.
Preparation and Password Encryption
Installation
Installation for Click to Dial (callto URL)
Configuration for OTRS Screen Pop
Configuration for SalesForce Screen Pop
Installation for ScreenPop OCX interface
Installation for REST interface Call Control
Installation for WebSocket interface Call Control
Support and License
Background
Some outbound programs required agent to play a voice file (Terms and Conditions) together with his/her customer during the call. This is a mandatory requirement for selling insurance or finance products in some countries. I’m looking for this solution quite a long time. When I read this Asterisk post that a patch was added to provide fine control of a playback using Asterisk Manager Interface (AMI), I believe I can make such solution in my Avaya platform. The work is so simple, barge-in the agent phone using TSAPI, conference the Asterisk extension which plays the voice file, then have the fine control using AMI.
I finally implemented the server module (TcPlayer) and the API (TcAPI32). The API is in the form of DLL and OCX, great!
Thanks Matt Jordan.
Introduction
The TcPlayer is a server module that barge-in an agent’s call with an Asterisk extension which is response for the playing of Terms and Conditions voice file, the software also provides API to control the playback. By using the API, you can PLAY, PAUSE, STOP, RESTART, FORWARD and REWIND of your voice file. This is very useful for outbound selling in call center.
The TcPlayer server module uses TSAPI library for the barge-in function, please make sure you meet the following requirements before installation of this software:
Preparation and Password Encryption
64 bit Windows System
Installation
Asterisk Configuration
TcAPI32
Redundancy Configuration
Uninstallation
Introduction
The TCPGate SOCKS (tgSOCKS) is a SOCKS4 and SOCKS5 server, it is built using the core modules of TCPGate. It supports the following features:
64 bit Windows System
Installation of tgSOCKS
Uninstallation
