Project

A Project is a top-level container for configuration resources, models, and logic used to design, organize, and execute document processing in Grooper.

Remarks

A Project serves as the primary organizational unit in Grooper, grouping together all resources, settings, and logic required for a solution.

Overview

• Projects contain configuration objects created by designers, such as Content Models, Data Models, Extractor Nodes, OCR Profiles, Object Libraries, and more.
• The main purpose of a Project is to expose one or more Batch Processes that perform document processing, extraction, and automation.
• Projects are stored in the 'Projects' folder at the root of the Grooper repository.

Resource Management

• Projects manage a wide variety of resources:
  • Content Models: Define document types and their structure.
  • Data Models: Specify the data elements to be extracted.
  • Extractor Nodes: Implement extraction logic for fields and tables.
  • OCR Profiles: Configure optical character recognition settings.
  • Object Libraries: Provide custom code, commands, and integrations.
  • Connections: Store connection settings for external systems (e.g., CMIS, databases).

Project References and Reuse

• Projects can reference other Projects, enabling resource sharing and modularity.
• Referenced Projects act as libraries, allowing commonly-used extractors, lexicons, and other resources to be reused across multiple solutions.
• The ReferencedProjects property lists all Projects referenced by this Project.
• Circular references are detected and prevented.

Environment Segregation and Connection Management

• Projects can be used to separate environment-specific resources (such as connection configurations) from solution logic.
• For example, maintain one Project for connection objects and another for the main solution, simplifying deployment between DEV, TEST, and PROD environments.

Copy and Move Validation

• When copying or moving nodes between Projects, validation ensures all required references are present and no reference violations occur.
• The user will receive detailed error messages if reference requirements are not met.

Best Practices

• Organize resources into logical Projects to promote maintainability and reuse.
• Use Project references to share common logic and extractors across solutions.
• Segregate environment-specific settings to simplify deployment and reduce errors.
• Regularly review Project references to avoid circular dependencies and unused references.

Example Workflow

1. Create a Project for your solution in the Grooper repository.
2. Add resources such as Content Models, Data Models, and Object Libraries as children of the Project.
3. Reference other Projects to reuse shared extractors or connection settings.
4. Design Batch Processes within the Project to automate document processing.
5. Validate references before copying or moving resources between Projects.
6. Deploy by publishing or exporting the Project to other environments as needed.

Properties

Name	Type		Description
Referenced Projects	Project[]	►	The list of Projects whose resources are available for use in this Project. EditorProjects Editor ConverterProjects Converter The Referenced Projects property defines which other Projects are referenced by this Project, enabling resource sharing and modularity across solutions. Purpose Allows this Project to use configuration objects (such as extractors, lexicons, profiles, Object Libraries, etc.) defined in other Projects. Supports the creation of shared library Projects that can be referenced by multiple solution Projects. How It Works Any resource in a referenced Project becomes available for use in the referencing Project, as if it were defined locally. Adding a reference grants access to all resources in the referenced Project. Removing a reference will break access to those resources and may cause validation errors if they are still in use. Best Practices Use Project references to promote reuse of common extractors, lexicons, and connection settings. Avoid circular references between Projects; Grooper will detect and prevent these. Regularly review and remove unused references to keep your solution clean and maintainable. Example Suppose you have a Project called "Common Extractors" containing shared extraction logic. You can add "Common Extractors" to the ReferencedProjects list of multiple solution Projects, allowing them all to use the same extractors without duplication. Validation and Error Handling If a required reference is missing, Grooper will display a detailed error message when copying or moving nodes between Projects. Circular references are automatically detected and reported as validation errors.
Description	String	►	Specifies a description for the item. EditorNode Description Editor

Design Tabs

General	View or edit properties of a node.
Reports	View reports for a node.
Usage	Examine references to and from resources in this project.
Advanced	View or edit advanced details about a node.

Context Menu Commands

Command	Shortcut	Description
account_tree Remove Empty Subfolders		Deletes all empty subfolders within the Project.

Child Types

Resource FileFolderObject LibraryIP ProfileOCR ProfileBatch ProcessContent ModelData ConnectionLexiconData TypeField ClassValue ReaderCMIS ConnectionControl SheetScanner ProfileSeparation ProfileAI Assistant

See Also

Project