Overview

The Doc. Viewer widget has two components:

• A viewer for documents loaded from the current query
• A workspace for saving curated documents by hand or from an automated query

Using the Viewer

Overview

You can use the Document Viewer widget to view individual documents and their metadata, ranked by score or date, together with their entities, geotags, and associations.  This is useful for analyzing specific documents once filtering or querying has reduced the dataset to a manageable size.

Using this widget has several key benefits:

• Provides an “initial read” of document

• Entity breakdowns w/ relevance/significance score

Dragging and Dropping

The  icon can be used to drag documents, entities and associations to the Case Visualizer.

The following entities will be linked:

• Checked associations in the entity table
• Entities from checked associations in the association table
• Target entities, or entities already present in the case visualizer

If multiple entities are dragged and dropped together, all entities will be linked by coreference. 

Dragging and Dropping Documents

An entire document (all corresponding entities, geotags, associations) can be dragged into the Case Visualizer.

To drag and drop the document

1. Selecting the document
2.  Drag the icon from the widget toolbar and drop it onto the Case Visualizer (Enterprise).
   
   

Dragging and Dropping Entities and Associations

The entity table or association tables can also be dragged into the Case Visualizer. This will create nodes and edges for all checked entities and associations.

Entities dragged from a document will contain a link to that document in the node properties

To drag and drop the entity or association

TODO procedure

Selecting Entities Across Multiple Documents:

The "Apply Text Filter To All Selected Docs" can be used to select entities across many documents (eg all "Person" entity types) before dragging multiple documents across.

Filtering the Workspace

To filter the workspace

1. Select an entity from one of the document data tables, 
2. Mouse over the  icon at the top left of the section header 
3. Select the appropriate filtering setting from the dropdown.  For more information, see section Document Viewer Interface.

Removing a Filter

To remove a filter, click the  button located just below the query bar.  This will revert the workspace back to the original query results.

Using the Workspace

You can use the workspace to save documents into buckets.  You can also setup queues.

About Buckets and Queues

You can use buckets and queues to help group and manage your documents.  Buckets can be used to group selected documents together, like a folder system.  A queue is away of segmenting documents by query term in an automated fashion.  When creating a queue, the system takes the given query term as the basis of a periodic job that will run and group documents resulting from that query.  New documents can optionally generate alerts.

Creating a Bucket

You can create a bucket to manage your documents

To create a bucket

1. From the Doc. Viewer widget, click on Workspace.
2. Click on Buckets.
3. Provide a name for the bucket.
4. Click on New.

A new bucket is created.

Adding Documents to a Bucket

After a bucket is created you can add documents to it.

To add a document to a bucket

1. From the Doc. Viewer, select a document.
2. From the rightmost panel, click the button Add to bucket.
3. Select the appropriate bucket from the dropdown.

The document is added to the bucket.

Removing a Document from a Bucket

TODO

Creating a Queue

To create a Queue

1. Firstly query the Community Edition system so that the appropriate results (documents) are returned.
2. From the Doc. Viewer widget, click on Workspace.
3. Click on Queues.
4. Provide a name for the queue.
5. Click on New.
6. From the dropdown select "Unshared (update to current)".
7. Click on Save.

Scheduling

The schedule will determine how often the query is run.

To set a schedule

1. Set frequency and time using the drop down menus.
2. Click on Save.

Alerting

Alerting will determine the email addresses to notify when a query is updated with new documents.

To set the alerting

1. Click on the "@" sign.
2. Specify the email address.
3. Click on Add Me.
4. Click on Save.