Configure Intelligent Global Search

Intelligent Global Search was introduced in Release 6.1.0. The feature uses Hypertext Preprocessor (PHP), 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 of words and parts of speech 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 than our previous searches.  

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

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

In Release  6.2.1, additional functionality was made available:

  • "Recent requests and opened items" are displayed in the Search suggestion form.
  • Users are informed when indexing is in progress.
  • 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; i.e., information that is searched across Names, Descriptions, Categories, Tags, and Custom Fields, but not the data that they contain. The system relies on metadata when locating Objects (except for Datasets) 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.

NOTE: The system updates at 12:30 each day. If you want to see changes to search setup during the same day, you need to update search indexes manually.

Access Admin > System > System Variables

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.

Starting Release 6.2.3, System Variables can be accessed only by System Admins.

For more information, see this article.

  1. Set the GLOBAL_SEARCH_USE_DATA_ANALYZER Variable to "Y"
  2. Voice Search is not enabled by default. Set the ENABLE_VOICE_SEARCH Variable to "Y" to enable it
  3. [Commit Changes]

2. Basic Search Setup 

Access Admin > System > Search Setup > Setup

  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 on the page:
    1. Default:  "All", "Tiles", "Datasets", "Bursts", Data Sources, and Datasets tabs
    2. Category: "All", existing Categories, and Datasets
    3. Content Type:  "All", "Metric", "Dataset Report", other existing content types and Datasets
  1. Include all Data Sources to be searched across External Reports
  2. Specify Datasets to be searched across metadata

Once you select a Dataset and [Save], the Dataset Search Setup page opens.

2.1. 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, Dataset columns, and Custom Fields.

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., the Name field weighs more than the Description field.

  1. Define the Dataset details:
    • 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], select a Column, and [Save]
  3. [Save]
  4. [Back to Search Setup]

3. Advanced Search Setup

Access Admin > System > Search Setup > Info > Advanced Search Tuning

Here, you can customize scoring of Search Entities and their Objects. Score(1) is a number that defines the search relevance of a search result. The higher the score, the higher the ranking. For more information on search rate calculation, see this article.

Each Search Entity or Object available from the drop-down(2) goes with its own set of parameters(3), and by adjusting the default score(4) of parameters, you can adjust the total score(1) of a given Search Entity or Object.

Using Testbench(5), you can see how ranking of a given search query changes based on adjustments applied to the score of individual parameters.

NOTE: Once you finish adjusting, you need to [Update All Search Indexes](6) to apply changes.
Go back to the Search Setup screen to view the indexing progress as shown on the screen below.

Metric Insights supports searching data across external tools that are set up for search under Search Setup > External Tools.

  1. [+New Tool]
  2. Enter a display Name for the tool
  3. Specify the External Tool URL
    • Note that the URL must be configured to send search request via a parameter
  4. Specify Behavior for External Tool:
    • Open the tool in a separate tab
    • Embed the tool in Metric Insights
  5. [Save]

Users can now conduct search via external tools by clicking the respective tool label.