Release Script for Kofax Ascent Capture 5

Transcription

1 IBM Content Manager for Multiplatforms Release Script for Kofax Ascent Capture 5 Services Offering

2

3 IBM Content Manager for Multiplatforms Release Script for Kofax Ascent Capture 5 Services Offering

4 Note Before using this information and the product it supports, read the information in Appendix C. Notices on page 25. Second Edition (September 2001) This edition applies to IBM Content Manager OnDemand for Multiplatforms, Version 7 Release 1 and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright International Business Machines Corporation All rights reserved. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents About this publication v How to use this publication vii Who should use this publication..... viii Where to find more information..... viii Where to get support viii How to send your comments viii Chapter 1. Before you begin Chapter 2. Installing the OnDemand Release Script Installing the Release Script Registering the Release Script Chapter 3. Setting up a batch class Defining field types Defining the document class Creating a form type Adding a sample page Drawing zones Defining the batch class Inserting the document class into the batch class Configuring the OnDemand Release Script.. 12 Publishing the batch class Chapter 4. Defining the OnDemand objects 17 Defining the application group General page Field Definition page Field Information page Defining the application General page View Information page Indexer Information page Load Information page Defining the folder Chapter 5. Running the OnDemand Release Script Appendix A. Upgrading the OnDemand Release Script Appendix B. Problem determination Appendix C. Notices Trademarks and service marks Copyright IBM Corp iii

6 iv IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5 Services Offering

7 About this publication This publication provides information to install and configure the IBM Content Manager OnDemand (OnDemand) Release Script for Kofax Ascent Capture 5 (Ascent Capture). The OnDemand Release Script is a custom Ascent Capture release script that releases index data and image or edocument files 1 to an OnDemand server. For example, you could use Ascent Capture to scan statements, extract index data from the statements, and save the statements as image files for processing by the OnDemand Release Script. The OnDemand Release Script converts the index data to the OnDemand generic indexer format and stores the index data and files in exported file systems. After releasing the index data and the files, you can use the OnDemand ARSLOAD program to load the index data and files into OnDemand. You can configure your system so that your organization can automatically scan thousands of documents, generate index data, and load the index data and documents into OnDemand. Figure 1 on page vi shows a typical system configuration. 1. In Ascent Capture, image files are defined as those having the following extensions: JPG, PCX, PDF, and TIF. All other types of files are classified as edocuments, regardless of content. Examples of edocuments are Adobe Photoshop files, bitmap (BMP) files, Corel WordPerfect files, Lotus files, and simple text files. See your Ascent Capture information for details about working with and releasing edocuments. Copyright IBM Corp v

8 SD Services Offering Ascent Capture Scan Station Network OnDemand Clients Ascent Capture Validation / Recognition Station OnDemand Server Load Ascent Capture Release Station Release Exported File System Release Directory Figure 1. OnDemand and Ascent Capture Integration This publication is organized into the following chapters: v Chapter 1. Before you begin on page 1 contains important information that you should read before you start installing the OnDemand Release Script v Chapter 2. Installing the OnDemand Release Script on page 3 describes how to install and register the OnDemand Release Script v Chapter 3. Setting up a batch class on page 5 provides information about setting up an Ascent Capture batch class, including defining field types, document classes, index fields, and batch classes, configuring the OnDemand Release Script, and publishing the batch class v Chapter 4. Defining the OnDemand objects on page 17 provides information about defining the OnDemand application group and application to receive data released by the OnDemand Release Script v Chapter 5. Running the OnDemand Release Script on page 19 provides information about running the OnDemand Release Script v Appendix A. Upgrading the OnDemand Release Script on page 21 contains important information about upgrading to a new version of the OnDemand Release Script v Appendix B. Problem determination on page 23 contains information to help you solve some of the more common problems that you may encounter when using the OnDemand Release Script vi IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

9 How to use this publication Table 1 contains a list of the tasks you typically need to do to release documents from Ascent Capture and load them into OnDemand. This publication describes how to do some of the tasks, but you will need other OnDemand information and your Ascent Capture information to do others. Table 1. Ascent Capture / OnDemand Task List Task Where to Find Information Installing and configuring Ascent Capture. Installing and configuring OnDemand. Sharing file systems between the Ascent Capture workstation that runs the OnDemand Release Script and the OnDemand server that loads the data. Installing and registering the OnDemand Release Script. Setting up a batch class. Defining OnDemand objects. Releasing batches. Loading data into OnDemand. Not described in this publication. See your Ascent Capture information. Not described in this publication. See your other OnDemand information. Not described in this publication. See your operating system information and, if you are using an NFS product to connect UNIX and Windows workstations, see the documentation provided with the NFS product. See Chapter 2. Installing the OnDemand Release Script on page 3. Chapter 3. Setting up a batch class on page 5 provides an overview of the process and details about information specific to an OnDemand system. See your Ascent Capture information for details about all of the steps in setting up a batch class. Chapter 4. Defining the OnDemand objects on page 17 provides specific information you need to define an application group and application to receive documents released by the OnDemand Release Script. See your other OnDemand information for details about all of the steps in defining an application group and an application. Chapter 5. Running the OnDemand Release Script on page 19 provides information about the files created by the OnDemand Release Script. See your Ascent Capture information for details about managing and releasing batches. Not described in this publication. See your other OnDemand information. About this publication vii

10 Who should use this publication This publication is of primary interest to administrators responsible for installing and configuring OnDemand software and applications. Note: This publication assumes that you understand how to configure and operate OnDemand servers, and that your organization already has an operational Ascent Capture system. This publication contains information about Ascent Capture only as it pertains to the OnDemand Release Script. For details about Ascent Capture, see Kofax Ascent Capture: Getting Started with Ascent Capture. Where to find more information OnDemand product documentation is available on the Web. Click Library from the product Web site at: Administrators who need to customize the client, distribute software and files to users, or automate the installation process can find more information in the IBM Content Manager OnDemand: Windows Client Customization Guide, SC Where to get support Product support is available on the Web. Click Support from the product Web site at: How to send your comments Your feedback helps IBM to provide quality information. If you have any comments about this publication or other OnDemand documentation, fill out the readers comment form at the back of this book. You can also send comments by FAX using the following number: or by to: Be sure to include the name of the product, the version number of the product, and the name of the book. If you are commenting on specific text, please include the location of the text (for example, a chapter and section title, a table number, a page number, or a help topic title). viii IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

11 Chapter 1. Before you begin Before you install the OnDemand Release Script, Ascent Capture must be installed on one or more network servers and client workstations. See Kofax Ascent Capture: Getting Started with Ascent Capture for details. If you are upgrading to a new version of the OnDemand Release Script, see Appendix A. Upgrading the OnDemand Release Script on page 21. Copyright IBM Corp

12 2 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5 Services Offering

13 Chapter 2. Installing the OnDemand Release Script This chapter describes how to install and register the OnDemand Release Script. Installing the Release Script You must install and register the OnDemand Release Script on a workstation that contains the Ascent Capture Administration and Batch Manager tools. You must run the OnDemand Release Script from a workstation that can write to the release directory. The release directory identifies a file system exported from the OnDemand server where you plan to load the data released by Ascent Capture. The release directory can be an NFS-mounted directory on a UNIX server or a shared folder on a Windows server. To install and register the OnDemand Release Script, follow these steps: 1. Insert the diskette that contains the OnDemand Release Script installation software in the drive or obtain the drive letter of the network drive that contains the OnDemand Release Script installation software. 2. From the Windows taskbar, click Start, and then choose Run. 3. Type X:\ODKOFAX7104.EXE (where X is the letter of the diskette drive or network drive) and then click OK. 4. Click Continue to start and open the Welcome dialog box. 5. Click Next to open the Choose Destination Location dialog box. 6. Accept the default directory or choose a directory to install the OnDemand Release Script. Click Next to continue. 7. Follow the instructions on the screen to complete the installation. Note: If the registration step fails (the installation program displays a message if it cannot register the release script), you must manually register the release script. See Registering the Release Script for the steps you can follow to register the release script. Registering the Release Script Note: You need to complete this step only if the installation program failed to register the release script. To verify that the release script is registered with the Ascent Capture system, follow these steps: Copyright IBM Corp

14 1. Start the Ascent Capture Administration tool. 2. From the Tools menu, select Release Script Manager. 3. If the IBM Content Manager OnDemand Version 5.0 Release Script is not listed, do the following: a. Click Add. b. Use the Open dialog box to locate the ODKRelSC.inf file. (The file should be in the directory in which you installed the OnDemand Release Script.) c. Click Open. The Release Script Manager dialog box should now list the IBM Content Manager OnDemand Release Script. 4 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

15 Chapter 3. Setting up a batch class Before you can process documents with Ascent Capture and load them into OnDemand, you must define at least one batch class. A batch class is a definition of all the settings for processing documents, including the field types, the types of documents in the batch and their index fields, the queues through which you process the batch, and the release script that releases the documents and index data to OnDemand. You should set up one batch class for each OnDemand application group that will receive documents released from the Ascent Capture system. You perform all batch class setup tasks with the Ascent Capture Administration tool. To start the Administration tool, follow these steps: 1. Click Start on the taskbar. 2. From Programs, select Ascent Capture. 3. Click Administration to start and open the main Ascent Capture Administration window. See the online Help and the Ascent Capture documentation for details about using the Administration tool. The following topics provide more information about setting up a batch class: v Defining field types v Defining the document class v Creating a form type v Adding a sample form v Drawing zones v Defining the batch class v Inserting the document class into the batch class v Configuring the OnDemand Release Script v Publishing the batch class Defining field types A field type is a global definition for a data field. Data fields contain information extracted from documents. For document capture purposes, the data is used to index the documents. The data type determines the type of data that the field can hold, for example character data, a date or time string, a number, and so forth. Copyright IBM Corp

16 Because field types are global in scope, you can use them in more than one batch class or document class. For example, if several different types of documents contain an account field that holds 12 bytes of character data, you can define one field type for the account field and use it for all of the documents. You must define a field type for each index field that holds a different kind of data or has other unique attributes. For example, if a document has two character fields, one that must hold four characters and one that must hold twelve characters, you must define a field type for each field. You can define one field type for one or more index fields that have the same attributes. For example, if a document has two integer fields, you can define one field type for both of the fields. For this reason, before you begin defining field types you should analyze the documents you plan to process with the OnDemand Release Script (and the application groups you plan to store them in) to determine the attributes of the index fields. Important: The Data type that you select for your field types must be supported in OnDemand. Table 2 lists the data types that OnDemand supports. Services Offering To begin defining your field types, follow these steps: 1. Select the Field Types tab on the Definitions panel. 2. Right click anywhere on the panel. 3. Select New Field Type from the popup menu to open the Create Field Type dialog box. 4. For each field type that you want to create: v On the General page, enter the Name. Use a name that identifies the type of field you are defining, such as VARCHAR21 and CHAR12. v Optionally enter a Description. v Select the Data type of the field. The Data type that you select must be supported in OnDemand. Table 2 lists the data types that OnDemand supports. v For CHAR and VARCHAR field types, specify the field length in bytes in the Number of characters field. For a Decimal field, specify the number of digits and decimal places. v Click OK or Apply to save the field type definition. Table 2. Ascent Capture Field Data Types and OnDemand Application Group Field Data Types Ascent Capture Field Data Type CHAR Description A fixed length character string. A CHAR field can hold up to 254 characters. OnDemand Application Group Field Data Type String (Fixed) 6 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

17 Table 2. Ascent Capture Field Data Types and OnDemand Application Group Field Data Types (continued) Ascent Capture Field Data Type DATE DECIMAL DOUBLE FLOAT INTEGER NUMERIC REAL Description A date string. Appearance of date fields depend on the format specified with the Regional Settings applet in Control Panel on the workstation that processes the batch. A signed, numeric value with the number of decimal digits greater than or equal to 1 (one) and less than or equal to 15 (fifteen). The number of decimal places must be greater than 0 (zero) and less than or equal to the number of numeric digits. A numeric value with the number of numeric digits equal to 10 (ten) and the number of decimal places equal to 0 (zero). An INTEGER field can hold a value in the range of 2,147,483,648 to 2,147,483,647. A signed, numeric value with the number of decimal digits greater than or equal to 1 (one) and less than or equal to 15 (fifteen). The number of decimal places must be greater than 0 (zero) and less than or equal to the number of numeric digits. OnDemand Application Group Field Data Type Date Decimal Not Supported Not Supported Integer Decimal Not Supported Chapter 3. Setting up a batch class 7

18 Table 2. Ascent Capture Field Data Types and OnDemand Application Group Field Data Types (continued) Ascent Capture Field Data Type SMALLINT Description A numeric value with the number of numeric digits equal to 5 (five) and the number of decimal places equal to 0 (zero). A SMALLINT field can hold a value in the range of 32,768 to 32,767. OnDemand Application Group Field Data Type Small Integer TIME A time string. Time VARCHAR A variable length character string. A CHAR field can hold up to 254 characters. String (Variable) Defining the document class A document class is a definition of a particular type of document, such as a bank statement or insurance policy. When you define a document class, you define index fields and assign a field type to each index field. When you define a document class that will be used to release data to OnDemand: v You must define a document class for each OnDemand application group or application. v The name of the document class must match the name of the OnDemand application group or application exactly, including the case. The OnDemand Release Script uses the document class name to generate the name of the output files created by a release. Note: The OnDemand Release Script uses the value of the OnDemand File Naming field from the Document Storage page to determine whether the application group name or the application name becomes the document class name. See OnDemand File Naming on page 13. The OnDemand Release Script does not support blank characters in a document class name. Blank characters in a document class name will be removed by the Release Script. v You must define an index field for each application group field. The name of the index field must match the name of the application group field exactly, including the case. IBM recommends that you follow the OnDemand application group field naming requirements. The data type of 8 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

19 the index field must be supported in OnDemand. The data type of the index field must match the data type of the application group field. Table 2 on page 6 lists the data types in OnDemand. To begin defining a document class, follow these steps: 1. Select the Document Class tab on the Definitions panel. 2. Right click anywhere on the panel. 3. Select New Document Class from the popup menu to open the Create Document Class dialog box. 4. For each document class that you want to create: v On the General page, enter the Name. The name of the document class must match the name of an OnDemand application group or application exactly, including the case. Note: The OnDemand Release Script uses the value of the OnDemand File Naming field from the Document Storage page to determine whether the application group name or the application name becomes the document class name. See OnDemand File Naming on page 13. v v The OnDemand Release Script does not support blank characters in a document class name. Blank characters in a document class name will be removed by the Release Script. Optionally enter a Description. Add one or more Index Fields. You must add one index field for each application group field. See the online Help for assistance with defining index fields. v Note: The name of the index field must match the name of the application group field exactly, including the case. IBM recommends that you follow the OnDemand application group field naming requirements. The order you list your index fields is the order that they will be presented to the index operators. To reorder the fields, use the mouse to select a field and drag and drop it into the desired location. v The Create Document Class dialog box includes an OCR page. The OCR options are not supported by OnDemand. 5. Click OK to save your selections and close the Create Document Class dialog box. Chapter 3. Setting up a batch class 9

20 Creating a form type A document class must have one or more form types. A form type contains settings and instructions that describe a particular type of document. All of the documents must use one or more of the index fields defined in the document class. If some of the documents that you process do not contain the index fields, you must assign a default value for the index fields in the document class. (You can also assign default values for database fields on the OnDemand application Load Information page.) See the Ascent Capture documentation for more information about creating form types. Adding a sample page Note: The Ascent Capture modules treat edocuments like blank pages. Additionally, each edocument is treated as if it were a single page. For image files, you must add at least one page from a sample document to each form type. The sample page(s) must contain the data that Ascent Capture can use to index documents in a batch. See the Ascent Capture documentation for more information about adding sample pages to your form types. Drawing zones Note: It is not possible to use zone-based automatic recognition or data capture features with edocuments. For image files, you should identify the location of index fields on your documents by drawing zones on the sample pages. During forms processing, Ascent Capture extracts index values from documents in a batch by using the zones you drew on the sample pages. See the Ascent Capture documentation for more information about drawing zones on your sample pages. Defining the batch class A batch class describes how the documents in a batch will be processed by Ascent Capture. You must define at least one batch class before you can capture documents or release them to OnDemand. To begin defining a document class, follow these steps: 10 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

21 1. Select the Batch Class tab on the Definitions panel. 2. Right click anywhere on the panel. 3. Select New Batch Class from the popup menu to open the Create Batch Class dialog box. 4. On the General page, enter the Name. IBM recommends that the name of the batch class match the name of the OnDemand application or application group. The OnDemand Release Script uses the batch class name to generate the name of the output files created by a release. Note: The OnDemand Release Script uses the value of the OnDemand File Naming field from the Document Storage page to determine whether the application name or the application group name becomes the document class name. See OnDemand File Naming on page 13. The OnDemand Release Script does not support blank characters in a document class name. Blank characters in a document class name will be removed by the Release Script. 5. Optionally enter a Description. 6. In the Image folder field, specify the location of a temporary directory that Ascent Capture can use to store image files until they are released. 7. On the Queues page, select the queues that you want to use for processing the batch. All batches based on the batch class will be routed through the queues you select. v Documents released to OnDemand typically require the Scan, Validate, and Release queues. The Recognition Server may be required to support automatic form identification and document separation. v The OnDemand Release Script does not support the OCR Full Text queue. See the online Help for details about the queues and assistance with specifying additional properties of the queues and changing the processing order of the queues. 8. The options on the remaining pages depend on how you process documents in a batch and your form types. See the Ascent Capture documentation for information about the options. 9. Click OK to save your selections and close the Create Batch Class dialog box. Chapter 3. Setting up a batch class 11

22 Inserting the document class into the batch class You must associate the document class with the batch class. To do so: 1. Select the Batch tab on the Definitions panel. 2. Right click on the batch class. 3. Select Insert Document Class from the popup menu to open the Insert Document Class dialog box. 4. Select the name of the document class. 5. Click OK. The document class appears under the batch class on the Batch page of the Definitions panel. Configuring the OnDemand Release Script For each batch class that will release documents to OnDemand, you must identify the release script to use when releasing the index data and files. You will use the IBM Content Manager OnDemand Release Script to release the index data and files to an OnDemand server. The release script must be associated with a batch class / document class combination; the document class must already be inserted into a batch class before you can select the release script. To begin configure the release script, follow these steps: 1. Select the Batch tab on the Definitions panel. 2. If necessary, expand the batch class to show the document class. 3. Right click on the document class. 4. Select Release Script from the popup menu to open the Release Script dialog box. The Release Script dialog box lists all available release scripts. (If the OnDemand Release Script is not listed, see Registering the Release Script on page 3.) 5. Select the IBM Content Manager OnDemand Release Script. 6. Click Add to open the Release Script setup dialog box. The Release setup dialog box allows you to specify index storage, document storage, and image format options for the release. 7. If you are releasing image files, the Index Storage page lists all of the index fields that you defined for the document class in the order in which they will be released to the index output file. You should verify that the names of the index fields match the names of the application group fields. 8. Specify the Name field. Enter a name (up to 32 characters) for the OnDemand Release Script. The name that you specify will be used to refer to the script in the Release Scripts dialog box. The Name field is not required, but may help you keep track of your scripts if you use the 12 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

23 multiple release feature. (Note: The Name field is on the Index Storage page, the Document Storage page, and the Image Format page.) 9. Specify the code page for the index data. The default value is code page 5348 (code set IBM-5348), which is the IBM equivalent code page for the Windows Latin-1 for US and Western Europe with Euro support code page. To specify a different code page, first select the Specify codepage check box. Then enter the value that corresponds to the IBM equivalent code page in the space provided. You must specify the code page that matches the code page of the OnDemand server instance. If you fail to do so, the data will not be usable in OnDemand. For more information about the IBM equivalent code pages, contact the IBM support center. 10. The Document Storage page is where you specify information used by the release script to process files: v Release Image Files. This option determines whether the OnDemand Release Script releases image files or edocuments. Select this option (the default) to index and release image files. Clear this option to index and release edocuments into OnDemand. v v v Note: If you choose to release edocuments to OnDemand, then you must manually index them in the Validation module. See your Ascent Capture documentation for details. To process edocuments in OnDemand, you must set the Data Type to User Defined in the OnDemand application and you must specify the File Type that the client operating system associates with the program that is used to open files of that type. Release Directory. The directory into which you want to release the output files. The release directory usually names NFS-mounted directory on the UNIX OnDemand server or a shared folder on the Windows OnDemand server that will be loading the released output files. For example: N:\RELEASEDIR. Use the Browse command to locate and select a directory. Skip First Page. If your batches include them, use this option to discard the page that separates documents in a batch. OnDemand File Naming. Choose one of the following: Document class maps to OnDemand application group Document class maps to OnDemand application If you choose Document class maps to OnDemand application group, then the batch class name will be the OnDemand application and the document class name becomes the OnDemand application group. If you choose Document class maps to OnDemand application, then the batch class will be the OnDemand application group name and the document class maps to the OnDemand application name. Chapter 3. Setting up a batch class 13

24 v OnDemand Directory Information. The directory that the release script uses to temporarily store Ascent Capture output files. For better performance, the working directory should be on the local machine. For example, C:\TEMP. Use the Browse command to locate and select a directory. v Services Offering Remote Directory Path. The full path name of the directory on the OnDemand server that will be loading the released output files. For example: /arsacif/acif1/releasedir/. The directory that you specify will be used in the index file to locate the image output file. If you plan to run the load process on the local machine, then you do not have to specify a directory. (The load process will retrieve output files from the Release Directory.) v Note: The Release Directory and the Remote Directory Path should specify the same location. The Release Directory is the alias that the location is known as on the local machine. The Remote Directory Path is the absolute location on the OnDemand server. PDF Related Settings. If you are releasing PDF documents, specify options that Adobe Acrobat Capture will use to process the documents. You can poll for status of submitted documents. You can automatically delete documents that have errors during processing in Acrobat Capture. See the online Help for assistance with the PDF options. Note: To release PDF documents, you must use Adobe Acrobat Capture Version 3.0. You must purchase Adobe Acrobat Capture from Adobe. 11. The Image Format page is where you specify the file type of the images created by the release and other options for PDF files. Note: If you are releasing edocuments, then continue with item 12 on page 16. (The options on the Image Format page do not apply to edocuments.) v Release Images As (Image file type). The image file type you select must match the Data Type on the View Information page of the OnDemand application. Table 3 on page 15 lists the Ascent Capture image formats and their corresponding OnDemand application data types. 14 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

25 Table 3. Ascent Capture Image Formats and OnDemand Application Data Types Ascent Capture Image Format OnDemand Application Data Type JPG - JPEG Compression JFIF (JPEG) Note: JPG is the standard file format for color and grayscale images. You cannot convert bitonal (black and white) images to the JPG file format. If all the images in the batch are color and / or grayscale, you should select JPG - JPEG Compression. If the images in the batch are mixed (color, grayscale, and / or bitonal images), you should select a combination that includes the TIFF file format with any compression other than JPEG. The released images will all have the.tif file extension. However, any color images in the batch will contain compressed JPEG data within the TIFF file format. Multipage TIFF - CCITT Group 3 Multipage TIFF - CCITT Group 3/2D Multipage TIFF - CCITT Group 4 Multipage TIFF - JPEG Compression Multipage TIFF - Uncompressed PCX - PackBytes PDF (from JPEG) PDF (from Multipage TIFF) PDF (from PCX) PDF (from Single Page TIFF) TIFF - CCITT Group 3 TIFF - CCITT Group 3/2D TIFF - CCITT Group 4 TIFF - JPEG Compression TIFF - Uncompressed TIFF TIFF TIFF TIFF User Defined (Set the Data Type to User Defined in the OnDemand application and specify the File Type that the client operating system associates with the program that is used to open TIF files.) PCX PDF PDF PDF PDF TIFF TIFF TIFF TIFF User Defined (Set the Data Type to User Defined in the OnDemand application and specify the File Type that the client operating system associates with the program that is used to open TIF files.) Chapter 3. Setting up a batch class 15

26 v PDF Settings. If you set the Image File Type to PDF, then specify the other options on the page. See the online Help for assistance with the PDF options. Note: To release PDF documents, you must use Adobe Acrobat Capture Version 3.0. To view PDF documents from the OnDemand client, IBM recommends that you use Adobe Acrobat or Adobe Acrobat Business Tools. You must purchase Adobe Acrobat Capture, Adobe Acrobat, and Adobe Acrobat Business Tools from Adobe. 12. Click OK to save your selections and close the Release Script setup dialog box. 13. Click Close to close the Release Script dialog box. Publishing the batch class A batch class must be successfully published before it is available for use. The publishing process checks the integrity of the settings in the batch class and makes the batch class available for use. Note: If you encounter problems publishing your batch classes, see the Ascent Capture documentation for help and recommended actions for fixing the problems. To publish a batch class, follow these steps: 1. Select the Batch tab on the Definitions panel. 2. Right click on the batch class. 3. Select Publish from the popup menu to open the Publish dialog box. The Publish dialog box lists all available batch classes and the date and time that they were last published. 4. Select the batch class that you want to publish. 5. Click Publish. Ascent Capture checks the batch class settings and lists the results in the Results box. 6. Click Close to close the Publish dialog box. 16 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

27 Chapter 4. Defining the OnDemand objects When you load documents into OnDemand you store index data into an application group table and store the documents into storage maintained by the application group. You must define an OnDemand application for each different report or type of document that you plan to store in OnDemand. The application definition provides OnDemand information about loading and viewing the data. You define a folder so that users can search for and retrieve documents from the system. You define application groups, applications, and folders with the OnDemand administrative client. The following topics provide specific information about defining application groups, applications, and folders that will receive documents released by the OnDemand Release Script: v Defining the application group v Defining the application v Defining the a folder For an overview of these topics and details about defining OnDemand objects, see the online Help for the administrative client and the IBM Content Manager OnDemand for Multiplatforms: Administrator s Guide, SC Defining the application group General page Name. The application group name must be the same as the Ascent Capture document class or batch class name. The mapping of the document class to the application group or the application is controlled by the value of the OnDemand File Naming option on the Document Storage page of the OnDemand Release Script. See OnDemand File Naming on page 13. Field Definition page Database Field Name. Define one database field for each index field that you defined for the Ascent Capture document class. The name of the database field must be the same as the name of the index field. Field Information page Data Type. The data type of the database field must match the field type that you selected for the index field when you defined the Ascent Capture document class. Table 2 on page 6 lists the Ascent Capture field types and their corresponding OnDemand data types. Copyright IBM Corp

28 Note: You should specify at least one date field; the date field should be selected as the Segment field for the application group. You should create one Application ID field and enter one identifier for each application that belongs to the application group. Defining the application General page Name. The application name must be the same as the Ascent Capture batch class or document class name. The mapping of the batch class to the application or application group is controlled by the value of the OnDemand File Naming option on the Document Storage page of the OnDemand Release Script. See OnDemand File Naming on page 13. Application Group. Select the name of the application group that you defined for the Ascent Capture document class or batch class, depending on how you intend to map the Ascent Capture batch class and document class. View Information page Data Type. Select the format of the images that will be created by the OnDemand Release Script. Choose from PCX, TIFF, PDF, and JFIF (JPEG). Table 3 on page 15 lists the Ascent Capture image formats and their corresponding OnDemand application data types. Indexer Information page Indexer. Choose Generic. Load Information page Data Compression. Choose Disable or *NONE. Format. The format of the date field must be match the format specified with the Regional Settings applet in Control Panel on the Ascent Capture workstation that releases the documents to OnDemand. Verify the date format by inspecting the index file created by a release. Then select the application date format that matches the format of the date in the index file. Defining the folder Note: There are no specific requirements when defining a folder to search and retrieve documents released by the OnDemand Release Script. 18 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

29 Chapter 5. Running the OnDemand Release Script The Ascent Capture Batch Manager is used to check the status or control the flow of batches in the Ascent Capture system. For example, an administrator can use the Batch Manager to process batches through the scan, validation / recognition server, and release queues. When a batch is released to OnDemand, the OnDemand Release Script creates the documents and index data and writes them to the release directory. The release directory (specified on the Document Storage page of the Release Script setup dialog box) is usually an NFS-mounted directory on a UNIX server or a shared folder on a Windows server from which the OnDemand ARSLOAD program can process the files. The OnDemand Release Script names the output files using the following convention: IBMCM.ODKREL.<Class1>.<Class2>.<DateStamp>.<TimeStamp>.ARD IBMCM.ODKREL.<Class1>.<Class2>.<DateStamp>.<TimeStamp>.ARD.ind IBMCM.ODKREL.<Class1>.<Class2>.<DateStamp>.<TimeStamp>.ARD.out Where: <Class1> is the name of the batch class or the document class, depending on how you mapped the batch class and the document class. See item 10 on page 13, OnDemand File Naming for additional information. The OnDemand Release script will remove blank characters in a class name. <Class2> is the name of the document class or the batch class, depending on how you mapped the document class and the batch class. See item 10 on page 13, OnDemand File Naming for additional information. The OnDemand Release Script will remove blank characters in a class name. <DateStamp> is the date of the release in YYYYMMDD format. <TimeStamp> is the time of the release in HHMMSS format. ARD is a file that can be automatically processed by the OnDemand ARSLOAD program. See the OnDemand documentation for details about configuring the ARSLOAD program to automatically process input files. ind is the file that contains the index data for a batch of documents, in the OnDemand generic index format. out is the file that contains all of the documents that are released in a batch, concatenated in a single output file. Copyright IBM Corp

30 20 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5 Services Offering

31 Appendix A. Upgrading the OnDemand Release Script You must complete the following steps each time that you upgrade to a new version of the OnDemand Release Script: 1. Install the latest version of the OnDemand Release Script. Follow the instructions in Chapter 2. Installing the OnDemand Release Script on page Configure the OnDemand Release Script in each batch class in which it is used. Follow the instructions in Configuring the OnDemand Release Script on page Publish each batch class that uses the OnDemand Release Script. Follow the instructions in Publishing the batch class on page 16. Copyright IBM Corp

32 22 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5 Services Offering

33 Appendix B. Problem determination Table 4 lists some of the more common problems that you and others in your organization may encounter when using the OnDemand Release Script. Table 4. OnDemand Release Script common problems Problem Cause Solution Release Script does not appear in the Release Script Manager window Scan process fails. The err_log.txt file contains messages including: The requested item is not in the collection Permission denied Image conversion error MultiTiff File: Bad filename or number Release Script takes a long timetorun Error message unable to load iconv convertor received when you run the ARSLOAD program. Error message unable to open.out file received when you run the ARSLOAD program. Registration of Release Script failed Batch class not set up Working directory and release directory specify the same location Incorrect code page specified in the release script. Incorrect remote directory path specified in the release script. Register the Release Script. See Registering the Release Script on page 3. You must set up a batch class before you run the scan process. Follow the instructions in Chapter 3. Setting up a batch class on page 5. Configure the Release Script so that the working directory and the release directory specify different locations. See Configuring the OnDemand Release Script on page 12. Change the code page in the release script to match the code page of the OnDemand server instance. See item 9 on page 13, Specify the Code Page. Verify that a trailing / (forward slash) is included in the remote directory path. Verify that the remote directory path is an absolute path from the root directory on the OnDemand server. See Remote Directory Path on page 14. Copyright IBM Corp

34 24 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5 Services Offering

35 Appendix C. Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only the IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe on any IBM intellectual property right may be used instead. However, it is the user s responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Directory of Licensing IBM Corporation North Castle Drive Armonk, NY U.S.A For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chrome, Minato-ku Tokyo 106, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. Copyright IBM Corp

36 This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation Department MYGA Building 001L 6300 Diagonal Highway Boulder, CO U.S.A Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. Services Offering The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm 26 IBM Content Manager for Multiplatforms: Release Script for Kofax Ascent Capture 5

37 products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM s future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. Note: This publication contains information Copyright Kofax Image Products All rights reserved. Trademarks and service marks IBM is a trademark of International Business Machines Corporation in the United States, other countries, or both. Adobe, the Adobe logo, Acrobat, and the Acrobat logo are trademarks of Adobe Systems Incorporated, which may be registered in certain jurisdictions. Lotus is a trademark of Lotus Development Corporation. UNIX is a registered trademark in the United States and other countries licensed exclusively through The Open Group. Windows is a trademark of Microsoft Corporation in the United States, other countries, or both. Other company, product, and service names may be trademarks or service marks of others. Appendix C. Notices 27