CXiaaS: Customer hosted installation

CXiaaS: Customer hosted installation

You can host our solution within your own nominated data centre cloud-hosted environment.

All you need is a Linux or Windows Server and an SQL server of your choice. 


We install our adapter, provide available analytics templates for out-of-the-box dashboards and supply your Genesys Cloud administrator with OAuth credential setup instructions


More information: https://support.customerscience.com.au/support/solutions/articles/36000406214-cxiaas-genesys-cloud-adapter-for-external-analytics

Ready to Install?

Server requirements

In order to sync your contact centre data, 2 servers are required. 

1 server is required to run the adapters and sync the data from your contact centre provider

1 server is required to run a PostgreSQL or Microsoft SQL Server

The below minimum requirements are recommended for optimal performance, 

Description

Value

CPU 4 cores

Memory 

8 GB

Disk Space 

80 GB

OS

Linux or Windows with docker support

User Account Exclusive user account to run the adapter

By default, we support the deployment of our adapter via your hosted server, but not the server itself. if you require support for a hosted solution/server, we recommend migrating to our hosted offering of CXiaaS.

Database requirements

  • If opting for a Postgresql database, it is recommended to run the Customer Science release of Postgresql, as this comes with bundled automated cron and partition management.

This can be installed using the below install process, instead by performing the below pull request.

docker pull customerscience/genesys_adapter:postgres15-bullseye
If the above docker container is not used for the Postgrest database, the following plugins are required to be installed for effective database management

pg_cron
pg_partman

If using AWS RDS, installation documentation is available he
  • If opting for a MS SQL database, please create this database on your preferred host, system requirements included below if a new host is required.

Description

Value

CPU 4 cores

Memory 

16 GB

Disk Space 

80 GB with up to an extra 5GB per month of data stored (~250 GB for 3 years of historical data)

OS

Linux or Windows with docker support

User Account An account with the ability to CRUD (Create, read, update and delete)

Networking requirements

The Following Access is required by the Application to operate correctly. 

The adapter requires outbound internet traffic to a series of locations, we recommend allowing external internet access from the server responsible for running your adapter. Whereas the database host will only require access from the adapter host.

We also require remote access to the server to assist with deployment, support and upgrades via SSH with the public key, this server should be whitelisted for connections from 52.64.146.96.

Install process

Adapter server address
Adapter server port
Adapter server username
Adapter server public key
Database server address
Database  server port
Database  server username
Database  server public key
Password for created csganalytics account
Genesys Cloud oAuth ClientID
Genesys Cloud oAuth ClientSecret
The following process has been documented on Debian, but this can be re-factored to your preferred operating system.

Install docker-engine for your operating system: https://docs.docker.com/engine/install/

sudo apt update;
sudo apt install -yy apt-transport-https ca-certificates curl software-properties-common;
sudo install -m 0755 -d /etc/apt/keyrings;
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg;
sudo chmod a+r /etc/apt/keyrings/docker.gpg;
echo \
 "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
 "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
 sudo tee /etc/apt/sources.list.d/docker.list > /dev/null;
sudo apt-get update -q;
sudo apt-get install -yq docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin;
sudo systemctl status docker;
export USER=csganalytics
#Update sudo to not require password
echo "$USER ALL=(ALL:ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/$USER
sudo adduser --shell /bin/bash --gecos "" $USER;
sudo usermod -a -G docker $USER;
sudo curl https://raw.githubusercontent.com/docker/docker-ce/master/components/cli/contrib/completion/bash/docker -o /etc/bash_completion.d/docker.sh

Prepare the local docker environment.

The password is provided by your Customer Science consultant
sudo curl https://raw.githubusercontent.com/docker/docker-ce/master/components/cli/contrib/completion/bash/docker -o /etc/bash_completion.d/docker.sh

If you would like to enable Customer Science to monitor your server uptime and load across disk, CPU and memory, you can install the monitoring agent

wget https://staticdownloads.site24x7.com/server/Site24x7InstallScript.sh -P /tmp/
bash /tmp/Site24x7InstallScript.sh -i -key=us_89bad4ab7266b928e5ec2201016e00ac

Install required remote access

Customer Science manages customer hosted instances their in-house instance of Portainer, via an installation of an edge agent.

This agent authenticates against our instance directly. 

Please submit the following email to our support team, and a agent install command will be provided, at which point Cuistomer Science support will complette your install.

Support process

If there are any issues with the installation or support process you can contact the support team via email at support@customerscience.com.au 

Schema and Data Dictionary

https://useast.connect.ucarchitects.com.au/Documentation/webframe.html

    • Related Articles

    • CXiaaS: Genesys Cloud Adapter for External Analytics

      Why do you need analytics? Data Analytics forms the backbone of business intelligence. It enables benchmarking, accurate reporting, KPI tracking and insights into consumer behaviour, allowing you to stay ahead of your competition. Customer Experience ...
    • CXiaaS Onboarding checklist

      The below is a list of items to be confirmed as part of an effective onboarding for CXiaaS Item Reference Genesys Client ID and Secret configured Customer Science provides a process to create this with a defined permissions role Genesys Cloud OAuth ...
    • public.partsumm_customer

      Description Columns Name Type Default Nullable Children Parents Comment keyid varchar(100) false conversationid varchar(50) true conversationstartdate timestamp without time zone false conversationstartdateltc timestamp without time zone true ...
    • CXiaaS: Table Update Frequency

      Please find a break down of the various jobs running as part of the Genesys Adapter. Each table is associated with a job and is updated according to the job frequency. Job Frequency Table Adherence 12 hours adherencedaydata adherenceexcdata ...
    • CXiaaS: Message of the Day

      The message of the day is normally, but not exclusively positioned in the bottom right hand corner of the dashboard. For simplicity, it typically consists of the following two widgets/panels: Text Panel Image Panel Editing the Text Panel To edit the ...