2021:Behaviors (Property)

2021	This article is in development for the upcoming version of Grooper, Grooper 2021. Behaviors are a new set of data control functionalities in 2021. This information is incomplete and/or may change by the time of release.

Behaviors are like telling the mind what to let in and out.

Behaviors are properties set on Content Types and Export activities that control the flow of documents into and out of Grooper .

About

Behaviors are new to Grooper 2021 and are born of the idea that consolidating the control of the flow of data to the objects most relevant to its collection and delivery (Content Types{Content Model, Content Category, Document Type} and the Export activity) creates a more streamlined and effective Grooper experience. If the Content Type controls all the relevant information about how documents are organized and what is to be collected from them, it is logical that controlling how those documents come into Grooper, and how they get out, should also be defined by the same object. It is also a much cleaner experience to no longer have multiple steps in a Batch Process to cover the types of Export activities (Legacy Export, Mapped Export, Database Export), but instead a single Export activity that leverages the Behaviors of the Content Type, Behaviors defined on the Export activity, or both.

If you take CMIS Connections, for example, Grooper previously created an unnecessary amount of objects to get to the CMIS Content Type. The mappings for importing and exporting were also set here, which made for more places which a person need to go to configure the flow of data into and out of Grooper. It also created a bottle neck of control because if you wanted to have disparate Content Types use a similar CMIS connection, but the import/export mappings inherently needed to be different, you would have had to create a separate CMIS Content Type. Now, one CMIS Repository object can exist, and the import/export mechanisms are controlled via Behaviors (again, defined on Content Types or Export activities.)

Types of Behaviors

There are four types of Behaviors that can be added to a Content Type or Export activity.

Import

Import Behaviors control the flow of documents into Grooper by establishing communication, an Import Definition (of which multiple can exist), between a CMIS Repository object and a Grooper Content Type. CMIS Content Type objects no longer exist in Grooper 2021, therefore Import mappings are no longer set there. They are instead set on an Import Behavior of a Content Type. This elminates the need for multiple CMIS Conent Type objects to exist for the individual needs of discrete Content Types, and instead consolidates the control to the object most pertinent to the import functionality.

Export

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). CMIS Content Type objects no longer exist in Grooper 2021, therefore Export mappings are no longer set there. They are instead set on the Export Behavior of a Content Type , or a Batch Process Step set to Export on its Activity Type property. This elminates the need for multiple CMIS Conent Type objects to exist for the individual needs of discrete Content Types, and instead consolidates the control to the object most pertinent to the export functionality.

Labeling

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 Understanding the full functionality of the Labeling Behavior is worthy of it’s own article, which can be found here.

PDF Generate

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. Understanding the full functionality of the PDF Generate Behavior is worthy of it’s own article, which can be found here.

How To

Following is a walkthrough demonstrating the setup of Behaviors using a simplified use-case utilizing SharePoint and a database table. It is important to understand that due to the self-contained nature of the aforementioned utilities that this walkthrough will require some translation on the reader's part.

Foundations

Understanding the infrastructure of what's being used for the following walkthrough will help the example make sense.

SharePoint

This test Sharepoint enviornment has three documents it in. The First Name and Last Name fields are left intentionally blank. The Employee ID fields are filled with the intention of reading those values into Grooper upon import. Two of the documents have the DocType fields filled, while the third does not. This will be used to demonstrate how documents can be classified with results from the CMIS repository, while also showing the default behavior otherwise. The Imported fields are set to No. The query used to import the documents will look for the No result to know what to import. Upon importing into Grooper this value will be read and simultaneously changed to InProcess to prevent further pickup. Finally, on export the fields will be written to with Yes to signify they’ve been processed.

Document Understanding

The documents are populated with the first and last names of the employee, which will be extracted and later exported back to the SharePoint to populate the First Name and Last Name columns. The Earnings table will be extracted by Grooper and sent to a database table. The information will be flattened out with the Employee ID read from the SharePoint and sent with the table information so that the SharePoint and database information can be related.

CMIS Repository

Here the imported CMIS Repository is selected in Grooper Design Studio. On the Type Definitions tab... ...you can see that because this particular subsite of the SharePoint environment is referenced by a Behavior that the icon has a green dot and... ...with it selected you can see the stucture of the SharePoint subsite like the column names and their properties.

Database

An imported database table is selected here in Grooper Design Studio. You can view the structure of the table and see that it includes what we saw from the Earnings table from the document, along with the Employee ID to marry rows from this table back to the SharePoint. In the Data Preview below, you’ll notice there is no data yet.

Data Model & Extraction

Here is the sample Data Model selected with three Data Fields and the accompanying Data Table. It is configured properly as you can see the successfully extracted information displayed in the Data Model Test Results area. You can also see the document structure of the extracted information displayed in the Document Viewer.

Batch Process

The Batch Process highlighted is a very simple model for this example setup. The main thing about this setup is to demonstrate the Export Activity. We&rsqo;ll cover the particulars later, but the idea here is to show that Behaviors can be setup on both a Content Type, as well as a Batch Process Step configured as an Export activity, and share the results.

Import Behavior Setup

In this section we will cover how to configure an Import Behavior with both read and write properties.

Behaviors

Here we have selected a Content Type, specifically the Content Model. Select the Behaviors property and click the ellipsis button. This will bring up the Behaviors - List of Behaviors menu from which you can click the Add dropdown and select Import Behavior.

File:Behaviours 010.png

Import Definitions

Select the Import Definitions property and click the ellipsis button. This will bring up the Import Definitions - List of Import Defintion menu from which you can click the Add dropdown and select CMIS Import Definition.

File:Behaviours 011.png

With the CMIS Import Definition added you can select the CMIS Repository property and choose an imported CMIS Repository object.

File:Behaviours 011a.png

After selecting a CMIS Repository you can select the CMIS Content Type property and choose, in this case of SharePoint, a subsite document library.

File:Behaviours 012.png