Provides a user interface optimized for creating batches and scanning or importing image-based pages.
Launches Attended Client with the Scan Viewer Batch View control. Scan is typically the first step in a Batch Process as it allows
you to bring content into Grooper.
| Property Name |
Property Type |
Description |
| ActivityStats |
Grooper.StatDictionary |
Dictionary of statistics for the batch processing activity. |
| AllowFlaggedPages |
System.Boolean |
Specifies whether a batch can be completed from Scan while it has flagged pages. Use this setting to force correction of image problems in the scan module. |
| CanComplete(CurFolder As BatchFolder) |
System.Boolean |
Override this property to indicate when the user is allowed to complete the current task.
| Parameters |
| CurFolder |
| Type: BatchFolder |
| |
|
| CommandConfigurations |
System.Collections.Generic.List(Of T) |
Defines the enabled state and shortcut keys for individual commands in Attended Client. By default, all object commands will display on the right-click context menu. This property allows administrators to control which options
will be available for end users when they right-click on an object used by the Activity. |
| ControlSettings |
Grooper.Capture.BatchScanControl.Settings |
Settings which define the behavior of the Scan Control. |
| 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. |
| MissingBatchViews |
System.Collections.Generic.IEnumerable(Of T) |
Validates that the configured Batch View control types exist. |
| RequiredPageLevel |
System.Int32 |
Specifies the level at which all pages must exist before a batch can be completed through scan. A value of zero indicates that pages may exist at any level. |
| Root |
Grooper.GrooperRoot |
Returns the root node |
| StatHostTypes |
System.Collections.Generic.IEnumerable(Of T) |
Derived classes should override this property to specify a list of types which represent stat-producing UI controls. |
| 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(). |
| StatProperties |
System.Collections.Generic.IEnumerable(Of T) |
Returns Property Info objects for all Activity Statistic properties on all Batch View controls for this activity. |
| UserActivityTimeout |
System.Int32 |
Specifies the amount of time, in minutes, that a user can be inactive before an automatic logout occurs. If a user has been inactive for this number of minutes, the current Processing Task will automatically close. This keeps
report statistics from becoming inflated because of users leaving the application open and unattended. Setting this property to 0 will disable
this feature. |
| Method Name |
Description |
| GetProperties() As PropertyDescriptorCollection |
|
| GetReferences() As List(Of GrooperNode) |
Returns a list of GrooperNode objects referenced in the properties of this object. |
| 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 |
| |
|
| OnTaskClose(Task As ProcessingTask) |
Called when a task is closed in Attended Client.
| Parameters |
| Task |
| Type: ProcessingTask |
| The task being closed. |
|
| OnTaskOpen(Task As ProcessingTask) |
Called when a task is opened in Attended Client.
| Parameters |
| Task |
| Type: ProcessingTask |
| The task being closed. |
|
| 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. |