2023:Execute (Activity)

From Grooper Wiki

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

202520232021

STUB

This article is a stub. It contains minimal information on the topic and should be expanded.

tv_options_edit_channels Execute is an Activity that runs one or more specified object commands. This gives access to a variety of Grooper commands in a settings Batch Process for which there is no Activity, such as the "Sort Children" command for Batch Folders or the "Expand Attachments" command for email attachments.

Glossary

Activity: Grooper Activities define specific document processing operations done to a inventory_2 Batch, folder Batch Folder, or contract Batch Page. In a settings Batch Process, each edit_document Batch Process Step executes a single Activity (determined by the step's "Activity" property).

  • Batch Process Steps are frequently referred by the name of their configured Activity followed by the word "step". For example: "Classify step".

AND: AND is a Collation Provider option for pin Data Type extractors. AND returns results only when each of its referenced or child extractors gets at least one hit, thus acting as a logical “AND” operator across multiple extractors.

Batch Folder: The folder Batch Folder is an organizational unit within a inventory_2 Batch, allowing for a structured approach to managing and processing a collection of documents. Batch Folder nodes serve two purposes in a Batch. (1) Primarily, they represent "documents" in Grooper. (2) They can also serve more generally as folders, holding other Batch Folders and/or contract Batch Page nodes as children.

  • Batch Folders are frequently referred to simply as "documents" or "folders" depending on how they are used in the Batch.

Batch Page: contract Batch Page nodes represent individual pages within a inventory_2 Batch. Batch Pages are created in one of two ways: (1) When images are scanned into a Batch using the Scan Viewer. (2) Or, when split from a PDF or TIFF file using the Split Pages activity.

  • Batch Pages are frequently referred to simply as "pages".

Batch: inventory_2 Batch nodes are fundamental in Grooper's architecture. They are containers of documents that are moved through workflow mechanisms called settings Batch Processes. Documents and their pages are represented in Batches by a hierarchy of folder Batch Folders and contract Batch Pages.

CMIS: CMIS (Content Management Interoperability Services) is open standard allowing different content management systems to "interoperate", sharing files, folders and their metadata as well as programmatic control of the platform over the internet.

Execute: tv_options_edit_channels Execute is an Activity that runs one or more specified object commands. This gives access to a variety of Grooper commands in a settings Batch Process for which there is no Activity, such as the "Sort Children" command for Batch Folders or the "Expand Attachments" command for email attachments.

FTP: FTP is a connection option for cloud CMIS Connections. It connects Grooper to FTP directories for import and export operations.

SFTP: SFTP is a connection option for cloud CMIS Connections. It connects Grooper to SFTP directories for import and export operations.

Split: Split is a Collation Provider option for pin Data Type extractors. Split separates a data instance at each match returned by the Data Type. The results are used as anchor points to "split" text into one or more smaller parts.

These are simple manipulations of one kind of object or another. Do "x" command to "y" type of object. That's it. Often, no further property configuration is required other than listing what command you want to apply to what object type.

  • For example, the ClearChildren command deletes the child objects of a Batch Folder in a Batch. No further configuration required. It is a very simple command applied to Batch Folder objects in aBatch.

The Execute activity applies one or more execution commands to an object type.

To configure the activity, you must define what command you want to execute. Do this using the Commands property.

Pressing the ellipsis button at the end of the Commands property will bring up list editor window to add one or more Commands.

  1. Press the "Add" button to add a Command.
    • There are two components of a Command:
      1. The Object Type the command is applied to.
      2. The specific Command executed.
  2. Depending on what you want to do, the first step is figuring out what the appropriate Object Type is.

Once you've selected an Object Type, the Command property allows you to choose the specific command you want to apply to that object in a Batch.

Available Commands By Object Type

Object Type Command Details
Batch Object Commands
Batch Folder Clear Children Deletes all child objects of the Batch Folder. This includes any subfolder Batch Folders as well as Batch Pages.
Remove Attachment Deletes the locally-stored attachment file for the document folder. For example, a PDF file from the source import.
Revert To Loose Pages Deletes all subfolder Batch Folders and moves any child Batch Pages to the root of the folder level. You can optionally configure an Extension Filter property, specifying a comma-separated list of file extensions to include in the operation.
Sort Children This reorders the children of the Batch Folder. You choose to sort by either ContentType or FlagStatus in either an Ascending or Descending direction. This could be useful to move any flagged items to the top of the folder level or to group different document types together.
Clear Flag Removes any existing error flags on the Batch Folders.
Remove PDF Version Deletes the Grooper-generated PDF version from this item. Note: This would not remove the attached file for a Batch Folder generated upon import, even if that file is a PDF file. This only applies to PDF files generated from Grooper activities.
Batch Page Clear Children
Clear Flag
Display As Color
Display As Grayscale
Display As Binary
Display Settings
Reset
Rotate Left
Rotate Right
Invert
Undo Image Cleanup
Rasterize
Generate Thumbnail
Storage Link Commands
CMIS Document Link Remove Link
Load
Update
Save Version
Delete CMIS Document
Clear
CMIS Folder Link Remove Link
Load Children
Load Pages
Load Properties
Save Properties
Delete
File System Link Remove Link
Load Content
Save Content
Move File
Copy File
Delete File
Change File Attributes
FTP Link Remove Link
Load Content
Save Content
Delete
Mail Link Remove Link
Load Content
Expand Attachments
Delete Message
PST Link Remove Link
Load Content
SFTP Link Remove Link
Load Content
Save Content
Delete File
Subfile Link Remove Link
Zip Link Load Content
Remove Link
Attachment Filetype Specific Commands
Excel Document Excel to CSV
Mail Message Convert to RFC822
Expand Attachments
PDF Document Repair
Compact
Burst
PST File Burst
Text Document Split
Normalize
vCard Expand Photo
Word Document Word to PDF
Zip Archive Unzip
Unpackage