Object Nomenclature (Concept)

From Grooper Wiki
Revision as of 12:16, 13 March 2024 by Randallkinard (talk | contribs) (made changes to overall structure // via Wikitext Extension for VSCode)
A Grooper environment consists of many interrelated objects.

Mastery of a Grooper environment is greately enhanced by understanding the myriad of objects that can exist and how they are related.

About

In Grooper, understanding the objects within the platform involves recognizing how various elements can serve similar functions and therefore be grouped together based on their shared functionalities. This concept stems from the recognition that disparate objects often perform analogous tasks, albeit with differing characteristics or representations.

By discerning commonalities in functionality across diverse objects, users can streamline their approach to data processing and analysis within Grooper. Rather than treating each object in isolation, users can categorize them based on their functional similarities, thus simplifying management and enhancing efficiency.

This approach fosters a more holistic understanding of the data ecosystem within Grooper, empowering users to devise more effective strategies for data extraction, classification, and interpretation. By recognizing the underlying functional relationships between objects, users can optimize workflows, improve accuracy, and derive deeper insights from their data.

Batch Objects

In Grooper, "Batch Objects" represent the hierarchical structure of documents being processed and consist of:

  • Batch ...
  • Batch Folder and ...
  • Batch Page objects ...

... each serving a distinct function within this hierarchy but also being fundamentally related.

The relationship between these objects is hierarchical in nature. The Batch object is the top level. It contains:

  • Batch Folders and ...
  • Batch Pages

Batch Folders may contain either further Batch Folders (to represent subfolders or grouped documents) or Batch Pages (to represent individual pages of documents). This structured approach allows Grooper to efficiently manage and process documents at various levels of granularity — from a full batch down to individual pages.

Related Objects

Batch

The Batch object is a fundamental construct in Grooper's architecture as it encompasses the documents that are grouped together to be processed through Grooper's workflow mechanisms, following the steps dictated by the related Batch Process.

Batch Folder

A Batch Folder in Grooper is defined as a container object within a Batch that is used to represent and organize both folders and documents. It can hold other Batch Folders or Batch Page objects as children. The Batch Folder acts as an organizational unit within a Batch, allowing for a structured approach to managing and processing a collection of documents.

Batch Page

A Batch Page object in Grooper represents an individual page within a Batch. The Batch Page object is the most granular unit in the hierarchy of "Batch Objects" in Grooper. It is created in one of two ways.

    • Physical pages can be acquired in Grooper by scanning them via the Grooper Desktop application.
    • Digital documents are acquired in Grooper as whole objects and represented as Batch Folders. Applying the Split Pages activity on a Batch Folder that represents a digital document will expose Batch Page objects as direct children.

Batch Pages allow Grooper to process and store information at the page level, which is essential for operations that include Image Processing and recognition of text (see Recognize). They enable the system to manage and process each page independently. This is critical for workflows that require detailed page-specific actions or for Batches composed of documents with different processing requirements per page.

Content Type Objects

In Grooper, the "Content Type Objects" consist of:

  • Content Model ...
  • Content Category and ...
  • Document Type objects.

Each of these objects serves a distinct function within Grooper's content classification and are related to each other through hierarchical relationships.

The relationship between these objects is established through a heirarchical inheritance system. Content Categories and Document Types are building blocks within a Content Model seen as the "tree". Content Categories act as the "branches". Document Types are the "leaves" of the hierarchy.

Data Elements can be defined on each Content Type object and are inherited down the "tree" of heirachy.

  • Data Elements defined at the Content Model level are applied to all Content Types within the Content Model.
  • Data Elements defined at the Content Category level are applied to all Content Types that exist within that specific "branch".
  • Data Elements defined on a Document Type will apply to that specific "leaf".

These "Content Type Objects" work together in Grooper to enable sophisticated document processing workflows. With different types of documents properly classified, they can have their data extracted and be handled according to the rules and behaviors defined by their respective Document Types within a Content Model hierarchy.

Related Objects

Content Model

A Content Model defines the taxonomy of document sets in terms of the Document Types it contains. It also defines the Data Elements that appear on each Content Category and Document Type. Content Models serve as the root of a Content Type hierarchy and are crucial for organizing the different types of documents that Grooper can recognize and process.

Content Category

A Content Category is a container within a Content Model that holds other Content Categories and Document Type objects. It allows for further classification and grouping of Document Types within a taxonomy, aiding in the logical structuring of complex document sets. Besides grouping Document Types together, Content Categories also serve to create new branches in a Data Element hierarchy.

Document Type

A Document Type represents a distinct type of document, like an invoice or contract. Document Types are created as children of a Content Model or a Content Category and are used to classify individual documents. Each Document Type in the hierarchy defines the Data Elements and Behaviors that apply to documents of that specific classification.

Data Element Objects

Related Objects

Data Field

Data Section

Data Table

Data Column

Extractor Objects

Related Objects

Value Reader

Data Type

Field Class

Connection Objects

Related Objects

CMIS Connection

CMIS Repository

Data Connection

Profile Objects

Related Objects

IP Profile

IP Group

IP Step

OCR Profile

Scanner Profile

Separation Profile

Queue Objects

Related Objects

Procssing Queue

Review Queue

Process Objects

In Grooper Batch Process and Batch Process Step objects are closely related in managing and executing a sequence of steps designed to process a collection of documents known as a Batch.

A Batch Process consists of a series of Batch Process Steps meant to be executed in a particular sequence for a batch of documents. Before a Batch Process can be used in production, it must be "published", which creates a read-only copy in the "Processes" folder of the node tree, making it accessible for production purposes.

In essence, a Batch Process defines the overall workflow for processing documents, but it relies on Batch Process Steps to perform each action required during the process. Each Batch Process Step represents a discrete operation, or "activity", within the broader scope of the Batch Process. Batches Processes and Batch Process Steps work together to ensure that documents are handled in a consistent and controlled manner.

Related Objects

Batch Process

A Batch Process is a crucial component in Grooper's architecture. A Batch Process orchestrates the document processing strategy and ensures each batch of documents is managed systematically and efficiently.

Batch Process Step

A Batch Process Step is a specific action within the sequence defined by a Batch Process. A Batch Procses Step plays a critical role in automating and managing the flow of documents through the various stages of processing within Grooper.

Architecture Objects

Related Objects

Root

Project

Filestore

Machine

Miscellaneous Objects

Related Objects

Lexicon

Data Rule

AI Analyst

Resource File

Object Library

Control Sheet