Jump to main content
Brainware Intelligent Capture Scripting
Brainware Intelligent Capture Scripting
 Foundation 23.1
  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
  • SCBCdrPROJLib
  • Working with the Associative Search Engine (CDRADSLib)
  • Working with the Check Analysis Engine (SCBCdrParaCheckLib)
  • Working with the Format Analysis Engine (SCBCdrFormatEngine)
  • Working with Format Settings (SCBCdrFormatSettings)
  • Working with Batches (SCBCdrBATCHLib)
  • Comparing Strings (SCBCdrSTRCOMPLib)
  • Working with Images (SCBCroIMGLib)
  • Working with CI Documents (SCBCroCiDocLib)
  • Working with Cairo Projects (SCBCroPROJLib)
  • Working with Collections (SCBCroCollLib)
  • Working with Worktext Objects (SCBCroWorktextLib)
  • Working with Verification Forms (DISTILLERVERIFIERCOMPLib)
  • Printing Documents (SCBCroPrintLib)
  • Error Handling
  • Troubleshooting Scripting Issues
  • Encryption
  1. Home
  2. ScriptModule Events
  • Documentation Notice
  • About Scripting
  • ScriptModule Events
    • About the ScriptModule Event Interface
    • Implementing an Event

      To implement a script handler of an event, complete the following steps.

    • AppendWorkdoc

      This event triggers when processing a document separation workflow step in Runtime Server. It appends a given workdoc after the last workdoc based on the append type.

    • BatchClose

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

    • BatchOpen

      This event triggers when a user opens a batch.

    • ExportDocument

      This event allows you to implement a customer specific export of all extracted data. This provides the ability to implement a customer-specific export of all extracted data.

    • Initialize

      This event triggers when a batch opens for processing.

    • MoveDocument

      This event triggers when a Verifier or Web Verifier user places a document in the exception batch and the document moves out of the batch.

    • PostClassify

      This event triggers after all defined classification methods are executed by the Cedar Project.

    • PostImport

      In general, this event triggers after the import.

    • PostImportBatch

      The Runtime Server triggers this event after it finishes importing the batch. Use this event to set batch properties such as batch name and external group ID.

    • PostOCR

      This event triggers after the OCR process.

    • PreClassify

      This event triggers before any defined classification method executes by the Cedar project. During this event, it is possible to apply an existing name of a DocClass to the workdoc.

    • PreClassifyAnalysis

      This event triggers between the PreClassify and PostClassify events that identify the beginning and end of the classification workflow step for a particular document. Using this event the custom script can clean-up and extend classification results before the final decision is made by the system and before the final classification matrix is built.

    • PreImport

      This event triggers before the import occurs.

    • PreOCR

      This event triggers before the OCR process occurs.

    • ProcessBatch

      The ProcessBatch event triggers when the Runtime Server instance begins processing during the custom processing workflow step.

    • RouteDocument

      This event triggers when the system extracts a document.

    • Terminate

      This event triggers before a batch closes after processing.

    • UpdateSystemSecurity

      This event triggers when running security updates in Runtime Server.

    • VerifierClassify

      This event triggers in Verifier in the following cases.

    • VerifierException

      This event triggers in case of an exception in Verifier and Web Verifier.

    • VerifierFormLoad

      This event triggers optionally in Designer before the Verifier form is loaded.

  • Cedar DocClass Event Interface
  • Cedar [FieldName] Event Interface
  • Working with Workdoc Objects (SCBCdrWKDOCLib)
  • SCBCdrPROJLib
  • Working with the Associative Search Engine (CDRADSLib)
  • Working with the Check Analysis Engine (SCBCdrParaCheckLib)
  • Working with the Format Analysis Engine (SCBCdrFormatEngine)
  • Working with Format Settings (SCBCdrFormatSettings)
  • Working with Batches (SCBCdrBATCHLib)
  • Comparing Strings (SCBCdrSTRCOMPLib)
  • Working with Images (SCBCroIMGLib)
  • Working with CI Documents (SCBCroCiDocLib)
  • Working with Cairo Projects (SCBCroPROJLib)
  • Working with Collections (SCBCroCollLib)
  • Working with Worktext Objects (SCBCroWorktextLib)
  • Working with Verification Forms (DISTILLERVERIFIERCOMPLib)
  • Printing Documents (SCBCroPrintLib)
  • Error Handling
  • Troubleshooting Scripting Issues
  • Encryption

ScriptModule Events

The ScriptModule object provides the following events.

  • AppendWorkdoc
  • BatchClose
  • BatchOpen
  • ExportDocument
  • Initialize
  • MoveDocument
  • PostClassify
  • PostImport
  • PostImportBatch
  • PostOCR
  • PreClassify
  • PreClassifyAnalysis
  • PreImport
  • PreOCR
  • ProcessBatch
  • RouteDocument
  • Terminate
  • UpdateSystemSecurity
  • VerifierClassify
  • VerifierException
  • VerifierFormLoad
footer © Hyland Software, Inc. and its affiliates. All rights reserved.