Grooper Object

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:

• Nodes in the Grooper node tree (including Batches, Content Models, Batch Processes and more)
• Embedded objects stored as properties of nodes (including Activities, Value Extractors,

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

This tree demonstrates what objects are derived from their parent. Expand an object to inspect its derived types. Click on the type name in parenthesis to navigate to the Grooper Help online.

• Connected Object (Grooper.ConnectedObject)
  • Batch Filter (Grooper.Core.BatchFilter)
  • Chat Filter (Grooper.GPT.ChatFilter)
  • Capture Device (Grooper.Capture.CaptureDevice)
    • ColorTrac Scanner (Grooper.Capture.ColorTrac.ColorTracCaptureDevice)
    • Import Device (Grooper.Capture.ImportDevice)
    • ISIS Device (Grooper.Capture.IsisDevice)
    • TWAIN Device (Grooper.Capture.TwainDevice)
  • Database Row (Grooper.DatabaseRow)
    • AI Chat (Grooper.GPT.AIChat)
    • AI Message (Grooper.GPT.AIMessage)
    • Doc Index (Grooper.Core.DocIndex)
    • File Store Entry (Grooper.FileStoreEntry)
    • Import Job (Grooper.Core.ImportJob)
    • Index State (Grooper.GPT.IndexState)
    • Index Table (Grooper.IndexTable)
      • Batch State (Grooper.Core.BatchState)
    • Log Event (Grooper.LogEvent)
    • Processing Job (Grooper.Core.ProcessingJob)
    • Processing Task (Grooper.Core.ProcessingTask)
    • Saved Query (Grooper.GPT.SavedQuery)
    • Session Stats (Grooper.SessionStats)
  • Embedded Object (Grooper.EmbeddedObject)
    • AI Chat Filter (Grooper.GPT.AIChatFilter)
    • AI Chat Settings (Grooper.GPT.AIChatSettings)
    • AI Generator (Grooper.GPT.AIGenerator)
    • Activity (Grooper.Core.BatchProcessingActivity)
      • Attended Activity (Grooper.Core.AttendedActivity)
        • Review (Grooper.Activities.Review)
      • Code Activity (Grooper.Core.CodeActivity)
        • Apply Rules (Grooper.Activities.ApplyRules)
        • Attach (Grooper.GPT.Attach)
        • Batch Transfer (Grooper.Activities.BatchTransfer)
        • Burst Book (Grooper.Microform.BurstBook)
        • Classify (Grooper.Activities.ClassifyFolders)
        • Clip Frames (Grooper.Microform.ClipFrames)
        • Convert Data (Grooper.Activities.ConvertData)
        • Correct (Grooper.Activities.CorrectOCR)
        • Deduplicate (Grooper.Activities.Deduplicate)
        • Detect Frames (Grooper.Microform.DetectFrames)
        • Detect Language (Grooper.GPT.DetectLanguage)
        • Dispose Batch (Grooper.Activities.DisposeBatch)
        • Execute (Grooper.Activities.Execute)
        • Export (Grooper.Activities.Export)
        • Extract (Grooper.Core.BatchFolder+Extract)
        • Fill Data (Grooper.Activities.FillData)
        • Image Processing (Grooper.Activities.ImageProcessing)
        • Initialize Card (Grooper.Microform.SortTiles)
        • Launch Process (Grooper.Activities.LaunchProcess)
        • Mark Attachments (Grooper.GPT.MarkAttachments)
        • Merge (Grooper.Activities.Merge)
        • Recognize (Grooper.Activities.Recognize)
        • Redact (Grooper.Activities.Redaction)
        • Remove Level (Grooper.Core.BatchFolder+RemoveLevel)
        • Render (Grooper.Activities.RenderDocument)
        • Route (Grooper.Activities.Route)
        • Send Mail (Grooper.Messaging.SendMail)
        • Separate (Grooper.Activities.Separation)
        • Spawn Batch (Grooper.Activities.SpawnBatch)
        • Split Pages (Grooper.Activities.SplitPages)
        • Split Text (Grooper.Activities.SplitText)
        • Text Transform (Grooper.Activities.TextTransform)
        • Translate (Grooper.Cloud.Translate)
        • XML Transform (Grooper.Activities.XmlTransform)
    • Anchor Definition (Grooper.Extract.AnchorDefinition)
    • Attachment Rule (Grooper.Core.AttachmentRule)
    • Attachment Type (Grooper.Core.MimeTypeHandler)
      • EDI File (Grooper.EDI.EDIFile)
      • HTML Document Base (Grooper.Messaging.HTMLDocumentBase)
        • HTML Document (Grooper.Messaging.HTMLDocument)
        • Mail Message (Grooper.Messaging.MailMimeTypeHandler)
      • JPEG Image (Grooper.Core.JpegImage)
      • Office Document (Grooper.Office.OfficeDocument)
        • Excel Document (Grooper.Office.ExcelDocument)
        • Power Point Document (Grooper.Office.PowerPointDocument)
        • Word Document (Grooper.Office.WordDocument)
      • PDF Document (Grooper.Core.PdfMimeTypeHandler)
      • PST File (Grooper.Office.PSTHandler)
      • Text Document (Grooper.Extract.TextDocument)
      • TIFF Document (Grooper.Core.TiffDocument)
      • vCard (Grooper.Messaging.VCardTypeHandler)
      • XML File (Grooper.EDI.XmlFile)
      • ZIP Archive (Grooper.Core.ZipHandler)
    • Auto Complete Settings (Grooper.Core.AutoCompleteSettings)
    • Barcode Reader (Grooper.IP.BarcodeReader)
      • 1D Reader (Grooper.IP.OneDimensionReader)
      • 2D Reader (Grooper.IP.TwoDimensionReader)
      • Postcode Reader (Grooper.IP.PostcodeReader)
      • Standard Reader (Grooper.IP.AtalaReader)
    • Batch Creation Settings (Grooper.Core.BatchCreationSettings)
    • Batch Name Settings (Grooper.Core.BatchNameSettings)
    • Behavior (Grooper.Core.Behavior)
      • Export Behavior (Grooper.Core.ExportBehavior)
      • Import Behavior (Grooper.Core.ImportBehavior)
      • Indexing Behavior (Grooper.GPT.IndexingBehavior)
      • Labeling Behavior (Grooper.Extract.LabelingBehavior)
      • PDF Data Mapping (Grooper.Core.PDFGenerateBehavior)
      • Separation Behavior (Grooper.Capture.SeparationBehavior)
      • Text Rendering (Grooper.Core.TextRendering)
    • Bookmark Options (Grooper.Core.BookmarkOptions)
    • Bot Connector (Grooper.GPT.BotConnector)
    • Chunk Settings (Grooper.GPT.ChunkSettings)
    • Cluster Parameters (Grooper.GPT.ClusterParameters)
    • CMIS Export Map (Grooper.CMIS.CMISExportMap)
    • CMIS Folder Reference (Grooper.CMIS.CMISFolderReference)
    • CMIS Type Definition (Grooper.CMIS.CmisTypeDefinition)
    • CMIS Type Reference (Grooper.CMIS.CMISTypeReference)
      • CMIS Compound Type (Grooper.CMIS.CMISCompoundType)
    • Code Expression (Grooper.Core.CodeExpression)
      • Boolean Expression (Grooper.Core.BooleanExpression)
      • String Expression (Grooper.Core.StringExpression)
    • Column Map (Grooper.Activities.ColumnMap)
    • Command Options (Grooper.Activities.Review+CommandOptions)
    • Computed Field (Grooper.GPT.ComputedField)
    • Content Mapping (Grooper.Core.OxiImport+ContentMapping)
    • Custom Statement (Grooper.Activities.CustomStatement)
    • Data Element Extension (Grooper.Core.DataElementExtension)
      • AI Extract Field Options (Grooper.GPT.AIExtractFieldOptions)
      • AI Extract Section Options (Grooper.GPT.AIExtractSectionOptions)
      • AI Extract Table Options (Grooper.GPT.AIExtractTableOptions)
      • Grid Layout Options (Grooper.Extract.GridLayoutOptions)
      • Tabular Layout Options (Grooper.Extract.TabularLayoutOptions)
    • Data Element Profile (Grooper.Core.DataElementProfile)
    • Data Fill Method (Grooper.Core.DataFillMethod)
      • AI Extract (Grooper.GPT.AIExtract)
      • Fill Descendants (Grooper.GPT.FillDescendants)
      • Run Child Extractors (Grooper.Core.RunChildExtractors)
    • Download Format (GrooperReview.Pages.Search.DownloadFormat)
      • Download CSV (GrooperReview.Pages.Search.DownloadCSV)
      • Download Custom (GrooperReview.Pages.Search.DownloadCustom)
      • Download PDF (GrooperReview.Pages.Search.DownloadPDF)
      • Download ZIP (GrooperReview.Pages.Search.DownloadZIP)
    • Edge Adjustment (Grooper.Extract.EdgeAdjustment)
      • Absolute (Grooper.Extract.AbsoluteAdjustment)
      • Anchor (Grooper.Extract.AnchorAdjustment)
      • Edge of Page (Grooper.Extract.EdgeOfPageAdjustment)
      • Relative (Grooper.Extract.RelativeAdjustment)
    • Embedded Lexicon (Grooper.Core.EmbeddedLexicon)
      • Field Value Lexicon (Grooper.Core.FieldValueLexicon)
      • Fuzzy Match Weightings (Grooper.Core.FuzzyMatchWeightings)
      • List Match Entries (Grooper.Extract.ListMatch+ListMatchEntries)
    • Environment Options (Grooper.Extract.EnvironmentOptions)
    • Execute Step (Grooper.Activities.ExecuteStep)
      • Execute Activity (Grooper.Activities.ExecuteActivity)
      • Execute Command (Grooper.Activities.ExecuteCommand)
    • Expression Set (Grooper.Core.ExpressionSet)
    • Field Annotation (Grooper.Core.PDFGenerateBehavior+FieldAnnotation)
      • • Checkbox Widget (Grooper.Core.PDFGenerateBehavior+CheckboxWidget)
        • Checkbox Widget (Grooper.Core.PDFGenerateBehavior+CheckboxWidget)
        • Radio Group Widget (Grooper.Core.PDFGenerateBehavior+RadioGroupWidget)
        • Signature Widget (Grooper.Core.PDFGenerateBehavior+SignatureWidget)
        • Textbox Widget (Grooper.Core.PDFGenerateBehavior+TextboxWidget)
      • Highlight Annotation (Grooper.Core.PDFGenerateBehavior+HighlightAnnotation)
      • Text Annotation (Grooper.IP.TextAnnotation)
    • Field Mapping (Grooper.Core.LexiconLookup+FieldMapping)
    • File Reference (Grooper.FileReference)
      • Resource Reference File (Error - Report error to groopereducation@bisok.com)
      • UNC File Reference (Grooper.UNCFileReference)
      • URL File Reference (Grooper.URLFileReference)
    • Folder Level Info (Grooper.Core.BatchCreationSettings+FolderLevelInfo)
    • FRX Options (Grooper.Core.FrxOptions)
    • FTP Repository Configuration (Grooper.Messaging.FtpBinding+FtpRepositoryConfiguration)
    • Fuzzy Lookup Options (Grooper.Extract.FuzzyLookupOptions)
    • Horizontal Tab Marker (Grooper.Core.HorizontalTabMarker)
    • HTTP Auth Method (Grooper.GPT.HTTPAuthMethod)
      • Basic (Grooper.GPT.Basic)
      • OAuth Client Credentials (Grooper.GPT.OAuthClientCredentials)
    • HTTP Resource (Grooper.Messaging.HTTPResource)
    • Hyperlink Selector (Grooper.Messaging.HyperlinkSelector)
    • Image Segmentation Options (Grooper.OCR.ImageSegmentationOptions)
    • Import Schedule (Grooper.Services.ImportSchedule)
      • Polling Loop (Grooper.Services.PollingLoop)
      • Specific Times (Grooper.Services.SpecificTimes)
    • Index Stats (Grooper.GPT.IndexStats)
    • Label Info (Grooper.Extract.LabelInfo)
    • Label Set (Grooper.Extract.LabelSet)
    • Label Version (Grooper.Extract.LabelVersion)
    • Layout Provider (Grooper.Extract.LayoutProvider)
      • Flow (Grooper.Extract.FlowLayoutProvider)
      • Horizontal (Grooper.Extract.HorizontalLayoutProvider)
      • Vertical (Grooper.Extract.VerticalLayoutProvider)
    • Line Periodicity Detector (Grooper.Extract.LinePeriodicityDetector)
    • LLM Provider (Grooper.GPT.LLMProvider)
      • Azure Provider (Grooper.GPT.AzureProvider)
      • GCS Provider (Grooper.GPT.GCSProvider)
      • Open AI Provider (Grooper.GPT.OpenAIProvider)
    • Lucene Query (Grooper.GPT.LuceneQuery)
      • Lucene Group (Grooper.GPT.LuceneGroup)
      • Lucene Phrase (Grooper.GPT.LucenePhrase)
      • Lucene Word (Grooper.GPT.LuceneWord)
    • Metadata Options (Grooper.Core.MetadataOptions)
    • Multiline Row Settings (Grooper.Extract.MultilineRowSettings)
    • OCR Layer (Grooper.Core.OcrLayer)
    • OCR Repair Options (Grooper.OCR.OcrRepairOptions)
      • Spell Corrector (Grooper.Core.SpellCorrector)
    • OMR Box (Grooper.Extract.ZonalOMR+OmrBox)
    • Page Attachment Rule (Grooper.Capture.PageAttachmentRule)
    • Paragraph Marker (Grooper.Core.ParagraphMarker)
    • Path Expression (Grooper.Core.PathExpression)
    • PDF Expand Method (Grooper.Core.PdfMimeTypeHandler+PDFExpandMethod)
      • Bookmarks (Grooper.Core.PdfMimeTypeHandler+Bookmarks)
      • Fixed Page Count (Grooper.Core.PdfMimeTypeHandler+FixedPageCount)
      • Page Piece (Grooper.Core.PdfMimeTypeHandler+PagePiece)
      • Tag Based (Grooper.Core.PdfMimeTypeHandler+TagBased)
    • Permission Set (Grooper.PermissionSet)
    • Piece Info Options (Grooper.Core.PieceInfoOptions)
    • Quoting Method (Grooper.GPT.QuotingMethod)
      • Data Values (Grooper.GPT.DataValues)
      • Extracted (Grooper.GPT.Extracted)
      • Labeled Region (Grooper.GPT.LabeledRegion)
      • Layout Objects (Grooper.GPT.LayoutObjects)
      • Semantic (Grooper.GPT.Semantic)
    • Region Definition (Grooper.Extract.RegionDefinition)
      • Dynamic Region (Grooper.Extract.DynamicRegion)
        • Shape Region (Grooper.Extract.ShapeRegion)
        • Text Region (Grooper.Extract.TextRegion)
      • Fixed Region (Grooper.Extract.FixedRegion)
        • Relative Region (Grooper.Extract.RelativeRegion)
    • Repository Configuration (Grooper.CMIS.WindowsFileSystem+RepositoryConfiguration)
    • Repository Option (Grooper.RepositoryOption)
      • AI Search (Grooper.GPT.AISearch)
      • LLM Connector (Grooper.GPT.OpenAIConnector)
      • Text Analysis Option (Grooper.GPT.Azure.TextAnalysisOption)
    • Resource Reference (Grooper.GPT.ResourceReference)
      • Bing Search (Grooper.GPT.BingSearchReference)
      • Database Table (Grooper.GPT.TableReference)
      • Search Index (Grooper.GPT.SearchIndexReference)
      • Web Service (Grooper.Services.WebService)
    • Result Filter (Grooper.Extract.ResultFilter)
    • Result Processor (Grooper.Extract.ResultProcessor)
      • OCR Reader (Grooper.Extract.OcrReader)
      • OMR Reader (Grooper.Extract.OmrReader)
      • Place Zone (Grooper.Extract.PlaceZone)
    • Result Set Options (Grooper.Extract.ResultSetOptions)
    • Return Value (Grooper.Activities.ReturnValue)
    • Route Definition (Grooper.Activities.RouteDefinition)
    • Sample Image Collection (Grooper.IP.SampleImageCollection)
    • Schema Mapping (Grooper.EDI.SchemaMapping)
    • Search Filter (Grooper.GPT.SearchFilter)
      • Boolean Filter (Grooper.GPT.BooleanFilter)
      • Field Filter (Grooper.GPT.FieldFilter)
        • Comparison Filter (Grooper.GPT.ComparisonFilter)
        • In Filter (Grooper.GPT.InFilter)
      • Is Match Filter (Grooper.GPT.IsMatchFilter)
      • Lambda Filter (Grooper.GPT.LambdaFilter)
    • Separate Action (Grooper.Core.SeparateAction)
      • Separation Event (Grooper.Capture.SeparationEvent)
        • Barcode Detected (Grooper.Capture.BarcodeDetected)
        • Blank Page Detected (Grooper.Capture.BlankPageDetected)
        • Content Type Detected (Grooper.Capture.ContentTypeDetected)
        • Page Count (Grooper.Capture.PageCount)
        • Shape Detected (Grooper.Capture.ShapeDetected)
    • Service Deployment (Grooper.GPT.ServiceDeployment)
      • Chat Service (Grooper.GPT.ChatService)
      • Embeddings Service (Grooper.GPT.EmbeddingsService)
      • Fine Tuning Service (Grooper.GPT.FineTuningService)
    • Service Stats (Grooper.GPT.AISearch+ServiceStats)
    • Stats Query (Grooper.Core.StatsQuery)
    • Subset Filter (Grooper.GPT.SubsetFilter)
    • Table Header Detector (Grooper.Extract.TableHeaderDetector)
    • Table Mapping (Grooper.Activities.TableMapping)
    • Table Row Detector (Grooper.Extract.TableRowDetector)
    • Text Preprocessor (Grooper.Core.TextPreprocessor)
    • Type Permissions (Grooper.TypePermissions)
    • Value Lookup (Grooper.Extract.ValueLookup)
      • Group Options (Grooper.Extract.GroupOptions)
    • Value Selector (Grooper.Cloud.ValueSelector)
    • Variable Definition (Grooper.Core.VariableDefinition)
    • Vector Search Options (Grooper.GPT.VectorSearchOptions)
    • Vertical Tab Marker (Grooper.Core.VerticalTabMarker)
    • Virtual Table Definition (Grooper.Core.VirtualTableDefinition)
    • XML Value Selector (Grooper.EDI.XMLValueSelector)
  • Import Provider (Grooper.Core.ImportProvider)
    • CMIS Import Base (Grooper.CMIS.CmisImportBase)
      • Import Descendants (Grooper.CMIS.ImportDescendants)
      • Import Query Results (Grooper.CMIS.ImportQueryResults)
    • File Import (Grooper.Core.FileImport)
      • File System Import (Grooper.Core.FileSystemImport)
      • FTP Import (Grooper.Messaging.FtpImport)
      • SFTP Import (Grooper.Messaging.SftpImport)
    • HTTP Import (Grooper.Messaging.HTTPImport)
    • Mail Import (Grooper.Messaging.MailImport)
    • OPEX Import (Grooper.Core.OxiImport)
    • Search Import (Grooper.GPT.SearchImport)
    • Test Batch (Grooper.Core.TestBatchImport)
  • Node (Grooper.GrooperNode)
    • AI Assistant (Grooper.GPT.AIAssistant)
    • Batch Object (Grooper.Core.BatchObject)
      • Batch Folder (Grooper.Core.BatchFolder)
        • Batch (Grooper.Core.Batch)
      • Batch Page (Grooper.Core.BatchPage)
    • Batch Process (Grooper.Core.BatchProcess)
    • Batch Process Step (Grooper.Core.BatchProcessStep)
    • CMIS Connection (Grooper.CMIS.CmisConnection)
    • CMIS Repository (Grooper.CMIS.CmisRepository)
    • Content Type (Grooper.Core.ContentType)
      • Content Category (Grooper.Core.ContentCategory)
      • Content Model (Grooper.Core.ContentModel)
      • Document Type (Grooper.Core.DocumentType)
      • Form Type (Grooper.Core.FormType)
      • Page Type (Grooper.Core.PageType)
    • Control Sheet (Grooper.Capture.ControlSheet)
    • Data Connection (Grooper.Core.DataConnection)
    • Data Element (Grooper.Core.DataElement)
      • Data Field (Grooper.Core.DataField)
        • Data Column (Grooper.Core.DataColumn)
      • Data Field Container (Grooper.Core.DataFieldContainer)
        • Data Element Container (Grooper.Core.DataElementContainer)
          • Data Model (Grooper.Core.DataModel)
          • Data Section (Grooper.Core.DataSection)
        • Data Table (Grooper.Core.DataTable)
    • Data Rule (Grooper.Core.DataRule)
    • Extractor Node (Grooper.Core.ExtractorNode)
      • Data Type (Grooper.Extract.DataType)
      • Field Class (Grooper.Extract.FieldClass)
      • Value Reader (Grooper.Extract.ValueReader)
    • File Store (Grooper.FileStore)
    • Folder (Grooper.Folder)
      • Batches Folder (Grooper.Core.BatchesFolder)
      • Local Resources Folder (Grooper.Core.LocalResourcesFolder)
      • Machines (Grooper.MachinesFolder)
      • Projects Folder (Grooper.ProjectsFolder)
    • IP Element (Grooper.IP.IpElement)
      • IP Step Container (Error - Report error to groopereducation@bisok.com)
        • IP Group (Grooper.IP.IpGroup)
        • IP Profile (Grooper.IP.IpProfile)
      • IP Step (Grooper.IP.IpStep)
    • Lexicon (Grooper.Core.Lexicon)
    • Machine (Grooper.Machine)
    • Object Library (Grooper.ObjectLibrary)
    • OCR Profile (Grooper.OCR.OcrProfile)
    • Project (Grooper.Project)
    • Resource File (Grooper.ResourceFile)
    • Root (Grooper.GrooperRoot)
    • Scanner Profile (Grooper.Capture.ScannerProfile)
    • Separation Profile (Grooper.Capture.SeparationProfile)
    • Training Page (Grooper.Core.TrainingPage)
    • Work Queue (Grooper.Core.WorkQueue)
      • Processing Queue (Grooper.Core.ThreadPool)
      • Review Queue (Grooper.Core.ReviewQueue)
  • Node Query (Grooper.Core.NodeQuery)
  • Purge Folder (Grooper.GrooperRoot+SystemMaintenance+PurgeFolder)
  • Search Index Query (Grooper.GPT.SearchIndexQuery)
  • Task Filter (Grooper.Core.TaskFilter)
    • Attended Task Filter (Grooper.Core.AttendedTaskFilter)
    • Unattended Task Filter (Grooper.Core.UnattendedTaskFilter)