The document model, Overview – Kofax DOKuStar Validation User Manual

Page 11

Advertising
background image

DOKuStar Validation for Ascent Capture

Page

7

The Document Model

Overview

In order to access fields, values, documents, etc., it is important to understand how data is organized in DOKuStar
Validation. This data structure is called the document model.

This document model is quite a large structure, and contains parts that you will probably never use. This manual
concentrates on those items that are common to most applications.

At the top of the hierarchy stands the

Application

object, which has some assigned members and methods. To get

down to the data, use the following chain of members:

Application.Project.DataSet

Note:

Application

and

Project

have some members and methods, but they will be disregarded right now to

concentrate on the dataset.

The

Dataset

has three members:

- the

Schema

: This is the part that describes the structure of the batch, i.e. the form types that are defined and

the index fields, and mainly corresponds to the Ascent Capture definition of form types and index fields, but
may also include the table definition from DOKuStar

- the

Data

: This is the part where the data is stored

- the

Controller

: This object controls the dataset’s behavior at the user interface.

You will use the

Schema

or the

Controller

when defining field and document events: For which document

and/or for which field is an event needed? The

Data

will then be used in the code you write for the specific event:

When an event is received, the data for the specific document will be handed over.

Before getting too theoretic, let us look at a simple example. But before that, one important remark:

In the Ascent Capture batch class definition, both document classes and form types exist. Index fields are defined
for the document class. In our document model, document classes do not appear at all. Everything is based on the
form types, which are here called document types. Index fields are assigned to these document types. So if, for
example, a document class “Invoice” is defined in Ascent Capture, along with two form types named “MyInvoice1”
and “MyInvoice2”, these two form types will appear as document types in the document model; something like
“Invoice” is unknown.

Now for the example:

Suppose a form type

Invoice

has been defined in the Ascent Capture batch definition, which has a field

TotalAmount

. Whenever the user changes this

TotalAmount

field, the field shall be checked if the value is

greater than 1000.00; if so, the user shall confirm the change in a message box.

Advertising