0 Replies Latest reply: May 14, 2012 3:55 PM by Bradley Gross RSS

DX 3 Search: How it works

Bradley Gross Newbie

Introduction

The following description of DX 3 search is based on the deploy made on 5/14.

"What is the old behavior?" you ask.

Good question.

 

Prior to DX 3, earlier versions of data web services (DX 2.1, 2.0) provided “full search” behavior (details described later in this article).   With the introduction of DX 3, new search behavior was introduced that is described later in this document as “single search”.

 

The DX 3 update that was deployed along with the 10.3 release (in March of this year) restored the “full search” behavior in order to provide consistent search behavior across our Analytics product line.  As a result of this 10.3 update, we unintentionally changed the default behavior of existing DX 3 search usage.

 

The DX 3 update of 5/14 will accomplish 3 goals:

     1. Restore the original DX 3 “single search” default behavior

     2. Make the additional “full search” behavior available for those who need it

     3. Create an additional “multidimensional search” capability

  

Sample data

We will be referencing two different examples of data a customer can encounter.  One of them is the Geography drilldown data which all accounts have access to by default.  The second set of data (for example purposes) will be a "Movie store" that has a few levels.

 

Geo Drilldown:

RegionCountryState/ProvinceCity
Western EuropeItaly-Rome
North AmericaCanadaOntarioRome
North AmericaCanadaOntarioToronto
North AmericaUnited StatesOregonPortland
Western EuropeUnited KingdomENGLondon

 

Movies:

FormatTypeGenreTitle
BlueRayMovieKidsShrek
BlueRayDocumentaryNatureNational Geographic on BlueRay
DVDMovieActionDie Hard
StreamingTVActionNCIS
StreamingTVRealityPawn Stars

 

Search Parameter

By default, the search parameter will search on the top level and return those items that match the search and all the sub-levels below that search.

 

Single Search

In the Geo Drilldown sample, doing a search:

search=Rome

You would return no rows.  This is because the top level is Region, and no Regions for Rome exist (Its a city, which is on the 4th level.)

 

In the Movie sample, doing a search:

search=BlueRay

 

Returns:

FormatTypeGenreTitle
BlueRayMovieKidsShrek
BlueRayDocumentaryNatureNational Geographic on BlueRay

 

This is because BlueRay was on the top level, and then it would return all rows beneath that top level.

 

Multidimensional search

The search parameter can be used to search multiple dimensions by separating the search terms with a comma (see below).

This takes the first term and applies to the top level, second to the second level, third to third and so on.

 

So, using the Geo Drilldown example, doing a search for:

search = North America, United States

 

Returns:

RegionCountryStateCity
North AmericaUnited StatesOregonPortland

 

This matched "North America" in the top Level and "United States" in the second.

Note: It did not return the row for Canada even though it matched the first search term.  You have to match all the search terms to get the row to come back.

 

Same thing if searching the Movie example with:

search=BlueRay,Movie

 

Returns:

FormatTypeGenreTitle
BlueRayMovieKidsShrek

 

This did not return a row for "Die Hard" even though the second level has "Movie" because the top level was not "BlueRay".

 

Full Search

The fullsearch parameter is used to find a specific term in all the levels.

This is to "target" the results based on a keyword search.  This functionality mimics the search behavior in both the A10 and A9 UI.

 

The search term is applied to all levels of the report and returns the "node" that matched the search term and all the parents of that node.

Another way to describe this is an End Node Search.

 

So in the Geo sample, using:

fullsearch=Rome

 

Returns:

RegionCountryStateCity
North AmericaCanadaOntarioRome
Western EuropeItalyrmRome

 

The search provided results down to the City level and that was returned along with all the parent's of that node.

 

Running a search like:

fullsearch=Ontario

 

Returns:

RegionCountryStateCity
North AmericaCanadaOntario

 

You would not get back any Cities, as there is no City that has "Ontario" for the search, you only get back the "end node" that matched the search and its parents.

 

Another example of this is a search in the Movies like:

fullsearch=Action

 

Returns:

FormatTypeGenreTitle
DVDMovieAction
StreamingTVAction

 

Result is down to the Genre of "Action" but none of the titles, as there was no Title that matched the search term.

 

But, if you did a search like:

fullsearch=BlueRay

 

Returns:

FormatTypeGenreTitle
BlueRay


BlueRayDocumentaryNatureNational Geographic on BlueRay

 

In this case  a row returning the top level because it matched BlueRay, but a row returned for the Title, as one of the titles had "BlueRay" in the title.