The document model: overview – Kofax DOKuStar Validation User Manual

Page 11

Advertising
background image

DOKuStar Validation Programming Manual

Page

7

The Document Model: Overview

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

Document Model

. For a complete description of the document

model, refer to the online reference.

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. One of

them is the

Project

property, which holds a

Project

object.

The

Project

is a central object within DOKuStar Validation. It holds a description of the Validation’s structure

(which document types and index fields are defined) as well as the data itself (the specific documents that are to be
validated). Projects can be saved to a file (optionally with or without the data part) and read in again. A project file
has the default filename extension

.vpj

(Validation Project).

Below the project, there is an object called

DataSet

:

The

DataSet

has three members:

- the

Schema

: This is the part that describes the structure of the project, i.e. the document types that are defined

and the index fields on them.

- the

Data

: This is the part where the data are stored

- the

Controller

: This object controls the behavior of the

DataSet

at the user interface.

The following chapters concentrate on the

Schema

and the

Data.

Advertising