Behaviors (Property)

This article is about the current version of Grooper.

Note that some content may still need to be updated.

2025

2023

2021

Behaviors refer a group of functionality configured using a Content Type's Behaviors property. Behaviors enable different features for how documents of a specific Content Type are processed and define their settings. This includes how they are exported, if Label Sets are used for the Document Type and more.

About

Behaviors refer to several different features enabled and configured using one or more Content Types in a Content Model. Content Types are assigned to documents during classification, most typically a Document Type. The basic idea behind Behaviors is once you know what a document is, you can control more precisely how it should behave.

For example, a common Behavior is the Export Behavior. You probably wouldn't want invoices going to the same file system as legal contracts. The Export Behavior allows you to control where and how documents are exported based on how they are classified in Grooper.

Behaviors may be added to any Content Type, including the Content Model itself. Child Content Types (such as Document Types) will inherit the behaviors of a parent Content Type if no such Behavior is configured.

Types of Behaviors

There are six types of Behaviors that can be added to a Content Type.

Export Behavior: Controls how documents and their data are exported.
Import Behavior: Controls how data is mapped on import using CMIS Import.
Labeling Behavior: Enables Label Sets for the Content Type and its descendants.
Indexing Behavior: Enables indexing allowing documents to be searched using AI Search and the Grooper Search Page.
PDF Data Mapping: Enables advanced PDF generation options allowing Grooper to insert metadata, bookmarks, annotations and/or different kinds of widgets.
Text Rendering Behavior: Causes text documents (TXT and other formats) to be interpreted as if they were printed, paginated content.

Import Behaviors

Import Behaviors control the flow of imported files' metadata into Grooper by establishing a CMIS Import definition between a CMIS Repository object and a Grooper Content Type.

Multiple CMIS Import definitions can be added to a single Import Behavior.

Read Mappings define what metadata are read from the import source and mapped to which Data Fields in Grooper. Write Mappings define what (if any) metadata are written back to the import source after the import completes.

For more information on Import Behaviors, visit the Import Behaviors article.

Export Behaviors

Export Behaviors control the flow of documents out of Grooper by defining export connectivity to external systems such as file systems (directly through a File Export definition, or a CMIS Repository object), content management systems (via CMIS Repository objects), Database Tables, mail servers (directly through an IMAP Export definition, or a CMIS Repository object), or FTP/SFTP servers (directly through FTP/SFTP Export definitions, or a CMIS Repository object).

Export Behaviors are unique in that they can be configured on Content Types as well as the Export activity. However, this capability exists mostly to provide backwards compatibility for older versions of Grooper that did not have Behaviors (before v2021) upgrading to newer versions. It is considered best practice going forward to configure Export Behaviors using a Content Type's Behaviors settings.

For more information on Export Behaviors, visit the Export Behaviors article.

Labeling Behavior

The Labeling Behavior is a Content Type Behavior designed to collect and utilize a document's field labels in a variety of ways. This includes functionality for classification and data extraction.

The Labeling Behavior functionality allows Grooper users to quickly onboard new Document Types for structured and semi-structured forms, utilizing labels as a thumbprint for classification and data extraction purposes. Once the Labeling Behavior is enabled, labels are identified and collected using the "Labels" tab of Document Types. These "Label Sets" can then be used for the following purposes:

Document classification - Using the Labelset-Based Classification Method
Field based data extraction - Using the Labeled Value Extractor Type
Tabular data extraction - Using a Data Table object's Tabular Layout Extract Method
Sectional data extraction - Using a Data Section object's Transaction Detection Extract Method

The Labeling Behavior, Label Sets and all their uses are discussed in full in the Labeling Behavior article.

Indexing Behavior

An Indexing Behavior is required to use AI Search and the Grooper Search Page. The Search Page is a document search and retrieval interface. Before documents can be searched for, they need to be added to an index. Adding documents to an index makes searching for a single document in a repository with thousands or even millions of documents lightning quick.

The Indexing Behavior determines which Document Types are added to an index. Like all Behaviors child Content Types will inherit a parent Content Type's Indexing Behavior settings. So, configuring an Indexing Behavior' on a Content Model will any document assigned one of its Document Types to be indexed. Or, each Document Type may be added to their own unique index.

The Indexing Behavior also allows users to control what fields are added it the index, including Data Elements extracted from a Data Model.

For more information on AI Search, the Search Page and the Indexing Behavior, visit the AI Search article.

PDF Data Mapping

The PDF Generate Behavior is a Content Type Behavior designed to create an exportable PDF file with additional native PDF elements, using the classification and extraction content of a Batch Folder. This includes capabilities to export extracted data as PDF metadata, inserting bookmarks, and creating PDF annotations, such as highlighting, checkbox and signature widgets.

For more information on PDF Data Mapping, visit the PDF Data Mapping article.

Text Rendering

The Text Rendering behavior controls the pagination (or lack thereof rather) of text based documents (like a TXT file) in Grooper.

By default, imported text files are handled natively and viewed in the Document Viewer as you would the file in any other normal text document handling software, like Notepad. In order to view a text based file as a paginated document you must add a Text Rendering behavior to a Content Type and classify it appropriately.

Text Rendering Setup

In this section we well look at the steps required to establish a Text Rendering behavior.

Default Text Document View

By default, when text based documents are viewed in Grooper you will see them as if you would in any other text editing application, which can be obvious when there is no word wrapping. No steps are required to view the text based document in this way.

Non Word-Wrapped Text Document

In previous versions of Grooper native text files were rendered as paginated documents without word wrapping (the rendered document would be as wide as the longest line of text.) To mimic this style, use the following steps.

Select the Content Type to which you will be applying the Text Rendering behavior. In this case, the Content Model.
Select the Behaviors property and click the ellipsis button.

In the Behaviors - List of Behaviors collection editor click Add and select Text Rendering.

Select the newly added Text Rendering behavior and...
...set the Page Width property to be blank and click OK.

Select your Batch.
Go to the Batch Viewer tab.
Select the text based document and right-click to bring up the object command menu.
Select Assign Document Type.

Select the desired Content Type.

In the Document Viewer notice that line one is not word wrapping.
Notice here in the top right of the Document Viewer we are viewing an image that has been rendered, not the native text file.

Word-Wrapped Document

With a Text Rendering behavior you can not only view a native text document as a non-standard, paginated image, but you can force a document dimension and cause lines of text to wrap accordingly.

Select the Content Type to which you will be applying the Text Rendering behavior. In this case, the Content Model.
Select the Behaviors property and click the ellipsis button.

In the Behaviors - List of Behaviors collection editor select the Text Rendering behavior and...
...set the Page Width property back to its defaul of 8.5in.

Select your Batch.
Go to the Batch Viewer tab.
Select the text based document.
Notice in the Document Viewer line 1 is word-wrapping.
Notice at the top right of the Document Viewer we are viewing an image that has been rendered, not the native text document.