2023:Summary Tabs (UI Element): Difference between revisions

From Grooper Wiki
No edit summary
No edit summary
Line 8: Line 8:
|
|
You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023).  The first contains a '''Project''' with resources used in examples throughout this article.  The second contains one or more '''Batches''' of sample documents.
You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023).  The first contains a '''Project''' with resources used in examples throughout this article.  The second contains one or more '''Batches''' of sample documents.
* [[File:2023 Wiki Summary-Tabs Project.zip]
* [[File:2023 Wiki Summary-Tabs Project.zip]]
|}
|}



Revision as of 11:56, 28 August 2024

This article is about an older version of Grooper.

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

20252023

stacks Content Models and collections_bookmark Content Categories have a Summary tab where you can view "Descendant Node Types", description Document Types, and Expressions.

You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023). The first contains a Project with resources used in examples throughout this article. The second contains one or more Batches of sample documents.

About

The Summary Tab is a new feature in Grooper 2023. It displays "at-a-glance" information about the selected node and its children.

Currently, the following object types have Summary Tabs.

  • Content Models
  • Content Categories

FYI

Prior to version 2023, some of this information was viewed by using the "Compile Stats" command. "Summary" tabs replace and expand on this functionality.

Content Model Summary

The Content Model Summary Tab displays the following information:

  • "Descendant Node Types" - The counts of different child object types.
  • "Document Types" - A linkable list of all Document Types and some basic information about them such as how many Data Elements have overrides.
  • "Expressions" - A list of Data Elements that have code expressions and the expressions' full text.

Descendant Node Types



Document Types









Expressions

Content Category Summary

The Content Category Summary Tab displaces the same information as the Content Model but only for its child Document Types.

Glossary

Batch: inventory_2 Batch nodes are fundamental in Grooper's architecture. They are containers of documents that are moved through workflow mechanisms called settings Batch Processes. Documents and their pages are represented in Batches by a hierarchy of folder Batch Folders and contract Batch Pages.

Content Category: collections_bookmark A Content Category is a container for other Content Category or description Document Type nodes in a stacks Content Model. Content Categories are often used simply as organizational buckets for Content Models with large numbers of Document Types. However, Content Categories are also necessary to create branches in a Content Model's classification taxonomy, allowing for more complex Data Element inheritance and Behavior inheritance.

Content Model: stacks Content Model nodes define a classification taxonomy for document sets in Grooper. This taxonomy is defined by the collections_bookmark Content Categories and description Document Types they contain. Content Models serve as the root of a Content Type hierarchy, which defines Data Element inheritance and Behavior inheritance. Content Models are crucial for organizing documents for data extraction and more.

Data Element: Data Elements are a class of node types used to collect data from a document. These include: data_table Data Models, insert_page_break Data Sections, variables Data Fields, table Data Tables, and view_column Data Columns.

Document Type: description Document Type nodes represent a distinct type of document, such as an invoice or a contract. Document Types are created as child nodes of a stacks Content Model or a collections_bookmark Content Category. They serve three primary purposes:

  1. They are used to classify documents. Documents are considered "classified" when the folder Batch Folder is assigned a Content Type (most typically, a Document Type).
  2. The Document Type's data_table Data Model defines the Data Elements extracted by the Extract activity (including any Data Elements inherited from parent Content Types).
  3. The Document Type defines all "Behaviors" that apply (whether from the Document Type's Behavior settings or those inherited from a parent Content Type).

Expressions: Expressions (not to be confused with regular expressions) are snippets of VB.NET code that expand Grooper's core functionality.

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.

Summary Tabs: stacks Content Models and collections_bookmark Content Categories have a Summary tab where you can view "Descendant Node Types", description Document Types, and Expressions.

UI Element: A UI Element is a portion of the Grooper interface that allows users to interact with or otherwise receive information about the application.