Grooper Object: Difference between revisions

From Grooper Wiki
 
(15 intermediate revisions by the same user not shown)
Line 3: Line 3:
'''Grooper Object''' is the foundational base class in Grooper. All configurable objects inherit from Grooper Object (''{{TypeName|Grooper Object}}''). This includes:
'''Grooper Object''' is the foundational base class in Grooper. All configurable objects inherit from Grooper Object (''{{TypeName|Grooper Object}}''). This includes:
* [[Node]]s in the Grooper node tree (including [[Batch]]es, [[Content Model]]s, [[Batch Process]]es and more)
* [[Node]]s in the Grooper node tree (including [[Batch]]es, [[Content Model]]s, [[Batch Process]]es and more)
* Embedded objects stored as properties of nodes (including [[Activity|Activities]], [[Value Extractor]]s,
* Embedded objects stored as properties of nodes (including [[Activity|Activities]], [[Command]]s, [[Value Extractor]]s and much much more).


Grooper Objects are designed to be user-configurable (in most cases). These objects are used to define, store, and manage settings and data throughout Grooper. Their properties are typically exposed in the Property Grid interface, allowing users to view and modify settings in the Grooper UI.
Grooper Objects are designed to be user-configurable (in most cases). These objects are used to define, store, and manage settings and data throughout Grooper. Their properties are typically exposed in the Property Grid interface, allowing users to view and modify settings in the Grooper UI.
Line 9: Line 9:
== Object Inheritance ==
== Object Inheritance ==


This tree demonstrates what objects are derived from their parent. Expand an object to inspect its derived types.
All items in this tree inherit from {{WikiHelpLinks|Grooper Object}}. Expand an object to inspect its derived types. Its type name and link to the Grooper Help page is listed in parenthesis.
*<li class="fyi-bullet"> ''Just looking for a list of all Grooper objects? Go to the [[List of Grooper Objects]] page for an expanded version of this tree.''


{{#tree:
{{#tree:
* {{NameTypeName|API Key}}
* {{WikiHelpLinks|API Key}}
* {{NameTypeName|Archive Info}}
* {{WikiHelpLinks|Archive Info}}
* {{NameTypeName|Border}}
* {{WikiHelpLinks|Border}}
* {{NameTypeName|Capture Settings}}
* {{WikiHelpLinks|Capture Settings}}
* {{NameTypeName|Character Class Filter}}
* {{WikiHelpLinks|Character Class Filter}}
* {{NameTypeName|Chat Parameters}}
* {{WikiHelpLinks|Chat Parameters}}
* {{NameTypeName|CMIS Object}}
* {{WikiHelpLinks|CMIS Object}}
** {{NameTypeName|CMIS Document}}
** {{WikiHelpLinks|CMIS Document}}
** {{NameTypeName|CMIS Folder}}
** {{WikiHelpLinks|CMIS Folder}}
* {{NameTypeName|CMIS Property Definition}}
* {{WikiHelpLinks|CMIS Property Definition}}
** {{NameTypeName|CMIS Boolean Property Definition}}
** {{WikiHelpLinks|CMIS Boolean Property Definition}}
** {{NameTypeName|CMIS DateTime Property Definition}}
** {{WikiHelpLinks|CMIS DateTime Property Definition}}
** {{NameTypeName|CMIS Decimal Property Definition}}
** {{WikiHelpLinks|CMIS Decimal Property Definition}}
** {{NameTypeName|CMIS HTML Property Definition}}
** {{WikiHelpLinks|CMIS HTML Property Definition}}
** {{NameTypeName|CMIS ID Property Definition}}
** {{WikiHelpLinks|CMIS ID Property Definition}}
** {{NameTypeName|CMIS Integer Property Definition}}
** {{WikiHelpLinks|CMIS Integer Property Definition}}
** {{NameTypeName|CMIS String Property Definition}}
** {{WikiHelpLinks|CMIS String Property Definition}}
** {{NameTypeName|CMIS URI Property Definition}}
** {{WikiHelpLinks|CMIS URI Property Definition}}
* {{NameTypeName|Code39Settings}}
* {{WikiHelpLinks|Code39Settings}}
* {{NameTypeName|Connected Object}}
* {{WikiHelpLinks|Connected Object}}
** {{NameTypeName|Batch Filter}}
** {{WikiHelpLinks|Batch Filter}}
** {{NameTypeName|Chat Filter}}
** {{WikiHelpLinks|Chat Filter}}
** {{NameTypeName|Capture Device}}
** {{WikiHelpLinks|Capture Device}}
*** {{NameTypeName|ColorTrac Scanner}}
*** {{WikiHelpLinks|ColorTrac Scanner}}
*** {{NameTypeName|Import Device}}
*** {{WikiHelpLinks|Import Device}}
*** {{NameTypeName|ISIS Device}}
*** {{WikiHelpLinks|ISIS Device}}
*** {{NameTypeName|TWAIN Device}}
*** {{WikiHelpLinks|TWAIN Device}}
** {{NameTypeName|Database Row}}
** {{WikiHelpLinks|Database Row}}
*** {{NameTypeName|AI Chat}}
*** {{WikiHelpLinks|AI Chat}}
*** {{NameTypeName|AI Message}}
*** {{WikiHelpLinks|AI Message}}
*** {{NameTypeName|Doc Index}}
*** {{WikiHelpLinks|Doc Index}}
*** {{NameTypeName|File Store Entry}}
*** {{WikiHelpLinks|File Store Entry}}
*** {{NameTypeName|Import Job}}
*** {{WikiHelpLinks|Import Job}}
*** {{NameTypeName|Index State}}
*** {{WikiHelpLinks|Index State}}
*** {{NameTypeName|Index Table}}
*** {{WikiHelpLinks|Index Table}}
**** {{NameTypeName|Batch State}}
**** {{WikiHelpLinks|Batch State}}
*** {{NameTypeName|Log Event}}
*** {{WikiHelpLinks|Log Event}}
*** {{NameTypeName|Processing Job}}
*** {{WikiHelpLinks|Processing Job}}
*** {{NameTypeName|Processing Task}}
*** {{WikiHelpLinks|Processing Task}}
*** {{NameTypeName|Saved Query}}
*** {{WikiHelpLinks|Saved Query}}
*** {{NameTypeName|Service Instance}}
*** {{WikiHelpLinks|Service Instance}}
**** {{NameTypeName|Activity Processing}}
**** {{WikiHelpLinks|Activity Processing}}
**** {{NameTypeName|API Services}}
**** {{WikiHelpLinks|API Services}}
**** {{NameTypeName|Import Watcher}}
**** {{WikiHelpLinks|Import Watcher}}
**** {{NameTypeName|Indexing Service}}
**** {{WikiHelpLinks|Indexing Service}}
**** {{NameTypeName|System Maintenance Service}}
**** {{WikiHelpLinks|System Maintenance Service}}
**** {{NameTypeName|Timer Service}}
**** {{WikiHelpLinks|Timer Service}}
**** {{NameTypeName|Web Service}}
**** {{WikiHelpLinks|Web Service}}
***** {{NameTypeName|Grooper Licensing}}
***** {{WikiHelpLinks|Grooper Licensing}}
**** {{NameTypeName|Activity Processing}}
**** {{WikiHelpLinks|Activity Processing}}
*** {{NameTypeName|Session Stats}}
*** {{WikiHelpLinks|Session Stats}}
** {{NameTypeName|Embedded Object}}
** {{WikiHelpLinks|Embedded Object}}
*** {{NameTypeName|AI Chat Filter}}
*** {{WikiHelpLinks|AI Chat Filter}}
*** {{NameTypeName|AI Chat Settings}}
*** {{WikiHelpLinks|AI Chat Settings}}
*** {{NameTypeName|AI Generator}}
*** {{WikiHelpLinks|AI Generator}}
*** {{NameTypeName|Activity}}
*** {{WikiHelpLinks|Activity}}
***** {{NameTypeName|Review}}
**** {{WikiHelpLinks|Attended Activity}}
**** {{NameTypeName|Code Activity}}
***** {{WikiHelpLinks|Review}}
***** {{NameTypeName|Apply Rules}}
**** {{WikiHelpLinks|Code Activity
***** {{NameTypeName|Attach}}
***** {{NameTypeName|Batch Transfer}}
***** {{NameTypeName|Burst Book}}
***** {{NameTypeName|Classify}}
***** {{NameTypeName|Clip Frames}}
***** {{NameTypeName|Convert Data}}
***** {{NameTypeName|Correct}}
***** {{NameTypeName|Deduplicate}}
***** {{NameTypeName|Detect Frames}}
***** {{NameTypeName|Detect Language}}
***** {{NameTypeName|Dispose Batch}}
***** {{NameTypeName|Execute}}
***** {{NameTypeName|Export}}
***** {{NameTypeName|Extract}}
***** {{NameTypeName|Fill Data}}
***** {{NameTypeName|

Latest revision as of 14:05, 10 September 2025

This page is intended for users creating and editing scripts in Grooper and other advanced users.

Grooper Object is the foundational base class in Grooper. All configurable objects inherit from Grooper Object (Grooper.GrooperObject). This includes:

Grooper Objects are designed to be user-configurable (in most cases). These objects are used to define, store, and manage settings and data throughout Grooper. Their properties are typically exposed in the Property Grid interface, allowing users to view and modify settings in the Grooper UI.

Object Inheritance

All items in this tree inherit from Grooper Object (Grooper.GrooperObject). Expand an object to inspect its derived types. Its type name and link to the Grooper Help page is listed in parenthesis.

  • Just looking for a list of all Grooper objects? Go to the List of Grooper Objects page for an expanded version of this tree.

What's not on this list?

Not much! Nearly everything in Grooper inherits from Grooper Object (Grooper.GrooperObject). Not included in this list are: