Quick Search Guide - tsgrp/HPI GitHub Wiki

NOTE - this page is a work in progress.

In general, HPI's quick search field is used to search document's full text as well as some text metadata. However, since HPI can run on multiple back end repositories, the way the search ends up being run can be different. This page overviews how quick search works across the various repositories.

##General Examples

An example document that contains the following text:

Daily Operations Checklist

These phrases SHOULD bring back the above document when entered directly into the 'Quick Search' field:

Daily (document has the word)

Daily Operations (document has both words)

"Daily Operations" (document has both words exactly next to each other)

Daily Checklist (document has both of the words, just not next to each other)

These phrases SHOULD NOT bring back the example document above when entered directly into the 'Quick Search' field:

"Daily Checklist" (document has both words, but the user requested an exact match, so it won't come back)

Alfresco

Documentum

Solr / HBase

Notes for the above sections

  • Write this with non-technical terms (anyone looking at this should be able to read it, even if they don't know Java, Lucene syntax, etc.)
  • Include what the search actually looks for (For alfresco - this would be full text and text properties)
  • Include detail on how OC processes the search. For example - are wildcards automatically added? What about double quotes?
  • Include some examples on common search scenarios
    • One word vs. multi-word searches
    • Wildcards (if applicable)
    • Phrasing (using " vs. not)