• Introduction
• Server Software
  • Installing
  • Settings
• Client Software
  • Installing
  • Submitting Emails From Microsoft Outlook
  • Submitting Files From Windows Explorer
  • Client Software Configuration
  • Monitoring folders
• Searching
  • Query Syntax
  • Search Results
  • Search Preferences
• Repositories
  • Creating a New Repository
  • Edit Repository Settings
  • Submitting Documents to a Repository From a Server Accessible File Path
  • Recreating a Repository In Case of Emergency
• Users
  • Creating a New User
  • User Permissions
  • Edit User Settings
  • Removing a User
• Email Submission
  • Adding An Email Account
  • Email Rules
  • Edit An Email Account
  • Removing An Email Account
• Misc.
  • Backups
  • Logging
  • Licensing
  • Shutdown
  • Restart
  • Custom Fields
  • SSL Configuration
  • Microsoft Exchange Integration

Searching

Search Results

Search results are shown with the most relevant matches at the top of the list.

Each document matched shows the date the file was created at the left, the title of the document, an icon representing the file type, and excerpts from the document with matched terms highlighted.  Emails show the sender and receiver email address details.  To see the document, click the subject.

Documents that were attachments to emails show a paperclip icon that can be clicked to view the original email that had the document attached.

On the rightmost side of the screen,  Museum shows a list of email addresses, internet links, and attachments from all the documents that matched the search.

Date Drill Down

Search Results can be resorted by date.  This then shows dates with matching documents to allow the result set to be refined to a selected year or month or day.  Drill down to the timeframe you are searching for.

Search Preferences

If you click on the "Preferences" link at the top right of the main search form, individual preferences can be saved for browsers connecting to Museum:

Everyone using Museum can display their own required number of results, in their own language.

Query Syntax

Terms

A query is broken up into terms and operators. There are two types of terms: Single Terms and Phrases.

A Single Term is a single word such as "test" or "hello".

A Phrase is a group of Terms surrounded by double quotes such as "hello dolly". Using double quotes around terms allows you to find the exact phrase you are after.

Multiple terms can be combined together with Boolean operators to form a more complex query (see below).

Boolean operators

Boolean operators allow terms to be combined through logic operators.

Museum supports AND, OR, NOT, "+" and "-" as Boolean operators(Note: Boolean operators must be ALL CAPS).

The AND operator is the default conjunction operator. This means that if there is no Boolean operator between two terms, the AND operator is used. The AND operator links two terms and finds a matching document if both of the terms exist in a document. This is equivalent to an intersection using sets. The symbol && can be used in place of the word AND.

The OR operator links two terms and finds a matching document if either of the terms exist in a document. This is equivalent to a union using sets. The symbol || can be used in place of the word OR.

The NOT operator excludes documents that contain the term after NOT. This is equivalent to a difference using sets. The symbol ! can be used in place of the word NOT.
 

The "+" or required operator includes only documents where the term after the "+" symbol exists.
 

The "-" or prohibit operator excludes documents that contain the term after the "-" symbol.

 

Fields

When performing a search you can optionally search any field by typing the field name followed by a colon ":" and then the term you are looking for.

This allows you to do something like the following:

from:dave@gmail.com subject:museum

This will search for emails from dave@gmail.com with the word museum in the subject.

Museum stores a "subject" and "date" for all documents.  For emails, Museum also stores "to", "from".

Phrase Searching

Wildcards

A single character wildcard search uses the "?" symbol and looks for terms that match that with the single character replaced.

A multiple character wildcard search use the "*" symbol and matches looks for 0 or more characters.

Fuzzy Searches

Museum supports fuzzy searches based on the Levenshtein Distance, or Edit Distance algorithm. To do a fuzzy search use the tilde, "~", symbol at the end of a Single word Term.

Proximity Searches

Museum supports finding words are a within a specific distance away. To do a proximity search use the tilde, "~", symbol at the end of a Phrase.

Range Searches

Range Queries allow one to match documents whose field(s) values are between the lower and upper bound specified by the Range Query.  Inclusive range queries are denoted by square brackets. Exclusive range queries are denoted by curly brackets.

e.g. A search for:
    date: [20040101 to 20050101] 

Would result in all the documents between the given date range.

Grouping

Museum supports using parentheses to group clauses to form sub queries.