Node

Represents an object in the Grooper repository tree, serving as the base class for all nodes such as folders, projects, documents, and configuration items.

Remarks

Overview

A Node is the foundational building block of the Grooper repository. All objects that appear in the main tree structure—such as Folders, Projects, Batches, Batch Folders, Batch Pages, and configuration resources—inherit from Node.

Nodes are organized hierarchically, forming a tree structure rooted at the Root node. Each node can have properties, child nodes, and references to other nodes, enabling complex configurations and relationships.

Key Features

• Hierarchy and Organization:
  Nodes are arranged in a parent-child hierarchy, allowing for flexible organization of repository content.
• Property Management:
  Each node exposes user-configurable properties, which can be edited via the UI or API. Properties are serialized and stored in the repository database.
• File Storage:
  Some node types can store files in the File Store, supporting content such as images, documents, and resources.
• Reference Tracking:
  Nodes can reference other nodes, with built-in mechanisms to prevent deletion of referenced items and to manage circular references.
• Extensibility:
  Custom node types can be created by inheriting from Node, enabling the addition of new behaviors, properties, and commands.

Usage Scenarios

• Organizing batches, projects, and configuration resources in a structured, navigable tree.
• Defining custom objects and logic by extending Node for specialized solutions.
• Managing relationships and dependencies between configuration items using references.
• Storing and retrieving files associated with nodes, such as templates, scripts, or sample data.

Best Practices

• Use descriptive names for nodes to clarify their purpose and contents.
• Leverage the reference tracking system to maintain repository integrity and prevent accidental deletion of in-use resources.
• When creating custom node types, override properties and methods as needed to implement specialized behaviors.
• Regularly review the node hierarchy and references to ensure a maintainable and efficient repository structure.

Properties

Name	Type		Description
Description	String	►	Specifies a description for the item. EditorNode Description Editor

Context Menu Commands

Command	Shortcut	Description
add_circle Add	Ctrl+Shift+Ins	Adds a new child Node of a specified type to the selected parent Node.
shopping_basket Add Multiple Items		Adds multiple child items of a specified type to the selected Node.
account_tree Clear Children		Removes all child nodes from the selected Node, deleting their contents from the repository.
copy_all Clone	Ctrl+Shift+D	Creates a copy of the selected Node and inserts it as a sibling.
delete Delete	Del	Deletes the selected Node or nodes from the repository.
move_down Move Down	Ctrl+Down	Moves the selected Node or nodes down one position within their parent container.
move_up Move Up	Ctrl+Up	Moves the selected Node or nodes up one position within their parent container.
database Publish To Repository		Publishes a configuration object to one or more Grooper repositories.
drive_file_rename_outline Rename	F2	Renames the selected Node to a new unique name.

Derived Types

There are 45 implementations of Node.

AI Assistant	Defines the capabilities and behavior of an AI chatbot designed for retrieval-augmented generation (RAG) in Grooper.
Batch Processing
Batch	Represents a hierarchy of folders and pages, serving as the root container for content and processing within a Grooper batch workflow.
Batch Folder	A Batch Folder is a hierarchical container within a Batch, representing both folders and documents in Grooper's batch processing system.
Batch Page	A Batch Page represents an individual page within a Batch, serving as the core unit of content for document processing in Grooper.
Batch Process	Defines a configurable workflow for processing batches of documents in Grooper.
Batch Process Step	Represents a single step (activity) in a Batch Process workflow.
Batches Folder	Represents a container for organizing Batches within the Grooper repository tree.
Control Sheet	Represents a special page used to control and automate aspects of the document scanning process.
Connectivity
CMIS Connection	Defines a connection to an external content storage platform using the CMIS standard.
CMIS Repository	Represents a logical container for documents on an external storage platform, when using a CMIS Connection.
Data Connection	Defines a connection to a database.
Content Types
Content Category	A Content Category is a container for organizing Document Types and other Content Categories within a Content Model.
Content Model	Defines the taxonomy, classification, and data extraction structure for a set of documents.
Document Type	Represents a distinct type of document within a Content Model, such as an invoice, contract, or letter.
Form Type	Represents a trained variation or version of a Document Type, used for classification and extraction in Grooper.
Page Type	Represents a logical page within a Form Type, used for page-level classification in Grooper.
Training Page	Represents an individual page used to train a Page Type, storing features and data from a training sample.
Data Extraction
Data Column	Represents a column in a DataTable, defining how tabular data is extracted, validated, and displayed for each row in a document.
Data Field	Represents a single extracted or user-entered value within a document's data model.
Data Model	Defines the root container for a document's extracted data, organizing fields, sections, and tables for data extraction, validation, and presentation.
Data Rule	Defines a data manipulation rule which applies to a Data Model, Data Section, or a Data Table.
Data Section	Defines a hierarchical container for related data elements within a document, enabling logical grouping, extraction, and validation of complex data structures.
Data Table	Represents a configurable, extractable table structure for capturing and validating tabular data from documents.
Data Type	Recognizes and extracts complex data values or structures from document text using one or more extractors and configurable collation logic.
Field Class	A trainable binary classifier for locating specific information on a document using contextual features.
Value Reader	Defines a primitive data extraction operation.
Infrastructure
File Store	Represents a storage location for file content associated with Nodes in a Grooper repository.
Machine	Represents a server that has previously connected to the repository.
Machines	Contains all Machine objects and provides a UI for collectively managing servers and Service Instance nodes.
Processing Queue	Defines a queue for machine-performed tasks.
Review Queue	Defines a queue for human-performed tasks.
Miscellaneous
Folder	Represents a container object for organizing and storing other nodes within the Grooper repository hierarchy.
Local Resources Folder	Stores local resources associated with a Content Type.
Project	A Project is a top-level container for configuration resources, models, and logic used to design, organize, and execute document processing in Grooper.
Projects Folder	Represents the root folder for storing all Project objects in the Grooper repository.
Resource File	Represents a file resource stored within a Project in the Grooper repository, such as a text file, XML schema, or other supporting file.
Root	The root node and central configuration point for a Grooper repository.
Resources
IP Group	Serves as a container for organizing and controlling groups of IP Steps and nested IP Groups within an IP Profile.
IP Profile	Serves as the root container for defining and executing a sequence or hierarchy of image processing operations in Grooper.
IP Step	Represents an individual image processing operation within an IP Profile, specifying an IP Command to execute and options for controlling behavior.
Lexicon	Represents a dictionary that stores a list of keys or key-value pairs for use in extraction, validation, and normalization throughout Grooper.
Object Library	A script project which compiles a .NET assembly containing custom objects, activities, commands, and other integrations for Grooper.
OCR Profile	Defines a configurable profile for performing optical character recognition (OCR) on images in Grooper.
Scanner Profile	Defines a connection to a capture device and the settings that control how the device operates during scanning.
Separation Profile	Defines how pages are separated into documents and folders within a batch.

Used By

File Store - Move Objects Here