1) Updating the apps

NOTE this is only good for 2.x to 2.y updates – you cannot go directly from 1.x to 2.x, it’s a whole different thing now.  Please contact us if this is the case and we can help you.

Version 2.2 and newer are all now hosted directly on Splunkbase.  This means you can use any of several methods to update that Splunk has “Built in”.  We’ll outline a recommended way below, but know that there are other ways to do this.  The key being that it’s just a “regular Splunk app update” now and the only different thing from most apps is you need to have your license key handy.

Also note – you can move directly from 2.x to 2.2 using any of these methods too – just be sure to have your license key at the ready!

  1. Find your new license key
    • This should be in an email from us and is clearly marked.
    • If you don’t have a license key handy, and you are upgrading from 1.x, STOP.  Contact us!
  2. Log into the Splunk UI as an admin user.
  3. Click the splunk>enterprise logo in the upper left
  4. Click the gear icon next to Apps
  5. In the resulting list, filter for sideview, you should end up with 2 or more apps.
    • You can also simply look down the list and find them that way, too.
  6. If there are updates waiting, it’ll say “Update to X.X.X” – and I know, I don’t have that screenshot so just pretend until we release an update, please!  (I promise, if you have updates waiting, that  spot on the right will really say these things!)
  7. If you don’t have any updates waiting, you are done!  Congratulations!
  8. Otherwise if Sideview Utils has an update waiting, start with it:
    1. Click the Update to XXX link beside Sideview Utils
    2. Check the box saying you have read and understand the license agreement.
    3. Click Accept and continue
    4. Log into Splunkbase (it’s your Splunk.com username and password), click Login and continue
    5. Wait while it installs.
    6. If it asks you to restart Splunk, you can safely click Restart later because we’ll have to do it after the next steps anyway.
  9. If the Mitel/Shoretel Call Reporting app has an update waiting, perform that too:
    1. Click the Update to XXX link beside Mitel/Shoretel Call Reporting
    2. Check the box saying you have read and understand the license agreement.
    3. Click Accept and continue
    4. Log into Splunkbase (it’s your Splunk.com username and password), click Login and continue
    5. Wait while it installs.
    6. Click Restart Now when finished.
  10. Open the app, and click the Home button.  If it tells you that you have to update your license, follow the steps below.

2) Updating the license (if needed)

Trial Version to Full Version, Extending your Trial, or Renewing Full Version

The directions to update your license is greatly simplified since version 2.1.    If you are still on a version before 2.0, please contact us before doing anything.  Otherwise, if you are on 2.0, please update your app to the latest (the directions above) then come back here.

  1. Find your new license key
    • This should be in an email from us and is clearly marked.
  2. Log into the Splunk UI as an admin user.
  3. Open the Mitel/Shoretel Call Reporting app.
  4. Click Setup, then Update license.
  5. Paste in your new license key, then click the Replace License button.
  6. After updating, you’ll see license information including company and expiration date.

3) Clear your browser cache

Unfortunately Splunk’s aggressive caching on static files will often result in some old content interleaving with the new. There are two methods of fixing this. The recommended method is to invalidate the cached files for everyone, but you could also simply clear your own browser cache.

To invalidate the cache for everyone

This method is non-destructive to anything in your browser.  What it does is trigger Splunk to append a new version string into all the web pages it is serving and thus make all browsers get a new copy.

  • Open your Splunk server in your browser.
  • In the address bar, you should have something similar to one of the below URLs being displayed.
    • http://<ip address or servername>:8000/en-US/app/launcher/home
    • https://<ip address or servername>:8443/en-US/app/shoretel/browse
  • Click up in there, and then carefully remove everything to the right of “en-US/” (or other localized version).  You will be left with something like
    • http://<ip address or servername>:<portnumber>/en-US/
  • Now, in the place of what you erased, add _bump, like so
    • http://<ip address>:8000/en-US/_bump
  • And press enter.  You’ll be take to a screen with a version number and a button labeled “Bump version”
  • Click the grey “Bump version” button, which will bump your version.
  • That’s it.  Simply navigate back to your Splunk instance’s regular log in page and all should be well now.

To clear the cache for a single browser

This method removes cached files from your computer, and your computer only.  When you next visit your Splunk server’s page, you won’t have a cached version of any of the web pages it is serving, and thus will have to get a new copy.

  • Press Ctrl-Shift-Delete.
    • This works for Firefox and Chrome, it may work for other browsers as well.
  • There are a variety of options exposed to you – our recommendation, which will erase all cached files but not erase anything else like browsing history, is to..
  • Uncheck all options except “Cache”
  • Change the time frame to “All Time”
  • Then click Clear Now, or whatever your button is called.
  • Be careful – there are options to remove all sorts of things inside here.  Some of which you may not want removed.
Notes

All the indexed data, the searches, reports, dashboards — all that will be backwards compatible. Of course if you have any questions or if you hit any problems, contact us