Property Name |
Property Type |
Description |
Action |
Grooper.Activities.ContentAction.CollateAction |
The action to perform.Can be one of the following values:
- Split: Splits multi-page TIF or PDF content to individual Batch Page objects. Deletes all of the folder's existing children and replaces them with pages generated from
the folder's file content. Pages will only be generated for folders having a PDF or an image-based native version.
- Merge: Merges the contents of all child objects to a multi-page file, and saves it on the Batch Folder object. The format of the output file is controlled by the Merge Output Format property. A Merge action will overwrite any
existing PDF or native file versions.
- ClearChildren: Deletes all child folders and pages.
- ClearContent: Deletes any existing native file versions and PDF file versions from the Batch Folder object.
- RepairPDF: Detects and attempts to repair corrupted PDF files.
|
ActivityStats |
Grooper.StatDictionary |
Dictionary of statistics for the batch processing activity. |
AutoColorDepthSettings |
Grooper.IP.AutoConvert |
Color detection settings to be used when the Target Image Format is set to AutoGray or AutoBW. |
ConcurrencyMode |
Grooper.ConcurrencyModeAttribute.ConcurrencyMode |
Specifies the parallel processing mode for this activity. This value determines the type of Thread Pool on which the activity can be executed.Can be one of the following values:
- Multiple: Multiple instances can run concurrently.
- PerMachine: Only a single instance can run per machine.
- Single: Only a single instance can run per Grooper repository.
|
ErrorDisposition |
Grooper.Core.UnattendedActivity.IssueDisposition |
Determines what happens when an error occurs processing an activity.A combination of the following flags:
- None: The issue will be ignored, and the item will complete successfully.
- Flag: The associated Batch Folder or Batch Page will be flagged.
- Log: The issue will be logged to the Grooper log. The log can be viewed from the Grooper Root node under the Batch Event Viewer tab.
- Stop: The Batch will stop processing, be set to an error state, and all pending tasks will be deleted.
|
FlagConversionIssues |
System.Boolean |
If set to true, documents will be flagged in cases where recoverable PDF conversion issues are encountered. |
HasReferenceProperties |
System.Boolean |
Returns true if the object has properties which reference Grooper Node objects. |
IsEmpty |
System.Boolean |
Returns true if all properties with a ViewableAttribute are set to their default value. |
IsWriteable |
System.Boolean |
Returns true if the object is writable, or false if it is not. |
MaximumConsecutiveErrors |
System.Int32 |
The maximum number of consecutive errors, after which a critical stop will be raised. A critical stop will cause services to stop running. |
MergeOutputFormat |
Grooper.Activities.ContentAction.MergeOutputFileFormat |
The output format for the merge operation.Can be one of the following values:
- PDF: Generate a PDF file.
- TIF: Generate a TIF file.
|
PageLimit |
System.Int32 |
Documents with a page count higher than this value will generate an error. |
PdfGenerator |
Grooper.Core.PdfFormat |
If enabled, PDF pages generated from Grooper pages will be generated as searchable PDF pages. |
PdfRenderResolution |
System.Int32 |
The resolution to use when rendering PDF pages as images. |
PdfSplitMethod |
Grooper.Activities.ContentAction.PdfSplitMethods |
Defines how a split operation is performed on PDF content.Can be one of the following values:
- Auto: PDF pages will be individually copied to Grooper page objects. If an error occurs while extracting the PDF
page, the page will be split as an image.
- Native: PDF pages will be individually copied to Grooper page objects. If an error occurs while extracting the PDF
page, the task will error out.
- Image: PDF pages will be split as images in all cases.
|
PdfTargetImageFormat |
Grooper.Activities.ContentAction.TargetColorFormat |
The color format in which PDF page images should be generated.Can be one of the following values:
- Auto: The output color format will be determined automatically.
- Color: All pages will be rendered as color images.
- Grayscale: All pages will be rendered as grayscale images.
- Binary: All pages will be rendered as binary (black and white) images.
|
RemoveOriginal |
System.Boolean |
If set to true, the original content on the parent folder will be deleted. |
Root |
Grooper.GrooperRoot |
Returns the root node |
StatNames |
System.Collections.Generic.IEnumerable(Of T) |
Returns all possible statistic names which could be logged for the Activity. Derived classed should override this method to return all stat names which
will be used in calls to AddCustomStatValue(). |
TifGenerator |
Grooper.Core.TifFormat |
If enabled, PDF pages generated from Grooper pages will be generated as searchable PDF pages. |
Method Name |
Description |
AddDiagImage(Name As String, Image As GrooperImage, Annotations As IEnumerable(Of Annotation)) |
Parameters |
Name |
Type: String |
|
|
Image |
Type: GrooperImage |
|
|
Annotations |
Type: IEnumerable`1 |
|
|
EnableDiagMode() |
|
GetProperties() As PropertyDescriptorCollection |
|
GetReferences() As List(Of GrooperNode) |
Returns a list of GrooperNode objects referenced in the properties of this object. |
InsertDiagImage(Index As Int32, Name As String, Image As GrooperImage, Annotations As IEnumerable(Of Annotation)) |
Parameters |
Index |
Type: Int32 |
|
|
Name |
Type: String |
|
|
Image |
Type: GrooperImage |
|
|
Annotations |
Type: IEnumerable`1 |
|
|
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently enabled.
Parameters |
PropertyName |
Type: String |
The name of the property to determine the enabled state for. |
|
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently visible.
Parameters |
PropertyName |
Type: String |
The name of the property to determine the visible state for. |
|
IsType(Type As Type) As Boolean |
Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters |
Type |
Type: Type |
The type to check. |
|
LogStatValue(Name As String, Value As Double) |
Adds a custom stat value to the Batch Processing Activity statistics.
Parameters |
Name |
Type: String |
|
|
Value |
Type: Double |
|
|
ProcessTask(CurNode As BatchObject) |
Mandatory override to implement processing logic.
Parameters |
CurNode |
Type: BatchObject |
The current batch object being processed. |
|
Serialize() As String |
Serializes the object. |
SetDatabase(Database As GrooperDb) |
Sets the database connection of the object.
Parameters |
Database |
Type: GrooperDb |
|
|
ToString() As String |
Returns the display name for this activity type. |
ValidateProperties() As ValidationErrorList |
Validates the properties of the object, returning a list of validation errors. |
Verify() |
|
WriteLogEntry(Message As String, pa() As Object()) |
Adds an entry to the Diagnostic Info Log.
Parameters |
Message |
Type: String |
|
|
pa |
Type: Object |
|
|
WriteLogEntry(TabLevel As Int32, Message As String, pa() As Object()) |
Adds an entry to the Diagnostic Info Log.
Parameters |
TabLevel |
Type: Int32 |
Level to indent the message within the log. |
|
Message |
Type: String |
|
|
pa |
Type: Object |
|
|