2023:Document Viewer (UI Element)

From Grooper Wiki

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

20252023.120232.90
Graphic depicting the Grooper Document Viewer.

The Grooper Document Viewer is the portal to your documents. It is the UI that allows you to see a folder Batch Folder's (or a contract Batch Page's) image, text content, and more.

You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023). The first contains one or more Batches of sample documents. The second contains one or more Projects with resources used in examples throughout this article.

Glossary

Batch Folder: The folder Batch Folder is an organizational unit within a inventory_2 Batch, allowing for a structured approach to managing and processing a collection of documents. Batch Folder nodes serve two purposes in a Batch. (1) Primarily, they represent "documents" in Grooper. (2) They can also serve more generally as folders, holding other Batch Folders and/or contract Batch Page nodes as children.

  • Batch Folders are frequently referred to simply as "documents" or "folders" depending on how they are used in the Batch.

Batch Page: contract Batch Page nodes represent individual pages within a inventory_2 Batch. Batch Pages are created in one of two ways: (1) When images are scanned into a Batch using the Scan Viewer. (2) Or, when split from a PDF or TIFF file using the Split Pages activity.

  • Batch Pages are frequently referred to simply as "pages".

Batch: inventory_2 Batch nodes are fundamental in Grooper's architecture. They are containers of documents that are moved through workflow mechanisms called settings Batch Processes. Documents and their pages are represented in Batches by a hierarchy of folder Batch Folders and contract Batch Pages.

Classification: Classification is the process of identifying and organizing documents into categorical types based on their content or layout. Classification is key for efficient document management and data extraction workflows. Grooper has different methods for classifying documents. These include methods that use machine learning and text pattern recognition. In a Grooper Batch Process, the Classify Activity will assign a Content Type to a folder Batch Folder.

Data Model: data_table Data Models are leveraged during the Extract activity to collect data from documents (folder Batch Folders). Data Models are the root of a Data Element hierarchy. The Data Model and its child Data Elements define a schema for data present on a document. The Data Model's configuration (and its child Data Elements' configuration) define data extraction logic and settings for how data is reviewed in a Data Viewer.

Document Viewer: The Grooper Document Viewer is the portal to your documents. It is the UI that allows you to see a folder Batch Folder's (or a contract Batch Page's) image, text content, and more.

Extract: export_notes Extract is an Activity that retrieves information from folder Batch Folder documents, as defined by Data Elements in a data_table Data Model. This is how Grooper locates unstructured data on your documents and collects it in a structured, usable format.

Project: package_2 Projects are the primary containers for configuration nodes within Grooper. The Project is where various processing objects such as stacks Content Models, settings Batch Processes, profile objects are stored. This makes resources easier to manage, easier to save, and simplifies how node references are made in a Grooper Repository.

UI Element: A UI Element is a portion of the Grooper interface that allows users to interact with or otherwise receive information about the application.

About

The Document Viewer allows users to view documents! It comes equipped with several different tools and settings that let you see what you need to see the way you need to see it.

Like the Batch Viewer, there is no one place the Document Viewer exists. As you navigate through Grooper anytime there is some kind of interface that needs you to view a document, or page, it will be present somewhere within the UI. These include, but are not limited to:

  • general viewing of batch contents when using a Batch Viewer anywhere
  • seeing the effects of an Image Processing Profile and using that visual feedback to make adjustments to said profile
  • when writing regular expression patterns and viewing the highlighted results
  • when testing extraction on any extractor, or even a full Data Model
  • when reviewing information like Classification, or Extraction
This is an example image of the Document Viewer in Grooper.

How To

Understanding the Document Viewer means knowing the functionality of its main toolset.

Interface Tools

Document Viewer Toolbar

The Document Viewer Toolbar runs along the top of the pane on the right of the screen, just above the document you are viewing. (Some buttons do not apply to certain file types and will be hidden in those contexts.)

Select Region Tool

Copy Tool

Zoom Tools

Magnify Tool

This lets users click & drag to see a magnified overlay window, great for viewing character or image quality details close-up.



Transform and File System Tools

Print and Save Page Tools

Detail Viewer



Document Navigation and Rendition

Navigation Buttons

Rendition Selector