Kofax DOKuStar Validation Manuel d'utilisateur

DOKuStar Validation for Ascent Capture Programming Manual Océ Document Technologies GmbH

DOKuStar Validation for Ascent Capture Page • 6 So, when you plan to copy the scripting code from one system to another, proceed as follows: - ex

DOKuStar Validation for Ascent Capture Page • 96 DOKuStar Validation is opened, and you can modify your scripting code for the batch class you sel

DOKuStar Validation for Ascent Capture Page • 97 You can now test your code with real loaded data. You can also add changes to your code. When you

DOKuStar Validation for Ascent Capture Page • 98 Not Restore Old Contents When a scripting routine returns False in the OnFieldChanging event, th

DOKuStar Validation for Ascent Capture Page • 99 Display Multi-Line Status Texts Sometimes it might be necessary to display more than one line of

DOKuStar Validation for Ascent Capture Page • 100 Check All Fields Before Closing the Batch When the user closes a batch, you might want to check

DOKuStar Validation for Ascent Capture Page • 101 Check if the Last Field is Reached When the user leaves the last field of the last document in t

DOKuStar Validation for Ascent Capture Page • 102 Merge Table Rows The following example merges two table rows into one. The corresponding columns

DOKuStar Validation for Ascent Capture Page • 103 Private Sub mergeZones(firstFld As Field, secondFld As Field) Dim firstSrcInfo As ImageSourc

DOKuStar Validation for Ascent Capture Page • 104 Changing the Color of Documents Sometimes it may be necessary to inform the validation operator,

DOKuStar Validation for Ascent Capture Page • 105 Private Sub colorDoc(doc As Document, bnOK As Boolean) Dim lngRed As Long Dim lngGreen A

DOKuStar Validation for Ascent Capture Page • 7 The Document Model Overview In order to access fields, values, documents, etc., it is important to

DOKuStar Validation for Ascent Capture Page • 8 Here is the source code for this example: Dim WithEvents Amount As FieldType Private Sub Applica

DOKuStar Validation for Ascent Capture Page • 9 Before getting more into the details, here is a second way of solving the same problem: Dim WithE

DOKuStar Validation for Ascent Capture Page • 10 Relation to the Ascent Capture Definition There are some relations between the document model and

DOKuStar Validation for Ascent Capture Page • 11 Ascent Capture Field Types can have value lists; if so, the user input is also checked against th

DOKuStar Validation for Ascent Capture Page • 12 Support of Ascent Capture Index Field Properties In the Document Class Properties dialog box, pro

DOKuStar Validation for Ascent Capture Page • 13 Hidden: A hidden field will not appear in Validation, but can still be accessed by scripting rout

DOKuStar Validation for Ascent Capture Page • 14 This is all that must be done. Beyond that, there are some options that can influence the layout

DOKuStar Validation for Ascent Capture Page • 15 To reorder columns, you can add a position number to the column name. This number is separated

The reproduction, transmission or use of this document or its contents is not permitted wi

DOKuStar Validation for Ascent Capture Page • 16 InvoiceItems Postprocessing There is obviously a correlation between the Invoice Items fields a

DOKuStar Validation for Ascent Capture Page • 17 Events Concept Certain objects can get events. You will probably use the events defined for the F

DOKuStar Validation for Ascent Capture Page • 18 When writing an event handling routine, proceed as follows: - Define a variable of the appropria

DOKuStar Validation for Ascent Capture Page • 19 Events for the FieldType Object OnFieldActivated This event will be fired when a field gets activ

DOKuStar Validation for Ascent Capture Page • 20 OnFieldDeactivated These events will be fired when the field was deactivated. If the OnFieldDeact

DOKuStar Validation for Ascent Capture Page • 21 OnFieldDataSourceChanged These events result when the DataSource (i.e. the image) of the field ch

DOKuStar Validation for Ascent Capture Page • 22 Table Fields Tables require additional features, because they are fields that are made up of rows

DOKuStar Validation for Ascent Capture Page • 23 If SubField.Name = "Quantity" Or SubField.Name = "SinglePrice" Then Next, the

DOKuStar Validation for Ascent Capture Page • 24 Event Order Field events occur in the following order: OnFieldActivating OnFieldActivated &

DOKuStar Validation for Ascent Capture Page • 25 For table fields, the event queue is as follows: OnFieldActivating (when the user steps into the

DOKuStar Validation for Ascent Capture Page • i Contents Introduction 1 The VBA Studio 2 Development Environment...

DOKuStar Validation for Ascent Capture Page • 26 Events for the DocumentType Object OnField Events For the DocumentType object, the same OnField..

DOKuStar Validation for Ascent Capture Page • 27 OnDocumentActivated This event occurs whenever a new document is selected. This may happen expli

DOKuStar Validation for Ascent Capture Page • 28 OnDocumentCreated This event will be fired when a new document is created. This may happen explic

DOKuStar Validation for Ascent Capture Page • 29 Definition: Private Sub doc_ OnDocumentDescriptorLost(Document As Document, DocumentDescriptor A

DOKuStar Validation for Ascent Capture Page • 30 Batch Events Batch events concern opening and closing of a batch. When a batch is opened and clos

DOKuStar Validation for Ascent Capture Page • 31 OnPreExported This event will be fired after the user selected to close or suspend the batch, but

DOKuStar Validation for Ascent Capture Page • 32 Controller Events The controller object itself is described below in a separate chapter, please r

DOKuStar Validation for Ascent Capture Page • 33 OnDocumentDeleted Will be fired for any document that gets deleted. Definition: Private Sub ctr

DOKuStar Validation for Ascent Capture Page • 34 OnFieldChanged Will be fired for any field that gets changed. Definition: Private Sub ctrl_OnFie

DOKuStar Validation for Ascent Capture Page • 35 FieldClass Events There are the same events for FieldClass objects as for FieldType objects, see

DOKuStar Validation for Ascent Capture Page • ii OnCursorChanged...

DOKuStar Validation for Ascent Capture Page • 36 Data Objects Dataset The Dataset is the topmost object in DOKuStar Validation concerning the dat

DOKuStar Validation for Ascent Capture Page • 37 Schema The Schema object describes the batch structure, i.e. the Document Types and Field Types.

DOKuStar Validation for Ascent Capture Page • 38 Property/Method Returns Description At DocumentType Delivers a document type object at the sp

DOKuStar Validation for Ascent Capture Page • 39 FieldTypes See the description for DocumentTypes. The properties and methods are identical after

DOKuStar Validation for Ascent Capture Page • 40 Data The Data object is situated below the Dataset object, parallel to the Schema object. While t

DOKuStar Validation for Ascent Capture Page • 41 Documents Holds the collection of documents in this batch. An individual document can be accessed

DOKuStar Validation for Ascent Capture Page • 42 Document Holds information about one document, especially the fields and the images. Furthermore,

DOKuStar Validation for Ascent Capture Page • 43 Fields Holds a collection of Field objects. Individual Fields can be accessed either by name or

DOKuStar Validation for Ascent Capture Page • 44 Field Properties and methods of the Field object (excerpt): Property/Method Returns Descriptio

DOKuStar Validation for Ascent Capture Page • 45 TableField A TableField is a special Field object. Being derived from Field, all Field’s propert

DOKuStar Validation for Ascent Capture Page • 1 Introduction This manual covers the topics an integrator needs to adapt DOKuStar Validation for As

DOKuStar Validation for Ascent Capture Page • 46 SourceInfo, ImageSourceInfo SourceInfo is the base class of ImageSourceInfo. Within DOKuStar Vali

DOKuStar Validation for Ascent Capture Page • 47 UserData UserData is an object that is linked to each field and document object. It serves as a c

DOKuStar Validation for Ascent Capture Page • 48 VerifyEventArgs VerifyEventArgs is an object that is used with some events like OnFieldChanging.

DOKuStar Validation for Ascent Capture Page • 49 Controller The Controller object is the third sub-object of the Dataset, with the purpose of cont

DOKuStar Validation for Ascent Capture Page • 50 Cursors and Filters These topics are covered together, because there are some dependencies betwee

DOKuStar Validation for Ascent Capture Page • 51 Option Explicit Private Sub Application_OnProjectLoaded(ByVal App As Application) Dim crs As

DOKuStar Validation for Ascent Capture Page • 52 Property/Method Returns Description Documents Documents Returns the list of documents with re

DOKuStar Validation for Ascent Capture Page • 53 In addition, all the methods defined for collections are available. For the filter objects, there

DOKuStar Validation for Ascent Capture Page • 54

DOKuStar Validation for Ascent Capture Page • 55 Add-Ins Introduction Validation allows to modify its behavior using VBA. Because of some limitati

DOKuStar Validation for Ascent Capture Page • 2 The VBA Studio Development Environment When planning to write scripts, you must know - where to w

DOKuStar Validation for Ascent Capture Page • 56 Registry Key for Validation Add-Ins To be able to use a newly created add-in you must first add s

DOKuStar Validation for Ascent Capture Page • 57 Under this key a sub-key has to be created for each add-in that should be used for the respective

DOKuStar Validation for Ascent Capture Page • 58 Creating an Add-In An add-in for DOKuStar Validation is always an ActiveX Control. You can write

DOKuStar Validation for Ascent Capture Page • 59 Private Sub IAddIn_Initialize(ByVal App As DOKuStarDataset.IApplication) for this class. It is c

DOKuStar Validation for Ascent Capture Page • 60 Creating a Custom User Control In the previous section is described, how to create an add-in for

DOKuStar Validation for Ascent Capture Page • 61 Modify the code of our example in the following way and generate ValiTour.dll: There is also

DOKuStar Validation for Ascent Capture Page • 62

DOKuStar Validation for Ascent Capture Page • 63 Creating a Custom Toolbar It is also possible to create one and only one custom toolbar for DOKuS

DOKuStar Validation for Ascent Capture Page • 64 As you can see, the toolbar is activated in the same way as the user control. The only differenc

DOKuStar Validation for Ascent Capture Page • 65

DOKuStar Validation for Ascent Capture Page • 3 Selecting this menu item will open the DOKuStar Validation Module. This is almost exactly the DOKu

DOKuStar Validation for Ascent Capture Page • 66 Creating Menu Entries for Validation The programming interface allows to change the menu entries

DOKuStar Validation for Ascent Capture Page • 67 After this code has been entered, generate ValiTour.dll and start dsval.exe. The File menu will

DOKuStar Validation for Ascent Capture Page • 68 The New command has been replaced and shows a submenu with two entries. Following the Export Da

DOKuStar Validation for Ascent Capture Page • 69 The second function of the Workspace service, workspaceSink_OnCommand, is needed to specify the

DOKuStar Validation for Ascent Capture Page • 70 If you enter the code shown above, generate ValiTour.dll, start dsval.exe, and open the File me

DOKuStar Validation for Ascent Capture Page • 71 Workspaces In the previous section we used the Workspace service of Validation. In this section i

DOKuStar Validation for Ascent Capture Page • 72 What happens? We have loaded the workspace default.vws at startup of Validation. In this works

DOKuStar Validation for Ascent Capture Page • 73 Validation now comes up with the last changes you made in the workspace. Play a little around t

DOKuStar Validation for Ascent Capture Page • 74 Then we have to modify the functions loadDefault() and storeDefault(). In loadDefault() we firs

DOKuStar Validation for Ascent Capture Page • 75 Handling Keyboard Strokes Keyboard strokes can also be handled by an add-in for DOKuStar Validati

DOKuStar Validation for Ascent Capture Page • 4 Some important remarks: - You can (but you don’t have to) publish the batch class before you star

DOKuStar Validation for Ascent Capture Page • 76 Now start now Validation with dsval ValiTour.vpj. The Validation window will look as follows:

DOKuStar Validation for Ascent Capture Page • 77 Replacing Existing Controls In a previous section we created a custom user control. As was stated

DOKuStar Validation for Ascent Capture Page • 78 Now start Validation with the command dsval ValiTour.vpj. The Validation will look like this:

DOKuStar Validation for Ascent Capture Page • 79 Managing the Image Control The behaviour of the image control, like scrolling and zooming, can al

DOKuStar Validation for Ascent Capture Page • 80 Now start dsval ValiTour.vpj and try the key combinations to see the effects. Predefined Add-In

DOKuStar Validation for Ascent Capture Page • 81 Special Issues Information Bar The information bar is one of the windows of the Validation’s user

DOKuStar Validation for Ascent Capture Page • 82 The result will look like this:

DOKuStar Validation for Ascent Capture Page • 83 Exchanging the Fields View In the Validation’s Fields View all fields of the current document are

DOKuStar Validation for Ascent Capture Page • 84 In this mode, you could also close the editing window. - Display Mode: In this mode, editing i

DOKuStar Validation for Ascent Capture Page • 85 Note 1: You can also mix the modes: Use the editing mode for some fields, and the display mode f

DOKuStar Validation for Ascent Capture Page • 5 Files Yet, I didn’t mention one important thing: Where does all the code go? In most development e

DOKuStar Validation for Ascent Capture Page • 86 Table Data Output When DOKuStar recognizes tables, the corresponding data is transported in separ

DOKuStar Validation for Ascent Capture Page • 87 If no table was found on the document, there will be a table data file whose <Rows> element

DOKuStar Validation for Ascent Capture Page • 88 Character correction mode For editing single characters (for example rejects as first step of a m

DOKuStar Validation for Ascent Capture Page • 89 Step 3 Now we are ready for integrating the following code lines When the project is loaded, f

DOKuStar Validation for Ascent Capture Page • 90 Remarks: You will find the above code lines, explaining the character correction mode, as a com

DOKuStar Validation for Ascent Capture Page • 91 Properties and methods of the ValRejectEdit control: Property/Method Value Default Descriptio

DOKuStar Validation for Ascent Capture Page • 92 In the snippet view window the image of the index field is displayed, where the rejected characte

DOKuStar Validation for Ascent Capture Page • 93 How Do I… Reject Documents and Pages Documents and pages can be rejected and un-rejected by the u

DOKuStar Validation for Ascent Capture Page • 94 Note: In this example, it is important to check for the existence of the Rejected UserData befor

DOKuStar Validation for Ascent Capture Page • 95 Test the Scripting Code Something about this topic has already been said in the first chapter, th