- Overview
- Help Status
-
Activity
- Attended Activity
-
Code Activity
- Apply Rules
- Attach
- Batch Transfer
- Burst Book
- Classify
- Clip Frames
- Convert Data
- Correct
- Deduplicate
- Detect Frames
- Detect Language
- Detect Language (Legacy)
- Dispose Batch
- Execute
- Export
- Extract
- Fill Data
- GPT Embed
- Image Processing
- Initialize Card
- Launch Process
- Mark Attachments
- Merge
- Recognize
- Redact
- Remove Level
- Render
- Route
- Send Mail
- Separate
- Spawn Batch
- Split Pages
- Split Text
- Text Transform
- Train Lexicon
- Translate
- XML Transform
-
Article
- AI Assistants
- AI Powered Features
- Batch Processing Workflows
- Document Scanning
- PDF Processing
- Search Overview
- Attachment Type
- Behavior
- Capture Device
- Classify Method
- CMIS Binding
- CMISQL Element
- Collation Provider
-
Command
- Action List - Create Copy Actions
- AI Chat
- Attachment Type
- Batch
-
Batch Folder
- Batch Folder - Add To Index
- Batch Folder - Assign Document Type
- Batch Folder - Classify Command
- Batch Folder - Collapse
- Batch Folder - Edit Type Assignment
- Batch Folder - Extract
- Batch Folder - Group Children
- Batch Folder - Insert Control Sheets
- Batch Folder - New Text Document
- Batch Folder - Remove From Index
- Batch Folder - Remove Level
- Batch Folder - Revert To Loose Pages
- Batch Folder - Set Field Value
- Batch Folder - Sort Children
- Batch Object
- Batch Page
- Batch Process
- CMIS Connection
- CMIS Document Link
- CMIS Export Map - Auto Map
- CMIS Folder Link
- CMIS Import Map - Auto Map
- CMIS Repository - Reset
- CMIS Type Definition - Generate Local Type
- Column Map - Auto Map
- Content Link - Remove Link
-
Content Type
- Content Type - Clean Overrides
- Content Type - Create Data Model
- Content Type - Create Local Resources Folder
- Content Type - Create Search Index
- Content Type - Delete Search Index
- Content Type - Generate Control Sheets
- Content Type - Purge Training
- Content Type - Rebuild Training
- Content Type - Submit Indexing Job
- Convert Data - Create Convert Actions
- Copy Base
- Data Connection
- Data Element - Remove Overrides
- Data Field Container
- Data Type - Convert To Value Reader
- EDI File
- Excel Document - Convert to CSV
- Exchange - Rebuild Search Folder
- Field Class - Purge Training
- File Store
- File System Link
- Folder - Remove Empty Subfolders
- FTP Link
- HTML Document
- HTTP Link
- JSON File
- Lexicon
- Machine - Tune File System
- Mail Link
- Mail Message
- Node
- OAuth Client Credentials - Test
- Object Library
- PDF Document
- Project - Remove Empty Subfolders
- PST File - Burst
- PST Link - Load Content
- Resource File
- Root
- Saved Query
- Search Index - Generate Subsets
- SFTP Link
- Text Document
- Value Reader - Convert To Data Type
- vCard - Expand Photo
- Word Document - Convert to PDF
- XML File
- ZIP Archive
- ZIP Link - Load Content
- Content Link
- Data Action
- Data Instance
- Export Definition
- Export Format
- Grooper Command Console (GCC)
- Import Definition
- Import Provider
-
IP Command
- Adjust Saturation
- Adjust Tint
- Analyze Photo
- Auto Adjust Levels
- Auto Color Balance
- Auto Convert
- Auto Deskew
- Auto Orient
- Auto QA
- Auto White Balance
- Barcode Detection
- Binarize
- Blank Page Detection
- Border Detect
- Box Detection
- Brightness Contrast
- Classify Image
- Color Detection
- Color Dropout
- Color Stamp Detection
- Colorize
- Compute Moments
- Contrast Stretch
- Convert
- Corner Detection
- Crop
- Dilate Erode
- Edge Detection
- Execute Profile
- Extract Channel
- Extract Features
- Extract Page
- Feature Dropout
- Filter
- Gamma Adjust
- Histogram
- Hough Lines
- Invert
- Line Detection
- Measure Entropy
- Mirror
- Negative Region Removal
- OCR Cleanup
- Patch Code Detection
- Posterize
- Projection Profile
- Randomize Defects
- Resize
- Rotate
- Shade Removal
- Shape Detection
- Solarize
- Sticky Note Detection
- Swap Channels
- Undistort
- Warp
- Lookup Specification
- Measurement
-
Node
- AI Assistant
- Batch Object
- Batch Process
- Batch Process Step
- CMIS Connection
- CMIS Repository
- Content Type
- Control Sheet
- Data Connection
- Data Element
- Data Rule
- Extractor Node
- File Store
- Folder
- IP Element
- Lexicon
- Machine
- Object Library
- OCR Profile
- Project
- Resource File
- Root
- Scanner Profile
- Separation Profile
- Training Page
- Work Queue
- OCR Engine
-
Property Converter
- Auto Deskew - Precision Converter
- Base Multi Culture Converter
- Blank Zero Converter
- Check List Converter
- CMIS Export Map - Column Converter
- CMIS Folder Reference - Converter
- CMIS Import Map - Field Converter
- CMIS Object - Choice Converter
- Code Expression - Converter
- Collection Converter
- Column Map - Column Converter
- Content Type - Unlimited Converter
- Degrees Converter
- Execute Command - Link Name Converter
-
Expandable Converter
- Base Culture Converter
- Batch Name Settings - Converter
- Border - Converter
-
Choice Converter
- Activity Processing - Queue Converter
- AI Chat Filter - Index Converter
- AI Search - Api Version Converter
- Apply Image Cleanup - Ip Profile Converter
- Azure OCR - Api Version Converter
- Azure OCR - Model Version Converter
- Barcode Extractor - Output Group Converter
- Base Combining Provider - Group Name Converter
- Batch - Step Converter
- Batch Process - Queue Converter
- Batch Process Step - Processing Scope Converter
- Batch Process Step - Queue Converter
- Batch Transfer - Process Converter
- Batch Transfer - Repository Converter
- Batch Transfer - Step Converter
- Build Fine Tuning File - Fill Method Converter
- Chat Filter - User Id Converter
- Chat Filter - User Name Converter
- Classify - Classification Level Converter
- Classify - Output Level Converter
- CMIS Export - Creatable Child Type Converter
- CMIS Export - Creatable Folder Converter
- CMIS Type Reference - Cmis Type Converter
- CMISQL Element - Qrderable Property Converter
- CMISQL Element - Queryable Property Converter
- CMISQL Element - Selectable Property Converter
- CMISQL Query - Primary Type Converter
- ColorTrac Scanner - Resolution Converter
- Comparison Filter - Function Name Converter
- Comparison Filter - Operand Type Converter
- Comparison Filter - Value Type Converter
- Comparison Predicate - Comp Op Converter
- Comparison Predicate - Value Converter
- Data Element - Display Label Converter
- Data Field - Sub Element Converter
- Database Table - Extended Property Name Converter
- Database Table - Table Name Converter
- EDI Schema Importer - X12Schema Converter
- Fill - Fill Method Converter
- Fill Data - Name Converter
- Fill Descendants - Name Converter
- Flag Item - Flag Reason Converter
- Generate Local Type - Doc Type Property Converter
- Import Provider - Disposition Converter
- Import Repository - Repository Converter
- ISIS Device - Device Name Converter
- Join Clause - Secondary Type Converter
- Label Info - Parent Label Converter
- Lexicon Lookup - Lookup Field Converter
- Lexicon Lookup - Target Field Converter
- Nested Table - Table Converter
- ODBC - Pg Odbc Dsn Converter
- Pattern-Based - Group Name Converter
- PDF Data Mapping - Font Name Converter
- Predicate List - Logical Operator Converter
- Read Metadata - Property Name Converter
- Reference - Group Name Converter
- Regular Expression - Group Converter
- Remove From Index - Index Name Converter
- Remove Overrides - Property Name Converter
- Reset - Step Converter
- Root - License Url Converter
- Route Definition - Process Converter
- Run Step - Step Converter
- Schema Mapping - Schema Name Converter
- Search Index - Index Name Converter
- Search Index Query - Index Name Converter
- Send To Test Batch - Flag Reason Converter
- Set Field Value - Value Converter
- String - Pdf Font Name Converter
- Task Filter - Activity Name Converter
- Task Filter - Process Name Converter
- Task Filter - Queue Converter
- Task Filter - Step Name Converter
- Text Document - Encoding Converter
- Text Document - Normalize Encoding Converter
- TWAIN Device - Compression Mode Converter
- TWAIN Device - Device Name Converter
- Update Process - Process Converter
- Update Process - Step Converter
- Value Selector - Target Field Converter
- XML Value Selector - Target Field Converter
- Double Range - Double Range Converter
- Expandable Info Converter
- Integer Range - Integer Range Converter
- Logical Border - Arrow Converter
- Logical Border - Logical Border Converter
- Logical Point - Logical Point Converter
- Logical Rectangle - Logical Rectangle Converter
- Logical Size - Logical Size Converter
- On Off Converter
- Percent Range - Percent Range Converter
- Point ExF - Converter
- Rectangle - Converter
-
Type Selector
- CMISQL Query - Where Element Converter
- Data Connection - Connection Converter
- Exchange - Auth Method Converter
- Execute - Command Converter
- Execute Activity - Activity Converter
- Execute Command - Command Converter
- Run Activity - Activity Converter
- SharePoint - Auth Method Converter
- Storage Type - Converter
- Web Service Lookup - Auth Method Converter
- Unit Border - Unit Border Converter
- Unit Line Length - Unit Line Length Converter
- Unit Point - Unit Point Converter
- Unit Range - Unit Range Converter
- Unit Rectangle - Converter
- Unit Size - Unit Size Converter
- Value Extractor - Converter
- JPEG 2000 - Ratio Converter
- Logical Value - Simple Value Converter
- Logical Value - Universal Value Converter
- Node Information - Value Converter
- Page Filter Converter
- Path Expression - Converter
- Percent Converter
- Pg Dictionary Converter
- Pg Flags Converter
- Pg Ref Collection Converter
- Pg String Collection Converter
- Pg Type Display Name Converter
- Product License - Quantity Converter
- Read Only Converter
- Rectangle - Inches Converter
-
Simple Converter
- Click to Edit Converter
- Data Action - Source Element Converter
- Data Action - Target Element Converter
- IN Predicate - In Predicate Values Converter
- OAuth Authentication - Login Converter
- Pattern Match - Group Options Converter
- Pg Format Converter
- Product License - Quantity Used Converter
- Project - Projects Converter
- Publish To Repository - Repository Converter
- Result Set Options - Sort Order Converter
- Review - View List Converter
- Stats Query - Name List Converter
- String - Pg Text Lines Converter
- Type Permissions - Command Converter
- Word Match - Term Options Converter
- Text Rendering - Size Converter
- Time Range Converter
- Time Ranges Converter
- Time Span Converter HMS
- Timer Service - Time Converter
- Times Converter
- Unit Value - Unit Value Converter
- Word Match - Integer Range Converter
-
Property Editor
- Anchor Definition - Location Editor
- Barcode Detected - Preview Image Editor
-
Choice Property Editor
- Azure Document Intelligence OCR - Model Editor
- Base Culture Editor
-
Check List Editor
- AI Assistant - Search Index Editor
- AI Table Reader - Included Columns Editor
- Batch Filter - Activity Editor
- Batch Filter - Process Editor
- Batch Filter - Status Editor
- Batch Filter - Step Editor
- CMIS Type Reference - Secondary Types Editor
- Data Fill Method - Included Children Editor
- Delete Fine Tuned Model - Models Editor
- Generate Local Type - Property Check List
- IMAP - folder Editor
- Publish To Repository - Repository Editor
- Rebuild Indexes - Table Names Editor
- Reset - Step Checklist Editor
- Stats Query - Name List Editor
- Table Mapping - Column Check List
- Text Analysis - Entity Type Editor
- Type Permissions - Command Editor
- Data Connection - Table Name Editor
- Delete Fine Tuned Model - Model Editor
- GPT Embed - Embeddings Model Editor
- LLM Connector - Chat Model Editor
- LLM Connector - Embeddings Model Editor
- Return Value - Column Editor
- SQL Server - Database Name Editor
- Start Fine Tuning Job - Model Editor
- CMIS Compound Type - Editor
- CMISQL Query - Query Editor
-
Code Property Editor
- AI Chat Filter - Filter Editor
- AI Schema Extractor - Schema Editor
- Ask AI - Schema Editor
-
Code Expression Editor
- Batch Process Step - Next Step Editor
- Batch Process Step - Should Submit Editor
- Calculate Value - Value Expression Editor
- CMIS Export Map - Expression Editor
- CMIS Import Map - Expression Editor
- Code Expression - Editor
- Column Map - Expression Editor
- Computed Field - Expression Editor
- Concat - Trigger Editor
- Content Type - Caption Editor
- Copy Base - Trigger Editor
- Custom Statement - Statement Editor
- Data Export - Alternate Database Editor
- Data Field - Default Value Editor
- Data Field - Field Expression Editor
- Data Rule - Trigger Editor
- Data Section - Caption Editor
- Expression Set - Default Value Editor
- Expression Set - Field Expression Editor
- IP Element - Next Step Editor
- IP Element - Should Execute Editor
- Lookup Specification - Trigger Editor
- Metadata Options - Value Editor
- Path Expression - Editor
- Raise Issue - Log Message Editor
- Remove - Trigger Editor
- Require Value - Log Message Editor
- Text Transform - Record Editor
- Variable Definition - Expression Editor
- Create Table - Statement Editor
- Data Field Container - Css Editor
- Database Lookup - SQL Query Editor
- Embedded Lexicon - Local Entries Editor
- Json Property Editor
- KVP Editor
- Lexicon - Lexicon Link Code Editor
- List Match - Local Entries Editor
- Mail Import - IMAP Query Editor
- Pattern Match - Output Format Editor
- Regex Property Editor
- Search Classifier - Filter Editor
- Search Index - Filter Editor
- Search Index Query - Filter Editor
- Search Index Query - Order By Editor
- Search Index Query - Search Editor
- Send Mail - Template Editor
- String List Editor
- Submit Indexing Job - Select Editor
- Subset Filter - Filter Editor
- Text Property Editor
- Web Service - Header Editor
- Web Service Lookup - Post Data Editor
- Web Service Lookup - Url Editor
- Word Match - Output Format Editor
- XML Lookup - Selector Editor
- XML Transform - Transform Editor
- XML Value Selector - Path Editor
- Folder Browse Editor
- LDAP - ACL Editor
- OAuth Authentication - Login Editor
- Object Collection Editor
- Object Properties Editor
- Open File Editor
-
Reference Editor Base
-
Node Reference Editor
- Archive - Folder Editor
- Batch Process Step Editor
- Content Type Editor
- Custom Statement - Scope Editor
- Data Action - Action Element Editor
- Data Action - Source Editor
- Data Action - Target Editor
- Data Field Container - Rule Editor
- Data Rule - Scope Editor
- Database Cleanup - Folder Editor
- Dispose Batch - Target Folder Editor
- Execute Rule - Rule Editor
- Field Match - Field Editor
- Generate Subsets - Field Editor
- Grid Layout - Header Column Editor
- Piece Info Options - Key Column Editor
- Piece Info Options - Value Column Editor
- Return Value - Field Editor
- Set Field Value - Field Editor
- Table Mapping - Scope Editor
- Task Filter - Batch Editor
- Test Batch Editor
- Text Transform - Scope Editor
- Train Lexicon - Scope Editor
- Virtual Table Definition - Collection Editor
- Web Service - Definition File Editor
- Ordered Reference Editor
-
Reference List Editor
- All Nodes Reference Editor
- Behavior - Field List Editor
- Bookmark Options - Data Element Editor
- Build Fine Tuning File - Batch Editor
- Content Types Editor
- Correct - Fields Editor
- Data Fill Method - Included Descendants Editor
- Data Model - Style Sheets Editor
- Data Rule - Required Elements Editor
- Data Values - Included Elements Editor
- Extract - Data Element Filter Editor
- Indexing Behavior - Included Elements Editor
- JSON Data Mapping - Included Elements Editor
- Lexicon - Lexicons Editor
- Piece Info Options - Element Editor
- Project - Projects Editor
- Redact - Extractors Editor
- Redact - Fields Editor
- Require Value - Required Elements Editor
- Section Extract Method - Included Descendants Editor
- Thumbnail View - IP Profiles Editor
- Transaction Detection - Field List Editor
-
Node Reference Editor
- Sample Image Collection - Editor
- Value Extractor - Editor
- Zone Editor
- Schema Importer
- Section Extract Method
- Separation Provider
- Service Instance
- Storage Type
- Table Extract Method
- Task View
-
UI Element
-
Control
- Active Task List
- AI Helper
- Batch Info Tab
- Batch Info Viewer
- Batch List
- Batch Manager
- Candidate List
- Card List
- Chat Console
- Class Help
- CMIS Repository Searcher
- CMIS Tree Browser
- CMIS Type Tree
- Code Editor
- Complete List
- Content Viewer
- Context Menu
- Conversation Viewer
- Data Element Tester
- Data Grid
- Data Grid Document
- Data Grid Element
- Data Inspector
- Data Tree
-
Design Tab
- AI Assistant - Chat History
- Batch
- Batch Folder - General
- Batch Page - General
- Batch Process
- Batch Process Step
- CMIS Connection - General
- CMIS Repository
- Content Type
- Control Sheet - General
- Data Connection - General
- Data Element
- Data Rule - Tester
- Extractor Node - Tester
- Field Class - Weightings
- Folder - Batches
- IP Element Container - Tester
- IP Step - Tester
- Lexicon - General
- Machines
- Node
- OCR Profile - Tester
- Processing Queue - Workers
- Project - Usage
- Resource File - General
- Root
- Training Page - General
- Design Tab Host
- Diagnostics Viewer
- Document Searcher
- Document Viewer
- Expression Grid
- Extractor Builder
- FRX Grid
- FRX Visualizer
- Image Editor
- Image Print Preview
- Image Viewer
- Instance Searcher
- Label Set Editor
- List Searcher
- Lookup Fields
- Lookup Results
- Node Finder
- Node Report
- Object List
- OCR Viewer
- Page Navigator
- Profile Browser
- Property Grid
-
Property Grid Editor
- ACL Editor
- Anchor Editor
- Choice Editor
- CMIS Query Editor
- Code Property Editor
- Collation Editor
- Collection Editor
- Extractor Property Editor
- Folder Editor
- List Editor
- Multi Reference Editor
- OAuth Log-in Editor
- Object Editor
- Ordered Reference Editor
- Preview Image Editor
- Reference Editor
- Sample Image Editor
- Zone Editor
- Property Help
- Query Editor
- Query Helper
- Query List
- Recognition Tester
- Rep Info Panel
- Review Tab
- Search Result Cards
- Separation List
- Service Collection
- Splitter
- Stats Report
- Stats Result Set
- Stats Viewer
- Tab List
- Task List
- Test Source
- Tree Viewer
- Upload Dialog
- Weightings List
- Web Page
-
Control
- Value Extractor
- Variable Provider
-
Other Configuration Types
- API Key
- Archive Info
- Border
- Capture Settings
- Character Class Filter
- Chat Parameters
- CMIS Object
- CMIS Property Definition
- Code39Settings
-
Connected Object
- Batch Filter
- Chat Filter
- Database Row
-
Embedded Object
- AI Chat Filter
- AI Chat Settings
- AI Generator
- Anchor Definition
- Attachment Rule
- Auto Complete Settings
- Barcode Reader
- Batch Creation Settings
- Batch Name Settings
- Bookmark Options
- Bot Connector
- Boundary Detector
- Chunk Settings
- Cluster Parameters
- CMIS Export Map
- CMIS Folder Reference
- CMIS Import Map
- CMIS Type Definition
- CMIS Type Reference
- Code Expression
- Column Map
- Command Options
- Computed Field
- Content Mapping
- Custom Statement
- Data Element Extension
- Data Element Profile
- Data Fill Method
- Data Generator
- Edge Adjustment
- Embedded Lexicon
- Environment Options
- Execute Step
- Expression Set
- Field Annotation
- Field Mapping
- File Reference
- Folder Level Info
- FRX Options
- FTP Repository Configuration
- Fuzzy Lookup Options
- Horizontal Tab Marker
- HTTP Auth Method
- HTTP Resource
- Hyperlink Selector
- Image Segmentation Options
- Import Schedule
- Index Stats
- Label Info
- Label Set
- Label Version
- Layout Provider
- Line Periodicity Detector
- LLM Provider
- Lucene Query
- Metadata Options
- Multiline Row Settings
- OCR Layer
- OCR Repair Options
- OMR Box
- Page Attachment Rule
- Paragraph Marker
- Path Expression
- PDF Expand Method
- Permission Set
- Piece Info Options
- Quoting Method
- Region Definition
- Repository Configuration
- Repository Option
- Resource Reference
- Result Filter
- Result Processor
- Result Set Options
- Return Value
- Route Definition
- Sample Image Collection
- Schema Mapping
- Search Filter
- Separate Action
- Service Deployment
- Service Stats
- Stats Query
- Subset Filter
- Table Header Detector
- Table Mapping
- Table Row Detector
- Text Preprocessor
- Transaction Extractor
- Type Permissions
- Value Lookup
- Value Selector
- Variable Definition
- Vector Search Options
- Vertical Tab Marker
- Virtual Table Definition
- XML Value Selector
- Node Query
- Purge Folder
- Search Index Query
- Task Filter
- Constrained Wrap Options
- Culture Data
- Dash Detector
- Database Connection Settings
- Defect Generator
- Double Range
- Dropout Method
- Event Filter
- Fiche Card Layout
- Folder Level Options
- Horizontal Alignment Settings
- HTTP Authentication Method
- Image Compression
- Image Info
- Integer Range
- Line Snap Options
- Margin Detector
- Multi Line Settings
- Node Information
- PDF Burst Settings
- PDF Page Generator
- PDF Render Settings
- Percent Range
- Rectangle
- Region Detector
- Regular Expression
- Remote Repository
- Row Alignment Settings
- Scan Once Settings
- Semantic Quoting Query
- SFTP Repository Configuration
- Shell Execute Info
- Sort Specification
- System Config
- Text Wrap Options
- TIFF Page
- Transaction Layout Detection
- Vertical Wrap Detection
- Advanced Topics
-
Enumerations
-
Grooper
- CharacterCasing
- ConcurrencyMode
- DatabaseStatus
- DCTModes
- EventType
- NodeAttributes
- Pages
- PixelFormat
- ProcessingScope
- ProcessingStatus
- ResultOrder
- SimplePixelFormat
-
Grooper.Activities
- ActionType
- BatchDisposition
- BatchNameSuffixEnum
- BodyRenderingMethod
- ComparisonMode
- DuplicateDisposition
- ExecuteType
- ExecutionScope
- ExtractMode
- FilterType
- MatchActions
- OcrAssistMode
- PageExtractMode
- ProblemDisposition
- ReclassifyModes
- RepairScope
- RouteMethod
- SaveDisposition
- SharedBehaviorModes
- SpawnMethod
- StatsLoggingMode
- TextExtractMode
- TrainingScope
- XmlSource
- XmlTarget
-
Grooper.Capture
- FeedOrientation
- ImportType
- MissDispositionEnum
- PageDirection
- ScanningSpeed
- TwainCompressionModes
-
Grooper.Capture.ColorTrac
- ColorFormat
- PageSizeMode
- PaperEndCondition
- PaperJustification
- ScanSpeed
- StandardPageSize
-
Grooper.Cloud
- ApiRegionEnum
- ContentLayout
- HttpVerbs
- MessageFormats
- MetadataModes
- TranslateDisposition
-
Grooper.CMIS
- AuthenticationProvider
- CmisProtocol
- ImportModes
- LoadScope
- NamingMethods
- OrderByDirection
- TransferScopes
-
Grooper.Core
- ActivateModes
- ArrayActions
- AttachmentPosition
- BrowserSuggestMode
- CalculateModes
- CalculateModes
- CaptureScope
- ClassificationLevel
- CompareMode
- ConflictDispositions
- ConflictResolution
- ControlCharacters
- CreateModes
- DedupMode
- DispositionType
- DuplicateFilenameResolution
- FolderRelativePosition
- FolderRelativePosition
- FooterModes
- FormatOptions
- FuzzyMatchMode
- GroupingColumn
- IdfModes
- IssueDisposition
- JsonLayout
- LexiconType
- MergeModes
- MissDispositions
- MissDispositions
- NumberFormats
- OxiElement
- PaginationType
- ParagraphOptions
- PdfBuildOptions
- PopulationMethod
- ProcessingLevel
- PropagationMode
- SegmentType
- SortColumns
- SortDirection
- SortDirections
- SortDirections
- SortOption
- SortOrder
- StandardWeightings
- TabOptions
- TaskScope
- TfModes
- TimeFrames
- TimeGrouping
- TrainingScopes
- TriggerModes
- TypeKind
- TypeModes
- TypeOperation
- UserTrainingMode
- ValueInterpretations
- ZIPDispositions
-
Grooper.EDI
- AttachmentNamingMethods
- DataDisposition
- NamingMethods
- NamingMethods
-
Grooper.Extract
- AdjustmentMethod
- AlignmentMode
- CollationType
- CombineType
- CompassDirection
- ConfidenceModes
- ContextScopes
- CultureScopes
- ExecutionScope
- FlowDirection
- GroupingType
- HorizontalDataAlignment
- HorizontalDataAlignment
- LabelLayout
- LookupOption
- MappingType
- OmrBoxDirection
- OmrFlowDirection
- OmrMode
- OutputValueOptions
- ReadDirection
- ReadMethods
- ReferencePointPosition
- ROIModes
- RowDetectionMode
- RowMatchOptions
- SecondaryExtractMethod
- SecondaryExtractTrigger
- SplitPositionEnum
- TableRowAlignment
- TableStyles
- VerticalDataAlignment
- WordTransform
-
Grooper.GPT
- AuthorizationMethod
- BooleanOperator
- BuiltInFieldKinds
- DocumentLinkingOptions
- FieldAlignMode
- IndexOperations
- LambdaFunction
- LayoutComponentTypes
- OperationType
- QueryTypes
- ReasoningEffortLevels
- ResultOrder
- RetrievalOptions
- RowAlignMode
- SearchModes
- SectionAlignMode
- ServiceTiers
- VerbosityLevels
-
Grooper.IP
- AdaptiveKernelType
- AngleCategory
- Axis
- BinarizationMethod
- ChannelNumber
- Code39Options
- ColorSpaceType
- CombDetectionType
- CompressionMode
- Connectivity
- CropMethod
- CurveType
- DetectMethod
- FeatureType
- FillMethod
- FilteringLevel
- FilterTypeEnum
- HarrisFilterType
- HoughLevel
- ImageEdges
- InpaintMethod
- MaskShape
- MaskSize
- MeasurementType
- Method
- OneDimSymbology
- OperationType
- OperationType
- Pdf417Options
- PostSymbology
- ProcessingResolution
- ProgressionOrder
- ReadDirection
- ReadingQuality
- ResizeInterpolationMode
- SizeMethod
- Symbology
- TwoDimSymbology
- WarpInterpolationMode
-
Grooper.Messaging
- BodyHandling
- Orientation
- PaperKind
- SaveAction
- SelectorKind
-
Grooper.OCR
- AccuracyLevels
- BaseCharacterSetEnum
- DetectionMethod
- EngineModeEnum
- FontPitchMode
- LexMode
- PageOrientation
- PageOrientation
- SegmentationModeEnum
- SynthesisMethodEnum
-
Grooper.Office
- SaveMethod
-
Grooper.PDF
- CompressionMode
- ImageLayout
- PDFAComplianceLevels
- PdfBorderStyle
- PdfDisplayMode
- PdfPermissions
- PdfViewerOptions
- SearchableTextFormat
- TargetColorFormat
-
Grooper.Services
- DaysOfWeek
-
Grooper.Services.CMIS
- ConnectMethod
- ContentMode
- FileType
- FormOverlayType
- MergeAction
-
Miscellaneous
- BaseTypeId
- CharacterCasing
- CompressionLevel
- ContentAlignment
- DateTimeStyles
- FileAttributes
- FontStyle
- Formatting
- HorizontalAlignment
- Keys
- NumberStyles
- RegexOptions
- ThreadPriority
- UriKind
-
Grooper
Burst Book
Extracts individual page images from a photograph of a book, automatically splitting, cropping, and dewarping pages for downstream processing.
Remarks
The Burst Book activity transforms photographs of open books into clean, individual page images suitable for extraction, OCR, and review. It is designed for use in Batch Process workflows where books are photographed rather than scanned, and pages must be separated and corrected for curvature and perspective.
Overview
BurstBook can be executed at either the Batch Folder or Batch Page level:
-
Folder-Level:
Processes a photograph of an open book (typically showing two pages), splitting it into separate page images. The input must be a photograph of a book on a solid black background. The photograph may show both pages, or one page may be covered with a black sheet. -
Page-Level:
Processes a single page photograph, dewarping and cropping the image so the page edges align with the image boundaries. The input should be a photograph of a single book page on a solid black background.
How It Works
BurstBook performs a series of image processing steps to extract high-quality page images:
-
Preprocessing:
The input image is resized to the configured resolution and optionally cropped to remove inconsistent borders using the 'Border Crop' property. -
Background Detection:
The black background is analyzed to determine the bounds of the book. The 'Max Background Noise' property controls tolerance for non-black pixels. -
Page Splitting:
For two-page images, the photograph is split into left and right pages. Margin detection and gutter analysis are used to accurately separate pages, even when a visible gutter is present. -
Dewarping and Curvature Correction:
Each page image is dewarped using edge and contour detection, correcting for perspective and page curvature. The 'Edge Threshold' property controls sensitivity for edge detection, and the 'Corner Radius' property can be set to handle rounded page corners. -
Output:
The resulting page images are saved as new Batch Pages (folder-level) or replace the original image (page-level), with resolution and size adjusted to match the configured 'Page Size'.
Configuration Guidance
-
Input Requirements:
- Use a solid black background for best results.
- Ensure the book is fully visible and not too close to the image edge.
- For two-page mode, one page may be covered with a black sheet if only one page should be extracted.
-
Tuning Properties:
- Adjust 'Resolution' to match the original photograph's DPI.
- Set 'Page Size' to the physical dimensions of a single book page.
- Use 'Border Crop' to remove inconsistent or non-black edges.
- Set 'Corner Radius' if the book pages have rounded corners.
- Lower 'Edge Threshold' for more sensitive edge detection; increase to ignore faint edges.
- Increase 'Max Background Noise' if the background is not perfectly black.
-
Diagnostics:
Enable diagnostic mode to review intermediate images and logs, which assist in tuning and troubleshooting.
Typical Workflow
- Photograph the book on a solid black background.
- Attach the photograph to a Batch Folder or Batch Page.
- Configure BurstBook properties as needed.
- Run the activity at the folder or page level.
- Review diagnostic images to verify page extraction and dewarping.
Diagnostic Artifacts
When diagnostics are enabled, BurstBook generates the following artifacts to assist with configuration and troubleshooting:
- Border Crop:
Shows the effect of the 'Border Crop' property on the input image. - Crop Profile:
Displays the projection profile used for background detection and cropping. - Bounds:
Highlights the detected book bounds on the original image. - Cropped:
Shows the image after cropping to the detected book area. - Page Extraction:
Logs the timing and steps of page extraction. - Margin Detection:
Visualizes detected margins used for splitting two-page images. - Gutter:
Annotates the detected gutter (if present) between pages. - Warp1, WarpY, WarpX:
Show intermediate and final dewarped images during curvature correction. - Contours Y:
Displays the detected top and bottom contours of the page(s). - Filled:
Shows the binarized image with gaps filled for contour detection. - Output image(s):
The final extracted and dewarped page images.
Review these artifacts in the diagnostics viewer to fine-tune property values and ensure optimal extraction results.
Usage Notes
- BurstBook is intended for use with photographs, not scanned images.
- For best results, use consistent lighting and avoid shadows or reflections.
- If extraction fails or produces poor results, review diagnostic images and adjust property values as needed.
- This activity is typically used as part of a Batch Process Step in automated workflows, but can also be run manually for testing and tuning.
Properties
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| General | ||||||||||||||||||||||
| Resolution | Int32 | ► |
The approximate resolution of the original photograph, in dots per inch (DPI).
300
100
600
The 'Resolution' property specifies the DPI (dots per inch) to which the input photograph will be normalized before processing. This ensures that all subsequent measurements and transformations are performed at a consistent scale, regardless of the original image's resolution metadata. Configuration Guidance
Impact
> Tip: If page dimensions or curvature correction appear distorted, verify that 'Resolution' matches the actual DPI of > your photographs. |
|||||||||||||||||||
| Page Size | Logical Size | ► |
The physical size of a single book page, used to scale and dewarp output images. The 'Page Size' property defines the real-world dimensions of a single book page. This information is used to calculate the correct aspect ratio and scaling for dewarped output images, ensuring that each extracted Batch Page matches the intended physical size. Configuration Guidance
Impact
> Example: |
|||||||||||||||||||
| Border Crop | Logical Border | ► |
The amount of border to crop from the original photograph, removing inconsistent or non-black edges. The 'Border Crop' property allows you to remove a uniform border from all sides of the input photograph before further processing. This is especially useful if the black background is not perfectly consistent, or if there are unwanted artifacts near the image edges. Configuration Guidance
Impact
> Tip: If you see unwanted edges or artifacts in the diagnostic images, increase the border crop value until only the > book and black background remain. |
|||||||||||||||||||
| Corner Radius | String | ► |
The radius used to account for rounded corners on book pages. The 'Corner Radius' property specifies the radius of rounded corners on the book pages, if present. This value is used to adjust contour detection and dewarping, ensuring that the page edges are accurately mapped even when corners are not square. Configuration Guidance
Impact
> Example: |
|||||||||||||||||||
| Edge Threshold | Int32 | ► |
Controls the sensitivity of edge detection during page extraction and dewarping.
8
1
255
The 'Edge Threshold' property determines how sensitive the edge detection algorithm is when identifying the boundaries of the book and its pages. Lower values increase sensitivity, detecting fainter edges; higher values decrease sensitivity, ignoring weaker edges. Configuration Guidance
Impact
> Tip: Use diagnostic images to review detected edges and adjust this value for optimal results. |
|||||||||||||||||||
| Max Background Noise | Double | ► |
The maximum percentage of non-black pixels tolerated in the background during cropping. The 'Max Background Noise' property sets the allowable proportion of non-black pixels in the background area when detecting the book's bounds. This helps accommodate minor imperfections, dust, or lighting variations in the black background. Configuration Guidance
Impact
> Example: |
|||||||||||||||||||
| Margin Detection | Margin Detector | ► |
Configures how the outside margins of an open book are detected in the Burst Book activity. The Margin Detector defines the logic and thresholds used to identify the left and right margins of a book in a photograph, enabling precise splitting of two-page images and improving the accuracy of downstream dewarping and cropping. Margin detection is essential when processing photographs of open books, as it determines where each page begins and ends, even in the presence of gutters, curved pages, or inconsistent backgrounds. The settings in this class allow you to tune margin detection for a wide variety of book layouts, lighting conditions, and photographic artifacts. How Margin Detection Works
Configuration Guidance
Diagnostic ArtifactsWhen diagnostics are enabled, Margin Detector produces the following artifacts to assist with configuration and troubleshooting:
These artifacts are available in the diagnostics viewer and are essential for tuning margin detection in challenging scenarios. Usage Notes
|
|||||||||||||||||||
| Processing Options | ||||||||||||||||||||||
| Error Disposition | IssueDisposition | ► |
Controls how errors are handled when this activity encounters an exception during processing.
Pg Flags Converter
Flag, Log
A combination of the following flags:
The Error Disposition property determines the system's response to errors that occur while executing the activity.
You can combine multiple options using the IssueDisposition flags. |
|||||||||||||||||||
| Maximum Consecutive Errors | Int32 | ► |
The maximum number of consecutive errors allowed before a critical stop is triggered.
0
If the number of consecutive errors reaches this value, a critical stop will occur and the Activity Processing service will halt further processing.
|
|||||||||||||||||||
| Concurrency Mode | ConcurrencyMode | ► |
Specifies the parallel processing mode for this activity.
Multiple
Can be one of the following values:
The Concurrency Mode property determines whether the activity can be executed in parallel across multiple Batch Objects, or if it must run sequentially.
|
|||||||||||||||||||
See Also
Logical SizeLogical BorderMargin Detector
Used By
Batch Process StepProcessing JobBatch Object - Run ActivityExecute Activity
