Captiva 5.3 Tutorial

Step by step guide to learn Captiva / InputAccel 5.3

Table of Contents

1 Introduction.............................................................................................................................4

1.1 Purpose ..............................................................................................................................4

1.2 Scope .................................................................................................................................4

1.3 A Brief Introduction to Captiva InputAccel..............................................................................4

1.4 Architecture of Captiva InputAccel System......................................................................................4

2 Setting up the System .............................................................................................................6

2.1 Installation of software .........................................................................................................6

2.2 Licensing Captiva InputAccel Server.................................................................................7

2.3 Creating and compiling and installing a Process ..................................................................10

2.4 Configuring the Process.....................................................................................................15

2.5 Configuration of Validation Environment .......................................................................................48

2.6 Configuration of OCR module ...................................................................................................... 54

3 Using the System ..................................................................................................................59

3.1 Process-Flow Diagram.......................................................................................................60

3.2 Batch Preparation ..............................................................................................................61ENGT010_20 User Documentation

Page 1 of 97CaptivaInputAccelKnowledgeTransferDocument

10/09/2013http://www.emccaptiva.net/captiva_5_3_tutorial/body.html

3.3 Using the Scan module ...................................................................................................... 62

3.4 Using the Image Enhancement module ...............................................................................66

3.5 Using the Multi module.......................................................................................................67

3.6 Using the Index module...................................................................................................... 68

3.7 Using the Export module ....................................................................................................73

3.8 Using the Rescan module ..................................................................................................75

3.9 Viewing Log Files ..............................................................................................................77

3.10 Using Scansoft OCR ........................................................................................................79

4 Different Requirement Scenarios.............................................................Error! Bookmark not defined.

4.1 Segregation of pages .........................................................................................................80

ENGT010_20 User Documentation

4.2 Reading Barcodes .............................................................................................................81

4.3 Using OCR-Captured Data................................................................................................. 83

4.4 Image Quality Assurance while Indexing .............................................................................84

4.5 Validating Indexed Data .....................................................................................................87

4.6 Creating a Folder-Hierarchy in Documentum .......................................................................87

4.7 Deleting Batches Automatically...........................................................................................88

4.8 Creating Log Files .............................................................................................................88

4.9 Creating User Restrictions on Batches ................................................................................ 89

4.10 Error handling..................................................................................................................91

5 Debugging a Batch ......................................................................................................................93

6 Monitoring a Batch.......................................................................................................................95

7 Error Messages............................................................................................................................ 96

8 Glossary.......................................................................................................................................97




Page 3 of 97


1 Introduction

1.1 Purpose

The purpose of this Document is to help the reader start using Captiva InputAccel to make

workflows to scan, process and export documents. This Document will make the user

familiar with the different modules used in the Captiva workflow and guide them as to how

to use these modules.

1.2 Scope

This Document is to be used as a User-Guide for anyone who wishes to start working with

Captiva InputAccel.

1.3 A Brief Introduction to Captiva InputAccel

Captiva InputAccel is an EMC2product just like Documentum and is, in fact, a part of the

Documentum solution package. It is a Scanning solution which is integrated with a number

of Content Management solutions such as Documentum, Filenet, CMIP, CSSAP, IBM Content

Manager, etc. Captiva InputAccel implements a workflow, in which the first step is Data

capture. Data capture is achieved either directly through a Scanner or through files

imported from a local or network directory.




Page 4 of 97

1.4 Architecture of Captiva InputAccel System

The Architecture of the Captiva InputAccel System is very simple. The Captiva system

comprises of a Sever and a Client. The Server and the Client can be installed on the same

machine as well as on different machines. The only requirement is that they have to be on

the same network. The client again comprises of a number of modules (which can be defined as functionalities

within InputAccel). A number of modules, when arranged in a particular sequence makes up

an InputAccel workflow. The workflow starts with Data Capture which is accomplished

through a Scanner which is attached to the Client machine or through file import from a

network Windows file system. At a particular point in the workflow, a module which

facilitates export of the scanned images to some database or file system comes into play. At

this point, the InputAccel Server establishes a connection with the corresponding Database

Server and exports the Data to the specific database.


Captiva InputAccel

Server

Captiva InputAccel

Client

Destination Database

Server

Fig1. Basic Architecture of Captiva InputAccel System




Page 5 of 97


2 Setting up the System

The entire process of making a Captiva InputAccel system ready to run according to our

requirements can be summarized according to the following steps –

1. Installation

2. Licensing

3. Creating, compiling and installing a process.

4. Configuring the process.

5. Running the Process.

Some other peripheral functions are –

1. Debugging a batch.

2. Monitoring a batch.

2.1 Installation of software

For Installation of Captiva InputAccel Server and Client, refer to the Installation Guide

available with Captiva InputAccel Capture package. Nearly all the steps are such that you

just have to click on a “Next” tab. There are just a few points you will need to keep in mind

during installation and these are-

During installation of Captiva InputAccel Server, you will get two options of set-up –Custom and Complete . Select Complete to install all the available features.




Page 6 of 97

During installation of Captiva InputAccel Client, you will get four options of set-up –

Typical, Indexing only, Scanning only and Custom. In this case, select Custom

and select all the modules you require. Please keep in mind that you should install

the Process Developer module to create your customized IPP (InputAccel Process-

Flow Project) files.

During installation of Captiva InputAccel Client, you will be provided with a list of

Scanners to choose from. If you have a scanner already installed on your system,

then chose that particular make and model of scanner from the list, otherwise select

the “No Scanner File Import Only” option. You can install the Scanner on the

system later on and select the correct Scanner Driver.

A pre-requisite for the installation of Captiva InputAccel Capture is the installation of

Documentum Desktop Client 5.2.5 or later version on your system.


2.2 Licensing Captiva InputAccel Server

The instructions given here regarding licensing of Captiva InputAccel Server refer to the

process followed for the latest version of Captiva InputAccel Server - version 5.3 and above.

For more detailed information, please refer to the “Installation and Licensing Guide”

available with Captiva InputAccel Server installation. After both Captiva InputAccel Server

and Client have been installed, the Captiva InputAccel Server has to be licensed with the

proper license and activation files. Following are the steps to license the Captiva InputAccel

Server.

1. While installing the Captiva InputAccel Server, select the option “Install

Demonstration Licenses”. We will install the full license later on after installation.

2. After installation of InputAccel Server and Client is complete, open the Administrator

module.

3. A pop-up will appear telling the reader that he is using a demonstration license

which is valid for 31 days and he will have to activate an activation file for the full

license. (Screen-shot is not available because replication of this scenario requires

uninstallation of the existing license).

4. In the above pop-up, the user will then select an Activation file to load. (The

Activation file is a .caf file which is provided along with the license file, which is a .lic

file).

5. On selecting the Activation File, the user will receive a prompt for an Activation Key.

If the user does not already have the activation key with him, he can click on a link

below which will provide him with an online form. The user will fill up this form and

submit it. The form will be received by Captiva Licensing and the user will

immediately receive an email notification of the receipt of his Activation Key request.

The user will receive the Activation key by 72 hours at the maximum (The time

required actually has never been observed to exceed 24 hours).

6. On receiving the Activation Key, the user will enter the Activation Key by opening the

Administrator module and the Activation file will be activated.

7. Next, the user will open the Supervisor module. Go to License Import from FileENGT010_20 User Documentation



Page 7 of 97


Fig2. Importing a license File




Page 8 of 97


The user will select the .lic file provided by Captiva Licensing. The licenses will be imported

from the file and loaded on the InputAccel Server.

Fig3. License Codes ENGT010_20 User Documentation



Page 9 of 97

Fig3. License Codes ENGT010_20 User Documentation

2.3 Creating and compiling and installing a Process

While working in Captiva InputAccel, we follow a process (you can call it a workflow). There

are a number of processes which are pre-installed on the InputAccel Server as a part of the

installation procedure. But these pre-installed processes are never sufficient to fulfill our

specific requirements. So we will need to create our own process. We can create our own

process from scratch or we can make changes to an existing process. Both processes work

equally fine. Here, we will discuss how to create a process from scratch. In order to create

and compile this process, we use a module provided by Captiva InputAccel – “Process

Developer”. Given below are the steps to create and compile a new Process. For further

details, please refer to the Process Developer Guide.

1. Open the Process Developer Module from the Start Menu.

2. Go to File New Process.

3. Select the MDF’s that you wish to include in your process.




Page 10 of 97

Fig4. Selecting MDF’s


4. Next define a Name and Trigger level for each instance that you are including in your

process.

Fig5. Adding an Instance

5. Now save the IPP file with some name. After saving it, you can now proceed to include

code in your IPP file. The interface where you will enter your code will look something like

this.




Page 11 of 97

Fig6. Basic code of an IPP


6. The basic code that you have to include in each instance is the code which will route the

scanned/processed images from that instance to the next instance in the workflow. This

code is written in the Finish Event Handler of that instance and it is written in VBA (Visual

Basic for Applications). The code in the Finish Event Handler is processed after the module

has completed its function.

The code will be something like this:

Private Sub Scan_Finish(ByVal p As IASLib.IAS_RECORD_0)

p.Index.InputImage = p.Scan.OutputImage

End Sub

We normally do not need to add any code in the Export Finish Event handler because it is

the last step in our workflow. But if we wish to perform some error handling in the Export

Module, we will have to add code in its Finish Event handler.

7. Once the basic code has been written, save the IPP file. Now, go to File Make IAP

and save your compiled IAP file (InputAccel Process-Flow Project file).




Page 12 of 97


8. The next step is to install the compiled IAP file. This can be done in three ways – from

Process Developer, from Administrator module, and from Supervisor module. The

screen-shots below show how installation of a process is done in these three different ways.




Page 13 of 97

Fig7. Installing a process from Process Developer module


Fig8. Installing a process from Administrator module




Page 14 of 97


Fig9. Installing a process from Supervisor module




Page 15 of 97

2.4 Configuring the Process

Before we start processing our documents, we have to configure or setup the process or the

workflow. Let us take a sample process – Motor_Policy_001. This process will perform

the following functions –

1. Scan documents into the Captiva InputAccel System. The records are in a specific

pattern. The documents are arranged into a number of records. Each record is again

made up of one or two documents. The first page makes up the first document,

which is to be named Covernote, while the rest of the pages (if there are any) make

up the other document which is to be named Accenture.

2. Split the documents into folders and documents. To split the scanned pages into

folders and documents, we need certain separators which will identify the starting

point of a new document or new folder. In this case, we use a barcode, Barcode

Type 39 as the folder separator. For splitting of documents, we use the simple

concept that that the first page of each folder is to be one document, while the rest

of the pages make up another document.


3. Improve the quality of scanned images if required. This process will straighten out

skewed images.

4. Capture data from the Covernote page of each record. We will detect a barcode text

on the top of the Covernote page (we will call it the Covernote Number) and store it

as a property of the record .

5. Validate captured data. The Barcode text which is captured from the Covernote page

will be validated against a table in an AS400 database.

6. Automatically get data. After validating if the Covernote number is correct, we will

collect other data in the table corresponding to the Covernote Number and store

them as properties of our records.

7. Export the scanned images to a specific repository. The images will be exported to

Documentum hierarchies which will be based on the properties of the records which

have been collected from the AS400 database. To do this, we will associate the

properties of the records with Documentum attributes.

8. The hierarchy to which documents will be exported in Documentum is – Cabinet (any

name) Hub code SBU code - Lateral name Contract type Policy name

(Registration No_ Serial No) Covernote and/or Annexure. The Hub Code field is

optional. There might be cases where it would not occur.

9. Verify the successful export of records. If export of a record fails due to some

reason, the record will be sent back for correction.

10. Log files will be generated, which will keep track which records have been scanned

and successfully exported to Documentum repository.




Page 16 of 97


The configuration of the process to perform these functions will be done as described hence.

Select your process from the Administrator module by using this path-

View all Processes Motor_Policy_001




Page 17 of 97

Fig 10. Selecting process for Motor-Policies in Administrator module


In the right-Hand window, you can see the sequence of modules for this process.

Following sections will describe how to configure each module

Scan Module

Here define the levels you want to display in your node tree during scanning. Levels identify

the organization of pages and documents in a record.




Page 18 of 97

Fig 11. Selecting the Levels of the Node Tree


Now select the Event Actions for configuring actions for scanner. Event Actions helps you

configure various actions to be performed during scan process like removal of Blank page(s)

scanned along with required documents, rotation of pages etc.




Page 19 of 97

Fig 12. Configuring the Scanner Event actions. ENGT010_20 User Documentation

Select “Scanner driver” to select appropriate scanner driver installed on machine to be used

by Captiva and select the type of Scanner installed. Choose the particular driver that comes

with you scanner installation . Incompatible driver may result in malfunctioning of the

process.




Page 20 of 97

Fig 13. Selecting the Scanner Driver


Select No Scanner File Import Only if you do not have a Scanner installed on your

system.

Fig 14. Selecting Scanner Model




Page 21 of 97


Selecting Driver and clicking OK will prompt Scanner property sheet for configuration.

Configure Mode, Resolution, Scan mode- Simplex/Duplex, paper size and ditheringoptions.




Page 22 of 97

Fig 15. Configuring Scanner Settings ENGT010_20 User Documentation

Use the values given in the table to fill in the options for Scanner settings for the purposes

of this process. Otherwise, fill them as required.

Property Motor Policy Scanning Non-Motor Policy Scanning

Duplex False True

Turnover False False

OutputImage IA value OutputImage OutputImage

Mode Black and White Black and White

Resolution 200 200

Page Size A4 A4

Dither None None

Brightness Auto Auto

Contrast Auto Auto

Table 1. Values for Scanner Settings Configuration




Page 23 of 97


Next click on the Index tab. Select the options as depicted in screenshot attached below.

Check the Do not index radio button and select Level as “0-Page”

Fig 16. Saving Index settings for Scan module. ENGT010_20 User Documentation



Page 24 of 97

Fig 16. Saving Index settings for Scan module. ENGT010_20 User Documentation

Next go to the Auto Batch Creation tab and give a batch name schema. This schema will

be followed for the naming of all the batches based on this process. For more information

regarding the naming schema, refer to the Scan help document. The extension @(Now)

seen below ensures that all the batches have a unique name. The name of the batch will

appear as-

NewProcess_ITGI_08_date/month/year-hours.minutes.seconds




Page 25 of 97

Fig 17. Specifying the Batch name schema


Image Enhancement module

Now setup the Image Enhancement module by double-clicking on the ImageEnhance

instance. IA module will enable the detection and capture of Barcodes from various

documents scanned. The batches will have Barcode printed on the Covernote document

that need to be captured and its value should be stored in index parameter for validation

and export.

First select a sample image and select the “Barcode Detection” filter from the

(Filter Insert Barcode Detection) option




Page 26 of 97

Fig 18. Enabling Barcode Detection


Now select the properties of this filter and set them up in the following way.

Fig 19. Configuring properties for Barcode detection




Page 27 of 97


Another filter we need to select is the “Deskew” filter. This filter will straighten out skewed

images.




Page 28 of 97

Fig 20. Enabling Deskewing of images.


Next we have to configure the properties of this filter in the way shown below.

Fig 21. Configuring properties of Deskew filter.




Page 29 of 97


Index module.

Create 7 Edit type fields and configure them as shown. The function name in the Validate

key field will be different for each field and will be named according to which function is

called for validation of each field value. The first three fields will be Editable, while the rest

of the fields will be Non-Editable i.e., the Editable checkbox will be cleared. You can see a

variable @(SplitPolicy.Level2_Title0) being passed in the Validation Key for the first

field. This variable passes the Barcode text to the Validation function.




Page 30 of 97

Fig 22. Configuring settings for Indexing Fields


Use the values given in the table to configure the Indexing Fields.

Field

name

Level Type Editable Auto-

Validate

Validate Key

Covernote

no

2 Edit True True Aux

ProjecforValidation.ClassforValidation

MyFunction0

@(SplitPolicy.Level2_Title0)

Registration

no

2 Edit True True Aux


MyFunction01

Serial no 2 Edit True True Aux


MyFunction02

Contract

type

2 Edit False True Aux


MyFunction03

Lateral

name



MyFunction04

Branch

name



MyFunction05

Hub name 2 Edit False True Aux

ProjecforValidation.ClassforValidation ENGT010_20 User Documentation



Page 31 of 97


MyFunction06

Table 23. Settings for Indexing Fields for Motor_Policy Batch.


Next we need to select the Quality Assurance check boxes from the Setup tab on the top

left hand corner. We shall check one or more check boxes from the list shown below. The

significance of these boxes is that checking any of them cancels the Indexing of the current

record and sends it to Rescan for replacement or removal.

Fig 24. Selecting Quality Assurance check boxes to be displayed.




Page 32 of 97


Export Module

We have used four instances of Documentum Server Export – two for exporting the Covernotes (ExpCov & EXpCovHub) and the other two for exporting the Annexures(ExpAnx & ExpAnxHub). The two instances ExpCovHub and ExpAnxHub are to handle a

special case, where we might want to store the documents in a different folder structure in

Documentum. There might be a case where we can have an SBU without having a Hub.

These two instances are included to handle this special case. First setup the ExpCov

instance.

First you have to login to the desired Docbase (Documentum Repository). In the Docbase

option, select the shown option if you intend to export to a single Docbase. Otherwise select

the desired Docbase.




Page 33 of 97

Fig 25. Selecting the Documentum repository to be used


To enable to export of documents in required folder hierarchy in Documentum, configure

the Objects options as described below. First create a list of following objects.




Page 34 of 97

Fig 26. Creating a list of objects to specify the Folder Structure.


Set the mapping for each Object.Mapping identifies how the Levels created during scan

stage will correspond to Documentum object during export.

The first object is the dm_cabinet object. This object is a must, because in a Documentum

Repository, everything is stored inside a cabinet. In its properties, we name a cabinet to

which we wish to send our documents. In this case, the name of the cabinet is

“ITGI_Demonstration”.




Page 35 of 97

Fig 27. Naming the Cabinet to which we want to export.





Page 36 of 97

Fig 28. Naming the folder for Hub. ENGT010_20 User Documentation

Fig 29. Naming the folder for Branch.




Page 37 of 97


Fig 30. Naming the folder for Lateral.




Page 38 of 97


Fig 31. Naming the folder for Contract Type.




Page 39 of 97


Fig 32. Passing attribute values for the Policy folder.




Page 40 of 97


Fig 33. Passing attribute values for the Documents inside a Policy.




Page 41 of 97


Next, Configure the Content option as shown.




Page 42 of 97

Fig 34. Selecting the type of content to be exported.


Now configure the Versions option.




Page 43 of 97

Fig 35. Configuring the version of documents to be exported.


Now go to the Errors option.




Page 44 of 97

Fig 36. Configuring the Error-Handling options.


For setting up the ExpAnx instance, follow the steps described in the setup of the ExpCov

instance. The only difference is in the settings for the itgi_document object




Page 45 of 97

Fig 37. Configuration of itgi_document in ExportAnnexure instance.


The setup of ExpCovHub differs only slightly from the setup of ExpCov .

While specifying the list of objects making up the folder structure, we need to include only

three dm_folder objects instead of four. The values to be passed to the object_name

attributes of the objects will start from Index.Level2_Index5 instead of

Index.Level2_Index6.




Page 46 of 97

Fig 38. Selecting the objects for ExpCovHub instance.

.

The differences between the setup of ExpCov and ExpCovHub are also applicable as the differences between ExpAnx and ExpAnxHub.


Consult the given table to map the attributes of the objects.

Object name

Attributes ExpCov (Values) ExpAnx (Values)

ExpCovHub (Values) ExpAnxHub (Values)

dm-

cabinet

object_name User-defined User-

defined

User-defined User-defined

dm_folder object_name Index.Level2_Index6 Index.Level

2_Index6


2_Index5

Index.Level2_Index5 Index.Level2_Index5


2_Index4



2_Index3


object_name (Index.Level2_Index

1)_

(Index.Level2_Index

2)

(Index.Leve

l2_Index1)

_

(Index.Leve

l2_Index2)

(Index.Level2_Index

1)_

(Index.Level2_Index

2)

(Index.Level2_Index1)_

(Index.Level2_Index2)

regnumber Index.Level2_Index1 Index.Level

2_Index1


serialnumbe

r

Index.Level2_Index2 Index.Level

2_Index2


itgi_policy




Page 47 of 97

r 2_Index2

contracttype Index.Level2_Index3 Index.Level

2_Index3


object_name Covernote.tif Annexure.ti

f

New_Covernote.tif New_Annexure.tif

doctype COV ANX COV ANX

instrumentty

pe

PL PL PL PL

itgi_docum

ent

pagecount SplitDoc.Level1_Page

count

SplitDoc.Le

vel1_Pagec

ount

SplitDoc.Level1_Page

count

SplitDoc.Level1_Pagecount

Table 2. Object Attributes for Motor_Policy Process Export instances.


2.5 Configuration of Validation Environment

For validation of the data entered (either manually or automatically) during Indexing with

the data contained in the P400 database, we require the registration of a custom-made DLL

(ProjecforValidation.dll) to enable the different Indexing fields to call their respective

validation functions. Besides, we require the creation of a DSN for ODBC connection of

P400 Server with Captiva.

First let us discuss how to create a DSN for ODBC connection. Go to Data Sources

in your system from the following path -

Start Settings Control Panel Administrative Tools Data Sources

(ODBC)

You will see the following window. Click on the second tab System DSN.




Page 48 of 97

Fig 39. Selecting the type of DSN


In the window that appears, click on the Add button.

Fig 40. Adding a DSN




Page 49 of 97


A list appears in a window. From this list, select the highlighted option – Client Access

ODBC Driver and click on Finish.

Fig 41. Specifying the ODBC Driver .




Page 50 of 97


In the window that appears, under the General option give a name for your DSN (In this

case P400) in the Data Source name field.




Page 51 of 97

Fig 42. Naming the DSN.


Now come to the Translation option . Check the single option available here .




Page 52 of 97

Fig 43. Specifying the type of translation.

The rest of the options can be left untouched. Click OK to finish the creation of your DSN.


Now lets come to the registration of the DLL – ProjecforValidation.dll . Before

registration, the DLL has to be placed in a specific location. The location is given

below –

C:\WINNT\system32

Open the System32 folder and paste the DLL here. Now go to the ProjecforValidation.dll

file in this folder and right click on it. You will see an option Register DLL Server. Click on

this option and the DLL will be registered and be ready for use during Validation.




Page 53 of 97

Fig 44. Registering the DLL


Configuration of OCR module

Here, we will discuss how to setup the Scansoft OCR module. Even though this module is

not a part of our sample process, still this is a very important and oft-used module.

The Scansoft OCR module can be setup to detect text in images in two ways –

1. Performing OCR on the entire image and capturing all the available data in it.

2. Performing OCR only on certain pre-defined zones and capturing only the data which

is relevant to us.

For both Full-page OCR and Zone-based OCR, most of the steps are common. First open the

OCR module in Setup mode. Select the tab “Document Recognition”. On this screen,

select the language you want to recognize as shown below.




Page 54 of 97

Fig 45. Selecting language


Then select the Zone Definition taband click on the Set up Zones button.




Page 55 of 97

Fig 46. Setting up zones


In the “Sample Image” field, specify the image for which you wish to do OCR.

Fig 47. Selecting a sample image




Page 56 of 97


Now we create a zone on which we wish to perform OCR as shown below in the figure. In

case we wish to perform OCR on the entire page, we will select the Full-page zone option.

Fig 48. Creating a zone




Page 57 of 97


Now click on the IAValues tab and select the options shown – “Return Recognized text

in IAValue” and “As ANSI Characters”. This will ensure that the recognized text is stored

some variables of InputAccel.




Page 58 of 97

Fig 49. Specifying the zone properties ENGT010_20 User Documentation

3 Using the System

To observe the process of running a system, we will again use a sample process. We will

use the same process with which we observed the configuration of a process -

Motor_Policy_001.

To run this process, the sequence of the modules which we have to run is something like

this –

Scan Image Enhancement Multi Index Rescan(Conditional) Export

Of these modules, the Image Enhancement, Multi and Export modules do not need any

input from the user. So they can be kept running continuously in the background. The

modules which the user will have to run manually are – the Scan module, the Index

module and the Rescan module (if it is required at all).




Page 59 of 97


3.1 Process-Flow Diagram

Batch Preparation

for Scanning

Scanning with

Scan module

Barcode

Detection with

Image Enhance

Policy separation

with Multi

Rescanning with

Rescan module

QC of images

and

Automatic

Population

Validation of

Covernote no

with P400

Database

Failed Passed

Failed

Passed No




Page 60 of 97

Policy Export with

Export module

Documentum

Repository

Validation of

Policy name

with

Documentum

repository

Do you want

to bypass

Export

Validation?

Passed

Failed

Yes


3.2 Batch Preparation

Batches would be made from the Policies, which have been registered through P400. Batch

Preparation will be done in the following steps.

Defiling: - The customer records will be taken out from the cartons.

Destapling: - The staples have to be removed from the pages to enable feeding into the

scanner.

Batch-Preparation Template: - The batches must follow the predefined template.

The single-page Covernote (a page with a barcode on top) will always be the first

page of each record. After the Covernote, will come the other pages of the record.

The records are to be placed one on top of the other. A number of records placed in

this way make up a Batch.

Extreme care must be taken to ensure that the Barcodes printed on the pages are not

damaged in any way and are Detectable by the system. Otherwise, the whole system might

fail.




Page 61 of 97


3.3 Using the Scan module

Use the following steps to run the Scan module in Production mode.

Click on the shortcut for the Scan module on your desktop. The following window will open.




Page 62 of 97

Fig 50. Opening a New Batch


Click on the New Batch tab and select the required process from the process list.

Fig 51. Selecting the Process. ENGT010_20 User Documentation



Page 63 of 97


Now place the Batch you have prepared in the feeder tray of the scanner and click on the

Scan Pages tab.




Page 64 of 97

Fig 52. Scanning the pages.


After all the pages have been scanned, click on the Close Batch tab. Your scanned pages

will be saved in the server. In this way you scan as many batches at time as you wish.




Page 65 of 97

Fig 53. Closing the Batch


3.4 Using the Image Enhancement module

First open the Image Enhancement module by from your Start Menu.




Page 66 of 97

Fig 54. Using Image Enhancement module.

You can click on the Run All Batches tab to run all the queued batches, which are ready

for the module. Or you can click on the Run Single Batch tab to select a particular batch to

process. In the normal scenario, you would want to Run All Batches. Image Enhancement

will be done automatically.


3.5 Using the Multi module

Open the Multi module and keep it running. You do not have to do anything in this module.

It will perform its functions automatically in the background. Just remember not to close

down the module.




Page 67 of 97

Fig 55. Multi module window.


3.6 Using the Index module

Open the Index module by clicking on its shortcut. The following window will appear.




Page 68 of 97

Fig 56. Opening the Index module.


In this case, too, you can click either on the Run All Batches or Run Single Batch tab as per

your requirements. You would normally want to Run All Batches to process all pending

batches on the server. The following window will appear in front of you.




Page 69 of 97

Fig 57. Opening a Motor Policy Batch for Indexing.


Initially, the focus will be on the Covernote field i.e., the first field. If the covernote number

is there in the barcode text, then, if you press Enter, the covernote number will be

populated in the first field and the focus will move on to the next field, the registration

number. Press Enter again and the registration number too will be populated from the P400

database. Now the focus will be on the third field, the serial number field. Now if you press

Enter, all the remaining fields will be populated automatically. In case the covernote number

is not present, the first field will remain empty. When the focus moves to the second field,

manually type in the registration number and the serial number. The validation will be now

performed on the basis of the registration number and the serial number. After the

validation is complete, keep on pressing enter to view each page individually or directly

move on to the next policy by clicking on the Accept Task button.




Page 70 of 97

Fig 58. Automatic population of Indexing Fields.

The next Policy appears in the window. Within the Policy, you can move on to the next page

by pressing Enter. Or you can navigate the pages within the policy by clicking on the Next

or Previous. Now if the data in the fields does not match the data in the P400 server, the

following message box will appear.


Press Enter to select OK and click on the Cancel Task tab. This will cancel the indexing of

the Policy. When you open the Batch again, the next Policy will appear for Indexing.




Page 71 of 97


Image Quality Assurance

If within the Policy, you find any of the pages unacceptable, click on any of the Image

Quality buttons on the left-hand side of the window. And continue your Indexing. If at any

time, you want to move on to the next Policy, click on the Accept Task tab. Continue with

the validation of the other policies of the batch in this way.




Page 72 of 97

Fig 59. Performing Image Quality Control.


3.7 Using the Export module

The procedure for using the Export module is the same for both Motor and Non-Motor

Policies.

First open the Export module from the shortcut. You will have to log in to the Documentum

repository or repositories that you are using. After logging into the repository or

repositories, you will observe the following window. Once again, you have the Run All

Batches and Run Single Batch options. Select whichever suits you .




Page 73 of 97

Fig 60. Opening the Export module.


After selecting the Batch or Batches, exportation starts. You will observe the progress of

exportation in this way.




Page 74 of 97

Fig 61. Exportation in progress.


3.8 Using the Rescan module

The images, which are rejected during Indexing by checking any of the boxes for Image

Quality, are sent to Rescan module for either replacement or removal.

First open the Rescan module by clicking on its shortcut. Once again, you have the Run All

Batches and Run Single Batch options in the following window.




Page 75 of 97

Fig 62. Opening the Rescan module.


The images, which were rejected during Image Quality Control, are shown highlighted as

shown. To scan another page in its place, place the required page in the Feeder tray and

click on the Scan Pages button. To replace the image with an image imported from your

local directory, click on Import and select the required page. To delete the highlighted page,

right click on the thumbnail of the image and select the Delete option as shown. After

replacing or deleting all the highlighted pages, close the batch. The replaced pages will be

then inserted back into the workflow at the Image Enhancement stage.




Page 76 of 97

Fig 63. Deleting an image from a batch.


3.9 Viewing Log Files

After you have finished processing a batch or batches, open Administrator module. Open

the Batches window from

View All Batches

From this window, delete the batches that you have processed.




Page 77 of 97

Fig 64. Deleting processed batches.


As soon as you delete the batches, logs are created in your C:\ drive in a text file named

Batchlog.txt. You can open this file to view details of your batches created and deleted.

This file will contain the information of the names of the Policies and their export result.

The export result will be there for all your Documentum Server Export instances. “0”

signifies successful export while “-1” signifies failure in export.




Page 78 of 97

Fig 65. Log file of deleted Batches.


3.10 Using Scansoft OCR

We will check out how to use the Scansoft OCR module though it is not part of our sample

process, because it is a very important module and is used very often.

The Scansoft OCR module is a module which runs automatically and does not need any user

input. Open the module, go to Run click on All Batches. All the batches queued up in this

module will be run automatically.




Page 79 of 97

Fig 66. Running Scansoft OCR


7 Different Requirement Scenarios

Now we will discuss some common requirement scenarios which the Captiva InputAccel

Developer has to handle very frequently.

4.1 Segregation of pages

It is very often required that the scanned pages need to be segregated into documents,

folders or other levels before they are exported to some Database. For this, we configure

the Scan module such that it can recognize the start of a new Document or Folder or some

other structure. We use separator pages to fulfill this purpose. There ae a niumber of types

of separator pages. The ones most commonly used are “Blank Page” and “Software

Patch Code”. The configuration of Scan module to perform segregation on the basis of

Blank page and Software patch code is shown in the figure below.

In this case, we have configured the Scan module to create a new document every time a

blank page is encountered and a new folder everytime a Software Patch Code of type

“Kodak T” is encountered (There are three types of Patch Codes – Kodak 2, Kodak 3, and

Kodak T). In both the cases, the separator pages i.e; the Blank Pages and the Software

Patch Code pages of Type T will be deleted from the batch (Since the Discard Page button

is checked).




Page 80 of 97

Fig 67


4.2 Reading Barcodes

Barcodes can be read and utilized in two ways –

1. Through Scan module configuration.

2. Through Image Enhancement module configuration, combined with an action

performed by the Multi module.

The first method requires the Scanner being used must have a Barcode detection hardware

attached to it, which is not always possible. So we will concentrate on the second method.

In this method, we use the Image Enhancement module to detect barcodes and the Multi

module to perform some action on the basis of barcode detection.

First, configure the Image Enhancement module to detect barcodes in the way shown

below. All we have to do is insert a Barcode Detection filter and configure the properties

of this filter.




Page 81 of 97

Fig 68


Fig 69

Next, we have to write code in our IPP file which will trigger the Multi module to perform ENGT010_20 User Documentation



Page 82 of 97

Next, we have to write code in our IPP file which will trigger the Multi module to perform

some action on the basis of barcodes detected. Suppose our requirement states that if there

is a barcode on any page, we need to create a new document and delete the page with the

barcode. The code in the Finish Event handler of the Image Enhancement instance will be

something like this.

Private Sub ImageEnhance_Finish ( ByVal p as IASlib.IAS_RECORD_0)

If p.ImageEnhance.Numbarcodes > 0 then ‘ the numbarcodes variable stores the number of

‘ Barcodes detected on a page

p.Multi.Ready = 1 + 16 ‘ triggering Multi with value “1” means that you

‘ are triggering Multi to create a new Document

‘ 16 – delete the node


Else

p.Multi.Ready = 8 ‘ 8 – hold nodes without performing any action

End If

End Sub

4.3 Using OCR-Captured Data

The text that we capture in OCR zones is stored in InputAccel Variables defined in the

Softscan OCR module definition file.

Level0_NumZoneValue as Long,Output – This variable stores the number of zones that

have been created for OCR.

Level0_ZoneValue(n)_RecText as String,Output – These variables store the values of

the text recognized in each zone. Here the value of n varies from 1 (for the first zone) to

the number of zones created.

Once OCR has been performed, the recognized text is available to us in these variables. We

can then access these variables in our IPP and code our process to perform any required

action on the basis of the values of these variables.




Page 83 of 97


4.4 Image Quality Assurance while Indexing

To perform Image Quality while Indexing, we use the Index and the Rescan module in

conjunction with each other.

This is how you configure the Index module to enable Image Quality Assurance.

Go to Setup Quality Assurance




Page 84 of 97

Fig 70


Now, in the window that pops up, select one or more boxes. Also check the “Bypass

validation if any QA boxes are checked at runtime” as shown below.

Fig 71

However before doing this, we first have to write code in our IPP file which will define an

action to take if the user checks any of the boxes while indexing a page. If the user finds

during Indexing that the image which he is indexing is a wrong image or a poorly scanned,

he can send this image to the Rescan module to be replaced or rescanned. ENGT010_20 User Documentation



Page 85 of 97

The first step in this Quality control is writing of code. We write the code in the Finish_Event

Handler of Index instance. The code will look something like this.

Private Sub Index_Finish(ByVal p2 As IASLib.IAS_RECORD_2) ‘ Lets assume that Index has

Been triggered at Level 2

Dim pPage As IASLib.IAS_RECORD_0

Dim strRescanReason As String

For Each pPage In p2.Tree.Pages

strRescanReason = ""

strRescanReason = CheckIndexFlags(pPage)

‘ The CheckIndexlags() function checks if any of the checkboxes of Image Quality

‘Assurance have been checked


If strRescanReason <> "" Then

‘ send the image to Rescan module

pPage.Rescan.InputImage = pPage.Index.InputImage

‘ Cancel the indexing of that page

pPage.Index.Ready = 0

Else

pPage.Sort.Ready = 8

End If

Next pPage

Now we will describe the function CheckIndexFlags() in Common Constants in the Module

folder of our IPP project.

Public Function CheckIndexFlags(pPage As IASLib.IAS_RECORD_0) As String

Dim strRescanReason As String

If pPage.Index.BentCorner Then

strRescanReason = ", Bent corner"

End If

If pPage.Index.DoubleFeed Then

strRescanReason = strRescanReason & ", Double feed"

End If

If pPage.Index.Delete Then

strRescanReason = strRescanReason & ", Delete"

End If

If pPage.Index.Noise Then

strRescanReason = strRescanReason & ", Noisy image"

End If ENGT010_20 User Documentation



Page 86 of 97

End If

If pPage.Index.Skewed Then

strRescanReason = strRescanReason & ", Skewed"

End If

If pPage.Index.TooDark Then

strRescanReason = strRescanReason & ", Too dark"

End If

If pPage.Index.TooLight Then

strRescanReason = strRescanReason & ", Too light"

End If

If pPage.Index.WrongImage Then

strRescanReason = strRescanReason & ", Wrong image"

End If

CheckIndexFlags = strRescanReason

End Function


Next we will write some code in the Prepare Event Handler of Index, so that initially all the

checkboxes for Quality Assurance are unchecked.

Private Sub Index_Prepare(ByVal p2 As IASLib.IAS_RECORD_2)

Dim pPage As IASLib.IAS_RECORD_0

For Each pPage In p2.Tree.Pages

pPage.Index.DoubleFeed = 0

pPage.Index.BentCorner = 0

pPage.Index.Noise = 0

pPage.Index.Skewed = 0

pPage.Index.TooDark = 0

pPage.Index.TooLight = 0

pPage.Index.WrongImage = 0

pPage.Scan.ThumbMarks = 0

Next pPage

End Sub

After this, we will include a Rescan instance in our process and write code in it so that the

images which are sent for rescanning are routed to an appropriate instance. Our coding part

is over with this step. Now, after the process has been compiled and installed, we will

configure the Index module as already shown.

While running the Index module, if the user checks any of the check-boxes for any of the

pages, these pages will be sent to the Rescan instance. The user will then open the Rescan

module and replace or rescan the highlighted documents as required.

4.5 Validating Indexed Data

One of the very frequent requirements is that the values entered into one or more Indexing

fields should be validated with some database or some other data source. Or we might be ENGT010_20 User Documentation



Page 87 of 97

fields should be validated with some database or some other data source. Or we might be

required to populate the fields automatically from some data source. Or we might be

required to add some specific validations such as Length, Type of data entered, etc. In order

top do this, we enter validating statements in the Validate Key field of that Indexing field. In

the sample process Motor_001, we saw how the data entered was validated against a

table in a P400 database.

If we use our customized DLL’s for validation, then we will use the Aux function to call the

customized dll. Otherwise, if we are using predefined validation DLL’s of captiva InputAccel,

then the syntax of our validating statement will be specific for each Validating Function. The

different Validating Functions and their syntax can be checked out in the Index Help

Document.

4.6 Creating a Folder-Hierarchy in Documentum

We specify the Documentum hierarchy to which we wish to export the Scanned images

while configuring the EMC Documentum Server Export module.

An example has been already discussed in the configuration of the sample process –

Motor_001.


The first thing to do is to create a list of objects which will specify the object-types which we

need to include in our hierarchy. The objects are placed in descending order in this list.

Now the names of the objects i.e; Cabinet, folders, sub-folders and document can be

picked up in a number of ways. We can hardcode their values in the value field for the

object_name attribute for each object, in which case, all the pages will be stored in a fixed

location. Or we can populate the object_name attribute of different objects with values

stored in InputAccel variables. In the sample process shown, we had populated the

object_name attributes of the different objects either from hardcoded values or from values

entered by the user in Indexing fields.

4.7 Deleting Batches Automatically

We often have a requirement of deleting batches automatically from the Captiva InputAccel

Server to prevent unnecessary loading of the Server. To delete any node, we use the Multi

module. In this case, we will use an instance of the Multi module in our process, and trigger

it at Level-7 to enable it to delete a batch. Suppose the instance of Multi has been named

“DeleteBatch”.

Let us assume that the EMC Documentum Server Export instance had been triggered at

level-7. Then the code to delete batches after export is this –

Private Sub ExportDocumentum_Finish (ByVal pRoot as IASLib.IAS_RECORD_7)

pRoot.DeleteBatch.Ready = 16

End Sub

4.8 Creating Log Files

Creation of Log files is done solely through code. Log files can be created at any point in a ENGT010_20 User Documentation



Page 88 of 97

Creation of Log files is done solely through code. Log files can be created at any point in a

process just by writing the code for log-file creation and writing at that point in the IPP.

A sample piece of code is given below –

Dim StrFileName as String

strFileName = "C:\InputAccelLogs\BatchCreationLog.txt"

Open strFileName For Append As #1

Print #1, "New batch: " & pRoot.BatchCreatLog.NameofBatch

Print #1, "Batch created at " & Now

Print #1, " "

Print #1, " "

Close #1


4.9 Creating User Restrictions on Batches

Suppose we have a requirement that a user who logs in to the InputAccel Server and scans

pages can Index only the batches that he himself has scanned.

To enable this User-Restriction, we will use the concept of Departments. Here, the process

of enabling user-restrictions starts from the coding stage. While selecting the MDF’s to

include in our process, we will assign these instances to specific departments. In our

requirement scenario, say we have two users – “dop” and “dop1”. These users have to be

restricted such that they can index only those batches which they themselves had scanned.

While selecting MDF’s to include in our process, we select as many instances of Index

module as there are users which we have to restrict. Assign each instance of Index to a

specific Department.

Fig 72




Page 89 of 97

Fig 73

Now in our IPP, we need to add some code which will check the username with which

scanning has been done and then on the basis of the username, route the images to the

appropriate Index instance. The code will look something like this –


Dim Username As String

Username = p.Scan.ScanOperator

Select Case Username

Case "dop":

p.IndexSD.InputImage = p.Scan.OutputImage

Case "dop1":

p.IndexSD1.InputImage = p.Scan.OutputImage

End Select

As a result of this, the images scanned by user “dop” will be available for Indexing only

through the “IndexSD” instance. Our coding part is completed with this.

Now, when running the process, when a user logs in to the Index module, we will make him

provide the Username, password and in addition, the Department name. This can be done

by creating a shortcut of the Index module and passing these parameters in the target field

of the shortcut.




Page 90 of 97

Fig 74

This will ensure that the user “dop” logs in with the Department “SD”. Now, he can view and

index only those batches which he himself has scanned.


4.10 Error handling

There can be a number of error scenarios and these are not always possible to foresee.

Listed below are a few common error scenarios and their solutions.

1. The user can sometimes face problems during Indexing if there is a Level-1 node in the

batch which does not contain any pages in it. The user repeatedly sees a blank page with a

red cross across it while indexing any document in the batch. To remedy this, we will

separate that particular Level 1 node and route it directly to the end of our process. This

has to be done through code. The code will look something like this –

If p1.Tree.NumChildren(0) = 0 then

‘ this will check if the document has 0 pages in it

p1.HoldBatch.Ready = 8 ‘ this is the stage where all the Level-1 nodes are collected into a

batch

Else

End If

2. Sometimes we might face errors during Export due to errors during Indexing. For

example, the user might include a “/” or a “\” symbol in an indexing field which has been

mapped to the object_name attribute of some object-type, or he might leave an indexing

field blank which had been mapped to the name of the Cabinet, or the indexing fields might

be wrongly filled up with the same indexing field values as some other document, which

would mean that we are trying to export the same document to the same location more

than once.

There is a variable defined for the EMC Documentum server Export module –ENGT010_20 User Documentation



Page 91 of 97

ExportResult. If any error is encountered during export, this variable takes a value “-1”,

otherwise its value is “0”. We will handle these errors on the basis of this value. If the

variable ExportResult has a value “-1”, then we will send the exported node back to the

Inde module so that the user can correct the entries. This will be done through code, which

will be written in the Finish Event handler of Export as shown below.

If p2.ExportDoc.ExportResult = -1 Then

pPage.Index.Ready = 1

pPage.Index.InputImage = pPage.ExportDoc.InputImage

End If

3. A very important thing to remember is that while routing images from an Index instance

to any other instance, we always use the “InputImage” variable rather than the

“OutputImage” variable. Using the OutputImage variable gives an unidentified error.

p.Export.InputImage = p.Index.InputImage


4. Often it is seen that an instance is wrongly triggered. This is especially true of instances

of the Multi module. To remedy this, we add a line in our Multi instance, which will ensure

that it is triggered only once in the process.

p2.Multi.Retriesleft = 0

However, this can be done only if that particular instance has a requirement of being

triggered only once in the process.

5. Another common error is when you try to access a higher level node inside an instance

triggered at a lower level node. You can access a lower-level node inside a higher level node

but the reverse is not true. For example –

Private Sub Index_Finish(ByVal p as IASLib.IAS_RECORD_0)

Dim p1 as IASLib.IAS_RECORD_1

P1. Index.Level1_Index0 = “Process”

End Sub

This code will give an error because you are trying to access a Level1 node from inside an

instance triggered at Level0.




Page 92 of 97


5 Debugging a Batch

Following are the steps involved in debugging a batch.

1. Create a new batch from Administrator module as shown below




Page 93 of 97

Fig 75


3. From Process Developer module, open the code for this batch.

Fig 76 ENGT010_20 User Documentation



Page 94 of 97

Fig 76 ENGT010_20 User Documentation

4. Now insert breakpoints wherever u need them.

Fig 77

3. Now Open this batch from the Scan module and run the batch. When the the point where ENGT010_20 User Documentation



Page 95 of 97

3. Now Open this batch from the Scan module and run the batch. When the the point where

u had added breakpoints comes up, the control will move to the break point. You can then

debug the code, using the “F8” key to move from line to line.

6 Monitoring a Batch

We can use the Administrator module or the Supervisor to monitor the progress of a

batch. In fact, the Administrator and the Supervisor modules can be used for all

administration and monitoring work. Read the user guides of Administrator and Supervisor

to learn about all their functions.

To monitor a batch from Administrator module, we first go to the Batch List Window from

View All batches

Or

View All Processes and then double-clicking on the specific process.


In the Batch List Window, double click on the batch name. We will see a window which will

show us the progress of the batch.

Fig 78




Page 96 of 97

7 Error Messages

The various Error Messages that you might encounter while running InputAccel are listed in

a document named Error Messages. This document can be accessed from the Start Menu

and will give you all the information regarding possible errors in InputAccel.


8 Glossary

Abbreviation Description

DMS Document Management System

P400 Polisy 400

DLL Dynamically-Linked Libraries

IPP InputAccel Process-Flow Project

IAP InputAccel Process

VB 6.0 Visual Basic version 6.0

MDF Module Definition File



Page 97 of 97



Date post:	30-Dec-2015
Category:	Documents
Upload:	neha-saraf
View:	327 times
Download:	16 times