Project (Object)

This article is about the current version of Grooper.

Note that some content may still need to be updated.

2025

2023

2022

package_2 Project node objects 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, and more are organized and managed. It allows for the encapsulation and modularization of these resources for easier management and reusability.

You may download the ZIP below and upload it into your own Grooper environment (version 2025). This ZIP contains several Projects which we use as examples throughout this article.

File:2025 Wiki Project Projects.zip

⚠	BE AWARE: Projects did not exist before versions 2022 If you are upgrading from 2021 or older, you may need some guidance on how Projects impact your node tree's organization. Visit the Project Migration Plan article for guidance.

About

A Project is a container for Grooper nodes in the node tree. It allows users to organize Grooper resources (such as Batch Processes, Content Models and other Grooper objects) in some logical manner. Access to nodes inside a Project can be shared with other Projects (discussed later) or can be restricted, only allowing nodes within the Project to reference (or use) them.

You can use Projects to organize nodes:

By use case - Use Projects to distinguish between different "kinds of work". Projects help keep processing assets organized and separate from each other. For example, the Content Model, Batch Process, OCR Profile and all other Grooper objects used to implement and invoice document processing solution could be placed in a single Project called "Invoice Processing".
By resource type - Use Projects to hold commonly used resources. Commonly, CMIS Connections and Data Connections are used by multiple Grooper resources. A Project holding these kids of "connection resources" makes them easier to find.
For modular use - Use Projects to hold a set of resources useful for one logical end. You may develop a series of resources that are useful in your industry (but not a specific use case). These resources can be shared across multiple Projects without needing to duplicate them by putting them in a Project.

You can also use Projects to facilitate a change management system in Grooper.

Say you want to archive your Grooper solution so that you can revert to a saved point at a later date if necessary.
- You can do this by downloading Grooper ZIP archives for the Project or Project involved.
- We recommend putting a date in the ZIP's title to keep track of the Project's state at a point in time.
Then, say you want to revert back to that Project you've previously downloaded.
- Grooper facilitates this by how its upload logic works.
- If you upload the ZIP to the Project's parent folder, it will overwrite the Project with the version in the ZIP.
- As long as GUIDs match Grooper will overwrite the child Project with that Project in the ZIP.

FYI

There are very few things that aren't stored in Projects.

Batches are stored in the "Batches" folder branch.
- Production Batches are stored in the "Production" folder branch.
- Test Batches are stored in the "Test" folder branch.
Batch Processes are stored in two different locations depending on if they are "working" or published"
- Working Batch Processes are stored in Projects.
- Published Batch Processes are stored in the "Processes" folder node.
Processing Queues and Review Queues are stored in the "Queues" folder node.
File Store nodes are stored in the "File Stores" folder node.
Machine nodes are stored in the "Machines" folder node.

Adding a New Project

Projects are added to the "Projects" folder node in the node tree.

Click here for an interactive walkthrough

To add a new Project first right-click the "Projects" folder (or one of its subfolders).
Select "Add", then "Project..."
This will bring up a window to name your new Project.
After giving it a name, press the "Execute" button to create the Project.
This will add the Project to the folder you selected.
Once the Project has been added you can add processing resources to it. Simply right click the Project, select add, then the node type you want to add.

Copying vs references resources in other Projects

One benefit to Projects is they isolate references. Without explicitly allowing it, Projects cannot reference nodes in other Projects. This maintains "reference integrity". It makes it harder to create references to Grooper nodes you did not intend on making.

That said, what if you need to use a resource in another Project? You have two options:

Copy that node (and any nodes it references) from one Project to another.
Explicitly allow one Project to use another Project's resources by referencing it.
- This is ideal when referencing resources shared across multiple Projects.
- For example, users may find multiple Projects make use of the same CMIS Connections to external CMS systems or Data Connections to external databases.

How to reference other Projects

Projects can make reference to other Projects to use their resources, like extractors, profiles, connection objects and more. To refence a Project...

Click here for an interactive walkthrough.

Select a Project in the node tree.
Select the "Referenced Projects" property and press the ellipsis (...) button.
This brings up the "Referenced Projects" editor. Select the Project you want to reference by checking the box next to its name.
Press the "OK" button when finished.
Finally, press the "Save" button.
This will make all resources in the refenced Project usable in the Project you just edited.

The Usage Tab

A Project's "Usage" tab details node references made between referenced Projects. It is a great tool to help users track what nodes are being referenced in another Project.

Usage tab provide two key benefits:

It provides a great way to inspect nodes being referenced and making references.
It provides a quick way to navigate to those nodes.

To access the "Usage" tab:

Click here for an interactive walkthrough

Select a Project in the node tree.
Select the "Usage" tab.
The "Outbound" and "Inbound References" detail how nodes in the Project are making references and being referenced. These links can be clicked to navigate to the listed nodes.
- "Outbound References" detail any nodes inside the Project referencing nodes outside the Project.
- "Inbound References" detail any nodes outside the Project referencing nodes inside the Project.

⚠

BE AWARE: Check the Usage tab before removing a Project reference.

Grooper will allow you to remove a Project reference even if outbound references are actively being made. You should never remove a reference to a Project with currently active outbound references. Always check the Usage tab to ensure to outbound references are being made before removing the Project reference.

Upgrade guidance for Grooper installs without Projects

If you are upgrading from a version before Grooper had Projects (2021 and older), you should check out our Project Migration Plan article.