Configure Intelligent Global Search

Intelligent Global Search was introduced in Release 6.1.0.  The feature uses Hypertext Preprocessor (PHP) that is  a general purpose scripting language and MySQL Natural Language Understanding (NLU) search facilities.  Searching is based on Python, the engine that receives a user request.  With the  help of Natural Language, the engine  combines different forms and parts of speech of words in the search argument  to produce an accurate and contextual base word ; i.e., a lemma.  The lemma is then used to return the most relevant results to meet the user's request.   This supports a search that is very flexible and produces more results that our previous searches.  

Examples of words and their base form (lemma) that typically have a similar contextual meaning:

  • going > go
  • sale > sale
  • is > be  

In Release  6.2.1, additional functionality is available:

  • "Recent requests and opened items" are displayed in the Search suggestion form.
  • Users are informed when indexing is in progress.
  • Search automatically switches/reverts to MySQL-based search whenever the Data Analyzer is indexing or re-indexing.
  • A Voice Search option is supported.
  • Documents are included in the Search and can be located by Document  Name, file name or URL
  • The Data Source tab contains External References and External Reports only.

Intelligent Search works with different types of Search Entities; i.e., objects in Metric Insights.  Search results can be grouped by:

  • Default:  "All", "Tiles", "Datasets", "Bursts", Data Sources and Datasets tabs
  • Category:  "All", existing Categories and Datasets are shown as tabs
  • Content Type:  "All", "Metric", "Dataset Report",   other existing content types and Datasets that are displayed as tabs

The search includes metadata about Search Entities:  Information is searched across Names, Descriptions, Categories, Tags but not the data that they contain.   The system relies on metadata when locating Elements and Bursts that meet the search criteria.

For Datasets, additional information about columns to be included is defined during the Search Setup process.  It is important to remember that only MySQL is supported for searching across Datasets.

To understand Searching, see this article.

System Variables are list of configuration parameters in the system that allow a particular value; e.g., Y or N, to be assigned in order to enable or disable a selected feature of the system.

  1. Set the Configuration Variable:  ENABLE_GLOBAL_SEARCH
  2. Click [gear] icon to Global Search,
  3. Assign "Y" value and  [Save] and [Commit Changes]
  4. Repeat Steps 2 and 3 for the GLOBAL_SEARCH_USE_DATA_ANALYZER Configuration Variable

1.1. Search Setup:  Admin > System > Search Setup

On the Search Setup Editor:

  1. Select one or all types of entities to be included in the Search
  2. Choose the manner by which Search Results are to be grouped:
    1. Default:  "All", "Tiles", "Datasets", "Bursts", Data Sources and Datasets tabs
    2. Category: "All", existing Categories and Datasets are shown as tabs
    3. Content Type:  "All", "Metric", "Dataset Report", other existing content types and Datasets are displayed as tabs
  3. Add all Data Sources to be searched across External Reports
  4. Specify Datasets to be searched across metadata
  5. [Save] and [Update All Search Indexes] to commit changes

1.2. Define Search of a specific Dataset

The system looks for lemmas in Objects; i.e., Search Entities themselves and Objects associated with them, such as Tags, Categories, Data Sources, Dimension Values, and Dataset columns.

Search Entities group results and order the entities by determining relevance (rating) of each item. This rating depends on a number of "hits" and a weight of a field where they are detected; e.g., a Name of a field weighs more than a field containing its Description.

To add new Dataset to search:

  1. [+Add Dataset]
  2. Select desired Dataset
  3. [Save]
  1. Define the Datasets:
    • Title Column: specifies the field where the search is performed
    • Link Column: allows attaching links to resources, if any
    • Thumbnail Link Column: identifies the preview to be displayed in the search results
  2. [+Add Dataset Column] adds data to the search
  3. Select a Column and [Save]
  4. [Back to Search Setup]
  5. [Update All Search Indexes]
  6. [Proceed]
  7. Indexing in Progress message appears

Continue adding Data Sources or Datasets to the Search criteria as necessary by repeating steps above.