BatchClose

This event triggers when a Verifier or Web Verifier user exits a batch in one of the following ways.

  • When verifying a batch and selecting Return to batch list.
  • Batch verification completion.
  • Partial batch verification completion.
  • The user exits Verifier while in a batch.

Syntax

ScriptModule_BatchClose(ByVal UserName as String, ByVal BatchDatabaseID as Long, ByVal ExternalGroupID as Long, ByVal ExternalBatchID as String, ByVal TransactionID as Long, ByVal WorkflowType as SCBCdrPROJLib.CDRDatabaseWorkflowTypes, BatchState as Long, BatchReleaseAction as SCBCdrPROJLib.CDRBatchReleaseAction)
Parameter Description
UserName The currently logged in user name who has closed the batch.
BatchDatabaseID The unique Batch ID within the database. For the file system, this batch ID is not used.
ExternalGroupID The Group ID assigned to a batch.

The Group ID that can be used with the scripting security methods that enable the developer to assign a batch to a security group. Only those users belonging to the same Group ID are able to access batches.

For example, a batch belonging to Group ID 80 is only accessible by a user who is assigned to group 80.

This ia a read-only field. You cannot modify the values.
ExternalBatchID The External Batch ID assigned to a batch.

The External Batch ID allows the developer to synchronize a newly created batch of documents with another external system. For example, an archiver or a storage box ID.

This ia a read-only field. You cannot modify the values.
TransactionID The Transaction ID assigned to a batch.

The Transaction ID allows the developer to synchronize a newly created batch of documents with another external system, such as an archiver or a storage box ID.

This ia a read-only field. You cannot modify the values.
WorkflowType

Corresponds to CDRDatabaseWorkflowTypes data type.

BatchState The current status of an open batch, such as status 550 (Extraction Verification).
BatchReleaseAction Batch Release Action represents the action taken when the last document of the batch verifies. The parameter can be set or read from a script. By default, it is set to 
CDRBatchReleaseActionUserDefined
(as a user always makes a selection). If you use a registry value to hide the batch release dialog box in Verifier, then the last action taken prior to the dialog box being hidden is the one showing in this parameter.

The scripter can set an override value to this parameter, such as every time batch verification completes, always goes to the next invalid batch.

Possible values

CDRBatchReleaseAction

Script Code

Private Sub ScriptModule_BatchClose(ByVal UserName as String, ByVal BatchDatabaseID as Long, ByVal ExternalGroupID as Long, ByVal ExternalBatchID as String, ByVal TransactionID as Long, ByVal WorkflowType as SCBCdrPROJLib.CDRDatabaseWorkflowTypes, BatchState as Long, BatchReleaseAction as SCBCdrPROJLib.CDRBatchReleaseAction)
   Call LogMessage(BatchDatabaseID & "," & UserName, "C:\EventTrace.Log") 
End Sub

See also