TABLE OF CONTENTS

• Introduction
• Definitions
• Client Side
  • Integration and Organization’s Firewall (if applicable)
  • Vidyo/Client Side Set Up
    • Information needed by IgnisHealth
• IgnisHealth/TRP Side
  • Navigate to Add Vidyo Connection
  • Name
  • Vidyo CDR Connection
  • Admin Portal Connection
  •  
  • Test Vidyo CDR Connection
• Integration Controls
  • Polling Frequency
• Vidyo Dashboards
  • Utilization overview
  • In Progress Calls
  • Max. License Usage

Introduction

The purpose of this document is to describe the Vidyo integration process with TRP. TRP can connect to multiple Vidyo instances at your organization. This document also briefly describes the built in dashboards that your TRP reporting instance comes with. 

Definitions

1. TRP: Telehealth Resource Program 

2. Organization: TRP client, the health care entity

3. Vidyo CDR: the MySQL database that stores the Vidyo call data record

4. Polling data: the ability to fetch data from a remote system

Client Side

Integration and Organization’s Firewall (if applicable)

TRP can be hosted in Ignis Health’s cloud based infrastructure. In such a case if the Vidyo system resides behind a firewall, TRP will need to be granted access to the Vidyo Portal that hosts the CDR data. Ignis Health will provide the client with the IP of the TRP server to provision such access. Ignis Health will also let the client know about this requirement when applicable. For a layer 3 or 7 lock down, please consider the following on top of the source IP and domain provided. 

1. Port: 3306

2. IP: Provided with this document

3. Encrypted Protocol: MySQL

Vidyo/Client Side Set Up

This section details how to enable the Vidyo CDR access for the 3rd party systems. Please head over to the Vidyo CDR page on the Vidyo portal. Here you can add the user details. Later TRP will use this user information to access the Vidyo CDR.

Information needed by IgnisHealth

Please provide IgnisHealth with the following information

1. IP Address of Vidyo Portal

2. Port (default is 3306, if not known it will be 3306)

3. Username (by default it is ‘cdraccess’)

4. Password

IgnisHealth/TRP Side

If TRP is hosted in the cloud, the following steps are taken by IgnisHealth. 

Navigate to Add Vidyo Connection

the Login to TRP, head over to the Imports and Integrations through left navigation bar, and click on the "Vidyo Instance"  as shown in the following screenshot. 

In the Vidyo Settings page, click on ‘Add Instance’ and add the connection details to the VidyoCDR. 

The fields in the following screenshot are used as such.

Name

Use this field to identify a single instance of Vidyo CDR.

Vidyo CDR Connection

Under the panel ‘MYSQL CDR Connection’ add the connection details to the Vidyo CDR. The user information is the same as entered in the previous step in the Vidyo Portal. Add the IP address and the port of the Vidyo instance where port is normally 3306. The database name is usually “portal2”.

Admin Portal Connection

This part of the connection allows importing registered users in the system. However, this is just a place holder and is not yet functional. These fields should be filled in with dummy details. 

Test Vidyo CDR Connection

Once the details of the connection are filled out and the user clicks on the ‘Save’ button, the details page will be displayed. The CDR connection can be tested by using the ‘Test MySQL Connection” button. On successful connection TRP will show the success message in a green popup.

Integration Controls

Polling Frequency

TRP uses periodic tasks to poll the Vidyo CDR data. TRP can be set to poll data at the required frequency depending on the organization’s needs. By default it is set to 15 minutes. Further, TRP only gets the updated/newly created data. By design, the first time TRP polls the entire CDR data i.e. it will get the full historical call records. 

Vidyo Dashboards

Currently, TRP comes built in with 3 dashboards. Users can create more however, these starting dashboards can help with using TRP reporting right away. These dashboards can also be cloned and edited to adapt to the analytics needs.

Utilization overview

,the This dashboard shows overall utilization of the Vidyo calls. The dashboard further dives into analysis by different users, their devices, OS, call types and status. 

This dashboard also shows periodic trends of daily and hourly calls.

In Progress Calls

This dashboard presents the calls in progress at the time TRP last fetched the data.

Max. License Usage

TRP processes the Vidyo CDR records and tags each call with the concurrent number of people making these calls. The license usage dashboards analyze the Vidyo system usage patterns and track the maximum license usage in near real time.