Version 5.2.1 (December 10th, 2019)
- Fixed a bug in the Call Concurrency and Gateway Utilization page where if you
narrowed the chart to just N gateways, the presence of any tandem legs in the
calls being analyzed would drag other (unselected) gateways into your chart.
- Added 3 extra hidden fields to the groups lookup, that are optional.
Admins can now customize the automatic lookup statements to use these fields
and alias them to more useful names reflecting the local use case
requirements, and then they will begin working as filtering, reporting and
grouping, and the ‘setup groups’ forms will automatically include appropriate
form elements to create/update/delete the values.
- Fixed a bug in the Canary UI where General Report and a few other pages would
sometimes get an extra “Loading…” indicator stuck open even when nothing
further was loading.
- Improved how the “type”, field is calculated from span integers to never
recognize conference bridge devices and conductors as ‘gateway’ devices.
Prior to this change, the default ^CFB and “CONF$$” regexes for device_type
“conference_bridge” were doing a lot of this work, so for many customers the
net improvement here may be minimal or zero. On the other hand for some this
will make a lot of “tandem” call legs become “incoming” or “outgoing” legs
more in line wiht expectation.
- As with the fixes to the “type” field (see above), the extraction of the
device_type and gateway fields has been improved.
- Fixed a bug where calls to/from, analog devices attached to MGCP gateways
would get the orig/dest gateway fields set to the MGCP gateway. This was
misleading at best.
- Fixed a bug where picking just incoming or internal calls, would erroneously
filter out matching calls involving conference bridge devices, (even where we
were previously extracting the ‘type’ field correctly).
- removed duplicate values from the internal_device_type field.
- Fixed a bug where the origSpan and destSpan fields were marked as categorical
instead of numeric, so you couldn’t build reports like max(origSpan).
- Fixed a bug causing the Canary UI on 8.0 to get a ‘switch back to the old
splunk UI’ (This was intended only for pre 8.0 versions, and the link when
clicked would just redirect you back to Canary UI).
- The Browse gateways page now uses improved SPL to populate the checkbox
pulldown for selecting which gateways you want to analyze.
(Note: this work was mistakenly reported in the 5.1.4 release notes although
it did not actually ship until this release).
Version 5.2 (November 5th, 2019)
- To implement the “upload lookup” functionality on Setup Groups and Setup
Devices in Splunk 8 and higher, a restmap.conf controller now exists to
replace the legacy web.conf controller, and the respective pages now POST
to this new controller when run in the Canary UI. There is also an
improvement to how the messaging works for both success and failure cases.
- Added a “download” tab to the “Define Sites” page so admins can download a
fresh copy of the current subnets to work on it, and then reupload it later.
- MLQK values of exactly 0 are now discarded automatically. These values
always seem to be false readings and previously they had to be filtered out
- Fixing a bug in the Call Detail page, where if many devices were involved,
- Fixed a misalignment of the Pager module in the Browse Devices pages.
the layout of the page would get pushed out and break.
- Fixed a bug that only affected the Canary UI where the page didn’t work
due to a typo where the page invokes app’s reusable ui pattern
- Fixed a bug that only affected the General Report and Browse Calls views
in the Canary UI where some fields would not get their special custom SPL
extractions/conversions inserted automatically behind the scenes.
- Changes to the Call Detail page to get the Field selection to work in both
the Canary UI and the old Splunk UI.
Version 5.1.5 (October 7th, 2019)
- Compatibility work for the transition from Sideview Utils to Canary.
- Layout fixes to the Browse Gateways page.
Version 5.1.4 (September 19th, 2019)
- Now when you use “Create Dashboard Panel”, the current choice of
visualization (chart vs table) as well as chartType and stackMode if
relevant, are passed along and saved into the final dashboard XML.
- Fixed a problem where CallManager misreports inbound calls to UCXNSubscriber
devices as though the device was a gateway and the leg a tandem leg.
- Added a new field called “bh_type” to the app whose value denotes whether
the origination time of the call is during “business_hours” or “off_hours”.
- Added fields to Browse Extensions that are unchecked by default that show
“business_hours” and “off_hours” call counts, as well as
“business_hours_duration” and “off_hours_duration”.
- Added proper logic to detect whether the Canary app is installed and if so
to switch to rendering the current page in the Canary UI instead of the
Advanced XML UI. Also text and links about Canary (currently in beta).
- Fixed a bug in General Report when doing a “max” “concurrency” report,
where if you weren’t using a splitby field, the legend would say “1” instead
- Fixed a bug where if you used the “Setup Clusters” page to generate your
clusters lookup, it would write the clusterLocale values as “”, which would
prevent the location lookup from running and thus you would not get any
location fields like area code, exchange, country, lat/long etc.
Version 5.1.3 (August 26th, 2019)
- Converted the encoding of a number of static file-based lookups from ascii
to UTF‑8 to allow customers to more easily translate the english language
content there into a local language.
- Added a key to server.conf so that when admins update the sideview license
on any Clustered Search Head, that license change will be propagated to the
other SHC members.
- Improvements to the app_setup/migration script so that it better handles
unexpected cases where the clusters/devices/groups/cidr lookups on disk
are found to be empty. It will now detect this case and attempt to replace
the contents of the file with the corresponding *.default.csv file.
- Tightened the regex that matches the SEP prefix for hardphones to eliminate
false positives on other devices whose names happen to have those first few
letters. Now it looks further for 12 subsequent characters of hex.
- Fixed a subtle problem in the Call Concurrency and Gateway Utilization page.
CallManager sometimes marks call legs canonically as outgoing or incoming
even when the destDevice or origDevice listed is clearly a hardphone or conf
bridge. Since gateway extractions all fail for these devicenames, the page
when splitting “by gateway” would end up with “NULL” as a legend item.
These have now been filtered out.
- The gateways pulldown in the Gateway Utilization page will now return much
faster, and will contain the canonical list of gateways for the given time
range even if there are hundreds of gateways across 100K+ call legs.
- Search optimization is disabled now for any user or view using our
‘get_locations‘ macro, as we have seen SPL optimization mangle the lookup
command for the external lookup.
- Fixed a bug in General Report where if “sourcetype” was a field you were
analyzing, the UI wouldn’t realize it should try to pull any CMR and CUBE
records into the analysis as well.
Version 5.1.2 (July 19th, 2019)
- Fixed a bug where when using max(concurrency) in the General Report view,
your “bins” setting would be ignored and a default bins ceiling of 400
would get used instead.
- Fixed a bug in Browse Extensions, and Browse Devices, where if you entered
values into a text field and then without changing anything else clicked
the submit button instead of hitting the enter key, the values you entered
would be ignored.
Version 5.1.1 (July 11th, 2019)
- Made a change so that if the Splunk instance is a Search Head Cluster and
someone tries to post a new license string into the Update License page,
it takes no action and gives them a helpful error.
- Snuck in a semi-secret feature whereby concurrency reports can be done in a
limited fashion within General Report and Browse Calls.
- Updated the “npa-nxx-lata-clli-ocn-location” lookup.
- Updated python to include latest version of libphonenumbers
Version 5.1 (June 10th, 2019)
- Major improvements to both functionality and usability of the Browse
- Devices lookup now can hold an additional column “productName”. When
present this creates fields origProductName and destProductName.
- Device Detail page now has an additional tab that displays additional
summary details like unicodeLoginUserId values and numbers associated with
the device, as well as any values that our SA_cisco_cdr_axl app may have
pulled from CallManager via AXL.
Version 5.0.10 (May 14th, 2019)
- Removed the CSR and SCSR field from the field gallery because we realized
that these fields don’t actually exist in the CMR itself yet.
- Added CS_total and SCS_total as new fields on the calls, which are the
total seconds of concealed speech and the total seconds of severely
concealed speech, across ALL CMR associated with the given call.
- Added CSR_overall and SCSR_overall fields, which are respectively the
CS_total/duration_total, and SCS_total/duration_total.
As such these represent reliable concealed speech ratio metrics for any
devices reporting CS and SCS.
- Fixing a bug in the transfers and legs fields, where if you used them
as a split-by field in reporting, they would get very significantly
overcounted, as represented by the range numbers in the legend for the
split by values.
- Call Detail view now displays the time of any CMR that are present, either
by listing the value of its dateTimeStamp field or failing that, presenting
the time that the record was indexed by Splunk.
- Fixed a bug where refreshing the browser manually on General Report pages
could reset your y‑axis field unexpectedly.
- Fixed some formatting problems in field_gallery.csv which were causing
General Report to treat some fields incorrectly as categorical or numeric.
- Changed the Update License page so it no longer attempts to preload the
textfield with the existing license string – instead now the raw string is
displayed in the table below.
- Fixed a bug in Browse Extensions where “Show – Include numbers with zero
calls” would return two rows for some numbers in the results.
- Fixed a bug where the devices lookup (rarely used, somewhat secret feature)
which is technically allowed to have null values in most of its fields,
would get some null values filled with “PLACEHOLDER” on Splunk restart.
- Added migration to make the field names within the devices lookup
- added new fields that can be pulled from the optional devices lookup.
- Device Detail and Extension Detail pages now have links under key panels
that show calls, to investigate these same calls over in Browse Calls.
- Fixed a bug in the Browse Extensions page, where the “no group” and “no
subgroup” options wouldn’t work when checked, if any other checkboxes were
Version 5.0.9 (April 12th, 2019)
- Improved error messaging when underprivileged users attempt to update
the app’s license string, and when invalid licenses are submitted.
- Removed the embedded app TA_cisco_cdr, as this has now been released
separately on Splunkbase. (NOTE – versions posted on Splunkbase never
had the TA’s in them so this only reflects a change for users
downloading from the Sideview website.)
- Fixed a bug where orig_device_type, dest_device_type and device_type
fields would not populate correctly for non-mgcp gateway devices.
- Implemented a small improvement for the device_type field on individual
call legs. If both types are the same, the field now only holds the single
- Implemented a subtle fix to what the app calls its “union fields”, (group,
name, subgroup, ip_addr and device_type) so that in the aggregated call
results, these fields now only list the distinct values.
- Improved the Groups lookup’s handling of wildcarded numbers by having it
check and correct the sort order of the lookup, so now nested wildcards
work in the expected way without manual sorting.
- Added Cisco’s somewhat newer redirect reason codes >300 to the app’s lookup.
- Fixed an error in the Concurrent calls page that complained about an invalid
- Added new default device_type extractions for conference bridges
- Fixed a bug where some conference bridge devices would get misidentified as
- Changes to default.meta to make some of our content not get flagged as
“orphaned” in splunk’s “reassign knowledge objects” admin UI.
Version 5.0.8 (March 12th, 2019)
- Improved the “to” and “from” fields so that if one of the geographical
fields like city OR state is blank, it does not fall all the way back to
displaying only country (this can happen with wireless numbers where there
is no city associated)
- Raising the minimum version asserted by the app, from Splunk Enterprise 6.2
to Splunk Enterprise 6.4, as our new license endpoint was found to be only
compatible with 6.4 and up.
- Fixed a bug when adding a dashboard panel to a shared dashboard not owned
by the current user. Previously this would fail with a confusing 404 error.
- Fixed a bug when creating a new dashboard entirely, where the dashboard
panel creation would fail with “ERROR 400 Cannot create an object with
empty or all whitespace name”
- When saving a new report, sharing the report with others now works properly.
- When creating a new dashboard for new dashboard panels, the UI now prompts
you if your desired dashboard name contains invalid characters.
- For multileg calls, the “from” and “to” fields now have only the distinct
string values from the various legs, and no longer list duplicate values.
- Removing the interactive timeline from the top of the Browse Devices page
as it seems a change in more recent Splunk Enterprise versions has made
this not render properly. (if you want it back and fixed let us know)
- Fixed a bug on the Browse Devices page where the device name filter would
allow the device names from the non-matching device (on the other side of
each call) to creep into the device search results.
- Fixed a bug in the Gantt chart on Call Detail where it now renders even in
the rare case where callingPartyNumber or finalCalledPartyNumber are blank.
- Fixed a bug in Browse Extensions where using the “name” field would filter
to the right people but could also return other internal parties that had
been on any multi-leg calls with them during the time range.
- The “number” field in Browse Devices now supports multiple comma-separated
numbers, numbers with wildcards and hyphenated ranges of numbers (only up
to a max of 50) and various combinations thereof.
- Cosmetic CSS fixes to render popuplayers, checkbox pulldowns and buttons
properly in the Splunk 7.3 beta.
- Screened out some erroneous rest command warnings from the 911 calls page
and the sites setup page.
Version 5.0.7 (March 1st, 2019)
- Fixed a critical bug for Cloud users and users downloading from Splunkbase
that effectively barred all non-admin users from the product.
- Health checks page can now be run even when product lacks a valid license.
- Filtered out unnecessary “Successfully loaded lookup file” UI messages.
- Added a warning to users who attempt to enter raw numeric terms into the
‘search filters’ field, as this is not supported and will return 0 results.
Version 5.0.6 (February 27th, 2019)
- Fixed a common problem where license strings pasted into “Update License”
would fail if they had an extra leading or trailing space character.
- Improved the fix done in 5.0.5 around the “Sideview Utils not installed”
error case to no longer require a custom module.
Version 5.0.5 (February 19th, 2019)
- on Site Detail and Gateway Detail pages, some drilldowns and links were
linking to Browse Calls with the “get only the” pulldown set to only pull
the most recent 1000 call legs. This has been fixed so those links will set
that pulldown to “all” and so will now return expected results.
- Implemented a workaround for a bug introduced in Splunk Enterprise 7.2.4
itself that causes an error message to appear on the app homepage saying
“ServerSideInclude Module Error”
- Improved the Edit Clusters page so that if Splunk fails to run our
app_setup script (we are still not sure why this happens sometimes), users
can still use the “Edit Clusters” page to fix the clusters lookup manually.
Version 5.0.4 (February 4th, 2019)
- Fixed a bug where if you were using * as a wildcard in your groups lookup
entries the Extension Detail page for matching numbers would fail to list
the name, group, subgroup information.
- Migration check added, to look for old saved reports that have ui_edit_view
specified but no ui_context. Since these will be unable to reload themselves
in the specified view they are now migrated to load in the default splunk
- the Setup Groups page now gives users the ability to download a copy of the
groups lookup as a csv or to open it directly in Excel.
- Fixed a bug around the “save report” buttons – the resulting reports would
reload fine in the Sideview UI but the underlying savedsearch stanza had an
extra “search” prepended to the SPL that would make it always return 0
results when run from core splunk interfaces and from the scheduler.
Version 5.0.3 (January 25th, 2019)
- Fixed a regression introduced surprisingly long ago where if you saved a
report and then tried to reload it from the “Saved Reports” menu, it would
not appear with the form elements selected to the right values and so the
results would be incorrect.
- Fixed a bug where after you saved a report or dashboard from any of the
app’s interfaces, you would have to reload the page or navigate to a
different page before the new report/dashboard appeared in the Saved Report
or Saved Dashboards menu.
Version 5.0.2 (January 17th, 2019)
- Fixed a bug in the Devices page, where if you had all of the options selected
in the “sites” pulldown, then all of the sites in the table would switch to
- Fixed a bug on Internet Explorer only that was introduced in 5.0.1, that
prevented the product from working properly on that browser.
Version 5.0.1 (January 14th, 2019)
- Fixed a problem introduced in Splunk 7.X where the TimeRangePicker control’s
menu options lost their submenus and became instead a huge flat list.
- Screened out a class of uninformative “Successfully read lookup file”
messages from being displayed in the UI.
- Improved clarity of product messaging when license/support terms expire.
- Within General Report, the “over time” option now always gives you an option
to set the “bins”, ie to set the granularity of time on the x‑axis.
- Cisco CDR app now requires at least Sideview Utils 3.4.6.
Version 5.0 (January 11th, 2019)
- The product has a new licensing mechanism. Instead of the license information
being embedded only in the source code served from our website, you can now
update the license by pasting your current valid license string into a page
in the product itself.
- Fixed a bug in the “number” field in Browse Calls and General Report where
you could quickly click into the field as the page was loading and the
“enter number()” text would get stuck in there as though it was valid input.
- Added Field Gallery docs for SCSR and CSR fields, and a sample report.
- Pulled new NANPA data into the “npa-nxx-lata-clli-ocn-location.csv” lookup.
- Fixed a bug that caused Browse Gateways to sometimes break a given gateway’s
stats into two different rows.
- updated python-phonenumbers library to latest version.