Welcome > Overview

Overview

The WinWrap Basic Editor is a VBA-compatible script engine that can be used to enhance the built-in Kofax Transformation Modules classification, extraction, and validation processes. It is an interactive design environment for developing, testing, and executing WinWrap Basic scripts. Events are fired that can be used to individually program new classification and/or extraction or validation procedures.

Besides a short introduction to the editor's user interface, this documentation provides an overview of the available events. Small code samples show their usage, and figures illustrate the event sequence during the document recognition process.

In the script environment, the document model of the CASCADE component suite objects is available for the experienced script programmer. To improve the usability of the COM components, an additional Kofax Transformation Scripting Object References Help is provided that contains the API documentation for the relevant object libraries.

The topics within this document are arranged thusly:

  • Getting Started - an introduction to the scripting objects.

  • Server, Document Review, Validation, Verification: Module specific scripting (by module that is supporting scripting) - these topics cover the scripts that have relation to a specific module.

  • Configuring Batch Operations - Batch operations are used to manipulate batch structure with or without operator interaction.

  • Applying Scripting - this topic is arranged by function and under certain conditions with information about module specific implementation.

  • Script Samples - this section contains code examples for the common scripting requirements.

Note Only the objects, methods, and properties that are documented in the Scripting Object References Help can be used for script programming. The use of undocumented methods or properties in script is not supported or recommended, as this can cause unpredictable behavior.

An example in the Scripting Help may use a method that is not documented to provide special functionality shown by the example. In this case, even though the method is not documented, it is supported, but only when restricted to the use provided by the sample.