Execute

Inherits From Code Activity Namespace Grooper.Activities

Executes a sequence of commands and/or activities on Batch Folder, Batch Page, or Batch objects.

Remarks

The Execute activity allows you to configure and run a series of actions, such as Commands or Code Activity steps, on items within a batch process.

How It Works

At each step in the sequence, either a Command or a Code Activity is executed. You can mix and match these actions to automate complex workflows.

Commands can target Batch Folder, Batch Page, Content Link, or Attachment Type objects.
Content Link commands operate on external documents linked to batch items, enabling tasks like parallel file loading, moving or deleting files after processing, or retrieving document IDs from external systems.
Attachment Type commands are specific to file types (such as PDF, mail messages, or ZIP archives) and allow operations like extracting attachments or unzipping files.

Configuration

To use the Execute activity:

Add one or more actions to the 'Steps' property. Each step can be a Command or a Code Activity.
If you only need to run a single Command, you can use the 'Command' property for a simplified configuration.
Actions that do not apply to the current object are automatically skipped.

Example Use Cases

Load external file content for sparse documents after import.
Delete or move input files after processing is complete.
Extract attachments from email messages or ZIP archives.
Chain together multiple commands and activities for advanced automation.

> [!TIP] > Use the 'Steps' property for multi-step workflows, or the 'Command' property for a single action.

Properties

Name Type Description

General

Steps

Execute Step[]

►

Specifies the sequence of actions to perform as part of this activity.

Command

►

A shortcut for specifying a single Command to execute.

Can be one of the following types:

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

Set the 'Command' property if you only need to run one Command as part of this activity. This provides a simplified configuration compared to using the 'Steps' collection.

Assigning a value to 'Command' will replace any existing steps with a single Command step.
Setting 'Command' to null will clear all steps.

> [!TIP] > Use 'Steps' if you need to run multiple actions in sequence.

Processing Options

Error Disposition

IssueDisposition

►

Controls how errors are handled when this activity encounters an exception during processing.

A combination of the following flags:

Name	Value	Description
None	0	The issue will be ignored, and the item will complete successfully.
Flag	1	The associated Batch Folder or Batch Page will be flagged.
Log	2	The issue will be logged to the Grooper log. The log can be viewed from the Root - Events tab on the Design Page.
Stop	4	The Batch will stop processing, be set to an error state, and all pending tasks will be deleted.

The Error Disposition property determines the system's response to errors that occur while executing the activity.

Flag: The affected Batch Folder or Batch Page will be flagged for review.
Log: The error will be written to the Grooper event log.
Stop: Processing will halt, the Batch will be set to an error state, and all pending tasks will be deleted.

You can combine multiple options using the IssueDisposition flags.
Adjust this property to match your organization's error handling and escalation policies.

Maximum Consecutive Errors

Int32

►

The maximum number of consecutive errors allowed before a critical stop is triggered.

Concurrency Mode

ConcurrencyMode

►

Specifies the parallel processing mode for this activity.

Can be one of the following values:

Name	Value	Description
Multiple	0	Multiple instances can run concurrently. The `Multiple` mode allows any number of instances of the activity or queue to run in parallel.	►
PerMachine	1	Only a single instance can run per machine. The `PerMachine` mode restricts execution to one instance per server or workstation.	►
Single	2	Only a single instance can run per Grooper repository. The `Single` mode enforces exclusive execution across the entire repository.	►

The Concurrency Mode property determines whether the activity can be executed in parallel across multiple Batch Objects, or if it must run sequentially.

This setting affects which Processing Queue the activity is submitted to and how tasks are distributed.
Choose the appropriate mode based on the activity's thread safety and resource requirements.

Used By

Batch Process Step Processing Job Batch Object - Run Activity Execute Activity