2023:Object Library (Node Type)

STUB

This article is a stub. It contains minimal information on the topic and should be expanded.

This article is about an older version of Grooper.

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

2025

2023

extension Object Library nodes are .NET libraries that contain code files for customizing the Grooper's functionality. These libraries are used for a range of customization and integration tasks, allowing users to extend Grooper's capabilities.
Examples include:
Adding custom Activities that execute within Batch Processes

Creating custom commands available during the Review activity and in the Design page.

Defining custom methods that can be called from code expressions on Data Field and Batch Process Step objects.

Creating custom Connection Types for CMIS Connections for import/export operations from/to CMS systems.

Establish custom Grooper Services that perform automated background tasks at regular intervals

Object Libraries are used to customize Grooper with scripting. They can be used to create a variety of new tools, including custom Activities, custom object commands, custom CMIS Connection types and more.

How To: Import and compile an Object Library

This tutorial is for users who are attempting to import an Object Library developed by BIS or another Grooper user into their own environment. This will explain how to upload an Object Library to a Project in your environment and compile it.

⚠	PLEASE NOTE: In version 2023, Object Libraries must be compiled in the Grooper Windows client (thick client), even if they are functional in the web client.

Import the Grooper ZIP

Copy the Grooper ZIP containing the Object Library to your Grooper server and Open Grooper Design Studio.

Right click the Project where you want to import the Object Library.
- Note: If the Grooper ZIP is itself a Project that contains the Object Library, you will need to import from the Projects folder node.
Select Share > Import ZIP Archive...

The "Import ZIP Archive" dialog will pop up.

Using the Filename property, select the Grooper ZIP you wish to import.
Press the "Execute" button when finished.

If successful you will see a dialog noting the file was imported. Press "OK" to continue.
The Object Library will be imported to the selected Project.

Compile the Object Library

In order for the Object Library to work, its code must first be compiled.

Select the Object Library you wish to compile.
Navigate to the "Scripting" tab.
Press the "Compile" button.
Wait for the script to complete compiling. You will see a message in the "Output" window noting it compiled successfully (or failed).
Close and re-open Grooper Design Studio.
- This is an important but sometimes overlooked step. You must close and re-open Grooper Design Studio in order to register the newly compiled DLLs.

⚠	If your Object Library is a custom Activity or a resource used by an Activity (such as a custom CMIS Connection type), you must also stop and start any running Activity Processing services. This will ensure the services register the newly compiled DLLs.

How To: Manually install the compile tool

In some cases the Grooper compile tool (MSBuild) does not install correctly, preventing users from compiling scripts (The "Compile" button will be greyed out). In this case, you can manually install the compile tool.

Download "MSBuild.zip" from https://grooper.bisok.com/Downloads/MSBuild/MSBuild.zip
Extract the ZIP contents.
Copy the "MSBuild" folder to the "Script Templates" folder in your Grooper install directory.
- By default this location will be C:\Program Files\BIS\Grooper\Script Templates
If Design Studio is open, close it and re-open it. You should now be able to compile scripts.

Glossary

Activity Processing: Activity Processing is the execution of a sequence of configured tasks which are performed within a settings Batch Process to transform raw data from documents into structured and actionable information. Tasks are defined by Grooper Activities, configurated to perform document classification, extraction, or data enhancement.

Activity Processing: Activity Processing is a Grooper Service that executes Activities assigned to edit_document Batch Process Steps in a settings Batch Process. This allows Grooper to automate Batch Steps that do not require a human operator.

Activity: Grooper Activities define specific document processing operations done to a inventory_2 Batch, folder Batch Folder, or contract Batch Page. In a settings Batch Process, each edit_document Batch Process Step executes a single Activity (determined by the step's "Activity" property).

Batch Process Steps are frequently referred by the name of their configured Activity followed by the word "step". For example: "Classify step".

AND: AND is a Collation Provider option for pin Data Type extractors. AND returns results only when each of its referenced or child extractors gets at least one hit, thus acting as a logical “AND” operator across multiple extractors.

Batch Process Step: edit_document Batch Process Steps are specific actions within a settings Batch Process sequence. Each Batch Process Step performs an "Activity" specific to some document processing task. These Activities will either be a "Code Activity" or "Review" activities. Code Activities are automated by Activity Processing services. Review activities are executed by human operators in the Grooper user interface.

Batch Process Steps are frequently referred to as simply "steps".
Because a single Batch Process Step executes a single Activity configuration, they are often referred to by their referenced Activity as well. For example, a "Recognize step".

Batch Process: settings Batch Process nodes are crucial components in Grooper's architecture. A Batch Process is the step-by-step processing instructions given to a inventory_2 Batch. Each step is comprised of a "Code Activity" or a Review activity. Code Activities are automated by Activity Processing services. Review activities are executed by human operators in the Grooper user interface.

Batch Processes by themselves do nothing. Instead, they execute edit_document Batch Process Steps which are added as children nodes.
A Batch Process is often referred to as simply a "process".

CMIS Connection: cloud CMIS Connections provide a standardized way of connecting to various content management systems (CMS). CMIS Connections allow Grooper to communicate with multiple external storage platforms, enabling access to documents and document metadata that reside outside of Grooper's immediate environment.

For those that support the CMIS standard, the CMIS Connection connects to the CMS using the CMIS standard.
For those that do not, the CMIS Connection normalizes connection and transfer protocol as if they were a CMIS platform.

CMIS: CMIS (Content Management Interoperability Services) is open standard allowing different content management systems to "interoperate", sharing files, folders and their metadata as well as programmatic control of the platform over the internet.

Data Field: variables Data Fields represent a single value targeted for data extraction on a document. Data Fields are created as child nodes of a data_table Data Model and/or insert_page_break Data Sections.

Data Fields are frequently referred to simply as "fields".

Execute: tv_options_edit_channels Execute is an Activity that runs one or more specified object commands. This gives access to a variety of Grooper commands in a settings Batch Process for which there is no Activity, such as the "Sort Children" command for Batch Folders or the "Expand Attachments" command for email attachments.

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.

Object Library: extension Object Library nodes are .NET libraries that contain code files for customizing the Grooper's functionality. These libraries are used for a range of customization and integration tasks, allowing users to extend Grooper's capabilities.

Examples include:

Adding custom Activities that execute within Batch Processes
Creating custom commands available during the Review activity and in the Design page.
Defining custom methods that can be called from code expressions on Data Field and Batch Process Step objects.
Creating custom Connection Types for CMIS Connections for import/export operations from/to CMS systems.
Establish custom Grooper Services that perform automated background tasks at regular intervals

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.

Review: person_search Review is an Activity that allows user attended review of Grooper's results. This allows human operators to validate processed contract Batch Page and folder Batch Folder content using specialized user interfaces called "Viewers". Different kinds of Viewers assist users in reviewing Grooper's image processing, document classification, data extraction and operating document scanners.