This page describes how to install the XiVO CC.
It describes the installation with the debian package of the whole XiVO CC.
As a reference, the manual installation page is here Manual configuration and installation.
- the wizard MUST be passed on the XiVO PBX
- XiVO PBX will be reconfigured during the installation and must be restarted. You may accept the automatic restart during the installation or you need to restart it manually later before starting the docker containers.
- If you configure HA on XiVO, you have to re-configure postgres to accept connection of XiVO CC - see PostgreSQL configuration section
- By default XiVO CC installation will pre-empt network subnet 172.17.0.0/16 If this subnet is already used, some manual steps will be needed to be able to install XiVO CC. These steps are not described here.
The following components will be installed :
- XuC : outsourced CTI server providing telephony events, statistics and commands through a WebSocket
- XuC Management : supervision web pages based on the XuC
- Pack Reporting : statistic summaries stored in a PostgreSQL database
- Totem Support : near-real time statistics based on ElasticSearch
- SpagoBI : BI suite with default statistic reports based on the Pack Reporting
- Recording Server : web server allowing to search recorded conversations
- Xuc Rights Management : permission provider used by XuC and Recording Server to manage the user rights
We will assume your XiVO CC server meets the following requirements:
- OS : Debian 9 (stretch), 64 bits.
- you have a XiVO PBX installed in a compatible version (basically the two components XiVO and XiVO CC have to be in the same version).
- the XiVO PBX is reachable on the network (ping and ssh between XiVO CC and XiVO PBX must be possible).
- the XiVO PBX is setup (wizard must be passed) with users, queues and agents, you must be able to place and answer calls.
For the rest of this page, we will make the following assumptions :
- the XiVO PBX has the IP 192.168.0.1
- some data (incoming calls, internal calls etc.) might be available on XiVO (otherwise, you will not see anything in the check-list below).
- the XiVO CC server has the IP 192.168.0.2
Architecture & Flows¶
This diagram is very important and shows the architecture between the different components inside XiVO CC and also interactions with XiVO PBX components.
XiVO PBX Restrictions and Limitations¶
XiVO PBX enables a wide range of configuration, XiVO-CC is tested and validated with a number of restriction concerning configurations of XiVO PBX:
- Do not activate Contexts Separation in xivo-ctid Configuration
- Users deactivation is not supported
- Queue ringing strategy should not be Ring All
- Do not use pause on one queue or a subset of queues status, only pause or ready on all queues
- Do not activate Call a member already on (Asterisk ringinuse) on xivo queue advanced configuration
User And Agent Configuration¶
- All users and queues have to be in the same context
- Agent and Supervisors profiles should use the same Presence Group
- Agents and Phones should be in the same context for mobile agents
- Agents must not have a password in XiVO agent configuration page
- All users must have the supervision on the XiVO (IPBX-Users-Edit-Services-Enable supervision checked)
- When and agent is disassociated from its user, xuc server has to be restarted.
- We strongly advise to not delete any user or agent to keep reporting available for them. Even so when an agent is deleted, xuc server has to be restarted,
- Restarting XUC server with active calls may result in wrong agent’s state.
Install from repository¶
The installation and configuration of XiVO CC (with its XiVO PBX part) is handled by the xivocc-installer package which is available in the repository.
Install process overview¶
The install process consists of two parts:
- The first part is to manually run the
xivocc_install.shscript to install the dependencies (ntp, docker, docker-compose…) and which will trigger the XiVO CC installation.
- The second part is to install the extra package for the recording.
The installation is automatic and you will be asked few questions during the process:
- Before copying the authentication keys, you will be prompted for the XiVO PBX root password.
- Enter IP addresses of XiVO PBX and XiVO CC.
- XiVO PBX must restart, the question will prompt you to restart during the process or to restart later.
Launch install script¶
To be run on the XiVO CC server
Once you have your Debian stretch properly installed, download the XiVO CC installation script and make it executable:
wget http://mirror.xivo.solutions/xivocc_install.sh chmod +x xivocc_install.sh
Running the script will install the XiVO CC components via the
xivocc-installer package. It is required to restart XiVO PBX during or after the setup process.
The installer will ask whether you wish to restart XiVO PBX later.
- Wizard MUST be passed on the XiVO PBX.
- XiVO PBX services will need to be restarted. The installer will ask whether you wish to restart XiVO PBX during or after the setup process.
Also, check that you have following information:
- XiVO PBX root password;
yes(you could revert to
noafter installation of XivoCC);
- XiVO PBX’s IP address;
- XiVO CC DNS name or IP address (the one visible by XiVO PBX);
- Number of weeks to keep statistics;
- Number of weeks to keep recordings (beware of disk space);
The number of weeks to keep statistics must be higher than the number of weeks to keep recordings. Recording purging is based on the statistic data, so the statistic data must not be removed before purging recordings.
Configure ntp server
The XiVO CC server and the XiVO PBX server must be synchronized to the same NTP source.
Recomended configuration : you should configure the NTP server of the XiVO CC server towards the XiVO PBX.
In our example it means to add the following line in the file
server 192.168.0.1 iburst
Launch the services
Please, ensure your server date is correct before starting. If system date differs too much from correct date, you may get an authentication error preventing download of the docker images.
After a successful installation, start docker containers using the installed
xivocc-dcomp up -d
To restart XiVO services, on XiVO PBX server run
xivo-service restart all
To reinstall the package, it is required to run
apt-get purge xivocc-installer then
apt-get install xivocc-installer. This will re-run the configuration
of the package, download the docker compose template and setup XiVO PBX.
Purging the package will also remove the xuc and stats users from the XiVO PBX database.
- To avoid uninstallation problems:
- please use the following command to uninstall
apt-get purge xivocc-installer
- if the process is aborted, it will break the installation. Then run
- please use the following command to uninstall
Checking Installed Version¶
Version of the running docker containers can be displayed by typing (see Show containers and images versions for other commands):
Component version can also be found in the log files and on the web pages for web components.
You should configure users and their rights in the Configuration manager http://<XiVO IP Address>:9100/configmgt/ (default user avencall/superpass).
If you change the cti login username in xivo configuration, user has to be recreated with apropriate rights in configuration manager.
To configure SpagoBI, go to http://192.168.0.2:9500/SpagoBI (by default login: biadmin, password: biadmin).
Update default language¶
- Go to “⚙ Resources” > “Configuration management”
- In the “Select Category” field, chose “LANGUAGE_SUPPORTED”
- change value of the label “SPAGOBI.LANGUAGE_SUPPORTED.LANGUAGE.default” in your language : fr,FR , en,US , …
Upload Sample Reports¶
- Download the sample reports from https://gitlab.com/xivocc/sample_reports/blob/master/spagobi/samplereports.zip
- Import zip file in SpagoBI:
- Goto “Repository Management” -> “Import/Export”
- Click on “Browse/Choose your file” and choose the previous
- Click on “Import” icon
- Click next with default options until you are asked to override metadata, set Yes as shown in screen below
You can now browse the sample reports in Document->Rapports->Exemples.
Use the database status report to check if replication and reporting generation is working :
Data replication can take some time if there are a lot of data in xivo cel and queue log tables. You may check xivo-db-replication log files (/var/log/xivocc/xivo-db-replication.log).
Preconfigured panels are available on http://@IP/kibana/#/dashboard/file/queues.json et http://@IP/kibana/#/dashboard/file/agents.json to be able to save this panels in elasticsearch database you have to sign on on request user admin/Kibana
Post Installation Check List¶
- All components are running : xivocc-dcomp ps
- Xuc internal database is synchronized with xivo check status page with http://xivoccserver:8090/
- CCManager is running, log a user and check if you can see and manage queues : http://xivoccserver:8070/ccmanager
- Check database replication status using spagobi system report http://xivoccserver:9500/SpagoBI
- Check elasticsearch database status (totem panels) http://xivoccserver:9200/queuelogs/_status
- Check that you can listen to recordings http://xivoccserver:9400/
- Check totem panels http://192.168.85.102/kibana
Make sure to have few calls made in your XiVO, despite you will not see anything in totem or spagobi.