Command
A Grooper "Command" is an action which can be performed on a specific type of object. Second to Grooper "Activities", Commands are one of the main ways work is performed in Grooper.
Commands can be executed in three ways:
- Command buttons: Commands may executed manually by pressing buttons in various Grooper UIs.
- Example: The "Pause" and "Resume" commands are Batch commands executed from the Batches page by pressing the Pause (pause_circle) and Resume (play_circle) buttons.
- Example: Property Grid configurations in the Design page are saved by pressing the Save (save) button. This executes the "Save" command.
- Context Menu commands: Commands are often accessed in a "context menu" by right-clicking nodes or other objects.
- Example: There are several viewer specific commands executed by users in Review steps. Data Viewer commands are executed by right-clicking Data Element instances in the Data Grid. For example, Data Fields and Data Column cells are confirmed by right clicking them and choosing the "Confirm" command.
- Example: Design users should be very familiar with context menu commands. Even something as simple as adding and deleting nodes in the node tree are done using Grooper commands (the "Add" and "Delete" commands).
- The Execute activity: Several commands are relevant to document processing and can be included in a Batch Process using the Execute activity. This allows users to automate command execution in a Batch Process.
- Example: "Convert to PDF" is a Word Document command required to convert DOC and DOCX files to PDF files. Grooper cannot process Word files natively, but once converted to PDF it can hand it to downstream Activities, such as Recognize, for subsequent processing.
- Example: "Expand Attachments" is a Mail Message command required to process files attached to emails.
Derived Types
The following are all the derived Command types in Grooper. In parenthesis, you will find the commands type name in Grooper and its link to the Grooper Help page.
- AI Chat - Delete (Grooper.GPT.AIChat+DeleteChat)
- AI Chat - Rename (Grooper.GPT.AIChat+Rename)
- Attachment Type - Change Extension (Grooper.Core.MimeTypeHandler+ChangeExtension)
- Attachment Type - Remove Attachment (Grooper.Core.MimeTypeHandler+RemoveAttachment)
- Attachment Type - Remove PDF Version (Grooper.Core.MimeTypeHandler+RemovePdfVersion)
- Attachment Type - Rename Attachment (Grooper.Core.MimeTypeHandler+RenameAttachment)
- Batch - Archive (Grooper.Core.Batch+Archive)
- Batch - Change Priority (Grooper.Core.Batch+ChangePriority)
- Batch - Combine (Grooper.Core.Batch+Combine)
- Batch - Pause (Grooper.Core.Batch+Pause)
- Batch - Remove Job History (Grooper.Core.Batch+RemoveJobHistory)
- Batch - Reset (Grooper.Core.Batch+Reset)
- Batch - Resume (Grooper.Core.Batch+Resume)
- Batch - Send To Production (Grooper.Core.Batch+SendToProduction)
- Batch - Send To Test (Grooper.Core.Batch+SendToTest)
- Batch - Update Process (Grooper.Core.Batch+UpdateProcess)
- Batch Folder - Add To Index (Grooper.GPT.AddToIndex)
- Batch Folder - Assign Document Type (Grooper.Core.BatchFolder+AssignDocumentType)
- Batch Folder - Classify Command (Grooper.Core.BatchFolder+ClassifyCommand)
- Batch Folder - Classify (Grooper.Core.BatchFolder+Classify)
- Batch Folder - Train As (Grooper.Core.BatchFolder+TrainAs)
- Batch Folder - Train From (Grooper.Core.BatchFolder+TrainFrom)
- Batch Folder - Collapse (Grooper.Core.BatchFolder+Collapse)
- Batch Folder - Edit Type Assignment (Grooper.Core.BatchFolder+EditTypeAssignment)
- Batch Folder - Extract (Grooper.Core.BatchFolder+Extract)
- Batch Folder - Group Children (Grooper.EDI.GroupChildren)
- Batch Folder - Insert Control Sheets (Grooper.Capture.InsertControlSheets)
- Batch Folder - New Text Document (Grooper.Core.BatchFolder+NewTextDocument)
- Batch Folder - Remove From Index (Grooper.GPT.RemoveFromIndex)
- Batch Folder - Remove Level (Grooper.Core.BatchFolder+RemoveLevel)
- Batch Folder - Revert To Loose Pages (Grooper.Core.BatchFolder+RevertToLoosePages)
- Batch Folder - Set Field Value (Grooper.Core.BatchFolder+SetFieldValue)
- Batch Folder - Sort Children (Grooper.Core.BatchFolder+SortChildren)
- Batch Object - Append (GrooperReview.BatchView.SeparationList+Append)
- Batch Object - Append To Previous (Grooper.Core.BatchObject+AppendToPrevious)
- Batch Object - Clear Flag (Grooper.Core.BatchObject+ClearFlagCommand)
- Batch Object - Create New Folder (Grooper.Core.BatchObject+CreateNewFolder)
- Batch Object - Add Folder (Grooper.Core.BatchObject+AddFolder)
- Batch Object - Insert Folder (Grooper.Core.BatchFolder+InsertFolder)
- Batch Object - Flag Item (Grooper.Core.BatchObject+FlagCommand)
- Batch Object - Merge Selected (Grooper.Core.BatchObject+MergeSelected)
- Batch Object - Prepend to Next (Grooper.Core.BatchObject+PrependToNext)
- Batch Object - Rename (Grooper.Core.BatchObject+Rename)
- Batch Object - Run Step (Grooper.Core.BatchObject+RunStep)
- Batch Object - Run Activity (Grooper.Core.BatchObject+RunActivity)
- Batch Object - Send To Test Batch (Grooper.Core.BatchObject+SendToTestBatch)
- Batch Object - Copy To Test Batch (Grooper.Core.BatchObject+CopyToTestBatch)
- Batch Object - Move To Test Batch (Grooper.Core.BatchObject+MoveToTestBatch)
- Batch Object - Separate (GrooperReview.BatchView.SeparationList+Separate)
- Batch Object - Split Folder (Grooper.Core.BatchObject+SplitFolder)
- Batch Object - Unseparate (GrooperReview.BatchView.SeparationList+Unseparate)
- Batch Page - Clear Results (GrooperReview.BatchView.SeparationList+ClearResults)
- Batch Page - Generate Thumbnail (Grooper.Core.BatchPage+GenerateThumbnail)
- Batch Page - Image Command (Grooper.Core.BatchPage+ImageCommand)
- Batch Page - Display As Color (Grooper.Core.BatchPage+DisplayAsColor)
- Batch Page - Display As Grayscale (Grooper.Core.BatchPage+DisplayAsGrayscale)
- Batch Page - Display As Binary (Grooper.Core.BatchPage+DisplayAsBinary)
- Batch Page - Image Editing Command (Grooper.Core.BatchPage+ImageEditingCommand)
- Batch Page - Invert (Grooper.Core.BatchPage+Invert)
- Batch Page - Image Editing Command (Grooper.Core.BatchPage+ImageEditingCommand)
- Batch Page - Reset (Grooper.Core.BatchPage+Reset)
- Batch Page - Rotate Left (Grooper.Core.BatchPage+RotateLeft)
- Batch Page - Rotate Right (Grooper.Core.BatchPage+RotateRight)
- Batch Page - Undo Image Cleanup (Grooper.Core.BatchPage+UndoImageCleanup)
- Batch Page - Image Review Command (Grooper.Core.BatchPage+ImageReviewCommand)
- Batch Page - Apply Image Cleanup (Grooper.Core.BatchPage+ApplyCleanup)
- Batch Page - Rasterize (Grooper.Core.BatchPage+Rasterize)
- Batch Page - Revert (GrooperReview.BatchView.SeparationList+Revert)
- Batch Process - Add Activity (Grooper.Core.BatchProcess+AddActivity)
- Batch Process - Create Project (Grooper.Core.BatchProcess+CreateProject)
- Batch Process - Publish (Grooper.Core.BatchProcess+Publish)
- Batch Process - Unpublish (Grooper.Core.BatchProcess+Unpublish)
- CMIS Connection - Reset (Grooper.CMIS.CmisConnection+Reset)
- CMIS Connection - Import Repository (Grooper.CMIS.CmisConnection+ImportRepository)
- CMIS Document Link - Delete CMIS Document (Grooper.CMIS.CmisLink+DeleteCommand)
- CMIS Document Link - Load (Grooper.CMIS.CmisLink+Load)
- CMIS Document Link - Move CMIS Document (Grooper.CMIS.CmisLink+Move)
- CMIS Document Link - Save Version (Grooper.CMIS.CmisLink+SaveVersionCommand)
- CMIS Document Link - Update (Grooper.CMIS.CmisLink+Update)
- CMIS Export Map - Auto Map (Grooper.CMIS.CMISExportMap+AutoMap)
- CMIS Folder Link - Delete (Grooper.CMIS.CmisFolderLink+DeleteCommand)
- CMIS Folder Link - Load Children (Grooper.CMIS.CmisFolderLink+LoadChildrenCommand)
- CMIS Folder Link - Load Pages (Grooper.CMIS.CmisFolderLink+LoadPages)
- CMIS Folder Link - Load Properties (Grooper.CMIS.CmisFolderLink+LoadPropertiesCommand)
- CMIS Folder Link - Save Properties (Grooper.CMIS.CmisFolderLink+SavePropertiesCommand)
- CMIS Import Map - Auto Map (Grooper.CMIS.CMISImportMap+AutoMap)
- CMIS Repository - Reset (Grooper.CMIS.CmisRepository+Reset)
- CMIS Type Definition - Generate Local Type (Grooper.CMIS.GenerateLocalType)
- Column Map - Auto Map (Grooper.Activities.ColumnMap+AutoMap)
- Content Link - Remove Link (Grooper.Core.ContentLink+RemoveLink)
- Content Type - Clean Overrides (Grooper.Core.ContentType+CleanOverrides)
- Content Type - Create Data Model (Grooper.Core.ContentType+CreateDataModel)
- Content Type - Create Local Resources Folder (Grooper.Core.ContentType+CreateLocalResourcesFolder)
- Content Type - Create Search Index (Grooper.GPT.CreateSearchIndex)
- Content Type - Delete Search Index (Grooper.GPT.DeleteSearchIndex)
- Content Type - Generate Control Sheets (Grooper.Capture.GenerateControlSheets)
- Content Type - Purge Training (Grooper.Core.ContentType+PurgeTraining)
- Content Type - Rebuild Training (Grooper.Core.ContentType+RebuildTraining)
- Content Type - Submit Indexing Job (Grooper.GPT.SubmitIndexingJob)
- Copy Base - Auto Map (Grooper.Core.CopyBase+AutoMap)
- Data Connection - Connection Command (Grooper.Core.DataConnection+ConnectionCommand)
- Data Connection - Create Database (Grooper.Core.DataConnection+CreateDatabase)
- Data Connection - Create Table (Grooper.Core.DataConnection+CreateTable)
- Data Connection - Drop Table (Grooper.Core.DataConnection+DropTable)
- Data Connection - Test Connection (Grooper.Core.DataConnection+TestConnection)
- Data Element - Remove Overrides (Grooper.Core.DataElement+RemoveOverrides)
- Data Element Instance - Execute Lookup (GrooperReview.DataGrid.ExecuteLookup)
- Data Field Container - Build Fine Tuning File (Grooper.GPT.BuildFineTuningFile)
- Data Field Container - Generate Schema (Grooper.Core.DataFieldContainer+GenerateSchema)
- Data Field Container - Import Schema (Grooper.Core.DataFieldContainer+ImportSchema)
- Data Type - Convert To Value Reader (Grooper.Extract.DataType+ConvertToValueReader)
- Document Instance - Validate All (GrooperReview.DataGrid.ValidateAll)
- EDI File - Bundle (Grooper.EDI.EDIFile+Bundle)
- EDI File - Load Data (Grooper.EDI.EDIFile+LoadData)
- EDI File - Split Envelopes (Grooper.EDI.EDIFile+SplitEnvelopes)
- Excel Document - Convert to CSV (Grooper.Office.ExcelToCsv)
- Exchange - Rebuild Search Folder (Grooper.Messaging.ExchangeBinding+RebuildSearchFolder)
- Field Class - Purge Training (Grooper.Extract.FieldClass+PurgeTraining)
- Field Container Instance - Run Fill Method (GrooperReview.Views.DataGrid.Commands.RunFillMethod)
- Field Container Instance - Run Rule (GrooperReview.DataGrid.RunRule)
- Field Instance - Confirm (GrooperReview.DataGrid.Confirm)
- Field Instance - Confirm All (GrooperReview.DataGrid.ConfirmAll)
- Field Instance - Rubberband Header Label (GrooperReview.DataGrid.RubberbandHeaderLabel)
- Field Instance - Rubberband OCR (GrooperReview.DataGrid.RubberbandOCR)
- Field Instance - Rubberband Zone (GrooperReview.DataGrid.RubberbandZone)
- Field Instance - Save Value (Error - Report error to groopereducation@bisok.com)
- File Store - Move Objects Here (Grooper.FileStore+MoveObjectsHere)
- File Store - Test Connection (Grooper.FileStore+TestConnection)
- File System Link - Change File Attributes (Grooper.Core.FileSystemLink+ChangeAttributes)
- File System Link - Copy File (Grooper.Core.FileSystemLink+CopyFile)
- File System Link - Delete File (Grooper.Core.FileSystemLink+DeleteFile)
- File System Link - Load Content (Grooper.Core.FileSystemLink+LoadContent)
- File System Link - Move File (Grooper.Core.FileSystemLink+MoveFile)
- File System Link - Save Content (Grooper.Core.FileSystemLink+SaveContent)
- Folder - Remove Empty Subfolders (Grooper.Project+RemoveEmptySubfolders)
- FTP Link - Delete File (Grooper.Messaging.FtpLink+DeleteFile)
- FTP Link - Load Content (Grooper.Messaging.FtpLink+LoadContent)
- FTP Link - Save Content (Grooper.Messaging.FtpLink+SaveContent)
- FTP Link - Save Content (Grooper.Messaging.FtpLink+SaveContent)
- HTML Document - Condition HTML (Grooper.Messaging.HTMLDocument+ConditionHTML)
- HTML Document - Convert to PDF (Grooper.Messaging.HTMLDocument+ConvertToPDF)
- HTML Document - Convert To Text (Grooper.Messaging.HTMLDocument+ConvertToText)
- HTTP Link - Load Content (Grooper.Messaging.HTTPLink+LoadContent)
- HTTP Link - Rename Attachment (Grooper.Messaging.HTTPLink+RenameAttachment)
- JSON File - Load Data (Grooper.EDI.JsonFile+LoadData)
- JSON File - Split (Grooper.EDI.JsonFile+Split)
- Lexicon - Intersect (Grooper.Core.Lexicon+Intersect)
- Lexicon - Merge Training (Grooper.Core.Lexicon+MergeTraining)
- Lexicon - Normalize (Grooper.Core.Lexicon+Normalize)
- Lexicon - Subtract (Grooper.Core.Lexicon+Subtract)
- Lexicon - Truncate (Grooper.Core.Lexicon+Truncate)
- Machine - Tune File System (Grooper.Machine+TuneFileSystem)
- Mail Link - Delete Message (Grooper.Messaging.MailLink+DeleteMessage)
- Mail Link - Expand Attachments (Grooper.Messaging.MailLink+ExpandAttachments)
- Mail Link - Load Content (Grooper.Messaging.MailLink+LoadContent)
- Mail Message - Convert To RFC822 (Grooper.Messaging.MailMimeTypeHandler+ConvertToRFC822)
- Mail Message - Expand Attachments (Grooper.Messaging.MailMimeTypeHandler+ExpandAttachments)
- Node - Add Multiple Items (Grooper.GrooperNode+AddMultipleItems)
- Node - Clear Children (Grooper.GrooperNode+ClearChildren)
- Node - Clone (Grooper.GrooperNode+CloneItem)
- Node - Copy (GrooperReview.Objects.NodeCommands+Copy)
- Node - Cut (GrooperReview.Objects.NodeCommands+Cut)
- Node - Delete (Grooper.GrooperNode+DeleteItem)
- Node - Move Down (Grooper.GrooperNode+MoveDown)
- Node - Move Up (Grooper.GrooperNode+MoveUp)
- Node - Paste (GrooperReview.Objects.NodeCommands+Paste)
- Node - Publish to Repository (Error - Report error to groopereducation@bisok.com)
- Node - Rename (Grooper.GrooperNode+Rename)
- OAuth Client Credentials - Test (Grooper.GPT.OAuthClientCredentials+Test)
- Object Library - Create Backup (Grooper.ObjectLibrary+CreateBackup)
- Object Library - Rename Script (Grooper.ObjectLibrary+RenameScript)
- PDF Document - Burst (Grooper.Core.PdfMimeTypeHandler+Burst)
- PDF Document - Compact (Grooper.Core.PdfMimeTypeHandler+Compact)
- PDF Document - Repair (Grooper.Core.PdfMimeTypeHandler+Repair)
- Project - Remove Empty Subfolders (Grooper.Project+RemoveEmptySubfolders)
- Property Grid - Clear (GrooperReview.Controls.PropertyGrid.PropertyGrid+Clear)
- Property Grid - Copy Properties (GrooperReview.Controls.PropertyGrid.PropertyGrid+CopyProperties)
- Property Grid - Paste Properties (GrooperReview.Controls.PropertyGrid.PropertyGrid+PasteProperties)
- Property Grid - Reset (GrooperReview.Controls.PropertyGrid.PropertyGrid+Reset)
- Property Grid - Reset All (GrooperReview.Controls.PropertyGrid.PropertyGrid+ResetAll)
- PST File - Burst (Grooper.Office.PSTHandler+Burst)
- PST Link - Load Content (Grooper.Office.PstLink+LoadContent)
- Resource File - Delete Fine Tuned Model (Grooper.GPT.DeleteFineTunedModel)
- Resource File - Rename (Grooper.ResourceFile+Rename)
- Resource File - Start Fine Tuning Job (Grooper.GPT.StartFineTuningJob)
- Root - Database Cleanup (Grooper.GrooperRoot+DatabaseCleanup)
- Root - Rebuild Indexes (Grooper.GrooperRoot+RebuildIndexes)
- Root - Run Import (Grooper.Core.RunImport)
- Saved Query - Delete (Grooper.GPT.SavedQuery+DeleteQuery)
- Saved Query - Rename (Grooper.GPT.SavedQuery+Rename)
- Search Index - Generate Subsets (Grooper.GPT.SearchIndexReference+GenerateSubsets)
- Section Instance - Record Command (GrooperReview.DataGrid.RecordCommand)
- Section Instance - Delete Record (GrooperReview.DataGrid.DeleteRecord)
- Section Instance - Insert Record (GrooperReview.DataGrid.InsertRecord)
- Section Instance - Merge With Previous (GrooperReview.DataGrid.MergeWithPrevious)
- Section Instance - Move Next (GrooperReview.DataGrid.MoveNext)
- Section Instance - Move Previous (GrooperReview.DataGrid.MovePrevious)
- Section Instance - Rubberband (GrooperReview.DataGrid.Rubberband)
- Section Instance Collection - Append Record (GrooperReview.DataGrid.AppendRecord)
- SFTP Link - Delete File (Grooper.Messaging.SftpLink+DeleteFile)
- SFTP Link - Load Content (Grooper.Messaging.SftpLink+LoadContent)
- SFTP Link - Save Content (Grooper.Messaging.SftpLink+SaveContent)
- Table Instance - Append Row (GrooperReview.DataGrid.AppendRow)
- Table Instance - Capture Rows (GrooperReview.Views.DataGrid.Commands.CaptureRows)
- Table Instance - Clear All Rows (GrooperReview.DataGrid.ClearAllRows)
- Table Instance - Read Empty Cells (GrooperReview.Views.DataGrid.Commands.ReadEmptyCells)
- Table Instance - Rubberband Header (GrooperReview.DataGrid.RubberbandHeader)
- Table Instance - Rubberband Rows (GrooperReview.DataGrid.RubberbandRows)
- Table Row Instance - Delete Row (GrooperReview.DataGrid.DeleteRow)
- Table Row Instance - Duplicate Row (GrooperReview.DataGrid.DuplicateRow)
- Table Row Instance - Insert Row (GrooperReview.DataGrid.InsertRow)
- Table Row Instance - Move Row Down (GrooperReview.DataGrid.MoveRowDown)
- Table Row Instance - Move Row Up (GrooperReview.DataGrid.MoveRowUp)
- Table Row Instance - Split Row (GrooperReview.DataGrid.SplitRow)
- Text Document - Insert Page Breaks (Grooper.Extract.TextDocument+InsertPageBreaks)
- Text Document - Normalize (Grooper.Extract.TextDocument+Normalize)
- Text Document - Split (Grooper.Extract.TextDocument+Split)
- Value Reader - Convert To Data Type (Grooper.Extract.ValueReader+ConvertToDataType)
- vCard - Expand Photo (Grooper.Messaging.VCardTypeHandler+ExpandPhoto)
- Word Document - Convert to PDF (Grooper.Office.WordDocument+WordToPdf)
- XML File - Condition XML (Grooper.EDI.XmlFile+ConditionXML)
- XML File - Format (Grooper.EDI.XmlFile+Format)
- XML File - Load Data (Grooper.EDI.XmlFile+LoadData)
- XML File - Split (Grooper.EDI.XmlFile+Split)
- XML File - Validate Schema (Grooper.EDI.XmlFile+ValidateSchema)
- ZIP Archive - Unpackage (Grooper.Core.ZipHandler+Unpackage)
- ZIP Archive - Unzip (Grooper.Core.ZipHandler+Unzip)
- ZIP Archive - Update (Grooper.Core.ZipHandler+Update)
- ZIP Link - Load Content (Grooper.Core.ZipLink+LoadContent)