Command

A Command is an action which can be performed on a specific type of object.

Remarks

Commands can be executed manually by users, or automatically during a Batch Process using the Execute activity.

Derived Types

There are 176 implementations of Command.

Applies To	Command	Shortcut	Description
AI Chat	delete Delete	Del	Permanently deletes the selected AI Chat session and all associated messages.
AI Chat	drive_file_rename_outline Rename	F2	Renames the selected AI Chat session.
Attachment Type	send_time_extension Change Extension		Changes the file extension of an attachment.
Attachment Type	description Remove Attachment		Deletes the locally-stored attachment file from this folder object.
Attachment Type	picture_as_pdf Remove PDF Version		Deletes the Grooper-generated PDF version from this item.
Attachment Type	edit_document Rename Attachment		Renames the attachment for this item.
Batch	sort Archive		Archives selected batches by moving them into a destination folder, optionally organizing them into subfolders by date and clearing job history.
Batch	low_priority Change Priority		Changes the priority level of the selected Batches.
Batch	merge Combine		Combines multiple Batch objects into a single batch.
Batch	pause_circle Pause		Pauses processing on one or more Batches.
Batch	settings Remove Job History		Deletes all jobs and tasks associated with the current batch.
Batch	history Reset		Resets a Batch to a specific Batch Process Step, optionally clearing tasks and statistics for selected steps.
Batch	play_circle Resume		Resumes processing on a paused Batch.
Batch	inventory_2 Send To Production		Clones or moves a Batch into production and launches it into a Batch Process.
Batch	inventory_2 Send To Test		Clones or moves a production Batch to the 'Production Clones' folder of the test branch.
Batch	system_update_alt Update Process		Updates or changes the Batch Process associated with this batch.
Batch Folder	search_check Add To Index		Adds or updates the current document in the search indexes associated with its Content Types.
Batch Folder	edit_document Assign Document Type	Ctrl+Shift+A	Assigns a primary and optional secondary Content Type to the selected Batch Folder.
Batch Folder	description Classify	Ctrl+Shift+L	Runs automated classification on the selected Batch Folder items.
Batch Folder	collapse_all Collapse		Moves all OCR and Layout Data from descendant pages and folders to the current Batch Folder, then removes all children.
Batch Folder	edit_document Edit Type Assignment	Ctrl+Shift+A	Adds, removes, or promotes a Document Type assignment for the selected Batch Folder.
Batch Folder	list_alt Extract		Runs data extraction on the selected Batch Folder and saves the results.
Batch Folder	account_tree Group Children		Organizes the children of a folder into subfolders based on item count and/or total file size.
Batch Folder	document_scanner Insert Control Sheets		Inserts a Control Sheet as the first page of each Batch Folder in a batch.
Batch Folder	description New Text Document		Creates a new text document inside this folder.
Batch Folder	search_check Remove From Index		Removes the current document from one or more search indexes, making it no longer discoverable via search or retrieval.
Batch Folder	account_tree Remove Level	Ctrl+U	Removes the selected Batch Folder and moves its children up one level in the hierarchy.
Batch Folder	restore_page Revert To Loose Pages		Moves all descendant Batch Pages to the root of the folder and deletes all subfolders.
Batch Folder	variable_insert Set Field Value		Sets the value of a field stored on a Batch Folder.
Batch Folder	sort_by_alpha Sort Children		Reorders the children of the current Batch Folder according to the specified sort options.
Batch Folder	school Train As	Ctrl+Shift+D	Trains the selected Batch Folder as a specific Document Type for classification purposes.
Batch Folder	description Train From	Ctrl+Shift+F	Trains the Content Model using the selected folders that have a Content Type assigned.
Batch Object	folder_open Add Folder	Ctrl+Shift+F	Adds a new folder as a child of the selected Batch Folder, with configurable position and metadata.
Batch Object	move_up Append To Previous	Ctrl+P	Appends selected items to the previous Batch Folder in the batch, reorganizing the batch structure.
Batch Object	flag Clear Flag	Ctrl+Shift+L	Clears the flagged state from one or more previously flagged items in a batch.
Batch Object	inventory_2 Copy To Test Batch		Copies selected items to a test batch, optionally flagging them for review or testing.
Batch Object	flag Flag Item	Ctrl+L	Flags the selected items in a batch with a specified reason for review or special handling.
Batch Object	folder_open Insert Folder	Ctrl+F	Inserts a new Batch Folder as a sibling to the selected folder.
Batch Object	account_tree Merge Selected	Ctrl+M	Merges selected items into one or more new Batch Folders, with configurable content type and grouping.
Batch Object	inventory_2 Move To Test Batch		Moves selected items to a test batch, removing them from their original location and optionally flagging them.
Batch Object	move_down Prepend to Next	Ctrl+Shift+P	Prepends selected items to the next Batch Folder in the batch, moving them to the start of that folder.
Batch Object	drive_file_rename_outline Rename	F2	Renames the selected Batch Object to a new display name.
Batch Object	video_settings Run Activity		Runs a selected code activity on the selected Batch Objects.
Batch Object	edit_document Run Step		Runs a specific batch process step on the selected item(s).
Batch Object	folder_zip Split Folder	Ctrl+S	Splits the parent Batch Folder at the selected item, moving it and all subsequent siblings into a new folder.
Batch Page	folder_open Apply Image Cleanup	Alt+I	Applies an IP Profile to one or more Batch Pages.
Batch Page	contrast Display As Binary	Ctrl+Shift+B	Changes the display format of the current Batch Page to black and white (binary).
Batch Page	palette Display As Color	Ctrl+Shift+C	Changes the display format of the current Batch Page to color.
Batch Page	filter_b_and_w Display As Grayscale	Ctrl+Shift+G	Changes the display format of the current Batch Page to grayscale.
Batch Page	gallery_thumbnail Generate Thumbnail		Generates and saves a thumbnail image for the Batch Page.
Batch Page	shadow Invert	Ctrl+Shift+V	Inverts the polarity of the image on the Batch Page.
Batch Page	move_up Prepend	Ctrl+N	Prepend the selected pages or folders to the next document or folder in the Separation List.
Batch Page	picture_as_pdf Rasterize		Converts a PDF page to an image for the selected Batch Page.
Batch Page	reset_image Reset	Ctrl+Shift+R	Clears all display format and ScanOnce settings stored on the Batch Page.
Batch Page	rotate_left Rotate Left	Ctrl+Left	Rotates the Batch Page counter-clockwise.
Batch Page	rotate_right Rotate Right	Ctrl+Right	Rotates the Batch Page clockwise.
Batch Page	undo Undo Image Cleanup	Ctrl+Z	Replace the selected Batch Page with its Undo Image.
Batch Process	edit_calendar Add Activity		Adds a new Batch Process Step to the Batch Process, configured with a specific Activity.
Batch Process	package_2 Create Project		Moves the Batch Process and its exclusively referenced nodes to a new Project.
Batch Process	publish Publish		Publishes the working version of a Batch Process, making it available for production use.
Batch Process	disabled_visible Unpublish		Unpublishes a Batch Process, making it unavailable for production use in the local Grooper repository.
CMIS Connection	settings_system_daydream Import Repository	Ctrl+I	Imports a CMIS Repository from the external content platform, making it available for use in Grooper.
CMIS Connection	cloud Reset		Resets the connection for all child repositories, clearing cached information and forcing a refresh from the external content platform.
CMIS Document Link	delete Delete CMIS Document		Deletes the CMIS Document associated with the link and removes the link from the Grooper document.
CMIS Document Link	file_copy Load		Loads the properties and/or content stream of the linked CMIS Document and saves it to the Grooper document.
CMIS Document Link	delete Move CMIS Document		Moves a CMIS Document to another folder in the same CMIS Repository.
CMIS Document Link	file_save Save Version		Adds a new version of the linked CMIS Document from the content of the Grooper document.
CMIS Document Link	file_copy Update		Updates the properties and/or content stream of the linked CMIS Document with the content of the Grooper document.
CMIS Export Map	conversion_path Auto Map		Automatically maps CMIS properties to Grooper fields using name similarity and type compatibility.
CMIS Folder Link	delete Delete		Deletes the CMIS folder associated with the link and removes the link.
CMIS Folder Link	upload_file Load Children		Loads the children or descendants of a linked CMIS Folder.
CMIS Folder Link	file_copy Load Pages		Loads all image-based children as Batch Page objects.
CMIS Folder Link	list_alt Load Properties		Reads properties from the CMIS folder and applies them to the Grooper folder.
CMIS Folder Link	list_alt Save Properties		Writes the Grooper folder properties to the CMIS folder.
CMIS Import Map	conversion_path Auto Map		Automatically maps Grooper fields to CMIS properties using name similarity and type compatibility.
CMIS Repository	settings_system_daydream Reset		Resets the connection and clears all cached information for this CMIS Repository.
CMIS Type Definition	list_alt Generate Local Type		Generates a Grooper Content Type from a CMIS content type definition.
Column Map	conversion_path Auto Map		Automatically maps database table columns to Grooper fields based on name similarity and data type compatibility.
Content Link	link Remove Link		Removes the link from its owning Batch Folder.
Content Type	playlist_remove Clean Overrides		Removes unnecessary property overrides from this Content Type and all descendants.
Content Type	list_alt Create Data Model		Adds a Data Model to the selected Content Type.
Content Type	folder_open Create Local Resources Folder		Creates a new Local Resources Folder as a child of this Content Type.
Content Type	plagiarism Create Search Index		Creates an Azure AI Search index for the selected Content Type, enabling search and retrieval features.
Content Type	plagiarism Delete Search Index		Deletes an Azure AI Search index previously created for this Content Type, removing all associated search and retrieval capabilities.
Content Type	document_scanner Generate Control Sheets		Command to generate Grooper Control Sheets for selected document types within a content model or content category.
Content Type	model_training Purge Training		Removes all classification training data and training samples from this Content Type and all descendants.
Content Type	model_training Rebuild Training		Removes all existing training and retrains the classification model from the current training set documents.
Content Type	manufacturing Submit Indexing Job		Submits an indexing job for the selected Content Type, updating the associated search index with new, updated, or deleted documents.
Copy Base	conversion_path Auto Map		Automatically maps source elements to target elements for copy or move operations in a Data Action.
Data Connection	database Create Database		Creates a new database on the server associated with this connection.
Data Connection	table Create Table		Generates database tables from Grooper data elements..
Data Connection	table Drop Table		Deletes a table from the database.
Data Connection	database Test Connection		Tests the data connection by making a connection to the server.
Data Element	variable_remove Remove Overrides		Removes property overrides from a Data Element for a single property or for all properties.
Data Field Container	psychology Build Fine Tuning File		Generates a fine-tuning file from the documents in one or more reference batches.
Data Field Container	input Import Schema		Imports child data elements from an external source.
Data Type	quick_reference_all Convert To Value Reader		Converts this Data Type to a Value Reader with equivalent functionality.
EDI File	published_with_changes Bundle		Replaces the selected EDI files with a new set of files containing N transactions each.
EDI File	data_table Load Data		Loads data from an EDI document into a Data Model.
EDI File	scan Split Envelopes		Splits an EDI 837 file, creating a child document for each interchange control envelope (ISA envelope).
Excel Document	csv Convert to CSV		Converts an Excel spreadsheet to a Comma-Separated Values (CSV) file.
Exchange	youtube_searched_for Rebuild Search Folder		Deletes and recreates the dedicated Exchange Search Folder used by Grooper for optimized message queries.
Field Class	bolt Purge Training		Deletes all training data from this Field Class.
File Store	account_tree Move Objects Here		Migrates selected objects and their files to this file store.
File Store	hard_drive Test Connection		Tests the connection to the file store.
File System Link	dataset_linked Change File Attributes		Changes the file attributes on the linked file.
File System Link	file_copy Copy File		Copies the file to a directory location on the file system.
File System Link	description Delete File		Deletes the linked file from the file system and removes the link.
File System Link	file_copy Load Content		Loads the linked file and stores it locally in Grooper.
File System Link	file_copy Move File		Move the remote file to a new location on the file system.
File System Link	file_copy Save Content		Overwrites the file system content with the content stored in Grooper.
Folder	account_tree Remove Empty Subfolders		Deletes all empty sub folders.
FTP Link	description Delete File		Deletes the linked file from the FTP server and removes the FTP Link from the Batch Folder.
FTP Link	file_copy Load Content		Loads the linked file from the FTP server and stores it locally as an attachment for the Batch Folder.
FTP Link	file_copy Save Content		Writes the native file version from the Batch Folder to the FTP server, updating or creating the external file.
HTML Document	code_blocks Condition HTML		Performs cleanup and normalization of HTML documents.
HTML Document	picture_as_pdf Convert to PDF		Converts an HTML document to PDF format.
HTML Document	code_off Convert To Text		Converts the HTML document to plain text or markdown.
HTTP Link	file_copy Load Content		Loads the linked file and stores it as the attachment for the associated Batch Folder.
HTTP Link	~/Resource/GetIcon?typeName=blank Rename Attachment		Renames the local attachment file to match the linked resource's name and MIME type.
IP Element Container	playlist_add Add Command		Command for interactively adding a new IP Step configured with a selected IP Command to an IP Element Container.
Lexicon	two_pager Intersect		Creates a new lexicon containing all entries which appear both in this lexicon and a reference lexicon.
Lexicon	book_2 Merge Training		Merges all training files into the main content of this Lexicon.
Lexicon	translate Normalize		Normalizes character data in the lexicon to the character set of the configured language.
Lexicon	two_pager Subtract		Removes all entries from this lexicon which appear in a reference lexicon.
Lexicon	book_2 Truncate		Truncates the lexicon to the top N entries.
Machine	devices Tune File System		Sets file system performance tuning parameters for a Grooper server.
Mail Link	mail Delete Message		Delete the linked Mail server object from the mail server.
Mail Link	mail Expand Attachments		Expands all attachments as children of the folder object.
Mail Link	mail Load Content		Loads the content from the linked Mail server object and saves it as the local attachment on the associated Batch Folder.
Mail Message	mail Convert To RFC822		Converts a proprietary Microsoft Outlook mail message (.msg) to an industry-standard RFC822 mail message (.eml).
Mail Message	mail Expand Attachments		Bursts out the individual components of a mail message and saves them as children of the mail message.
Node	add_circle Add	Ctrl+Shift+Ins	Adds a new child Node of a specified type to the selected parent Node.
Node	shopping_basket Add Multiple Items		Adds multiple child items of a specified type to the selected Node.
Node	account_tree Clear Children		Removes all child nodes from the selected Node, deleting their contents from the repository.
Node	copy_all Clone	Ctrl+Shift+D	Creates a copy of the selected Node and inserts it as a sibling.
Node	delete Delete	Del	Deletes the selected Node or nodes from the repository.
Node	move_down Move Down	Ctrl+Down	Moves the selected Node or nodes down one position within their parent container.
Node	move_up Move Up	Ctrl+Up	Moves the selected Node or nodes up one position within their parent container.
Node	database Publish To Repository		Publishes a configuration object to one or more Grooper repositories.
Node	drive_file_rename_outline Rename	F2	Renames the selected Node to a new unique name.
OAuth Client Credentials	~/Resource/GetIcon?typeName=blank Test		Tests the process of obtaining an OAuth 2.0 access token using the configured client credentials.
Object Library	settings_backup_restore Create Backup		Creates a backup of the script project.
Object Library	drive_file_rename_outline Rename Script		Renames the script project files and .NET namespace to match the current Object Library node name.
PDF Document	burst_mode Burst		Splits a PDF document into multiple smaller documents based on user-defined rules or content structure.
PDF Document	photo_size_select_small Compact		Reduces the size of a PDF file by removing duplicate resources and optimizing compression.
PDF Document	picture_as_pdf Repair		Repairs PDF files which contain minor errors.
Project	account_tree Remove Empty Subfolders		Deletes all empty subfolders within the Project.
PST File	mail Burst		Extracts mail messages from the PST file and creates a child document for each message.
PST Link	mail Load Content		Loads the linked file and stores it locally in Grooper.
Resource File	psychology Delete Fine Tuned Model		Deletes a fine-tuned LLM model from the connected provider.
Resource File	drive_file_rename_outline Rename	F2	Renames the selected Resource File and its associated file in the File Store.
Resource File	psychology Start Fine Tuning Job		Creates a fine-tuning job using the set of fine-tuning files saved on this data element.
Root	Publish Run Import		Executes an import provider within the current user session.
Root	storage System Maintenance		Performs a set of system maintenance operations on the Grooper repository, including database index rebuilds, log and statistics purging, machine cleanup, and batch/test data management.
Saved Query	delete Delete		Permanently deletes the selected saved query from the repository.
Saved Query	drive_file_rename_outline Rename		Renames the selected saved query.
Search Index	data_array Generate Subsets		Generates subset filters for a search index based on a selected field or document types.
SFTP Link	description Delete File		Deletes the linked file from the SFTP server and removes the SFTP Link from the Batch Folder.
SFTP Link	file_copy Load Content		Loads the linked file from the SFTP server and stores it locally as the attachment for the Batch Folder.
SFTP Link	file_copy Save Content		Writes the local attachment from the Batch Folder to the SSH/SFTP file server, updating or creating the external file.
Text Document	splitscreen Insert Page Breaks		Inserts page breaks into a text document based on a regular expression pattern.
Text Document	draft Normalize		Normalizes encoding, whitespace, and control characters in a text document.
Text Document	insert_page_break Split		Splits a text document into smaller documents, using an extractor to identify split positions within the text content.
Value Reader	pin Convert To Data Type		Converts this Value Reader to a Data Type with equivalent functionality.
vCard	image Expand Photo		Extracts the embedded photo from the vCard (if available) and saves it as a child document under the Batch Folder.
Word Document	picture_as_pdf Convert to PDF		Converts the attached Word document to PDF and saves it as a PDF version in the batch folder.
XML File	code Condition XML		Applies conditioning and normalization to an XML file.
XML File	edit_document Format		Applies formatting to an XML file.
XML File	data_table Load Data		Loads data from an XML file into a Data Model.
XML File	arrow_split Split		Splits an XML file.
XML File	description Validate Schema		Validates an XML document against an XML schema, and flags the document with any issues.
ZIP Archive	folder_zip Unpackage		Extracts a primary file and optional companion files from the ZIP Archive, replacing the ZIP attachment with the extracted file(s).
ZIP Archive	folder_zip Unzip		Extracts files from the ZIP Archive and saves them as child documents of the Batch Folder.
ZIP Archive	folder_zip Update		Updates the ZIP archive to match the current child attachments of the Batch Folder.
ZIP Link	folder_zip Load Content		Loads the linked file and stores it locally in Grooper.

Used By

Execute CommandExecute