Property Name |
Property Type |
Description |
ActivityStats |
Grooper.StatDictionary |
Dictionary of statistics for the batch processing activity. |
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.
|
EnableUndo |
System.Boolean |
Causes an undo image to be saved prior to any image processing being applied to page images, allowing them to be reverted to their original state. |
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.
|
HasReferenceProperties |
System.Boolean |
Returns true if the object has properties which reference Grooper Node objects. |
IpProfile |
Grooper.IP.IpProfile |
The IP Profile to apply. |
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. |
JpegQuality |
System.Double |
The JPEG compression quality to be used when saving color and grayscale images. |
JpegSmoothing |
System.Double |
The JPEG smoothing amount to be used when saving color and grayscale images. |
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. |
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(). |
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(Node As BatchObject) |
Mandatory override to implement processing logic.
Parameters |
Node |
Type: BatchObject |
|
|
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 |
|
|