Grooper Colloquialisms: Difference between revisions

From Grooper Wiki
← Older edit
No edit summary
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
* "Step"
This article seeks to formalize "colloquialisms" in how people talk about Grooper. Colloquialisms are commonly accepted substitution for a formal term.  Colloquialisms serve a good purpose.  They shorten speech or text and can make it easier for someone to understand something. For example, "Batch Process Steps" are commonly just called "steps."
** '''Batch Procss Step'''
** '''IP Step'''
* "Recognize Step"
** '''Batch Process Step''' who's '''''Activity''''' property is set to ''Recognize''
* "Page"
** '''Batch Page'''
* "Folder"
** A folder in the node tree
** '''Batch Folder'''
** A browsable location in a CMIS repository
* "Document"
** A '''Batch Folder''' with content
*** May include an attachment, or '''Batch Pages'''
** May or may not be classified
* "Extractor"
*: ''Always refer to extractor properties by their full property name''
*:* '''Data Field's''' '''''Value Extractor''''' property
** Extractor Type
*** such as ''Labeled Value'', ''Pattern Match'', etc.
** Extractor object
*** Data Type, Field Class, Value Reader
* "Field"
** '''Data Field''' only
* "Section"
** '''Data Section'''
* "Table"
** '''Data Table'''
* "Column"
** '''Data Column'''
* "Cell" (not "Field")
** The singular '''Data Column''' instance for a single row instance
* "Doc Type"
** Always refer to '''Document Types''' as '''Document Types'''
* "Model"
** Always refer specifically to either a '''Content Model''' or '''Data Model'''
* "Expression(s)"
** specifically refers to a .NET expression, not a regular expression pattern
* "Profile"
** used to refer to the group of "Profile Objects", never an individual Profile Object
* "Level 1"
** May refer to the '''''Scope''''' of ''Folder'' and '''''Folder Level''''' of ''1'' as "Level 1"


This table documents accepted and unaccepted colloquial terms in the formal Grooper vocabulary.
{|
|
'''Colloquial Term'''
|
'''Formal Grooper Term'''
|-
|valign=top|
"step"
|
This term can refer to many things:
* '''Batch Procss Step'''
* '''IP Step'''
|-
|valign=top|
"'''''Recognize''''' activity"
|
The Grooper '''''Activity''''' known as '''''Recognize'''''.
* This is an accepted written substitute to "'''''Recognize Activity'''''".
* This is common across all '''''Activity''''' types, not just '''''Recognize'''''.
|-
|valign=top|
"'''''Recognize''''' step"
|
A '''Batch Process Step''' who's '''''Activity''''' property is set to "'''''Recognize'''''".
* This is common across all '''''Activity''''' types, not just '''''Recognize'''''.
|-
|valign=top|
"page"
|
'''Batch Page'''
|-
|valign=top|
"folder"
|
This term can refer to many things:
* A folder in the node tree
* '''Batch Folder'''
* A browsable location in a CMIS repository
|-
|valign=top|
"document"
|
A '''Batch Folder''' with content
* A folder has content when (1) it has an imported file attached to the folder or (2) it has child '''Batch Pages'''
* May or may not be classified
|-
|valign=top|
"extractor"
|
This is a general term that refers to either:
* Extractor ''nodes''
** '''Data Fields'''
** '''Value Readers'''
** '''Field Classes'''
* Or, the various Grooper "[[Value Extractor]]s"
** Such as Labeled Value, Pattern Match, etc.
''It is best practice to refer to specific extractor properties by their full property name''
* Example: A '''Data Field's''' "Value Extractor" property
* Example: A '''Document Type's''' "Positive Extractor" property.
|-
|valign=top|
"field"
|
'''Data Field'''
|-
|valign=top|
"section"
|
'''Data Section'''
|-
|valign=top|
"table"
|
'''Data Table'''
|-
|valign=top|
"column"
|
'''Data Column'''
|-
|valign=top|
"cell" (as opposed to "field")
|
A singular '''Data Column''' instance for a single row instance
|-
|valign=top|
"Doc Type"
|
'''''This is an unaccepted standard for the Grooper Wiki.''''' Always refer to '''Document Types''' as "'''Document Types'''."
|-
|valign=top|
"model"
|
'''''This is an unaccepted standard for the Grooper Wiki.''''' Always refer specifically to either a '''Content Model''' or '''Data Model''' to avoid confusion,
|-
|valign=top|
"expression(s)"
|
Specifically refers to a .NET code expression, not a regular expression pattern
|-
|valign=top|
"regex"
|
A regular expression pattern
|-
|valign=top|
"profile"
|
''It is best practice to use this term when referring to the group of "Profile Objects", never an individual Profile Object.''  Refer to individual Profile Objects by their full name ('''IP Profile''', '''OCR Profile''', '''Scanner Profile''' etc)
|-
|valign=top|
"level 1"
|
Generally refers to the '''''Scope''''' of ''Folder'' and '''''Folder Level''''' of ''1'' as "Level 1"
|-
|valign=top|
'''''CMIS Connection Type''''' or "connection type"
|
This refers to a "'''''CMIS Binding'''''". In code, a '''[[CMIS Connection]]'s''' connection is defined by a '''''CMIS Binding''''' ([[NTFS]], [[Exchange]], [[Box]], etc).  However, in practice, "connection type" is so ubiquitous, you will probably only hear it called a '''''CMIS Binding''''' when talking to a developer.
|-
|valign=top|
"element"
|
This term refers to any '''Data Element'''. These "elements" are:
* '''Data Model'''
* '''Data Field'''
* '''Data Section'''
* '''Data Table'''
* '''Data Column'''
|-
|valign=top|
"container element" (or sometimes just "container")
|
This term refers to the three '''Data Elements''' that can have child '''Data Elements'''. Container elements have special properties like ''''Lookup Specifications'''''. These "container elements" are:
* '''Data Model'''
* '''Data Section'''
* '''Data Table'''
|}
<!--- Randall stuff
<section begin="Glossary" />
<section begin="Glossary" />
== Glossary ==
== Glossary ==
<span class="mw-customtoggle-Glossary" style="color:blue; font-size:18px;">
<span class="mw-customtoggle-Glossary" style="color:blue; font-size:18px;">
'''Click to expand/collapse the Glossary'''
'''Click to expand/collapse the Glossary''' <span font-size:12px;">(partial)</span>
</span>
</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-Glossary" style="margin-left:1em;">
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-Glossary" style="margin-left:1em;">
<span class="mw-customtoggle-Objects" style="color:#F89420; font-size:22px;">
<span class="mw-customtoggle-Objects" style="color:#F89420; font-size:22px;">
'''OBJECTS''' <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
OBJECTS <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
</span>
</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-Objects">
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-Objects">
Line 61: Line 163:
<hr>
<hr>
<span class="mw-customtoggle-Batch">
<span class="mw-customtoggle-Batch">
[[image:GrooperIcon_Batch.png]] '''Batch''' <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
[[image:GrooperIcon_Batch.png]] <big>'''Batch'''</big> <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
</span>
</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-Batch">
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-Batch">
<hr>
<p>{{#lst:Object Nomenclature|Batch}}</p><br>
<p>{{#lst:Object Nomenclature|Batch}}</p>
</div>
</div>
<span class="mw-customtoggle-BatchFolder">
<span class="mw-customtoggle-BatchFolder">
[[image:GrooperIcon_BatchFolder.png]] '''Batch Folder''' <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
[[image:GrooperIcon_BatchFolder.png]] <big>'''Batch Folder'''</big> <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
</span>
</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-BatchFolder">
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-BatchFolder">
<hr>
<p>{{#lst:Object Nomenclature|BatchFolder}}</p>
<p>{{#lst:Object Nomenclature|BatchFolder}}</p>
<big style="font-weight:bold;">Colloquialisms</big>
<big style="margin-left:1em;">'''Colloquialisms'''</big>
<ul>
<ul style="margin-left:3em;">
<li>Referred to as "document" when the '''Batch Folder''' has content (child Batch Pages or an attachment), ie not an empty '''Batch Folder'''</li>
<li>Referred to as "document" when the '''Batch Folder''' has content (child Batch Pages or an attachment), ie not an empty '''Batch Folder'''</li>
<li>Referred to as "folder" when the '''Batch Folder''' is empty or is used only when creating hierarchy in a '''Batch'''</li>
<li>Referred to as "folder" when the '''Batch Folder''' is empty or is used only when creating hierarchy in a '''Batch'''</li>
</ul>  
</ul><br>
</div>
</div>
<span class="mw-customtoggle-BatchPage">
<span class="mw-customtoggle-BatchPage">
[[image:GrooperIcon_BatchPage.png]] '''Batch Page''' <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
[[image:GrooperIcon_BatchPage.png]] <big>'''Batch Page'''</big> <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
</span>
</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-BatchPage">
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-BatchPage">
<hr>
<p>{{#lst:Object Nomenclature|BatchPage}}</p>
<p>{{#lst:Object Nomenclature|BatchPage}}</p>
<big style="font-weight:bold;">Colloquialisms</big>
<big style="margin-left:1em;">'''Colloquialisms'''</big>
<ul>
<ul style="margin-left:3em;">
<li>Referred to as "page"</li>
<li>Referred to as "page"</li>
</ul>  
</ul>
</div>
</div>
</div>
</div>
Line 97: Line 196:
<hr>
<hr>
<span class="mw-customtoggle-BatchProcess">
<span class="mw-customtoggle-BatchProcess">
[[image:GrooperIcon_BatchProcess.png]] '''Batch Process''' <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
[[image:GrooperIcon_BatchProcess.png]] <big>'''Batch Process'''</big> <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
</span>
</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-BatchProcess">
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-BatchProcess">
<hr>
<p>{{#lst:Object Nomenclature|BatchProcess}}</p><br>
<p>{{#lst:Object Nomenclature|BatchProcess}}</p>
</div>
</div>
<span class="mw-customtoggle-BatchProcessStep">
<span class="mw-customtoggle-BatchProcessStep">
[[image:GrooperIcon_BatchProcessStep.png]] '''Batch Process Step''' <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
[[image:GrooperIcon_BatchProcessStep.png]] <big>'''Batch Process Step'''</big> <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
</span>
</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-BatchProcessStep">
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-BatchProcessStep">
<hr>
<p>{{#lst:Object Nomenclature|BatchProcessStep}}</p>
<p>{{#lst:Object Nomenclature|BatchProcessStep}}</p>
<big style="font-weight:bold;">Colloquialisms</big>
<big style="margin-left:1em;">'''Colloquialisms'''</big>
<ul>
<ul style="margin-left:3em;">
<li>Referred to as "step"</li>
<li>Referred to as "step"</li>
<li>A '''Batch Process Step''' who's '''''Activity''''' property is set to ''Recognize'' may be referred to as "Recognize Step" (the same is true for any other activity)</li>
<li>A '''Batch Process Step''' who's '''''Activity''''' property is set to ''Recognize'' may be referred to as "Recognize Step" (the same is true for any other activity)</li>
Line 118: Line 215:
</div>
</div>
</div>
</div>
<span class="mw-customtoggle-Activities" style="color:#F89420; font-size:22px;">
<span class="mw-customtoggle-Activities" style="color:#F89420; font-size:22px;">
'''ACTIVITIES''' <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
ACTIVITIES <span style="color:blue; font-size:12px;">(click to expand/collapse)</span>
</span>
</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-Activities">
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-Activities">
Line 126: Line 222:
<p>'''''[[Activity|Activities]]''''' {{#lst:Activity|Activity}}</p>
<p>'''''[[Activity|Activities]]''''' {{#lst:Activity|Activity}}</p>
</div>
</div>
</div>
<span class="mw-customtoggle-GlossaryAll" style="color:blue; font-size:18px;">
'''Click to expand/collapse the Glossary''' <span font-size:12px;">(all)
</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-GlossaryAll" style="margin-left:1em;">
<span style="color:#F89420; font-size:22px;">OBJECTS</span>
<hr>
<p>{{#lst:Object Nomenclature|Objects}}</p>
<div style="margin-left:1em;">
<span style="color:#F89420; font-size:20px;">Batch Objects</span>
<hr>
<div style="margin-left:1em;">
<p>[[image:GrooperIcon_Batch.png]] <big>'''Batch'''</big></p>
<p>{{#lst:Object Nomenclature|Batch}}</p><br>
<p>[[image:GrooperIcon_BatchFolder.png]] <big>'''Batch Folder'''</big></p>
<p>{{#lst:Object Nomenclature|BatchFolder}}</p>
<big style="margin-left:1em;">'''Colloquialisms'''</big>
<ul style="margin-left:3em;">
<li>Referred to as "document" when the '''Batch Folder''' has content (child Batch Pages or an attachment), ie not an empty '''Batch Folder'''</li>
<li>Referred to as "folder" when the '''Batch Folder''' is empty or is used only when creating hierarchy in a '''Batch'''</li>
</ul><br>
<p>[[image:GrooperIcon_BatchPage.png]] <big>'''Batch Page'''</big></p>
<p>{{#lst:Object Nomenclature|BatchPage}}</p>
<big style="margin-left:1em;">'''Colloquialisms'''</big>
<ul style="margin-left:3em;">
<li>Referred to as "page"</li>
</ul>
</div>
<span style="color:#F89420; font-size:20px;">Process Objects</span>
<hr>
<div style="margin-left:1em;">
<p>[[image:GrooperIcon_BatchProcess.png]] <big>'''Batch Process'''</big></p>
<p>{{#lst:Object Nomenclature|BatchProcess}}</p><br>
<p>[[image:GrooperIcon_BatchProcessStep.png]] <big>'''Batch Process Step'''</big></p>
<p>{{#lst:Object Nomenclature|BatchProcessStep}}</p>
<big style="margin-left:1em;">'''Colloquialisms'''</big>
<ul style="margin-left:3em;">
<li>Referred to as "step"</li>
<li>A '''Batch Process Step''' who's '''''Activity''''' property is set to ''Recognize'' may be referred to as "Recognize Step" (the same is true for any other activity)</li>
</ul>
</div>
</div>
<span style="color:#F89420; font-size:22px;">ACTIVITIES</span>
<hr>
<p>'''''[[Activity|Activities]]''''' {{#lst:Activity|Activity}}</p>
</div>
</div>
<section end="Glossary" />
<section end="Glossary" />

Latest revision as of 16:27, 27 August 2025

This article seeks to formalize "colloquialisms" in how people talk about Grooper. Colloquialisms are commonly accepted substitution for a formal term. Colloquialisms serve a good purpose. They shorten speech or text and can make it easier for someone to understand something. For example, "Batch Process Steps" are commonly just called "steps."

This table documents accepted and unaccepted colloquial terms in the formal Grooper vocabulary.

Colloquial Term

Formal Grooper Term

"step"

This term can refer to many things:

  • Batch Procss Step
  • IP Step

"Recognize activity"

The Grooper Activity known as Recognize.

  • This is an accepted written substitute to "Recognize Activity".
  • This is common across all Activity types, not just Recognize.

"Recognize step"

A Batch Process Step who's Activity property is set to "Recognize".

  • This is common across all Activity types, not just Recognize.

"page"

Batch Page

"folder"

This term can refer to many things:

  • A folder in the node tree
  • Batch Folder
  • A browsable location in a CMIS repository

"document"

A Batch Folder with content

  • A folder has content when (1) it has an imported file attached to the folder or (2) it has child Batch Pages
  • May or may not be classified

"extractor"

This is a general term that refers to either:

  • Extractor nodes
    • Data Fields
    • Value Readers
    • Field Classes
  • Or, the various Grooper "Value Extractors"
    • Such as Labeled Value, Pattern Match, etc.

It is best practice to refer to specific extractor properties by their full property name

  • Example: A Data Field's "Value Extractor" property
  • Example: A Document Type's "Positive Extractor" property.

"field"

Data Field

"section"

Data Section

"table"

Data Table

"column"

Data Column

"cell" (as opposed to "field")

A singular Data Column instance for a single row instance

"Doc Type"

This is an unaccepted standard for the Grooper Wiki. Always refer to Document Types as "Document Types."

"model"

This is an unaccepted standard for the Grooper Wiki. Always refer specifically to either a Content Model or Data Model to avoid confusion,

"expression(s)"

Specifically refers to a .NET code expression, not a regular expression pattern

"regex"

A regular expression pattern

"profile"

It is best practice to use this term when referring to the group of "Profile Objects", never an individual Profile Object. Refer to individual Profile Objects by their full name (IP Profile, OCR Profile, Scanner Profile etc)

"level 1"

Generally refers to the Scope of Folder and Folder Level of 1 as "Level 1"

CMIS Connection Type or "connection type"

This refers to a "CMIS Binding". In code, a CMIS Connection's connection is defined by a CMIS Binding (NTFS, Exchange, Box, etc). However, in practice, "connection type" is so ubiquitous, you will probably only hear it called a CMIS Binding when talking to a developer.

"element"

This term refers to any Data Element. These "elements" are:

  • Data Model
  • Data Field
  • Data Section
  • Data Table
  • Data Column

"container element" (or sometimes just "container")

This term refers to the three Data Elements that can have child Data Elements. Container elements have special properties like 'Lookup Specifications. These "container elements" are:

  • Data Model
  • Data Section
  • Data Table


Retrieved from "https://wiki.grooper.com/index.php?title=Grooper_Colloquialisms&oldid=30772"