Tech Note: Providing Access to ehealth for Voice Data for Custom Reports and Third-Party Applications

Transcription

1 ehealth for Voice Tech Note: Providing Access to ehealth for Voice Data for Custom Reports and Third-Party Applications This document describes the process of accessing data collected and stored by the ehealth for Voice application with a third-party tool, such as Microsoft Access. In order to preserve data integrity, all thirdparty access to ehealth for Voice data should take place through an ODBC connection utilizing the ivizeguest SQL login, which is established as part of the database setup during program installation. Ivize is the name of the SQL database in which ehealth for Voice stores data. Using the ivizeguest login allows administrators to grant data access to any users who may want to create custom reports or utilize the data through third-party software such as Microsoft Access, Microsoft Excel, or Crystal Reports. Because the ivizeguest login is given permission only to read data from the database, this method of access does not compromise data integrity and provides no risk to the database configuration. It is the only means of third-party data access supported. Accessing the database with third-party software can be broken down into two major operations, each with a number of specific steps. The first operation is the establishment of an ODBC data source connection to the database through the ivizeguest login. This will be the same regardless of the specific application which is to utilize the data. The second operation consists of connecting to specific data tables through the ODBC link. The exact steps to perform this operation will depend on the application in question and the specific data required. In order to provide an example of the process, this document will trace the operation of creating a linked database in Microsoft Access. Similar steps would be undertaken to connect to the data with Microsoft Excel or another application. The final section of the document consists of a table reference to the ehealth for Voice platform data tables. Creating the ODBC Connection Following are the steps to create an ODBC system data source. 1) Open the Control Panel window, (StartèSettingsèControl Panel) and double-click the Administrative Tools icon. (Note to users of Windows NT: In Windows NT the ODBC icon will be found in the main control panel rather than in a Administrative Tools subfolder.) Concord Communications, Inc. 600 Nickerson Road Marlboro, Massachusetts P F ehealth for Voice Tech Note no /16/ , Concord Communications, Inc. All rights reserved. ehvtn

2 Third-Party Data Access 2 2) Double-click the Data Source (ODBC) icon. 3) In the ODBC Data Source Administrator window, Click the System DSN tab. 4) Click the Add button to create the new data source. 5) In the Create New Data Source window, scroll to the end of the list of drivers and select SQL Server and click Finish.

3 Third-Party Data Access 3 6) In the Create a New Data Source to SQL Server window, type an appropriate name such as ehv Reports in the Name and Description text fields. In the Server pull-down menu, you must select the machine where the SQL Server resides. You may either select the machine from the pulldown list (recommended) or enter an IP address into the text box. If your current system is the SQL Server, then select (local). Click Next. 7) Select With SQL Server authentication using a login ID and password entered by the user. In the Login ID field, type ivizeguest. In the Password box type ivizeguest again. Click Next. Note: these fields are case sensitive. Make sure you type Login ID and Password in all lower case. If you receive a message that the login fails when you click the Next button, try entering the password again, making sure that the caps lock key is off. 8) Verify that the default database is Ivize. It will appear in the greyed out box at the top of the form. If the database listed there is not Ivize, then check the Change the default database to: checkbox and select Ivize from the list. If the Ivize database does not appear, you may be attempting to access the database on the wrong server. In this case, click the back button twice to return to the screen in step 6 and select the correct server. Make sure the checkboxes for Use ANSI quoted identifiers and Use ANSI nulls, paddings and warnings are checked. Click Next.

4 Third-Party Data Access 4 9) Make sure the checkbox for Perform translation for character data is checked. Click Finish. 10) Click the Test Data Source button in the confirmation dialog. A new window will appear displaying the results of the test execution. If test is successful, then you should see the message TESTS COM- PLETED SUCCESSFULLY! at the bottom of the new window. Click OK in the new window. Click OK in the confirmation window.. 11) In the ODBC Data Source Administrator window, under the System Data Sources, you should see the new system data source called ehv Reports. Click OK.

5 Third-Party Data Access 5 Application Example: Creating Linked tables in Microsoft Access Once a data source has been created through ODBC, your ehealth for Voice data may be accessed by any application which supports ODBC connectivity. Because you have set up the ODBC data source using the ivizeguest login, your third-party application will not be able to write to the database, and the integrity of your data will be preserved. As an example of the process of connecting to an ODBC data source, we list below the steps to create a linked database in Microsoft Access. The procedure for accessing the data with another ODBC compliant application such as Microsoft Excel would be quite similar. Consult the documentation for your application for details. 1) Start the Microsoft Access program. Select Create a new database using a Blank Access database. Click OK. 2) Specify the location and name for the new Microsoft Access database. Click Create.

6 Third-Party Data Access 6 3) Select Tables from the Objects list, then from the File menu of the main console window select Get External Data and then Link Tables. 4) In the Link window, from the Files of type pull-down menu, select ODBC Databases and click Link. 5) In Select Data Source window, select the Machine Data Source tab option. Select the name of the ODBC data source you created (e.g. ehv Reports) from the scroll-down menu. Click OK.

7 Third-Party Data Access 7 6) When the SQL Server Login appears, type in Ivizeguest as the password for the ivizeguest user. Click OK. 7) In the Link Tables window, from the tables scroll-down menu, you can select the tables to which you want to link. See the Ivize table reference at the end of this document. Creating a link effectively will create an Access table which is livelinked to the Ivize SQL database. This means that the linked table is created once and will automatically update with current data from the SQL database. 8) A link icon should appear in your database with the table name you selected earlier. If you double-click the table link icon, then you will see the content of that particular table. Because the ODBC data source is read-only, the data in the database cannot be modified through the Access table, and data integrity is preserved. You may generate reports and views and run queries on the tables as you would with any Access table.

8 Third-Party Data Access 8 ehealth for Voice Platform Table Reference Platform Data Element Ivize Table Avaya Interchange AMIS Network Day pr5_el169 Avaya Interchange AMIS Network Hour pr5_el168 Avaya Interchange AMIS Subscriber Detail pr5_el166 Avaya Interchange Call Detail Event Totals pr5_el165 Avaya Interchange Call Detail Events pr5_el164 Avaya Interchange CDR Subscriber Detail pr5_el167 Avaya Interchange Dial Plan Settings pr5_el177 Avaya Interchange Enterprise Lists pr5_el161 Avaya Interchange List Detail pr5_el162 Avaya Interchange Network Day Traffic pr5_el176 Avaya Interchange Network Hour Traffic pr5_el175 Avaya Interchange Network Status pr5_el170 Avaya Interchange Port Day Traffic pr5_el172 Avaya Interchange Port Hour Traffic pr5_el171 Avaya Interchange Remote Node Configuration pr5_el160 Avaya Interchange Subscriber Lists pr5_el163 Avaya Intuity Active Alarms pr4_el137 Avaya Intuity Class of Service pr4_el138 Avaya Intuity Feature Day Traffic pr4_el146 Avaya Intuity Feature Hour Traffic pr4_el145 Avaya Intuity Load Day Traffic pr4_el143 Avaya Intuity Load Hour Traffic pr4_el142 Avaya Intuity Network Day Traffic pr4_el136 Avaya Intuity Network Hour Traffic pr4_el130 Avaya Intuity Remote Day Traffic pr4_el148 Avaya Intuity Remote Month Traffic pr4_el147 Avaya Intuity Resolved Alarms pr4_el150 Avaya Intuity Servers pr4_el133 Avaya Intuity Sp Feature Day Traffic pr4_el141 Avaya Intuity Sp Feature Hour Traffic pr4_el140 Avaya Intuity Subscriber Day Traffic pr4_el151 Avaya Intuity Subscriber Month Traffic pr4_el152 Avaya Intuity Subscribers Local pr4_el144 Avaya Intuity Subscribers Remote pr4_el149 Avaya Intuity System Attendants pr4_el135 Avaya Intuity System Limits pr4_el139 Avaya Intuity System Log Events pr4_el131 Avaya Intuity User Activity Log pr4_el132 Avaya Intuity User Activity Summary pr4_el134 Avaya Media Servers Active Alarms pr6_el70

9 Third-Party Data Access 9 Platform Data Element Ivize Table Avaya Media Servers Attendant Group Measurements pr6_el72 Avaya Media Servers Attendant Position Measurements pr6_el73 Avaya Media Servers C-Lan Ethernet Measurements pr6_el77 Avaya Media Servers C-Lan Sockets Measurements pr6_el89 Avaya Media Servers Configuration List pr6_el78 Avaya Media Servers Data Call Rate Measurements pr6_el92 Avaya Media Servers ESM Measurements pr6_el90 Avaya Media Servers Extensions pr6_el101 Avaya Media Servers Hardware Errors pr6_el97 Avaya Media Servers Hunt Group Measurements pr6_el79 Avaya Media Servers Hunt Groups pr6_el88 Avaya Media Servers IP Codec Measurements pr6_el95 Avaya Media Servers IP DSP Resource Detail pr6_el96 Avaya Media Servers IP Signalling Measurements pr6_el94 Avaya Media Servers Multimedia-Interface Measurements pr6_el71 Avaya Media Servers Occupancy Summary Measurements pr6_el80 Avaya Media Servers Port Network Blockage Measurements pr6_el74 Avaya Media Servers Port Network Load Balance pr6_el91 Avaya Media Servers Security-Violations pr6_el81 Avaya Media Servers Stations pr6_el82 Avaya Media Servers Switch Node Blockage Measurements pr6_el75 Avaya Media Servers System Capacity pr6_el100 Avaya Media Servers Total Call Rate Measurements pr6_el76 Avaya Media Servers Transaction History pr6_el98 Avaya Media Servers Trunk Group Measurements pr6_el84 Avaya Media Servers Trunk Groups pr6_el83 Avaya Media Servers Trunk Lightly Used pr6_el86 Avaya Media Servers Trunk Outages pr6_el87 Avaya Media Servers Voice Call Rate Measurements pr6_el93 Avaya Media Servers Voice Conditioner Measurements pr6_el85 Avaya Modular Messaging All Ports Busy pr11_el529 Avaya Modular Messaging All Text-to-Speech Ports Busy pr11_el514 Avaya Modular Messaging Assistance Requests pr11_el527 Avaya Modular Messaging Caller Applications pr11_el523 Avaya Modular Messaging Class of Service pr11_el500 Avaya Modular Messaging Day Port Traffic pr11_el519 Avaya Modular Messaging Day System Traffic pr11_el518 Avaya Modular Messaging Day User Traffic pr11_el517 Avaya Modular Messaging Defaults to Assistance pr11_el515 Avaya Modular Messaging Hour Port Traffic pr11_el513 Avaya Modular Messaging Hour System Traffic pr11_el512 Avaya Modular Messaging Hour User Traffic pr11_el511

10 Third-Party Data Access 10 Platform Data Element Ivize Table Avaya Modular Messaging Installed Software pr11_el533 Avaya Modular Messaging Local Subscribers pr11_el501 Avaya Modular Messaging MAS Event Log pr11_el507 Avaya Modular Messaging Modular Messaging License pr11_el524 Avaya Modular Messaging MSS Active Alarms pr11_el508 Avaya Modular Messaging MSS Activity Log pr11_el531 Avaya Modular Messaging MSS Activity Log Summary pr11_el532 Avaya Modular Messaging MSS Resolved Alarms pr11_el509 Avaya Modular Messaging MSS System Log pr11_el530 Avaya Modular Messaging Other Events pr11_el516 Avaya Modular Messaging Personal Operator Schedules pr11_el525 Avaya Modular Messaging Port Usage pr11_el521 Avaya Modular Messaging Remote Subscribers pr11_el502 Avaya Modular Messaging Subscriber Counts pr11_el534 Avaya Modular Messaging System Attendant pr11_el506 Avaya Modular Messaging System Features pr11_el504 Avaya Modular Messaging System Limits pr11_el503 Avaya Modular Messaging System Properties pr11_el505 Avaya Modular Messaging Transactions Database pr11_el510 Avaya Modular Messaging Trusted Servers pr11_el520 Avaya Modular Messaging Voice Mail Domain Summary pr11_el522 Avaya Octel Analog Traffic pr3_el210 Avaya Octel Call Detail Records pr3_el198 Avaya Octel Class of Service pr3_el193 Avaya Octel Digital Traffic pr3_el209 Avaya Octel Disk Usage pr3_el199 Avaya Octel Features pr3_el208 Avaya Octel Hardware Errors pr3_el190 Avaya Octel Integration Call Traffic pr3_el204 Avaya Octel Mailbox List pr3_el203 Avaya Octel Port Traffic pr3_el194 Avaya Octel Traffic Pegs pr3_el192 Avaya Octel User Call Statistics pr3_el206 Avaya Octel User Message Statistics pr3_el205 Avaya Octel User Status Detail pr3_el191 Avaya Octel All Ports Busy pr1_el23 Avaya Octel Caller Menu Event pr1_el24 Avaya Octel Community Group pr1_el26 Avaya Octel Community Profile pr1_el1 Avaya Octel Daily Mailbox Totals pr1_count1 Avaya Octel Daily Network Totals pr1_count2 Avaya Octel Digital Network pr1_el28

11 Third-Party Data Access 11 Platform Data Element Ivize Table Avaya Octel Disk Space pr1_el15 Avaya Octel Forms pr1_el20 Avaya Octel IVR Tree Records pr1_el12 Avaya Octel List Statistics pr1_el21 Avaya Octel Mailbox Profile pr1_el4 Avaya Octel Mailbox Statistics pr1_el6 Avaya Octel Message Activity pr1_el14 Avaya Octel Message Counts pr1_el16 Avaya Octel Message Review pr1_el18 Avaya Octel MW Records pr1_el17 Avaya Octel Network Node Profile pr1_el3 Avaya Octel Network Traffic pr1_el11 Avaya Octel Outcall pr1_el22 Avaya Octel PBX Link pr1_el31 Avaya Octel Personal List Members pr1_el27 Avaya Octel Personal Lists pr1_el2 Avaya Octel Port Statistics pr1_el10 Avaya Octel SDM Destination pr1_el9 Avaya Octel Session Activity pr1_el13 Avaya Octel Status Log pr1_el5 Avaya Octel Status Log 13.3 pr1_el30 Avaya Octel System List Members pr1_el25 Avaya Octel System Lists pr1_el7 Avaya Octel User Profile Changes pr1_el19 Latitude Audio Conferencing Group Info pr9_el44 Latitude Audio Conferencing Meeting Attachments pr9_el47 Latitude Audio Conferencing Meeting Details pr9_el41 Latitude Audio Conferencing Meeting Participant pr9_el42 Latitude Audio Conferencing Participant Join Leave Info pr9_el43 Latitude Audio Conferencing Profile pr9_el40 Latitude Audio Conferencing Scheduling Failures pr9_el49 Latitude Audio Conferencing Server Outdial Info pr9_el46 Latitude Audio Conferencing System Outdial Info pr9_el48 Latitude Audio Conferencing User Outdial Info pr9_el45 Nortel Meridian PBX ACD pr7_el333 Nortel Meridian PBX Alarm History pr7_el300 Nortel Meridian PBX Call Pickup Network pr7_el336 Nortel Meridian PBX Common Equipment pr7_el328 Nortel Meridian PBX Configuration pr7_el331 Nortel Meridian PBX Console Queue Measurements pr7_el322 Nortel Meridian PBX Controlled COS pr7_el334 Nortel Meridian PBX Customer Data pr7_el330

12 Third-Party Data Access 12 Platform Data Element Ivize Table Nortel Meridian PBX Customer Network Measurements pr7_el320 Nortel Meridian PBX D Channel Traffic pr7_el338 Nortel Meridian PBX Dial Intecom Groups pr7_el327 Nortel Meridian PBX Dial Tone Delay pr7_el317 Nortel Meridian PBX Directory Numbers pr7_el302 Nortel Meridian PBX Indiv Console Measurements pr7_el323 Nortel Meridian PBX Junctor Measurements pr7_el319 Nortel Meridian PBX Listed Directory Numbers pr7_el311 Nortel Meridian PBX Network Attendant Measurements pr7_el329 Nortel Meridian PBX Network COS pr7_el337 Nortel Meridian PBX Network COS Measurements pr7_el326 Nortel Meridian PBX Network Data pr7_el335 Nortel Meridian PBX Network Loop Traffic pr7_el315 Nortel Meridian PBX Nortel System Messages pr7_el301 Nortel Meridian PBX Out of Service Units pr7_el308 Nortel Meridian PBX Processor Load pr7_el318 Nortel Meridian PBX Route Data Blocks pr7_el313 Nortel Meridian PBX Route List Measurements pr7_el325 Nortel Meridian PBX Route Lists pr7_el339 Nortel Meridian PBX Service Loop Traffic pr7_el316 Nortel Meridian PBX Sets pr7_el303 Nortel Meridian PBX Speed Call Lists pr7_el305 Nortel Meridian PBX Terminal Numbers pr7_el309 Nortel Meridian PBX Trunk Group Measurements pr7_el321 Nortel Meridian PBX Trunk Members pr7_el306 Nortel Meridian PBX Trunks pr7_el314 Nortel Meridian PBX Unused Cards pr7_el304 Nortel Meridian PBX Unused Directory Numbers pr7_el307 Nortel Meridian PBX Unused Sets pr7_el312 Nortel Meridian PBX Unused Trunks pr7_el310 Right Fax FaxDump (5) pr2_el60 Security Devices Access History pr10_el400 Security Devices Activity Log pr10_el401 Security Devices Failure History pr10_el402 System (Ivize) Agents Agents System (Ivize) Alerts Alerts System (Ivize) Closed Tasks ClosedJobs System (Ivize) Nodes Nodes