Search Keywords

This article provides both visual and written instructions for searching Reveal data for keywords.

Non-Audio Video Tutorial

Entering a term in the Search Bar at the top of the Dashboard or any of its views will start a Keyword search. There are many options available and a few syntactical things to keep in mind.24 - 02 - Keyword Search-2

  1. The Dashboard (which offers visualizations through the Dashboard, Grid, Clusters, or Heatmap) features the Search Bar in its top center. 
  2.  To search for a word, a string or a phrase in the project document data, type it into the Search Bar. NOTE that a multi-word phrase must be set between quotation marks (e.g., “limited partners”). We will start with a one-word example, raptor.25 - 00a - Search Entry Prompts (simple term)
    1. If you simply press ENTER, this will be treated as a keyword search by default, the same as selecting All documents with keyword raptor to set this as a keyword search. All project documents containing the word raptor will be retrieved. 

Caution Please Read: There are two symbols that are treated as text: the period  "." and underscore "_"  symbols. These symbols will NOT be considered spaces.  Instead, they will be treated as a character. Please see examples below: 

  • Example 1: "first.last" will be tokenized as a single term "first.last" 
  • Example 2: "first_last" will be tokenized as a single term "first_last"
  • Example 3: "first-last" will be tokenized as two separate terms "first" and "last" 


    1. You may select Discover concepts about raptor to begin a Concept Search. Project documents analyzed by Reveal as conceptually related to that term or proposed related terms will be retrieved. 
    2. You may Open Builder to develop an Advanced Search
  1. All document counts, graphs, Filter lists and tables will update with results of the search, and the Results pane will open with document cards for the top items.
  2. The search may be refined with additional keywords or added conditions (in Advanced Search) or Filters (from Filters in the Sidebar or as selected from bars in the Dashboard graphs).
  3. When adding a Keyword under Advanced Search (ADD > Common > Advanced Keyword), the tilde (“~”) character will open a list of fields that may be selected to set an RQL (Reveal Query Language) metadata filter. Simple RQL keyword searches use the format <FIELDNAME>::”<term>”, such as accountant AND FILE_EXTENSION::"xls*"
    24 - 01a - Add Keyword Field list
    NOTE that the curly braces at the right of the Keyword Search pop-up entry box open a prompt to assist with syntax. 25 - 03a - Advanced Search Add Condition - keyword assist
  4. The search may also be enhanced with Concepts added under Add in Advanced Search or from a Clusters selection.
  5. As you start entering a search term, Reveal may offer additional prompts relevant to your project including keywords, tag names, field names and score names. In this example, typing the string posi suggests a Field and an Emotional Intelligence score.
    25 - 00 - Search Entry Prompts

Keywords versus Concepts

  1. A Keyword is a word or phrase that directly matches material indexed in Project documents and when entered retrieves these documents.
  2. Concept is a word or phrase that is parsed by Reveal to suggest other possibly related content found in the project. See How to Search Concepts for more information.

Phrases and Special Characters

  1. Keyword Phrases must be entered between quotation marks ("") in order to be treated as a phrase and not a syntax error. 
  2. Concept Phrases are evaluated differently and may be entered without quotation marks.
  3. Keywords with special characters (e.g., "AT&T") must be entered between quotation marks ("") in order to be treated as a phrase and not a collection of legal and illegal characters. 
  4. Proximity is expressed as <term1> w/# <term2>, for example ice w/2 soda.
  5. Wildcard search is currently limited to the asterisk (*), and will interpret * as zero or more characters.
  6. Negative: Reveal supports A AND NOT B, and A OR NOT B, but does not support A NOT B.
  7. Common words are treated differently in Reveal 11. Reveal 11 uses different Elasticsearch analyzers: instead of using the StopFilter to keep common words from being indexed, the CommonGramsFilter is used instead to support efficient searching of common words. 

See Reveal Query Language Basics to begin exploring advanced search syntax in Reveal.


Last Updated 6/28/2024