Search2 User Guide

From KnowledgeTree Document Management Made Simple

The new search engine provides for more complicated search expressions than were possible in the past.

Expression Language

The core of the search engine is the 'expression language'.

Expressions may be built up using the following grammar:

expr ::= expr { AND | OR } expr
expr ::= NOT expr
expr ::= (expr)
expr ::= expr { < | <= | = | > | >= | CONTAINS |STARTS WITH | ENDS WITH } value
expr ::= field BETWEEN value AND value 
expr ::= field DOES [ NOT ] CONTAIN value
expr ::= field IS [ NOT ] LIKE value
value ::= "search text here"

A field may be one of the following:

CheckedOut , CheckedOutBy , CheckedoutDelta , Created , CreatedBy , CreatedDelta , DiscussionText , DocumentId ,
DocumentText , DocumentType , Filename , Filesize , Folder , GeneralText , IsCheckedOut , IsImmutable ,
Metadata , MimeType , Modified , ModifiedBy , ModifiedDelta , Tag , Title , Workflow ,
WorkflowID , WorkflowState , WorkflowStateID

A 'field' may also refer to metadata using the following syntax: ["fieldset name"]["field name"]

Note that 'values' must be contained within "double quotes".

Example Expressions

Title contains "contract" and filesize <= "10000"

Filename ends with ".doc" and (title starts with "ENG" OR filename starts with "ENG") OR WorkflowState = "Draft"

["Invoice"]["InvoiceNo"] starts with ("ENG", "INV")

is equivalent to

(["Invoice"]["InvoiceNo"] starts with "ENG") or (["Invoice"]["InvoiceNo"] starts with "INV")

DocumentText : "SECRET"

is equivalent to

DocumentText contains "SECRET"

User Interface Features

Quick Search widget

This appears on the main navigation bar. Text entered into this widget will be searched according to two options: 1) metadata only 2) filename, title, metadata and document content

Text Extractor Diagnostics Plugin

This is available via the dashboard to the administrator. The results may also be obtained by running the search2/indexing/bin/diagnose.php script.

Search Portlet

When browsing through the repository, the search portlet will be available to the right. It will provide a few extra options regarding search.