Revolution Web ShoreTel Innovation Network Application Note for ShoreTel 14.1

Transcription

1 Revolution Web ShoreTel Innovation Network Application Note for ShoreTel 14.1 December 2013 Resource Software International Ltd. (RSI) 40 King Street West, Suite 300 Oshawa, Ontario. L1H 1A4 Website:

2 TABLE OF CONTENTS NOTICE... 3 INTRODUCTION... 4 ABSTRACT... 4 OVERVIEW... 5 FEATURES AND BENEFITS... 5 RSI OVERVIEW AND CONTACT... 6 RSI PRODUCT INFORMATION... 7 ARCHITECTURE OVERVIEW... 8 ODBC CONNECTION TO SHORETEL SERVER... 9 RS-232 (SERIAL) CONNECTION TO SHORETEL SERVER REQUIREMENTS AND LIMITATIONS VERSION SUPPORT VALIDATION TESTING RESULTS SUMMARY TABLE 1: SAMPLE TEST CASES TABLE 2: EXTENDED FEATURE TEST CASES CONFIGURATION OVERVIEW SHORETEL CONFIGURATION RETRIEVE MYSQL RECORDS VIA AN ODBC CONNECTION RETRIEVE MS-ACCESS CDR RECORDS VIA AN ODBC CONNECTION RETRIEVE PROFESSIONAL SERVICES L&P CDR RECORDS VIA AN ODBC CONNECTION RETRIEVE CDR RECORDS VIA A SERIAL CONNECTION RSI CONFIGURATION INSTALLATION CONFIGURING REVOLUTION WEB TO INTEROPERATE WITH SHORETEL RSI TROUBLESHOOTING RSI SUPPORT SERVICES DOCUMENT AND SOFTWARE COPYRIGHTS TRADEMARKS DISCLAIMER COMPANY INFORMATION RSI SPECTRUM OF SERVICES CALL ACCOUNTING CONTACT CENTER REPORTING TRAFFIC ANALYSIS FACILITIES MANAGEMENT RSI CLOUD SOLUTIONS ON-SITE NOTIFICATION / ALARM MANAGEMENT INVOICE MANAGEMENT CTI APPLICATIONS / CRM INTEGRATION Resource Software International Ltd. Page 2

3 Notice Resource Software International Ltd. reserves the right to make improvements to the product described in this manual at any time and without notice. This document contains no warranty of any kind with regard to this material, including but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Resource Software International Ltd. shall not be liable for errors contained herein or for incidental consequential damages in connection with the furnishing, performance or use of this material or product. In no event will Resource Software International be liable to you for any special damages including, any lost profits; lost savings, or other incidental or consequential damages, even if Resource Software International has been advised of the possibility of such damages, or for any claim by any other party. Some places do not allow the exclusion or limitation of special, incidental or consequential damages, so the above limitation or exclusion may not apply to you. This document is copyrighted. All rights are reserved. This document may not, in whole or in part, be copied, photocopied, reproduced, translated or reduced to any electronic medium or machinereadable form without prior consent, in writing, from Resource Software International Ltd. (c) , Resource Software International Ltd. 40 King Street West, Suite 300, Oshawa, Ontario. Canada. L1H 1A4. Phone: (905) Fax: (905) All Rights Reserved. Printed in Canada Resource Software International Ltd. Page 3

4 Introduction Resource Software International Ltd. (RSI) is a dynamic development and distribution company specializing in voice and data management systems. Our unique approach to data storage, call management, carrier comparisons, equipment billing, bill analysis, contact center reporting, real-time dashboards, emergency on-site notification, CRM Integration, and computer telephony integration (CTI) have given RSI the competitive advantages in a market dominated by outdated and inflexible systems. RSI believes communication is the essential key in a competitive world that demands instantaneous results. The influx of long distance providers, countless rate structures and discount calling plans has left many telecom managers baffled about best available services. Abstract Revolution Web Call Accounting is a robust browser based communication management solution for ShoreTel IP phone systems. Revolution Web Call Accounting can be deployed in virtually any SMB enterprise including retail, government agencies, brokers, professional firms, banks, hospitals and universities. This solution can be utilized to allocate telecom costs to individuals and departments. It can also be used to monitor telephone productivity of each employee in the company. The software can be accessed from your desktop or from around the world through a true web interface. Revolution Web Call Accounting reports can be generated manually or be scheduled for automatic daily, weekly and/or monthly distribution. Alarms can be scheduled for emergency 911 notifications, toll fraud or misuse reporting. A built-in contacts database can be used to quickly identify all calls made to / from a particular contact and tagged as personal or business related. RSI is committed to continued refinement and enhancement of all our product line. To assist us in future enhancements, both with the product itself and the effectiveness of our literature and documentation, you are invited to call Resource Software International Ltd. at (905) Resource Software International Ltd. Page 4

5 Overview This document provides a technical overview of the Resource Software International (RSI) Revolution Web Call Accounting application. A summary of the feature and benefits of the combined RSI and ShoreTel solutions is also presented. This document also contains detailed Vendor contact information for our sales, technical sales and technical support groups. Features and Benefits 100% browser based solution Installs easily and quickly with limited to no user training required. Retrieves ShoreTel CDR data via IP or serial connection without the need for costly hardware buffers Can be deployed anywhere around the globe. Supports both North American and International Numbering plans. Equipped with its own built-in web server eliminating the needs for IIS or Apache Allocate calls and costs to individuals and/or departments Comprehensive reporting tools including, detail, summary, graphical and user definable report creation. Built-in task scheduler allows user to automate report generation and delivery. Generates real-time alerts for user definable priority conditions (i.e. 911, misuse, international calling) No client software required. Reports can be accessed by any authorized user with intranet/internet access. User defined login accounts allows the administrator to restrict access to the application and call data by user and/or department. Resource Software International Ltd. Page 5

6 RSI Overview and Contact Resource Software International (RSI) Ltd. has been developing award-winning communications management solutions for businesses of all sizes since RSI is a leading provider of call accounting, hotel billing, computer-telephony integration, CRM integration, call center reporting, real-time dashboards, switch management, on-site emergency notification, mobile tracking, and cloud-based communications management solutions around the globe. For general sales questions contact your reseller or contact Resource Software International (RSI) directly at: Drew Walker General Manager (905) x 246 sales@telecost.com Resellers who want to start selling our solutions should contact: Rana Banik Director of Business Development and Strategic Alliances (905) x 258 rana@telecost.com Technical Support inquiries from any region can contact Resource Software International (RSI) directly at: RSI Support Services (905) support@telecost.com Resource Software International Ltd. Page 6

7 RSI Product Information The following image depicts the Revolution Web Call Accounting browser based user interface. Product Model number / sku number Product Code Description URWEB25-P Revolution Web Call Accounting (25 Extensions) URWEB50-P URWEB100-P URWEB250-P URWEB500-P URWEBUNL-P Revolution Web Call Accounting (50 Extensions) Revolution Web Call Accounting (100 Extensions) Revolution Web Call Accounting (250 Extensions) Revolution Web Call Accounting (500 Extensions) Revolution Web Call Accounting (Unlimited Extensions) Product Approximate List Price Prices start at $ US. Resource Software International Ltd. Page 7

8 Architecture Overview Our Revolution Web Call Accounting solution architecture supports the following configurations to capture and store CDR data retrieved from a ShoreTel telephone system. ODBC Connection Revolution Web Call Accounting can be integrated with a ShoreTel Unified Commnications platform (release 5.0 or later) utilizing an ODBC connection to the ShoreTel call record database via a LAN. No additional hardware is required. Prior to ShoreTel releases 7 call records were stored in a Joint Engine Technology (JET) database (also referred to as Microsoft Access). ShoreTel release 7 and later stores call transaction information in a MySQL database table. Our Revolution Web software supports retrieval of database records from each of these database technologies. Additionally, our Revolution Web software can also support retrieval of call records from the ShoreTel Professional Services L&P CDR table (release 6.1 or later). The ShoreTel server must be visible to the computer operating our Revolution Web software (i.e. connected to the same LAN / WAN). RS-232 Connection Revolution Web can be integrated with a ShoreTel Unified Communications platform (release 7 or later) utilizing an RS-232 (serial) connection with the ShoreTel Server A detailed description of the architecture, including a connectivity diagram, for both ODBC and RS-232 connectivity can be found below. Please note the Revolution Web software should not be installed on the ShoreTel server. Resource Software International Ltd. Page 8

9 ODBC Connection to ShoreTel Server Revolution Web utilizes our WinLINK ODBC data collection module to create an ODBC connection to either the ShoreTel MySQL database (ShoreTel v7.0 or later) or the ShoreTel MS-Access CDR table (ShoreTel v6.x or earlier). Additionally, the ODBC data collection module can also be utilized to retrieve call records from the ShoreTel Professional Services L&P CDR database (ShoreTel v6.1 or later). After successfully connecting to the ShoreTel server, the software utilizes an SQL query to retrieve any new call records (CDR data) stored in its database since the previous connection. Retrieval of this data from the ShoreTel database can be scheduled at user defined intervals (i.e. every x minutes, hours, days, etc).the retrieved data is normalized by the Revolution Web data parsing engine and appended to its database. Note: Our Revolution Web software utilizes its ODBC data collection module to capture ShoreTel CDR/SMDR via the corporate LAN/WAN. The lines between ShoreTel Hardware, Data switch, Router, IP phones, etc. and the computer where the Revolution Web software is installed are provided to illustrate the presence of a network connection. The Revolution Web computer must utilize a Microsoft operating system (Windows XP, 7/8, 2003/2008/2012 or later). Resource Software International Ltd. Page 9

10 RS-232 (Serial) Connection to ShoreTel Server Our Revolution Web software utilizes its serial collection module to capture ShoreTel CDR/SMDR data in real-time via an RS-232 (serial) connection. Captured data is normalized by the Revolution Web data parsing engine and appended to its database. Note: Our Revolution Web software utilizes its built-in data collection module to capture ShoreTel CDR/SMDR data in real-time via an RS-232 (serial) connection. The lines between ShoreTel Hardware, Data switch, Router, IP phones, etc. are provided to illustrate the presence of a network connection. The Revolution Web computer must utilize a Microsoft operating system (Windows XP, 7/8, 2003/2008/2012 or later). Resource Software International Ltd. Page 10

11 Requirements and Limitations The following section details the minimum hardware/software requirements needed to implement our Revolution Web Call Accounting solution with a ShoreTel telephone system. Hardware/Software Requirements 1. ShoreTel Unified Communications System release 5.0 or later (release 14 recommended). 2. Minimum of two of ShoreTel telephone sets (100 Series, 200 Series, 500 Series, etc.). Telephone sets must be capable of placing and receiving telephone calls. 3. Minimum of two telephone lines. 4. ShoreTel CDR feature active and configured to generate/deliver CDR data via serial/odbc connection. 5. Workstation or Server Computer (Windows XP, 7/8, Windows 2003, 2008/2012 or later). A network connection is required for retrieval of ShoreTel CDR/SMDR via an ODBC connection. A serial port (or USB port with USB to Serial port converter) is required for collection of CDR data from the ShoreTel system via an RS-232 connection. 6. Microsoft Internet Explorer version 7.x or later 7. MySQL ODBC Driver compatible with your ShoreTel phone system (i.e. MySQL ODBC 3.51 or MySQL ODBC 5.1 driver). 8. Network Share on folder on ShoreTel Server where the CDR records (ShoreTel v 6.x or earlier) or Professional Services L&P CDR records are stored (ShoreTel 6.1 or later). 911 Interaction Revolution Web Call Accounting can monitor incoming and outgoing calls in real time. The software can be configured to detect 911 events and deliver emergency 911 notifications messages, via , to user defined addresses. Resource Software International Ltd. Page 11

12 Version Support Revolution Web is certified via the Technology Partner Validation Process for the ShoreTel system. The table below contains the matrix of Revolution Web releases certified on the identified ShoreTel software releases. Revolution Web 2.6.x 2.7.x 9.1 ü ShoreTel Release 10.x ü 11.x ü 12.x ü 13.x ü 14.1 ü Resource Software International Ltd. Page 12

13 Validation Testing Results Summary The following section contains a list of the test cases performed to confirm the interoperability of RSI Revolution Web solution with ShoreTel s published software interfaces. Please note ShoreTel does not test, nor vouch for the Member's development and/or quality assurance process, nor the overall feature functionality of the Member's solution(s). ShoreTel does not test the Member's solution under load or assess the scalability of the Member's solution. It is the responsibility of the Member to ensure their solution is current with ShoreTel's published interfaces. The ShoreTel Technical Support organization will provide Customers with support of ShoreTel's published software interfaces. This does not imply any support for the Member's solution directly. Customers or reseller partners will need to work directly with the Member to obtain support for their solution. Table 1: Sample Test Cases ID Name Description Results 1.1 Installation Verify successful installation and configuration of Pass the ShoreTel Server and Revolution Web Call Accounting Software 1.2 ODBC Connectivity Verify Revolution Web Call Accounting Pass successfully retrieves call records from the MySQL CDR table or MS Access CDR table via an ODBC connection 1.3 Serial Connectivity Verify Revolution Web Call Accounting Pass successfully captures call records via a serial connection 1.4 ShoreTel Professional Services L&P CDR Connectivity Verify Revolution Web Call Accounting successfully retrieves call records from the ShoreTel Professional Services L&P CDR (MS Pass 1.5 Device Reset (Power failure) 1.6 Loss of Network Connection Access) table via an ODBC connection. Verify successful collection of data after reinitialization of ShoreTel server. Verify duplicate records are not collected Verify successful collection of data after connectivity between ShoreTel server and Revolution computer is reset (i.e. disconnected and then reconnected). Pass Pass Resource Software International Ltd. Page 13

14 Table 2: Extended Feature Test Cases ID Name Description Notes 2.1 Outbound Analog Trunk Call Place an outbound analog trunk call and verify the CDR is properly processed and reported by Pass 2.2 Outbound Digital Trunk Call 2.3 Outbound SIP Trunk Call 2.4 Inbound Analog Trunk Call 2.5 Inbound Digital Trunk Call 2.6 Inbound SIP Trunk Call the Revolution Web software. Place an outbound digital trunk call and verify the CDR is properly processed and reported by the Revolution Web software. Place an outbound SIP trunk call and verify the CDR is properly processed and reported by the Revolution Web software. Answer an inbound analog trunk call and verify the CDR is properly processed and reported by the Revolution Web software. Answer an inbound digital trunk call and verify the CDR is properly processed and reported by the Revolution Web software. Answer an inbound SIP trunk call and verify the CDR is properly processed and reported by the Revolution Web software. 2.7 Internal Call Place and answer an internal call. Verify the CDR is properly processed and reported by the Revolution Web software. 2.8 Supervised Transfer Answer an inbound call at extension A and perform a supervised transfer to extension B. Verify the CDR is properly processed and reported by the Revolution Web software. 2.9 Unsupervised Transfer Answer an inbound call at extension A and perform an unsupervised transfer to extension B. Verify the CDR is properly processed and reported by the Revolution Web software Conference Call Create a three party conference call (at least one call is an outgoing external call). Verify the CDR is properly processed and reported by the Revolution Web software Voice Mail Call Answer an inbound call and transfer it to voice mail. Verify the CDR is properly processed by the Revolution Web software Auto Attendant Call Place an inbound call to the ShoreTel telephone system that is answered by the auto attendant. Verify the CDR is properly processed by the Revolution Web software 2.12 Auto Attendant Call Place an inbound call to the ShoreTel telephone system that is answered by the auto attendant. Verify the CDR is properly processed by the Revolution Web software 2.13 Call Hold Place an inbound or outbound call, then place the call on-hold, then resume the call. Verify the CDR is properly processed by the Revolution Web software Pass Pass Pass Pass Pass Pass Pass Pass Pass Pass Pass Pass Pass Resource Software International Ltd. Page 14

15 ID Name Description Notes 2.14 Call Forward Place an inbound call to ext. 1 that is configured Pass to always forward to ext. 2. Verify the CDR is properly processed by the Revolution Web software and the extension recorded in the CDR is ext Account Code Place an outbound call with the extension user group configured for Forced account codes. Verify the CDR is properly process by the Revolution Web software and that the account code utilized is properly reflected. Pass Configuration Overview The ShoreTel telephone system generates a call detail record (CDR) for each telephone call placed or received by the telephone system. The CDR records are stored on the ShoreTel telephone server s hard drive. The Revolution Web Call Accounting software can process and retrieve ShoreTel CDR records utilizing either IP (ShoreTel 5.x or later) or serial (ShoreTel v7.0 or later) connection. Collection of CDR data via IP utilizes an ODBC connection to the ShoreTel server s CDR database. The CDR database on ShoreTel versions 6.x or earlier utilizes an MS Access database format. The CDR database on ShoreTel versions 7.0 or later utilizes a MySQL database. ShoreTel release 6.1 introduced an additional CDR database to the ShoreTel platform called the ShoreTel Professional Services L&P CDR records. The L&P CDR feature was designed specifically for professional services customers (i.e. lawyers, accountants) that perform customer bill back of telephone calls. The L&P database call detail records contain additional customer account information (i.e. client matter numbers). The L&P database utilizes an MS- Access database format. The Revolution Web Call Accounting software can retrieve CDR records from this database utilizing an ODBC connection. Note: The ShoreTel Professional Services Legal & Professional Cost Recovery Application does not come standard with the ShoreTel system and must be purchased separately. ShoreTel releases 7.x or later can also generate and deliver CDR records via an RS-232 (serial port) connection. This CDR delivery method requires a serial communications port to be installed on both the ShoreTel Server and Revolution Web hardware. Alternatively, if no serial port is available a USB port may be utilized. Please note to utilize a USB port, a USB to serial port converter must be installed and connected to the hardware. The ShoreTel telephone system s COM port feature must also be configured to deliver the CDR data via a serial port. The Revolution Web software can be installed on either a Windows workstation (Windows XP, 7/8 or greater) or a Windows Server (Windows 2003, 2008, 2012 Server or later). Please note a server is not required. However if a workstation is utilized for the installation it should be one that remains powered on throughout the business day. Resource Software International Ltd. Page 15

16 ShoreTel Configuration The ShoreTel system can generate and store CDR records utilizing multiple methods. ShoreTel Configuration changes required to interoperate with the Revolution Web software will vary depending on the collection method utilized (ODBC or Serial), ShoreTel software release version, and the type of CDR data being retrieved - MySQL records (release 7 or later) or MS- Access CDR Records (release 6 or earlier), or ShoreTel Professional Services L&P CDR records (release 6.1 or later). The following section provides a detailed description of the ShoreTel configuration changes required to support each of these different connection types. Retrieve MySQL Records via an ODBC Connection ShoreTel telephone systems version 7 or later utilize a MySQL database to store standard CDR records. Generation and storage of the data into the MySQL database is configured by default. No additional configuration changes are required on the ShoreTel server to support our Revolution Web software. However, users can modify the ShoreTel configuration to specify the retention period of the CDR data. For additional information on how to modify these settings please review the ShoreTel documentation regarding CDR Reporting Options. Retrieve MS-Access CDR Records via an ODBC Connection ShoreTel telephone systems version 6.x or earlier utilize an MS Access database to store standard CDR records. CDR generation and storage of the data into the MS Access database (cdr.mdb) is configured by default. A network share allowing the computer where the Revolutoin Web software is installed to access the MS-Access database is required. Please use the following steps to configure the Network Share on the ShoreTel Server. 1. Press the Windows Start button then select the Run command. The following Run dialog should now be visible on your screen. Type the bolded text c:\shoretel Data into the open box (shown above) and press the OK button. 2. Locate and right click the Call Records 2 folder (for release 3.1 or earlier the folder name will be Call Records). A popup menu should now appear. Locate and select the Properties menu item. 3. The Call Records 2 folder options dialog should now be visible on your screen. Click the Sharing tab. The following should now be visible on your screen. Resource Software International Ltd. Page 16

17 The share name specified will be used by our Revolution Web software to access the CDR records stored in cdr.mdb file on the ShoreTel server. 4. Activate the Share this folder option and type a share name (i.e. ShoreTelCDR) into the Share name text box (pictured above). The share name provided will be utilized by the Revolution Web ODBC collection module to retrieve CDR records from the ShoreTel server. 5. Press the OK button. Your share settings have now been saved. You have now successfully configured the ShoreTel Server to allow Revolution Web to access and retrieve CDR records from the cdr.mdb file. Retrieve Professional Services L&P CDR Records via an ODBC Connection ShoreTel telephone systems version 6.1 and later have an additional feature, when activated, that generates and stores enhanced CDR data to the ShoreTel Professional Services L&P CDR database. For example the L&P CDR database contains a client/matter number field that is not found in the standard CDR database (cdr.mdb). The ShoreTel Professional Services L&P feature automatically generates and stores CDR data into the L&P CDR MS-Access database (STPSCodeRecords.mdb). A network share allowing the computer where the Revolution Web software is installed to access the L&P MS-Access database is required. Please use the following steps to configure the Network Share on the ShoreTel Server. Resource Software International Ltd. Page 17

18 1. Press the Windows Start button then select the Run command. The following Run dialog should now be visible on your screen. Type the bolded text c:\program Files\ShoreTel into the open box (shown above) and press the OK button. 2. Locate and right click the LPServer folder. A popup menu should now appear. Locate and select the Properties menu item. 3. The LPServer folder options dialog should now be visible on your screen. Click the Sharing tab. The following should now be visible on your screen. The share name specified will be used by our Revolution Web software to access the CDR records stored in STPSCodeRecords.mdb file on the ShoreTel server. 4. Activate the Share this folder option and type a share name (i.e. LPServerCDR) into the Share name text box (pictured above). The share name provided will be utilized by the Revolution Web ODBC data collection module to retrieve L&P CDR records from the ShoreTel server. 5. Press the OK button. Your share settings have now been saved. Resource Software International Ltd. Page 18

19 You have now successfully configured the ShoreTel Server to allow Revolution Web to access and retrieve CDR records from the L&P CDR database (STPSCodeRecords.mdb file). Retrieve CDR Records via a Serial Connection ShoreTel telephone systems version 7 and later support the delivery of CDR data via a serial connection. By default delivery of CDR data via a serial port is disabled on the ShoreTel server. The following provides detailed instructions on how to activate this feature. 1. Launch and log into the ShoreWare Director tool utilizing the system administrator account. 2. Click the Reporting link option (the list should now expand revealing additional options, if it does not expand click it again). 3. Click the Options Link. The following window should now be visible on your screen. 4. Use the COM Port for CDR Output option to select the CDR port to be utilized on the ShoreTel server for the delivery of CDR data. Please note this port must be connected via a serial cable to the computer where the Revolution Web software has been installed. 5. Note: All other options can utilize their default settings. 6. Warning: Serial connections degrade over distance. We recommend the use of shielded cables with a maximum length of 100. Data loss or corruption can occur over greater distances. We strongly recommend the use of one of the ODBC connection methods specified above instead of a serial connection. 7. Press the Save button to record your changes. You have now successfully configured the ShoreTel server to deliver CDR data via a serial connection to the Revolution Web software. Resource Software International Ltd. Page 19

20 RSI Configuration The following section details the installation and configuration steps necessary for the Revolution Web software to interoperate with ShoreTel. Installation Before attempting to install the Revolution Web software please verify all necessary telephone system programming required to generate CDR records has been completed (see ShoreTel Configuration). Once you have activated the ShoreTel telephone system s CDR feature and completed the connection between it and the computer operating the Revolution Web software, you can proceed to install the Revolution Web Call Accounting Software. Install Revolution by using the following instructions: 1. Insert the Revolution Web Call Accounting CD into your computer s CD-ROM drive. The installation software should automatically start after you insert the CD-ROM. If the installation program does not appear within a few moments, simply double click the My Computer icon on your desktop. Next, double click the drive containing your Revolution Web Software (i.e. your CD- ROM drive icon), locate the file rweb###.exe and double click it. The installation program will now start. The following introduction window should now appear on your screen. Press the Next button to proceed with the installation button or the Cancel button to abort the installation. Resource Software International Ltd. Page 20

21 2. The Installation program may now display additional information about the Revolution Web Software. Please carefully read any information that is presented before proceeding. Press the Next button to proceed with the installation or the Cancel button to abort the installation. 3. The installation program will now prompt you to specify where you would like the Revolution Call Accounting start menu short-cuts to be installed. We recommend you install the short-cuts in the default location (i.e. RSI). To change the short-cut location press the Browse button. Once the desired location has been selected, press the Next button to continue or the Cancel button to abort the installation. Resource Software International Ltd. Page 21

22 4. Next the Installation program will present the Select Additional Tasks dialog. Checking the Register Revolution Web Call Accounting as a Windows service option will configure the Revolution Web server to automatically start each time the computer is booted (recommended). Additionally, users will be able access the software from their desktop even if the computer operating the Revolution Web Software is not logged in. Press the Next button to proceed with the installation or the Cancel button to abort the installation. Resource Software International Ltd. Page 22

23 5. The Ready to Install dialog box should now be visible on your screen. Verify the installation settings you have chosen are correct (i.e. Destination Location and Start Menu folder). Press the Back button to modify your settings, press the Install button to Install the software or press Cancel button to abort the installation. 6. The following dialog box highlighting the progress of the installation will be presented. Resource Software International Ltd. Page 23

24 The installation process may take from a few moments to several minutes depending on the speed of your computer. If you encounter installation errors please ensure you have enough disk space and/or computer rights to install this application. If an error occurs and you require assistance please contact either RSI (see Third Party Technical Support) or your distributor. You can abort the installation at anytime by pressing the Cancel button. 7. Once the installation has successfully completed the following confirmation screen will be displayed. Press the Finish button to complete the installation. Some operating systems may display an additional screen prompting you to restart your computer.. The installation is now completed. You are now ready to begin configuring the Revolution Call Accounting Software to interoperate with ShoreTel. Resource Software International Ltd. Page 24

25 Configuring Revolution Web to Interoperate with ShoreTel The Revolution Web Call Accounting software can retrieve and process ShoreTel CDR records utilizing one of the following methods. ODBC connection to ShoreTel MS-Access CDR database (ShoreTel version 6.x or earlier). ODBC connection to ShoreTel MySQL CDR database (ShoreTel version 7.0 or later). ODBC connection to ShoreTel Professional Services L&P CDR database (ShoreTel version 6.1 or later) Serial (RS-232) connection to ShoreTel Server (ShoreTel version 7.0 or later) The following sections of this document describe how to configure Revolution Web to utilize the above CDR collection methods. ODBC Connection to ShoreTel MS Access CDR Database Revolution Web software can be configured to retrieve CDR records from a ShoreTel MS Access CDR database (requires ShoreTel 6.x or earlier) utilizing an ODBC connection. Please note a network share on the ShoreTel server folder containing the CDR.MDB file must have been previously created (see Retrieve MS-Access CDR Records via an ODBC Connection). The following details the configuration steps required to support an ODBC connection to a ShoreTel MS Access CDR database. 1. Start the Revolution Web WinLINK ODBC data collection module. Press the Windows Start button and then select the Run command. The following window should be visible on your screen. Type the following bolded text c:\program files\rsi\cms\drivers\wodbc.exe into the Open drop down box and press the OK button. Please note on Windows 64 bit computers the following bolded text c:\program files (x86)\rsi\cms\drivers\wodbc.exe should be entered into the Run box. Resource Software International Ltd. Page 25

26 2. The WinLINK ODBC software main window should now be visible on your screen. Enter a Profile name identifying your ShoreTel telephone system (i.e. ShoreTel or ShoreTelNY). Any name can be used. Please note spaces are not permitted in a profile name (i.e. please use an underscore instead of a space). 3. Press the Add or Modify an ODBC Connection button. The Windows ODBC Data Source Administrator dialog should now be visible on your screen. A Database Source Name (DSN) containing the database details required for an ODBC connection to the ShoreTel telephone system must be created. Either a User DSN or a Resource Software International Ltd. Page 26

27 System DSN can be utilized. We recommend a System DSN be used as this will allow retrieval of CDR data to continue regardless of which user is logged into the computer. 4. Click the System DNS tab and then press the Add button. The Create New Data Source dialog will now be visible. Locate and select the Microsoft Access Driver (*.mdb) driver in the driver list. 5. Press the Finish button to create the new data source. The ODBC Microsoft Access Setup dialog should now be visible on your screen (pictured below). Resource Software International Ltd. Page 27

28 The Data Source Name and Description fields are utilized to identify and describe the ODBC connection being defined. Set the Data Source Name field to a name that identifies the ShoreTel server being utilized for this ODBC connection. For example if the customer has a single ShoreTel server then set this field to ShoreTel CDR. However if they have multiple ShoreTel servers and the server we are connecting to is in New York then use ShoreTel CDR NY. The Description field is optional and is used to provide a brief description identifying the connection we are configuring. We recommend you set this value to ShoreTel CDR Database Table. Note: the values entered into these fields are labels and do not impact the ODBC configuration. Press the Select button in the Database options section. The Select Database dialog should now appear on your screen. Use the Select Database dialog to locate the ShoreTel MS Access CDR file (cdr.mdb). You can locate this file by either pressing the Network button or by entering the name or IP address of the ShoreTel server followed by the Shared Folder name (folder on ShoreTel server containing the cdr.mdb file) and the CDR file name (i.e. \\<ShoreTel Server Name or IP Address>\ShoreTelCDR\cdr.mdb). Next, press the OK button to save your settings. After pressing the OK button you should be returned to the ODBC Microsoft Access Setup dialog. Press the OK button to close the ODBC Microsoft Access Setup window and return to the WinLINK ODBC main window. Resource Software International Ltd. Page 28

29 6. Click the WinLINK ODBC DSN drop down list box to select the DSN created in steps 3-5 (i.e. ShoreTel CDR. The WinLINK ODBC main window should now resemble the following. 7. Press the Properties button. The Properties dialog box should now be visible on your screen. Resource Software International Ltd. Page 29

30 The Profile Name field should contain the profile name you specified in step 2. If this box is blank then enter a Profile name identifying your ShoreTel server (i.e. ShoreTel or ShoreTelNY) into the space provided (spaces are not permitted in a profile name - use an underscore instead of a space). 8. If a dial-up connection is required to connect the ShoreTel server then click the Connect tab and activate the Use Dial Up Connection option. Otherwise proceed to step 9. Note: A dial-up connection is not usually required. 9. Click the Retrieval tab. The Retrieval settings window will now be visible on your screen. Set the Destination Path & Filename option to the location where the retrieved CDR records are to be saved. We recommend you set this value to c:\bill\smdr.raw. Alternatively, you can press the Browse button to locate and select the desired location. Use the Overwrite existing file when merging new transfers option to identify if the file identified in the Destination Path & Filename option is to be overwritten each time CDR records are retrieved from the ShoreTel server. This option is typically only utilized during testing. Activating this option may cause records to be lost. As a result, we strongly recommend leaving this box unchecked. Use the Polling Mode option to determine which CDR records are to be retrieved from the ShoreTel server. Set this option to 1 Most Recent Records. This option instructs the WinLINK ODBC software to retrieve only new CDR records from the ShoreTel server. Using the All Records option will instruct the WinLINK ODBC software to retrieve all CDR records from the ShoreTel server. Warning: Using the All Records Resource Software International Ltd. Page 30

31 option could result in duplicate call records being stored in the Revolution Web Call Accounting database. As a result, this option should only be utilized if the Revolution Web Call Accounting software database has been corrupted and lost all call records. The Unique Id field is only utilized when the Polling Mode option is set to 1 Most Recent Records. Only CDR records on the ShoreTel server whose ID field is greater than the value in the Unique ID field will be retrieved. At the conclusion of each CDR retrieval the Unique Id value will be updated with the largest ID value contained in the retrieved CDR records. For newly created profiles the Unique ID field should either be blank or set to minus 1 (-1). Use the SQL Statement(s) text box to specify the SQL query utilized to retrieve CDR records from the ShoreTel server. The required SQL statements can be automatically generated by setting the Populate with drop down list box to ShoreTel 5.x/6.x and then pressing the Set button. The recommended SQL statement(s) value is as follows: Select *,ID as IDN from CALL where ID > {idn} order by ID 10. Press the OK button to save your profile. You have now successfully configured a WinLINK ODBC Profile to retrieve CDR records from a ShoreTel server (version 6.x or earlier). You must now configure the Revolution Web Call Accounting software to utilize this profile (see Configuring Revolution Web Retrieving CDR via an ODBC Connection). ODBC Connection to ShoreTel MySQL CDR Database Revolution Web software can be configured to retrieve CDR records from a ShoreTel MySQL CDR database (requires ShoreTel 7.x or later). The following details the configuration steps required to support an ODBC connection to a ShoreTel MySQL CDR database. 1. Start the Revolution Web WinLINK ODBC software module. Press the Windows Start button and then select the Run command. The following window should be visible on your screen. Type the following bolded text c:\program files\rsi\cms\drivers\wodbc.exe into the Open drop down box and press the OK button. Please note on Windows 64 bit computers the following bolded text c:\program files (x86)\rsi\cms\drivers\wodbc.exe should be entered into the Run box. Resource Software International Ltd. Page 31

32 2. The WinLINK ODBC software main window should now be visible on your screen. Enter a Profile name identifying your ShoreTel telephone system (i.e. ShoreTel or ShoreTelNY). Any name can be used. Please note spaces are not permitted in a profile name (i.e. please use an underscore instead of a space). 3. Press the Add or Modify an ODBC Connection button. The Windows ODBC Data Source Administrator dialog should now be visible on your screen. Resource Software International Ltd. Page 32

33 A Database Source Name (DSN) containing the database details required for an ODBC connection to the ShoreTel telephone system must be created. Either a User DSN or a System DSN can be utilized. We recommend a System DSN be used as this will allow retrieval of CDR data to continue regardless of which user is logged into the computer. 4. Click the System DNS tab and then press the Add button. The Create New Data Source dialog will now be visible. Locate and select the MySQL ODBC Driver compatible with your ShoreTel phone system (i.e. MySQL ODBC 3.51 or MySQL ODBC 5.1 driver). The MySQL ODBC Driver version used will depend on what version your ShoreTel phone system is currently running. ShoreTel 7.0, 7.5 and 8.x use MySQL ODBC driver version 3.51.x, while ShoreTel 9.x and later uses MySQL ODBC driver version 5.1.x. Please note these options will only be visible if the MySQL ODBC driver has been installed on your computer. If these options are not visible then locate and download the required MySQL driver. MySQL drivers can be found at one of the following locations. MySQL ODBC 3.51: MySQL ODBC 5.1: Resource Software International Ltd. Page 33

34 5. Press the Finish button to create the new data source. The MySQL Connector/ODBC Driver 3.51 or 5.1 dialog should now be visible on your screen (pictured below). The Data Source and Description fields are utilized to identify and describe the ODBC connection being defined. Set the Data Source field to a name that identifies the ShoreTel server being utilized for this ODBC connection. For example if the customer has a single ShoreTel server then set this field to ShoreTel CDR. However if they have multiple ShoreTel servers and the server we are connecting to is in New York then use ShoreTel CDR NY. The Description field is optional and is used to provide a brief description identifying the connection we are configuring. We recommend you set this value to ShoreTel CDR Database Table. Note: the values entered into these fields are labels and do not impact the ODBC configuration. The Server and Port fields identify the ODBC connection settings utilized to retrieve CDR records from the ShoreTel CDR database. Set the Server field to the IP Address or computer name of the ShoreTel Server. The Port field value specified must match the port value utilized by the ShoreTel Server. The default port value is A User Name and Password is also required to connect to the ShoreTel CDR database. The default User Name is st_cdrreport. The default Password is passwordcdrreport. Set the Database field to the ShoreTel CDR database name (i.e. shorewarecdr). Resource Software International Ltd. Page 34

35 Press the Test button to confirm an ODBC connection to the ShoreTel CDR database can be successfully completed using the configuration settings you have specified. If the ODBC settings provided are incorrect a message box will be displayed indicating a connection attempt to the ShoreTel server has failed. Please verify the settings provided are correct and then re-test the configuration by pressing the Test button again. The following message box will be displayed if the connection settings provided are correct. You have now successfully tested your ODBC connection to the ShoreTel Server. Press the OK button to create the DSN. Press the OK button to close the ODBC Data Source Configuration window and return to the WinLINK ODBC main window. 6. Click the WinLINK ODBC DSN drop down list box to select the DSN created in steps 3-5 (i.e. ShoreTel CDR. The WinLINK ODBC main window should now resemble the following. Resource Software International Ltd. Page 35

36 7. Press the Properties button. The Properties dialog box should now be visible on your screen. The Profile Name field should contain the profile name you specified in step 2. If this box is blank then enter a Profile name identifying your ShoreTel server (i.e. ShoreTel or ShoreTelNY) into the space provided (spaces are not permitted in a profile name - use an underscore instead of a space). 8. If a dial-up connection is required to connect the ShoreTel server then click the Connect tab and activate the Use Dial Up Connection option. Otherwise proceed to step 9. Note: A dial-up connection is not usually required. Resource Software International Ltd. Page 36

37 9. Click the Retrieval tab. The Retrieval settings window will now be visible on your screen. Set the Destination Path & Filename option to the location where the retrieved CDR records are to be saved. We recommend you set this value to c:\bill\smdr.raw. Alternatively, you can press the Browse button to locate and select the desired location. Use the Overwrite existing file when merging new transfers option to identify if the file identified in the Destination Path & Filename option is to be overwritten each time CDR records are retrieved from the ShoreTel server. This option is typically only utilized during testing. Activating this option may cause records to be lost. As a result, we strongly recommend leaving this box unchecked. Use the Polling Mode option to determine which CDR records are to be retrieved from the ShoreTel server. Set this option to 1 Most Recent Records. This option instructs the WinLINK ODBC software to retrieve only new CDR records from the ShoreTel server. Using the All Records option will instruct the WinLINK ODBC software to retrieve all CDR records from the ShoreTel server. Warning: Using the All Records option could result in duplicate call records being stored in the Revolution Web Call Accounting database. As a result, this option should only be utilized if the Revolution Web Call Accounting software database has been corrupted and lost all call records. The Unique Id field is only utilized when the Polling Mode option is set to 1 Most Recent Records. Only CDR records on the ShoreTel server whose ID field is greater than the value in the Unique ID field will be retrieved. At the conclusion of each CDR retrieval the Unique Id value will be updated with the largest ID value contained in the Resource Software International Ltd. Page 37

38 retrieved CDR records. For newly created profiles the Unique ID field should either be blank or set to minus 1 (-1). Use the SQL Statement(s) text box to specify the SQL query utilized to retrieve CDR records from the ShoreTel server. The required SQL statements can be automatically generated by setting the Populate with drop down list box to either ShoreTel 7.x or later or ShoreTel (CDR/Workgroups) and then pressing the Set button. If your ShoreTel system is using workgroups we recommend you utilize the ShoreTel (CDR/Workgroups) option otherwise select the ShoreTel 7.x or later option. 10. Press the OK button to save your profile. You have now successfully configured a WinLINK ODBC Profile to retrieve CDR records from a ShoreTel server (version 7.x or later). You must now configure the Revolution Web Call Accounting software to utilize this profile (see Configuring Revolution Web to Process CDR Retrieved via an ODBC Connection). ODBC Connection to ShoreTel Professional Services L&P CDR database Revolution Web software can be configured to retrieve CDR records from a ShoreTel Professional Services L&P CDR database (requires ShoreTel 6.1 or later) utilizing an ODBC connection. Please note a network share on the ShoreTel server folder containing the STPSCodeRecords.mdb file must have been previously created (see Retrieve Professional Services L&P CDR Records via an ODBC Connection). The following details the configuration steps required to support an ODBC connection to a ShoreTel Professional Services L&P CDR database. 1. Start the Revolution Web WinLINK ODBC software module. Press the Windows Start button, and then select the Run command. The following window should be visible on your screen. Type the following bolded text c:\program files\rsi\cms\drivers\wodbc.exe into the Open drop down box and press the OK button. Please note on Windows 64 bit computers the following bolded text c:\program files (x86)\rsi\cms\drivers\wodbc.exe should be entered into the Run box. Resource Software International Ltd. Page 38

39 2. The WinLINK ODBC software main window should now be visible on your screen. Enter a Profile name identifying your ShoreTel telephone system (i.e. ShoreTel or ShoreTelNY). Any name can be used. Please note spaces are not permitted in a profile name (i.e. please use an underscore instead of a space). 3. Press the Add or Modify an ODBC Connection button. The Windows ODBC Data Source Administrator dialog should now be visible on your screen. Resource Software International Ltd. Page 39

40 A Database Source Name (DSN) containing the database details required for an ODBC connection to the ShoreTel telephone system must be created. Either a User DSN or a System DSN can be utilized. We recommend a System DSN be used as this will allow retrieval of CDR data to continue regardless of which user is logged into the computer. 4. Click the System DNS tab and then press the Add button. The Create New Data Source dialog will now be visible. Locate and select the Microsoft Access Driver (*.mdb) driver in the driver list. 5. Press the Finish button to create the new data source. The ODBC Microsoft Access Setup dialog should now be visible on your screen (pictured below). Resource Software International Ltd. Page 40