Datastore CTI Event Relay

Updated on 08 Jan 2024
3 Minutes to read

Print
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Mindful Datastore is accessible on the Mindful platform and seamlessly integrates with the entire suite of Mindful cloud products. However, the Datastore can also be used by other applications via the CTI Event Relay.

Download and Install

Quick access: Datastore > Data Set Templates

Click Edit on the Data Set Template to which you would like to connect. This takes you to the New Data Set Template page.
Click +Add Template Data Key. This opens the New Template Data Key modal.
Download the CTI Event Relay executable (.exe) file by clicking the Click to download the CTI Event Relay link. Then click Cancel to close the modal.
Launch the .exe file. You may need to grant permissions for this trusted executable file to be run.
Close all other applications before starting the Setup Wizard. This keeps you from having to reboot your computer if there are relevant system file updates that need to occur during setup.
Follow the Setup Wizard prompts.
Enter the necessary information on the first configuration page:
- IP Address and Port number for the local machine the event relay is being installed on.
- API Access Token copied from the Mindful Datastore's Data Set Templates page.
Click Next process, then confirm the Destination Folder where the CTI Event Relay will live.
Click Install. You will see a progress bar advance until installation is complete.
When installation is marked as Completed, click Close.

Connect the CTI Event Relay

Before beginning, keep in mind that the Mindful Solution Delivery team is available to assist with this step, if needed.

To begin, locate the CTIEventRelay folder using the file path specified as the Destination Folder during installation.
Next, update the appsettings.json file as needed for your specific confirmation (see details below).

Configuration details

The appsettings.json file contains the configuration items for the EventParser and CTIEventRelay components. Refer to the following table for definitions of appsettings.json parameters.

Item name	Description
switch_type	Sets the default root log path for log files Currently only supports the value of TIALICM.
local_ip_hostname	The IP or hostname to start the Application Gateway server on. More than likely this should be the IP or hostname of the machine that the CTIEventRelay is running on.
local_port	The port that the Application Gateway server will be listening on
datastore_url	URL to the data_sets API of the Datastore
api_token	API token that correlates to the Datastore data set
log_level	Controls the verbosity of the logger. By default this should be set to 5
log_path	Sets the default root log path for log files

Example

{
    "switch_type": "TIALICM",
    "local_ip_hostname": "10.100.61.14",
    "local_port": 3000,
    "datastore_url": "https://qa-datastore.vhtops.net/api/v1/data_sets",
    "datastore_api_token": "KV+xz9REqgfGpvZK31VV6UGeq78Y9oYinGCRzlvWha4=",
    "log_level": 5,
    "log_path": "C:\\EventRelay\\Logs"
}

Logging

Startup logging

On startup, the logs will be quiet until events start coming into the system unless there was an issue loading the TIAL dll or an issue starting the Application Gateway server.

Log message	Likely causes	Notes
`TIALWrapper::TIALWrapper\|Failed to load DLL: TIAL_ICM.dll`	Mindful Datastore failed to load the TIAL dll.	n/a
`TIALWrapper::TIALWrapper\|Failed to load DLL:[dll name]`(presence of dll name)	An issue locating the dll.	The switch_type was set correctly.
`TIALWrapper::TIALWrapper\|Failed to load DLL:`(no dll name)	The switch type was not set correctly.	n/a
`TIALWrapper::TIALWrapper\|Failed to initialize AppGWServer with HostName 10.100.61.14 and Port 3000`	Mindful Datastore failed to start the Application Gateway. Hostname is not correct. Port is not available.	n/a

Event Processing

When an event enters the system, initial checks are made, and the event may be discarded as a result of missing fields or unexpected values.

Log message	Likely causes	Notes
`DS_GET:1234567890`	n/a	We expect the subtype to be either DS_GET or DS_POST. These values can be suffixed with the customer's contact number.
`TIALWrapper::process_event\|Failed TEPRM_SubType missing`	The subtype field is missing.	n/a
`TIALWrapper::process_event\|Failed invalid TEPRM_SubType: Some_Other_Value`	The subtype is not: DS_GET or DS_POST	n/a
`TIALWrapper::process_event\|Failed\|customer contact number not set`	The subtype is not suffixed with customer's contact number AND The calling line ID is not set with the customer's contact number	We expect either the calling line ID to be set or the contact number to be suffixed onto the subtype. The contact number in the subtype takes precedence over the calling line ID if both are set.
`TIALWrapper::process_event\|Failed\|could not create interaction ID`	The router call key and router call day values are not available.	The router call key and router call day are used to generate an interaction ID for the request.
`TIALWrapper::process_post\|Sending POST request for interaction ID = 153288\|301`	n/a	Send a POST request to the Mindful Datastore.
`TIALWrapper::process_get\|Sending GET request for interaction ID = 153288\|301`	n/a	Send a GET request to the Mindful Datastore.

Web requests to Mindful Datastore

Log message	Likely causes	Notes
`GetHandler\|Failed\|interaction ID = 153288\|301\|Datastore URL = https://qa-datastore.vhtops.net/api/v1/data_sets\|HTTP Response Code = 500`	Unsuccessful GET request to the Mindful Datastore.	n/a
`PostHandler\|Failed\|interaction ID = 153288\|301\|Datastore URL = https://qa-datastore.vhtops.net/api/v1/data_sets\|HTTP Response Code = 500`	Unsuccessful POST request to the Mindful Datastore .	n/a
`GetHandler\|Exception\|interaction ID = 153288\|301\|Datastore URL = not://a.valid-uri`	GetHandler Exception orccurred: URI is not valid or Network connectivity issue	n/a
`PostHandler\|Exception\|interaction ID = 153288\|301\|Datastore URL = not://a.valid-uri`	PostHandler Exception occurred: URI is not valid or Network connectivity issue	n/a

Data Keys

Call Variables

Up to 10 call variables are supported. The expected key names are as follows:

call_variable1, call_variable2, call_variable3, call_variable4, call_variable5, call_variable6, call_variable7, call_variable8, call_variable9, call_variable10

Call Context Collection

The expected key name is:

call_context_collection

Was this article helpful?

What's Next

Global Settings

Table of contents

Download and Install
Connect the CTI Event Relay
Logging
Data Keys