Mitel/Shoretel Call Reporting

 

Installation docs

 

Additional required configuration

Overview

After installation of the apps, there are some steps left yet to configure them.  These steps are

  • Installing the API key for Google Maps
  • Configuring the Shoretel DB to allow access
  • MySQL drivers and Java for the Splunk App for DB Connect
  • Creating the inputs needed to start data collection
    • (There’s a required MySQL step, then another option log we can collect as well).

Details

Installing the API key for Google Maps

First get your API key from here:
https://developers.google.com/maps/documentation/javascript/get-api-key

Then edit $SPLUNK_HOME\etc\apps\maps\appserver\modules\GoogleMaps\GoogleMaps.js

Line 29 should read;

s.src = "https://maps.google.com/maps/api/js?key=%%INSERT_API_KEY_HERE%%k&sensor=false&version=v3.6&callback=_gmapsOnLoad";

Replace %%INSERT_API_KEY_HERE%% with the API key you retrieved in the earlier step.

Configuring the Shoretel DB to allow access

We will either add a new user to the MySQL DB inside Shoretel,  or add privileges to an existing user for remote access.

  1. Open a command prompt on the shoretel server.
  2. Change the directory to the MySQL path, eg C:\Program Files (x86)\Shoreline Communications\ShoreWare Server\MySQLCDR\MySQL Server\bin
  3. Launch MySQL  ie   mysql.exe -u root -p Hit return.
  4. You will be prompted for the password of the root user as defined inside mysql.
  5. From here,  to add a read only user  called ‘splunk’,  you would run:
    > grant select on shorewarecdr.* to ‘splunk’@’%’ identified by ‘somePassword’;

    1. NOTE: you should pick a real password of course, and if you prefer (or for  security) you can specify the particular IP of the Splunk server instead of “%”

MySQL drivers and Java for the Splunk App for DB Connect

Java

A prerequisite of the DB Connect app is tp have Java 8 installed.

If you are  using Windows as your Splunk server running DB Connect:

  1. Visit the Java download site
  2. Find the section for the latest version of the Java JRE and click the download button next to it.
  3. On the resulting page at Oracle (who owns Java),
    1. Accept the license agreement,
    2. Download the latest version of “Windows x64 Offline”
  4. Run that when it finishes downloading.
  5. Accept all defaults for the installation.

If your server is *nix,

  1. Use your distribution’s provided mechanism for installing the Java JRE, version 8.

Configure DB Connect to use Java

  • Launch Splunk on your server in a browser, if you don’t already have it open.
  • Navigate to your Splunk DB Connect app.
  • Click the Configuration tab, then Settings, then General.
  • Provide the path to your java.exe or java executable
  • The other fields will populate automatically.
  • Click “Save” on the right.

Add the required MySQL drivers

  • As per Splunk’s official documentation here;
    • Download the Mysql Connector
    • (Be sure to pick the “Platform Independent” version of the download!)
    • As per Splunk’s documentation, unzip the zip file and you will see the mysql connector jar file.
    • Copy this to  $SPLUNK_HOME\etc\apps\dbx\bin\lib” and restart Splunk.
  • Launch Splunk on your server in a browser, if you don’t already have it open.
  • Navigate to your Splunk DB Connect app.
  • Click the Configuration tab, then Settings, then General.

 

  • Under “Identities” on the left,  go ahead and add a new identity matching the username and password that you just created or selected in the MySQL command line tool.
    Next under “Connections” you will create a new connection.
    For the connection name enter “shoretel_connection”. This will be important later.
    Set the host to be the host of your Shoretel server.
    Set the “Database Type” to “MySQL”.
    In the “Default Database” field you can enter “shorewarecdr”. Make sure it is all in lowercase.
    For “Identity”, choose the identity that you just created in DBConnect.
    Unless the shoretel DB was set up in a nonstandard way on a nonstandard port, you should leave the port field blank.
    Last but not least, leave “Read only” checked.
    submit the form.
    Assuming the validation on the next page succeeds, at this point we have a working JDBC connection to the database, but we aren’t actually pulling any information in yet.

Creating the inputs needed to start data collection