Grooper Colloquialisms: Difference between revisions
Dgreenwood (talk | contribs) No edit summary |
|||
| (19 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
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''' | |||
|- | |||
|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 == | ||
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:
|
|
"Recognize activity" |
The Grooper Activity known as Recognize.
|
|
"Recognize step" |
A Batch Process Step who's Activity property is set to "Recognize".
|
|
"page" |
Batch Page |
|
"folder" |
This term can refer to many things:
|
|
"document" |
A Batch Folder with content
|
|
"extractor" |
This is a general term that refers to either:
It is best practice to refer to specific extractor properties by their full property name
|
|
"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:
|
|
"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:
|