Grooper Object: Difference between revisions

From Grooper Wiki
← Older edit
No edit summary
 
(26 intermediate revisions by the same user not shown)
Line 1: Line 1:
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 (''{{TypeName|Grooper Object}}''). This includes:
* [[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]], [[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.
== Object Inheritance ==
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:
*{{WikiHelpLinks|Grooper Object}}
* {{WikiHelpLinks|API Key}}
**{{WikiHelpLinks|Connected Object}}
* {{WikiHelpLinks|Archive Info}}
***{{WikiHelpLinks|Batch Filter}}
* {{WikiHelpLinks|Border}}
***{{WikiHelpLinks|Chat Filter}}
* {{WikiHelpLinks|Capture Settings}}
*** {{WikiHelpLinks|Capture Device}}
* {{WikiHelpLinks|Character Class Filter}}
**** {{WikiHelpLinks|ColorTrac Scanner}}
* {{WikiHelpLinks|Chat Parameters}}
**** {{WikiHelpLinks|Import Device}}
* {{WikiHelpLinks|CMIS Object}}
**** {{WikiHelpLinks|ISIS Device}}
** {{WikiHelpLinks|CMIS Document}}
**** {{WikiHelpLinks|TWAIN Device}}
** {{WikiHelpLinks|CMIS Folder}}
***{{WikiHelpLinks|Database Row}}
* {{WikiHelpLinks|CMIS Property Definition}}
****{{WikiHelpLinks|AI Chat}}
** {{WikiHelpLinks|CMIS Boolean Property Definition}}
****{{WikiHelpLinks|AI Message}}
** {{WikiHelpLinks|CMIS DateTime Property Definition}}
****{{WikiHelpLinks|Doc Index}}
** {{WikiHelpLinks|CMIS Decimal Property Definition}}
****{{WikiHelpLinks|File Store Entry}}
** {{WikiHelpLinks|CMIS HTML Property Definition}}
****{{WikiHelpLinks|Import Job}}
** {{WikiHelpLinks|CMIS ID Property Definition}}
****{{WikiHelpLinks|Index State}}
** {{WikiHelpLinks|CMIS Integer Property Definition}}
****{{WikiHelpLinks|Index Table}}
** {{WikiHelpLinks|CMIS String Property Definition}}
*****{{WikiHelpLinks|Batch State}}
** {{WikiHelpLinks|CMIS URI Property Definition}}
****{{WikiHelpLinks|Log Event}}
* {{WikiHelpLinks|Code39Settings}}
****{{WikiHelpLinks|Processing Job}}
* {{WikiHelpLinks|Connected Object}}
****{{WikiHelpLinks|Processing Task}}
** {{WikiHelpLinks|Batch Filter}}
****{{WikiHelpLinks|Saved Query}}
** {{WikiHelpLinks|Chat Filter}}
****{{WikiHelpLinks|Session Stats}}
** {{WikiHelpLinks|Capture Device}}
***{{WikiHelpLinks|Embedded Object}}
*** {{WikiHelpLinks|ColorTrac Scanner}}
**** {{WikiHelpLinks|AI Chat Filter}}
*** {{WikiHelpLinks|Import Device}}
**** {{WikiHelpLinks|AI Chat Settings}}
*** {{WikiHelpLinks|ISIS Device}}
**** {{WikiHelpLinks|AI Generator}}
*** {{WikiHelpLinks|TWAIN Device}}
**
** {{WikiHelpLinks|Database Row}}
*** {{WikiHelpLinks|AI Chat}}
*** {{WikiHelpLinks|AI Message}}
*** {{WikiHelpLinks|Doc Index}}
*** {{WikiHelpLinks|File Store Entry}}
*** {{WikiHelpLinks|Import Job}}
*** {{WikiHelpLinks|Index State}}
*** {{WikiHelpLinks|Index Table}}
**** {{WikiHelpLinks|Batch State}}
*** {{WikiHelpLinks|Log Event}}
*** {{WikiHelpLinks|Processing Job}}
*** {{WikiHelpLinks|Processing Task}}
*** {{WikiHelpLinks|Saved Query}}
*** {{WikiHelpLinks|Service Instance}}
**** {{WikiHelpLinks|Activity Processing}}
**** {{WikiHelpLinks|API Services}}
**** {{WikiHelpLinks|Import Watcher}}
**** {{WikiHelpLinks|Indexing Service}}
**** {{WikiHelpLinks|System Maintenance Service}}
**** {{WikiHelpLinks|Timer Service}}
**** {{WikiHelpLinks|Web Service}}
***** {{WikiHelpLinks|Grooper Licensing}}
**** {{WikiHelpLinks|Activity Processing}}
*** {{WikiHelpLinks|Session Stats}}
** {{WikiHelpLinks|Embedded Object}}
*** {{WikiHelpLinks|AI Chat Filter}}
*** {{WikiHelpLinks|AI Chat Settings}}
*** {{WikiHelpLinks|AI Generator}}
*** {{WikiHelpLinks|Activity}}
**** {{WikiHelpLinks|Attended Activity}}
***** {{WikiHelpLinks|Review}}
 
}}
}}


=== What's not on this list? ===


<!---
Not much! Nearly everything in Grooper inherits from {{WikiHelpLinks|Grooper Object}}. Not included in this list are:
<br clear=all>
* [[Grooper Command Console]] and its commands
{|class="mw-collapsible wikitable"
* {{WikiHelpLinks|Property Converter}} and its derived types
|Grooper Object
* {{WikiHelpLinks|Property Editor}} and its derived types
|-
* {{WikiHelpLinks|UI Element}} and its derived types
|
* ''[https://help.grooper.com/v2025/help&typeName=Grooper.StringManager+CharacterCasing Enumerations]''
{|class="mw-collapsible wikitable"
|Connected Object
|-
|
{|class="mw-collapsible wikitable"
|Capture Device
|-
|ColorTrac Scanner
|-
|Import Device
|-
|ISIS Device
|-
|TWAIN Device
|}
|-
|
{|class="mw-collapsible wikitable"
|Embedded Object
|-
|
{|class="mw-collapsible wikitable"
|Activity
|-
|
{|class="mw-collapsible wikitable"
|Attended Activity
|-
|Review
|}
|-
|
{|class="mw-collapsible wikitable"
|Code Activity
|-
|Apply Rules
|-
|Attach
|-
|Batch Transfer
|}
|}
|}
|}
|}
|}

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:

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