Command: Difference between revisions

Revision as of 11:13, 9 September 2025

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 and Resume buttons.
- Example: Property Grid configurations in the Design page are saved by pressing the Save button. This executes the "Save" command.
Context Menu: 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.

The following Commands all inherit from Command (Grooper.ObjectCommand) in Grooper. In parenthesis, you will find the commands type name in Grooper and its link to the Grooper Help page.

@@ Line 3: / Line 3: @@
 "Activities", Commands are one of the main ways work is performed in Grooper.
-Commands can be executed in two ways:
+Commands can be executed in three ways:
-* Manually by users.
+* '''Command buttons:''' Commands may executed manually by pressing buttons in various Grooper UIs.
-** 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 and Resume buttons.
-*** Example: The "Pause" and "Resume" commands are Batch commands executed from the Batches page by pressing the Pause and Resume buttons.
+** Example: Property Grid configurations in the Design page are saved by pressing the Save button. This executes the "Save" command.
-*** Example: Property Grid configurations in the Design page are saved by pressing the Save button. This executes the "Save" command.
+* '''Context Menu:''' Commands are often accessed in a "context menu" by right-clicking nodes or other objects.
-** 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: 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).
-*** 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.
-* Automatically in a Batch Process, using the [[Execute]] activity.
+** 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.
-** Several commands are relevant to document processing and are included in a Batch Process using the Execute activity.
+** Example: "Expand Attachments" is a Mail Message command required to process files attached to emails.
-*** 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.
-<big>Derived Types</big>
 The following Commands all inherit from {{WikiHelpLinks|Command}} in Grooper. In parenthesis, you will find the commands type name in Grooper and its link to the Grooper Help page.