Search panel

The Search panel is where you can create and run search queries against one or more collectionsA collection is a container for storing and organising ingested files and documents. Only the textual content is stored in collections, not the original files and documents. in your project. The Search panel consists of a Collections pane and a Search Query pane.

Collections Pane

The Collection pane displays a list of available Collections you can include in your Search Query.

Task

Action

Select a Collection to be included in a search

Select the checkbox next to the Collections you want to include.

Select all Collections to be included in a search

Click Select All.

Open a Collection in Collection view

On the specific Collection you want to open, click to this collection .

Search Query pane

The Search Query pane is where you can create, save and run your searches. To start a new query, the first thing you need to do is add Search Facets. Without Search Facets, running the search would display every Document in the search results.

Search Facets allow you to narrow or broaden the focus of your query by letting you search for words in specific areas of a Document such as its body text, Text References, Document Tags, and Document or Ingestion Property metadata.

Task

Action

Add a new facet to the Search Query

Click Add and select a Search Facet from the list.

Refer to the specific search facet in the sections below for detailed information on how to use them.

Enable grouping of similar search results

  1. Select Group similar search results.
  2. Move the slider left or right to adjust the match tolerance.

Similar Documents will be grouped together when the search query is run.

Note: The lower the slider percentage, the more similar the documents need to be to be grouped together. A good rule is to not exceed 10%. At this level, you would be able group together emails that share much of the same content. At 1%, documents would have to be nearly identical to be matched, which is good for deduplication of identical content that appears in different file formats.

Add a Search Query to Favourites

Click Add to Favourites .

Save a Network Search Indicator

Click Save as Network Search Indicator .

Note: Network Search Indicators are a kind of configuration and can only be used in the Project they were created in.

Show Recent Searches

Click Recent Searches .

Run a Search Query

  1. Click Add and select a Search Facet from the list.
  2. Configure the Search Facet (refer to Search Facet Configuration section).
  3. Repeat steps 1 and 2 to add additional Search Facets.
  4. Click Search.

View the Query parameter used by the Document Search service

Click Show Query.

Search Facet Configuration

There are nine search facets that you can use in the construction of your search queries :

Every search facet shares a few common functions. These are explained below followed by more detailed information and instructions for configuring each search facet.

Task

Action

Change to a different search facet

Click the Change search facet arrow and select a Search Facet from the list.

Invert a query

Click POS .

Note: Tip: An inverted query will display search results that don't contain the query keyword.

Enable/Disable a Search Face

Select the Enable Search Facet checkbox to enable the search facet or clear it to disable the search facet.

Create a copy of a Search Facet

Click Copy .

Remove a Search Facet

Click Remove .

Text

This facet will search all the available text in a Collection. This is a good place if you just need to perform a broad keyword search on your Collection.

Keyword Search

Task

Action

Enter a new query

In the Query box, enter a keyword query.

Switch to Dictionary search

Click Text and select Dictionary from the list.

The Keyword Search options will be replaced with Dictionary Search options.

Enable keyword highlighting

Select the Highlight checkbox.

Matching keywords will be highlighted in the search results.

Find Synonyms

Select the Find Synonyms checkbox.

Synonyms of the query keywords will display in the search results

Dictionary Search

Task

Action

Enter a new wordlist query

  1. In the Query box, select a Dictionary from the list.
  2. In Wordlist, select a Dictionary wordlist.

Note: Using a Dictionary allows you to quickly include groups of related keywords in a query.

Switch to Keyword search

Click Dictionary and select Text from the list.

The Dictionary Search options will be replaced with Keyword Search options.

Enable keyword highlighting

Select the Highlight checkbox.

Matching keywords will be highlighted in the search results.

Find Synonyms

Select the Find Synonyms checkbox.

Synonyms of the query keywords will display in the search results

 

Text Reference

This search facet is used to find Documents based on their Text References.

Keyword Search

Task

Action

Select a Text Reference Tag

In the Tag box, enter the name of a Text Reference tag or select one from the list.

Enter a new query

In the Query box, enter a keyword query.

Switch to Dictionary search

Click Text and select Dictionary from the list.

The Keyword Search options will be replaced with Dictionary Search options.

Add a new Context Query

  1. Click Add Another Context Item .
  2. In the Context box, enter a Context Query.

Note: Context is used to refine search results so that only Text References that meet a specified context criteria are returned in search results. Refer to the Context Query Language help page for more information on how to Context Queries work and how to structure them.

Dictionary Search

Task

Action

Select a Text Reference Tag

In the Tag box, enter the name of a Text Reference tag or select one from the list.

Enter a new wordlist query

  1. In the Query box, select a Dictionary from the list.
  2. In Wordlist, select a Dictionary wordlist.

Note: Tip: Using a Dictionary allows you to quickly include groups of related keywords in a query.

Switch to Keyword search

Click Dictionary and select Text from the list.

The Dictionary Search options will be replaced with Keyword Search options.

Add a new Context Query

  1. Click Add Another Context Item .
  2. In the Context box, enter a Context Query.

Note: Context is used to refine search results so that only Text References that meet a specified context criteria are returned in search results. Refer to the Context Query Language help page for more information on how to Context Queries work and how to structure them.

 

Document Tag

This search facet is used to find Documents based on their Document Tags.

Keyword Search

Task

Action

Select a Document Tag Category

In the Category box, enter the name of a Document Tag category or select one from the list.

Enter a new query

In the Query box, enter an exact query.

Untokenized fields which include text in Document Tags and Ingestion Properties can only be searched using exact queries. Refer to the Search Query Language help page for information on how to write exact queries.

Switch to Dictionary search

Click Text and select Dictionary from the list.

The Keyword Search options will be replaced with Dictionary Search options.

Dictionary Search

Task

Action

Select a Document Tag Category

In the Category box, enter the name of a Document Tag category or select one from the list.

Enter a new wordlist query

  1. In the Query box, select a Dictionary from the list.
  2. In Wordlist, select a Dictionary wordlist.

Note: Using a Dictionary allows you to quickly include groups of related keywords in a query.

Switch to Keyword search

Click Dictionary and select Text from the list.

The Dictionary Search options will be replaced with Keyword Search options.

Document Property

This search facet is used to find Documents based on their Document Properties.

Keyword Search

Task

Action

Enter a Document Property

  1. In the Category box, enter the name of a Document Property category or select one from the list.
  2. In the Property box, enter the name of a Document Property or select one from the list.

Enter a new query

In the Query box, enter a keyword query.

Switch to Dictionary search

Click Text and select Dictionary from the list.

The Keyword Search options will be replaced with Dictionary Search options.

Switch to Date Time search

Click Text and select Date Time from the list.

The Keyword Search options will be replaced with Date Time Search options.

Dictionary Search

Task

Action

Enter a Document Property

  1. In the Category box, enter the name of a Document Property category or select one from the list.
  2. In the Property box, enter the name of a Document Property or select one from the list.

Enter a new wordlist query

  1. In the Query box, select a Dictionary from the list.
  2. In Wordlist, select a Dictionary wordlist.

Note: Tip: Using a Dictionary allows you to quickly include groups of related keywords in a query.

Switch to Keyword search

Click Dictionary and select Text from the list.

The Dictionary Search options will be replaced with Keyword Search options.

Switch to Date Time search

Click Dictionary and select Date Time from the list.

The Dictionary Search options will be replaced with Date Time Search options.

Date Time Search

Task

Action

Enter a Document Property

  1. In the Category box, enter the name of a Document Property category or select one from the list.
  2. In the Property box, enter the name of a Document Property or select one from the list.

Enter a new Date Time range

Option 1:

  1. Click Select Period.
  2. Select a preset date range from the list.
  3. Select a Query Timezone.
  4. Select or clear the Default to Query Timezone checkbox:
    • Select the checkbox to assume all results without a timezone are within the selected query timezone.
    • Clear the checkbox to ignore all results that do not state a timezone.

Option 2:

  1. Enter a From date and time.
  2. Enter a To date and time.
  3. Select a Query Timezone.
  4. Select or clear the Default to Query Timezone checkbox:
    • Select the checkbox to assume all results without a timezone are within the selected query timezone.
    • Clear the checkbox to ignore all results that do not state a timezone.

Switch to Dictionary search

Click Date Time and select Dictionary from the list.

The Date Time Search options will be replaced with Dictionary Search options.

Switch to Text search

Click Date Time and select Text from the list.

The Date Time Search options will be replaced with Keyword Search options.

Ingestion Property

This search facet is used to find Documents based on their Ingestion Properties.

Keyword Search

Task

Action

Enter an Ingestion Property

In the Property box, enter the name of a Ingestion Property or select one from the list.

Enter a new query

In the Query box, enter an exact query.

Note: Tip: Untokenized fields which include text in Document Tags and Ingestion Properties can only be searched using exact queries. Refer to the Search Query Language help page for information on how to write exact queries.

Switch to Dictionary search

Click Text and select Dictionary from the list.

The Keyword Search options will be replaced with Dictionary Search options.

Dictionary Search

Task

Action

Enter a Document Property

  1. In the Category box, enter the name of a Document Property category or select one from the list.
  2. In the Property box, enter the name of a Document Property or select one from the list.

Enter a new wordlist query

  1. In the Query box, select a Dictionary from the list.
  2. In Wordlist, select a Dictionary wordlist.

Note: Using a Dictionary allows you to quickly include groups of related keywords in a query.

Switch to Keyword search

Click Dictionary and select Text from the list.

The Keyword Search options will be replaced with Dictionary Search options.

Date Time Search

Task

Action

Enter an Ingestion Property

In the Property box, enter the name of an Ingestion Property or select one from the list.

Enter a new Date Time range

Option 1:

  1. Click Select Period.
  2. Select a preset date range from the list.
  3. Select a Query Timezone.
  4. Select or clear the Default to Query Timezone checkbox:
    • Select the checkbox to assume all results without a timezone are within the selected query timezone.
    • Clear the checkbox to ignore all results that do not state a timezone.

Option 2:

  1. Enter a From date and time.
  2. Enter a To date and time.
  3. Select a Query Timezone.
  4. Select or clear the Default to Query Timezone checkbox:
    • Select the checkbox to assume all results without a timezone are within the selected query timezone.
    • Clear the checkbox to ignore all results that do not state a timezone.

Switch to Dictionary search

Click Date Time and select Dictionary from the list.

The Date Time Search options will be replaced with Dictionary Search options.

Switch to Text search

Click Date Time and select Text from the list.

The Date Time Search options will be replaced with Keyword Search options.

Document Date Time

Task

Action

Enter a Property

In the Property box, enter the name of a Document or Ingestion Property, or select one from the list.

Enter a new Date Time range

Option 1:

  1. Click Select Period.
  2. Select a preset date range from the list.
  3. Select a Query Timezone.
  4. Select or clear the Default to Query Timezone checkbox:
    • Select the checkbox to assume all results without a timezone are within the selected query timezone.
    • Clear the checkbox to ignore all results that do not state a timezone.

Option 2:

  1. Enter a From date and time.
  2. Enter a To date and time.
  3. Select a Query Timezone.
  4. Select or clear the Default to Query Timezone checkbox:
    • Select the checkbox to assume all results without a timezone are within the selected query timezone.
    • Clear the checkbox to ignore all results that do not state a timezone.

Switch to Dictionary search

Click Date Time and select Dictionary from the list.

The Date Time Search options will be replaced with Dictionary Search options.

Switch to Text search

Click Date Time and select Text from the list.

The Date Time Search options will be replaced with Keyword Search options.

Document Similarity

This search facet is used to find Documents in your Collection that are similar to a specific Document.

Task

Action

Enter a Document Id

In the Query box, enter a Document Id.

Display the Document linked to a Document Id

With a valid Document ID entered in the Query box, click Open Document .

Find Documents that are identical in content

Move the slider to 1%.

Note: This is good setting if you want to filter out Documents that have the exact same content from your Collection.

Find Documents that contain mostly identical content

Move the slider to 10%.

Note: At 10%, you will be able to identify Documents that share significant blocks of identical content to the Document you are using as reference. This is useful when for example you might be trying to find Documents that have the same email content which can indicate conversations and potential relationships between people of interest.

Find Documents that may be related by subject matter

Move the slider to 50%.

Note: Repeating the search while gradually reducing the tolerance percentage can help reveal which Documents in the search results are more closely related.

Document Id

This search facet is used to find Documents based on its Document Id.

Task

Action

Enter a Document Id

In the Query box, enter a Document Id.

Enter multiple Document Id's

In the Query box, enter the Document Id's, with each separated by a comma.

Network Node Reference

This search facet is used to find Documents based on a Network Node ID.

Task

Action

Enter a Node ID

  1. In the Network box, select a Network from the list.
  2. In the Node ID box, enter a Node ID.

Open a Network in Network view

With a Network selected in the Network box, click Open Network .

Show Node details

Click Show Node Details .

Add a new Context Query

  1. Click Add Another Context Item .
  2. In the Context box, enter a Context Query.

Note: Context is used to refine search results so that only Text References that meet a specified context criteria are returned in search results. Refer to the Context Query Language help page for more information on how Context Queries work and how to structure them.

 

fontfontfont