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.
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.
CellChecked
This event triggers when a check box cell of the table is checked or unchecked by a user.
CellFocusChanged
This event triggers each time the focus inside the verification table changes.
Format
This event is used to reformat the content of a field, for example to unify a date or amount format or removing prefixes and suffixes. This event prepares the field data for validation.
FormatForExport
Use this event to reformat the content of a field, for example to unify a date or amount format or to remove prefixes and suffixes.
PostAnalysis
This event triggers after the analysis step performs. It is possible to examine the list of all candidates and to add further candidates to the field.
PostEvaluate
This event triggers after the evaluation step performs. It is possible to examine the list of all candidates and to change their weights.
PreExtract
This event triggers before any defined analysis or evaluation method for this field executes by the Cedar DocClass.
SmartIndex
This event triggers for the field where the smart indexing is defined. This field typically provides the key for the select statement.
TableHeaderClicked
This event triggers when a user clicks on one of the table header buttons. There are three different table header buttons: the Row Header, the Column Header, and the Table Header button.
Validate
Use this event to perform project specific validation rules. Use the pValid parameter to return the validation decision. If the parameter remains unchanged or if the event is not implemented, the document state gets valid if all fields are valid.
ValidateCell
This event method triggers for each cell of the table. You can implement validation checks specific for a single cell.
ValidateRow
Use this event to implement validation rules, which combine two or more cells of a row.
ValidateTable
Use this event to implement a validation rule for the entire table.
SCBCdrWKDOCLib Type Definitions
The SCBCdrWKDOCLib object provides the following type definitions.
SCBCdrCandidate
Cedar candidates are generated during the analysis step and are representing possible results of a field.
SCBCdrDocPage
The SCBCdrDocPage object represents a single DocPage within a workdoc.
SCBCdrEmailProperties
When importing a MSG file into a workdoc, the most important properties of the email are stored in the workdoc and available in the custom script through the "ISCBCdrEmailProperties" interface that can be queried from the SCBCdrWorkdoc interface.
SCBCdrField
This object contains the evaluated data to extract from the document.
SCBCdrFields
This is a collection of all field objects contained in the current WorkDoc object.
SCBCdrFolder
A folder can represent an array of workdocs within a batch. A folder can contain one or more workdocs. During classification and extraction, you can access all workdocs of the same folder from within a script.
SCBCdrTable
The Cedar table object represents a logical table in a document assigned to a Cedar field of a workdoc.
SCBCdrTextblock
This object represents a TextBlock on a document. A TextBlock can contain one or more lines.
SCBCdrWord
This object represents a textual word of a document.
SCBCdrWorkdoc
The Cedar workdoc object stores all data of one document. The amount of data grows during the processing steps of OCR, classification and extraction.
SCBCdrPROJLib Type Definitions
The SCBCdrPROJLib object provides the following type definitions.
SCBCdrProject Methods
The Cedar Project object provides the following methods.
SCBCdrProject Properties
The Cedar Project object provides the following properties.
SCBCdrDocClass
A Cedar DocClass object represents a single document class within a Cedar project class hierarchy.
SCBCdrDocClasses
This collection contains all defined DocClass objects of the Cedar project.
SCBCdrFieldDef
A Cedar FieldDef object represents the definition of a single FieldDef inside a Cedar DocClass
SCBCdrFieldDefs
This collection contains all defined FieldDef objects of a single DocClass.
SCBCdrLicenseInfoAccess
The Licensing Information Access object allows direct retrieval to the active licensing object. You can directly query any licensing component in a custom script.
SCBCdrSettings
The Cedar Settings object stores arbitrary strings for usage in script.
SCBCdrScriptModule
This is a global object at the project level. All script module events occurred at project level belong to this object.
SCBCdrScriptAccess
Brainware Intelligent Capture provides a public interface "SCBCdrScriptAccess" for external access to the project and class level custom script pages. The interface can be queried from the main "SCBCdrProject" interface available in Brainware Intelligent Capture custom script. Using this interface it is possible to get, modify and dump project and class level scripts.
SCBCdrSupExSettings Type Definitions
The SCBCdrSupExSettings object provides the following type definition.
SCBCdrSupExSettings Methods
The SCBCdrSupExSettings object provides the following methods.
SCBCdrSupExSettings Properties
The SCBCdrSupExSettings object provides the following property.
SCBCdrSupplierExtractionEngine Methods
The SCBCdrSupplierExtractionEngine object provides the following method.
SCBCdrParaCheckLib Type Definitions
The SCBCdrParaCheckLib object provides the following type definition.
SCBCdrParaCheckAnalysisSettings Methods
The SCBCdrParaCheckAnalysisSettings provides the following methods.
SCBCdrParaCheckAnalysisSettings Properties
The SCBCdrParaCheckAnalysisSettings provides the following properties.
Vocabulary Entry Objects (PayeeVocEntries)
This is a collection of all vocabulary entry objects contained in the current ParaCheckSettings object.
SCBCdrFormatEngine Methods
The SCBCdrFormatEngine provides the following methods.
SCBCdrFormatEngine Properties
The SCBCdrFormatEngine provides the following property.
SCBCdrFormatSettings Type Definitions
The SCBCdrFormatSettings object provides the following type definitions.
SCBCdrFormatSettings Methods and Properties to Modify the List of Format Strings
Use the following methods and properties to modify the list of format strings.
SCBCdrFormatSettings Methods and Properties to Specify the Settings for each Format String
Use the following properties to specify the settings for each format string.
SCBCdrFormatSettings Methods and Properties to Specify the General Search Settings
Use the following methods and properties to specify the general search settings.
SCBCdrFormatSettings Methods and Properties to Specify the Settings for the Search Regions
Use the following properties to specify the settings for the search regions.
SCBCdrBatchRoot Methods
The SCBCdrBatchRoot object provides the following methods for batch administration.
SCBCdrBatchRoot Properties
The SCBCdrBatchRoot object provides the following properties for batch administration.
SCBCdrSTRCOMPLib Type Definitions
The SCBCdrStringComp object provides the following type definition.
SCBCdrStringComp Methods
The SCBCdrStringComp object provides the following methods.
SCBCdrStringComp Properties
The SCBCdrStringComp object provides the following properties.
SCBCroIMGLib Type Definitions
The SCBCroImage object provides the following type definitions.
Image Object SCBCroImage
The component SCBCroImage provides methods and properties to load, modify, and save image files.
Viewer Object SCBCroViewer
The component SCBCroViewer provides methods and properties to display various objects, such as images, text documents, annotations, or OCR and scanning results.
SCBCroCiDocLib Type Definitions
The SCBCroCiDocLib object provides the following type definition.
CI Document Object SCBCroCIDOC
The component SCBCroCIDOC provides methods and properties to work with CI documents.
CI Document Conversion Object SCBCroCIDOCConv
The component SCBCroCIDOCConv provides methods to convert a CI document to a text file or a Worktext.
SCBCroPROJLib Type Definitions
The SCBCroProject object provides the following type definitions.
Project Object SCBCroProject
The component SCBCroProject provides methods and properties to work with projects.
Page Object SCBCroPage
The component SCBCroPage provides methods and properties to work with single pages.
Pages Object SCBCroPages
The component SCBCroPages provides methods and properties to work with all contained page objects.
Zone Object SCBCroZone
The component SCBCroZone provides methods and properties to work with zones.
Zones Object SCBCroZones
The component SCBCroZones provides access to all contained zone objects.
Collection Object SCBCroCollection
The component SCBCroCollection provides methods and properties to work with collections.
SCBCroWorktextLib Type Definitions
The SCBCroWorktextLib object provides the following type definitions.
SCBCroWorktext
The SCBCroWorktext library provides methods and properties to modify the worktext object.
DISTILLERVERIFIERCOMPLib Type Definitions
The DISTILLERVERIFIERCOMPLib provides the following type definition.
SCBCdrVerificationForm
Use this interface to set specific verification form properties, as well as to set default properties for embedded elements, such as verification fields, labels, tables, and buttons.
SCBCdrVerificationField
This interface is used to identify verification properties specific for header fields’ validation elements, like drop down lists, check-boxes, and normal edit fields.
SCBCdrVerificationTable
This interface is used to identify verification properties specific for table validation elements.
SCBCdrVerificationButton
Use this interface to set verification properties specific for all custom buttons defined on a verification form.
SCBCdrVerificationLabel
This object is part of the Cedar Verifier Component Library. It enables the scripter to manipulate the verifier form labels.
SCBCroPrintLib Type Definitions
The SCBCroPrint object provides the following type definitions.
Print Object SCBCroPrint
The component SCBCroPrint provides methods and properties to configure the printing process.
On Error
The On Error statement enables you to handle runtime errors.
ErrObject
The ErrObject module provides methods and properties to identify and handle runtime errors using the Err object.
Sample Code
The following sample code sample shows how to use On Error Goto and the ErrObject.
Password Encryption for Database Connection Strings
The BIC architecture makes it important to be able to hide sensitive security information, such as database passwords stored in BIC or custom project configuration files.