Grooper Colloquialisms: Difference between revisions

From Grooper Wiki
← Older editNewer edit →
No edit summary
No edit summary
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Glossary==
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."
<u>'''Content Model'''</u>: {{#lst:Glossary|Content Model}}


<u>'''Content Category'''</u>: {{#lst:Glossary|Content Category}}
This table documents accepted and unaccepted colloquial terms in the formal Grooper vocabulary.


<u>'''Document Type'''</u>: {{#lst:Glossary|Document Type}}
{|
|
'''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 ''objects''
** '''Data Fields'''
** '''Value Readers'''
** '''Field Classes'''
* Or, the various Grooper "'''''[[Extractor Type]]s'''''"
** Such as "'''''Labeled Value'''''", "'''''Pattern Match'''''", etc.


<u>'''CMIS Connection'''</u>: {{#lst:Glossary|CMIS Connection}}
''It is best practice to refer to extractor properties by their full property name''
 
* Such as a '''Data Field's''' '''''Value Extractor''''' property
<syntaxhighlight lang="csharp" line start="1">
|-
using System;
|valign=top|
 
"field"
// Declare a delegate type named MathOperation
|
public delegate int MathOperation(int a, int b);
'''Data Field'''
 
|-
public class Calculator
|valign=top|
{
"section"
    // Method to add two numbers
|
    public static int Add(int a, int b)
'''Data Section'''
    {
|-
        return a + b;
|valign=top|
    }
"table"
 
|
    // Method to multiply two numbers
'''Data Table'''
    public static int Multiply(int a, int b)
|-
    {
|valign=top|
        return a * b;
"column"
    }
|
}
'''Data Column'''
 
|-
public class Program
|valign=top|
{
"cell" (as opposed to "field")
    public static void Main()
|
    {
A singular '''Data Column''' instance for a single row instance
        // Instantiate a delegate of type MathOperation and assign the Add method
|-
        MathOperation operation = Calculator.Add;
|valign=top|
 
"Doc Type"
        // Invoke the delegate, which calls the Add method
|
        int result = operation(5, 3);
'''''This is an unaccepted standard for the Grooper Wiki.''''' Always refer to '''Document Types''' as "'''Document Types'''."
        Console.WriteLine("Result: " + result); // Output: Result: 8
|-
 
|valign=top|
        // Reassign the delegate to reference the Multiply method
"model"
        operation = Calculator.Multiply;
|
 
'''''This is an unaccepted standard for the Grooper Wiki.''''' Always refer specifically to either a '''Content Model''' or '''Data Model''' to avoid confusion,
        // Invoke the delegate, which calls the Multiply method
|-
        result = operation(5, 3);
|valign=top|
        Console.WriteLine("Result: " + result); // Output: Result: 15
"expression(s)"
    }
|
}
Specifically refers to a .NET code expression, not a regular expression pattern
</syntaxhighlight>
|-
 
|valign=top|
== ABout ==
"regex"
* "Step"
|
** '''Batch Procss Step'''
A regular expression pattern
** '''IP Step'''
|-
* "Recognize Step"
|valign=top|
** '''Batch Process Step''' who's '''''Activity''''' property is set to ''Recognize''
"profile"
* "Page"
|
** '''Batch Page'''
''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)
* "Folder"
|-
** A folder in the node tree
|valign=top|
** '''Batch Folder'''
"level 1"
** A browsable location in a CMIS repository
|
* "Document"
Generally refers to the '''''Scope''''' of ''Folder'' and '''''Folder Level''''' of ''1'' as "Level 1"
** A '''Batch Folder''' with content
|-
*** May include an attachment, or '''Batch Pages'''
|valign=top|
** May or may not be classified
'''''CMIS Connection Type''''' or "connection type"
* "Extractor"
|
*: ''Always refer to extractor properties by their full property name''
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.
*:* '''Data Field's''' '''''Value Extractor''''' property
|-
** Extractor Type
|valign=top|
*** such as ''Labeled Value'', ''Pattern Match'', etc.
"element"
** Extractor object
|
*** Data Type, Field Class, Value Reader
This term refers to any '''Data Element'''. These "elements" are:
* "Field"
* '''Data Model'''
** '''Data Field''' only
* '''Data Field'''
* "Section"
* '''Data Section'''
** '''Data Section'''
* '''Data Table'''
* "Table"
* '''Data Column'''
** '''Data Table'''
|-
* "Column"
|valign=top|
** '''Data Column'''
"container element" (or sometimes just "container")
* "Cell" (not "Field")
|
** The singular '''Data Column''' instance for a single row instance
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:
* "Doc Type"
* '''Data Model'''
** Always refer to '''Document Types''' as '''Document Types'''
* '''Data Section'''
* "Model"
* '''Data Table'''
** 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"


<!--- Randall stuff
<section begin="Glossary" />
<section begin="Glossary" />
== Glossary ==
== Glossary ==

Revision as of 07:54, 4 October 2024

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 objects
    • Data Fields
    • Value Readers
    • Field Classes
  • Or, the various Grooper "Extractor Types"
    • Such as "Labeled Value", "Pattern Match", etc.

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

  • Such as a Data Field's Value 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=26371"