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. Cedar DocClass Event Interface
  • Documentation Notice
  • About Scripting
  • ScriptModule Events
  • Cedar DocClass Event Interface
    • FocusChanged

      This event triggers each time before the focus inside the verification form changes. You can modify the focus change by modifying the pNewFieldIndex parameter. You can write a different field index into that parameter, which causes Verifier to change to a specific field instead of the originally selected field. The system triggers this event in Designer, if you set the Reason parameter to CdrBeforeFormLoaded, and if you enable the option in the Settings dialog box, on the Compatibility tab.

    • OnAction

      This event triggers if any of the configured actions in the Verifier Design Mode were caused by the user clicking a button or pressing any of the configured keyboard short cuts.

    • PostExtract

      This event triggers after all defined analysis or evaluation methods execute by the Cedar DocClass. During this event, it is possible to examine and change the results of one or more fields of the document.

    • PreExtract

      This event triggers before any defined analysis or evaluation method executes by the Cedar DocClass.

    • PreVerifierTrain

      The PreVerifierTrain event is added to control SLW training in Verifier, Learnset Manager, and Designer.

    • Validate

      Use the Validate event to perform validation on document level. At this point, the validation of all single fields executes. If one of the fields is still invalid, pValid is FALSE. During the Document_Validate event, it is possible to implement validation rules combining several fields. This may cause some fields to be invalid again. Do not make the document invalid if all fields are valid, because the Verifier needs an invalid field for focus control. If you want to keep the document invalid, always set at least one field to an invalid state.

    • VerifierTrain

      After a document processed in self-learning Verifier has been checked whether it is supposed to be automatically trained for the local project, the Verifier has to trigger an event that adds a document to the local learnset.

  • 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

Cedar DocClass Event Interface

Document events are specific for each Cedar DocClass instance. Each DocClass has its own script module and implementation of script events.

The Cedar DocClass event interface provides the following events.

  • FocusChanged
  • OnAction
  • PostExtract
  • PreExtract
  • PreVerifierTrain
  • Validate
  • VerifierTrain
footer © Hyland Software, Inc. and its affiliates. All rights reserved.