vignette idm ia export module

Version 20.1

Vignette IDM IA Export Module

Technical Reference

Notices

Publisher

This document is published anddistributed by Vignette Corporation.

Version

Vignette IDM IA Export Module TechnicalReference, version 20.1 (Publication Date:22 January 2007)

Disclaimer

Vignette does not warrant, guarantee, ormake representations concerning thecontents of this document. All informationis provided as is, without express orimplied warranties of any kind including,without limitation, the warranties ofmerchantability, fitness for a particularpurpose, quality, and title. Vignettereserves the right to change the contentsof this document and the features orfunctionalities of its products and servicesat any time without obligation to notifyanyone of such changes.

Copyright and trademarks

Copyright © 2007 Vignette Corporation. Allrights reserved. Vignette and the V logoare trademarks or registered trademarksof Vignette Corporation in the UnitedStates and other countries. All othercompany, product, and service names orbrands are the trademarks or registeredtrademarks of their respective owners

Send us your comments

If you have comments or suggestions aboutthis manual, please send them to thisaddress:

[email protected]

A member of the Publications team willacknowledge your mail as soon aspossible.

You can also reach us at the followingaddress:

Vignette CorporationPublications Department1301 South MoPac Expressway, Suite 100Austin, TX 78746USA

© 2007 Vignette Corporation. All rights reserved.2 v20.1

Contents

Chapter 1. Introduction 5Overview 5

Intended audience 5Vignette IDM IA Export Module Architecture 5

Chapter 2. Processing architecture 7Vignette IDM IA Export Module processing architecture 7

Modes of operation 7Administrator tasks 7

Chapter 3. Configuration 9Specify export settings 9

Inputs 9Configure Vignette IDM IA Export Module 11Specify data source for export to IDM Server 12

Outputs 15Production mode 15

Inputs 15Processing 16Outputs 16

Appendix A. Error codes 17

v20.1 3Vignette IDM IA Export Module Technical Reference

Table of Contents


Chapter

1
Introduction
OverviewVignette IDM IA Export Module provides a GUI interface between the third-party product InputAccel and IDM Server. InputAccel scans and stores batches of documents. Vignette IDM IA Export Module provides the facility for these batches to be exported from the InputAccel database and imported into a specific application within IDM Server.

Intended audienceThis Guide is for readers with knowledge of InputAccel. Refer to the InputAccel product documentation for information about that product.

Vignette IDM IA Export Module ArchitectureInputAccel uses a network server for storage, with each of the modules running on its own client workstation. Ultimately, the Vignette IDM IA Export Module loads the images (and optionally other renditions) into IDM Server. Figure 1 shows a typical configuration of Vignette IDM IA Export Module:

Figure 1: Vignette IDM IA Export Module and InputAccel Configuration

ScannerFax

InputAccel Server IDM Server

Retrieval Clients

IA ScanModule

IA Custom/OptionalModules

Vignette IDM IAExport Module/

IA CustomModule


1Chapter


Chapter

2
Processing architecture
Vignette IDM IA Export Module processing architecture

Vignette IDM IA Export Module is a program that allows IDM Server to receive scanned images and indexing data from an InputAccel process. It requires a correctly configured InputAccel system and a Vignette document server. Both of these systems require a TCP/IP network.

Modes of operationVignette IDM IA Export Module can be run in two modes: setup mode, and production mode. In both modes the user must log into IDM Server when Vignette IDM IA Export Module is launched.

During setup, an instance of Vignette IDM IA Export Module can have its settings modified. These settings include the application table to commit into, values to place into each field of the application table (either a value from InputAccel indexing or some other function), and what renditions to commit. See Chapter 3 for more information.

NOTE: A rendition is one of many possible outputs associated with a document. Forexample, a scanned document may have a TIFF image rendition, and an OCRed textrendition. These renditions could be placed into different IFNs in IDM Server.

The following actions occur when a task is sent to Vignette IDM IA Export Module during production mode:

• For each document scanned up to that point, an IFN will be created in IDM Server for the renditions specified in the configuration;

• The specified application table will be updated with the IFN and other indexing data as specified in the Vignette IDM IA Export Module configuration.

Administrator tasksDuring setup mode, the user of Vignette IDM IA Export Module is the InputAccel administrator. The administrator must configure each instance of Vignette IDM IA Export Module in a process. A GUI displays all the relevant options.

During production mode, Vignette IDM IA Export Module can run standalone (without any operator). For standalone operation, Vignette IDM IA Export Module may require logging on to IDM Server when it is launched. This depends on how the Vignette login is configured.


2Chapter

ImportantImages and index data can only be exported to a single IDM Server. The administrator must ensure that the same server is referenced during both setup and production modes. Successful operation of the Vignette IDM IA Export Module depends on the correct configuration of the InputAccel process/batch subsystem.


Chapter

3
Configuration
Specify export settingsInputAccel uses the Vignette IDM IA Export Module to define export settings for images that are exported to IDM Server.

NOTE: In InputAccel you can specify the export settings on all batches, or on one batch.

The InputAccel administrator specifies export settings using the Supervisor module, when setting up specific processes and batches.

InputsUse these steps to configure the settings for an instance of the Vignette IDM IA Export Module:

1. From the Windows Desktop, click Start > Programs > InputAccel.

2. Select the Supervisor Module.

Figure 2: InputAccel Supervisor Module initial dialog

3. Input the name or IP address of the InputAccel server.


3Chapter

Figure 3: Input Accel select server dialog

4. Enter user name and password.

5. From the process window, select a process that uses Vignette IDM IA Export Module, or select a batch based on such a process. See the InputAccel documentation for the format of this dialog.

6. Double click on a Vignette IDM IA Export Module instance, such as TowerExp. Instances are listed on the right side of the window.

Figure 4: Vignette IDM IA Export Module logon dialog

This starts Vignette IDM IA Export Module in configuration mode. You can now configure the Vignette IDM IA Export Module.


Configure Vignette IDM IA Export ModuleWhen the Vignette IDM IA Export Module starts in configuration mode, it will first logon to IDM Server according to the Vignette logon settings.

After logging in, the Export configuration dialog displays with the Renditions tab active.

RenditionsIn the Export dialog you can choose how each rendition will be handled by the Vignette IDM IA Export Module.

Figure 5: Export dialog Renditions tab

Application

Select an application from the drop-down list. The list shows all applications on the IDM Server.

Rendition list display

Select a rendition from the list on the left panel. The list displays the available renditions for the current process or batch.

Rendition settings

Set the appropriate options for each rendition, as described in Table 1.

Table 1: Rendition Settings Options

Field name Description

Do not export Ignores the file.

Export to application diskset Exports the file to the application diskset, based on the COMMIT file settings.

Export to fixed diskset Exports the file to the specified diskset.

File extension A drop-down list of available file formats.

Import into A drop-down list of destination storage pools for the file on the image server

Use log file The option to enable or disable logging. If enabled, specify the path for the log file called iaextwr.


3Chapter

In the example shown in Figure 5 on page 11, Export to application diskset is selected. This means the image rendition will be exported to the selected application’s diskset on the IDM Server. Selecting Export to fixed diskset gives the same result.

Click OK to accept the settings.

Specify data source for export to IDM ServerClick the Titles tab to display a list of application fields.

Figure 6: Export dialog Titles tab

You can set the number of rows that will be added to the application table for each IFN imported. This is called multiple titles. Multiple titles allows the document to be accessed through multiple sets of title information. For example, a loan document may be in joint names, so you would want to be able to retrieve the same document by accessing it through either parties name.

For each application field you can select one export type, as described in Table 2.

ImportantThe npages, ifnds and ifnid fields are mandatory titling fields in IDM Server. If these are not specified, a warning message displays to show the invalid field values.

Table 2: Data export options

Field value Description

Formatted text Allows the administrator to enter fixed (raw) text, or another value from InputAccel (such as a barcode batch variable), or a combination of these.

See the following section for more detail about the Formatted text option.

IFN Number Pages Exports the npages (number of pages) value in a rendition to the specified application title.

IFN Diskset Exports the ifnds (diskset number) value to the selected application title.

IFN Ordinal Exports the idnid (document ID) value to the selected application title.


Formatted Text data source option

Figure 7: Vignette IDM IA Export Module Formatted text option

If you select the Formatted Text option and then click on the [...] button, the Choose Value dialog opens. This dialog shows all available information, such as batch variables, and system variables like date, time, and user name.

Figure 8, Formatted Text - Choose Value shows the array of IA values that are used in various module instances. Typically, the IA values are captured data such as scaned barcode information or images (files).

Figure 8: Formatted Text - Choose Value


3Chapter

Example: specify a level for an IA ValueThe following example shows selections for the module instance TowerExp and the value TowerExp.IFN_Rendition_1, the IFN for the first rendition.

Figure 9: Example lookup list of IA values for a given instance

You can choose an IA Value at a particular level. This means you can define which IA values (variables) can be used at the page level compared with the document level. Here, All Levels is selected in the lookup list.

The next step is to select an IA Value at the page level for the Scan module instance.


Figure 10: Select an IA value for a specific level

To save the settings, click OK.

OutputsThe specified settings are saved back to the Vignette IDM IA Export Module instance selected in the Supervisor module, and the program logs off IDM Server before closing.

To cancel the settings click Cancel. The program will logoff IDM Server before closing, without saving the settings.

Production modeWhen Vignette IDM IA Export Module is started directly from the command line or shortcut (and not from the InputAccel supervisor module), it will go directly into production mode. When in this mode, the module will wait for the InputAccel server to send it tasks to process. When it receives a task, it will export the images and indexes as specified in each job configuration.

InputsOnce Vignette IDM IA Export Module has registered itself with the server, a new dialog asks whether to specify all batches or which batch to accept tasks from. It will then wait for the server to send it tasks to process. The batch processing dialog is displayed, as shown in Figure 11 on page 16.


3Chapter

Figure 11: Batch processing dialog

ProcessingDepending upon how the InputAccel process has been configured, there may be one or many pages in a task.

Depending on how each instance was configured, processing for each page may mean a number of renditions are stored in IDM Server, along with associated indexing data. When each rendition is exported, an IFN is allocated, and the rendition image(s) is imported into the IFN. One or more rows are inserted in the application table. The rows contain the IFNs and all other indexing data as specified in the instance configuration.

Once the job has been processed, the module will signal job completion to the InputAccel server, and will then wait for more jobs to be allocated by the server.

OutputsIf logging was selected, the local log file called iaextwr will be written to, with details of the IDM Server interactions. You can specify the name and location of the log file during configuration. This information will also be written to a log on the server. The iaextwr event will be generated, and the server log will be updated.


Appendix

A
Error codes
The following error codes are returned to the VignetteStatus variable, by the Vignette IDM IA Export Module executable:

0 - Success.

1 - Unable to determine the application diskset for export.

2 - Unable to allocate a new IFN in the diskset.

3 - Unable to find the file to be exported from the InputAccel node.

4 - Unable to copy the file to a temporary location on the InputAccel server.

5 - Import of the rendition failed.

6 - There were no pages found in the batch to be exported.

7 - Attempt to insert invalid data into the database.


AAppendix


vignette idm ia export module

Documents