Archive Index Files
for Image Scanner Implementation Only

ScanTools generates a single index file containing the index values for all the image clip files generated. The index file is not used by ScanTools but is created for the archiving system that will be used to store and access the image files. The index file format is selected for:

• Post-scan archiving in the Archive Options dialog.
• Scan-time archiving in iNAME Configuration.

The index file format can be one of the following formats:

• ScanTools Native, .ndx
• ApplicationXtender, .apx
• RAW, for iNAME scan-time use only
• RAW with Index Name, for iNAME scan-time use only

NOTE: The file name in the archive index will be set to *NOT TAKEN*** if Conditional Clipping for Image Archiving was enabled for a graybox and the graybox clip region did not contain data.

ScanTools Native Index Format

The index file has one line for each archive clip taken. Each line contains the following data:

• Document name.
• File suffix of the associated clip (grid).
• Serial number of the associated document.
• Name of the associated image file. When using iNAME scan-time archiving, the full path name is included.
• Pairs of index fields and the associated data. Index/data pairs are delimited by the tilde (~) character.

Each field in the index information is delimited by the tab character.

Each line is delimited by a carriage return line feed.

Though this index file format is unlikely to be directly usable by any archiving software as it stands, it is designed so that it can be easily manipulated into some other format. It contains data sufficient for an application to easily extract all the clips for either a document, a serial number, or a clip suffix.

The following is a sample ScanTools index (.ndx) file created during post-scan archiving.

GPAS(tab)PH(tab)000001(tab)000001PH.TIF(tab)Name~John Doe(tab)ID~6128920316

GPAS(tab)SIG(tab)000001(tab)000001SIG.TIF(tab)Name~John Doe(tab)ID~6128920316

GPAS(tab)PH(tab)000002(tab)000002PH.TIF(tab)Name~Mary Richards

GPAS(tab)SIG(tab)000002(tab)000002SIG.TIF(tab)Name~Mary Richards

GPAS(tab)PH(tab)000003(tab)000003PH.TIF(tab)Name~Jay Smith(tab)ID~6126832231

GPAS(tab)SIG(tab)000003(tab)000003SIG.TIF(tab)Name~Jay Smith(tab)ID~6126832231

This example is for 3 serial numbers that are a mix of the "Single Sided GPAS" and "Double Sided GPAS" documents in sample application 701. The single sided form is indexed by name and ID number while the double sided form is indexed by name only. Each document archives a photo, designated by suffix PH, and a signature, designated by suffix SIG.

ApplicationXtender Index Format

ScanTools creates an index file with an .APX extension for ApplicationXtender.

The index file consists of one or more index records. Each index record consists of one or more data fields and their associated image path field(s). The data fields appear first in the record and are delimited by the comma character.

The image path fields are the directory/subdirectory paths that identify the associated image file(s). It is delimited from the data fields by the "@" character for a single-page image file or "@@" for a multi-page image file.

Multi-Page TIFF Support: Multi-page tiffs are supported for scan-time image archiving with the iNAME function. Multi-page tiffs are not supported for post-scan image archiving.

The set of data fields in the index record may be applied to more than one image file. Therefore, multiple image path references may be listed per record.

Example 1. The following is a sample index (.apx) file:

JOHN ,DALE ,021861@C:\Program Files\Scantron\ScanTools Plus\Data Files\applicationxtender\000004abc.tif

@C:\Program Files\Scantron\ScanTools Plus\Data Files\applicationxtender\000004def.tif

@C:\Program Files\Scantron\ScanTools Plus\Data Files\applicationxtender\000004ghi.tif

BOCK ,JENN ,0814 @C:\Program Files\Scantron\ScanTools Plus\Data Files\applicationxtender\000005abc.tif

@C:\Program Files\Scantron\ScanTools Plus\Data Files\applicationxtender\000005def.tif

@C:\Program Files\Scantron\ScanTools Plus\Data Files\applicationxtender\000005ghi.tif

EMERY ,CALLAN ,122121@C:\Program Files\Scantron\ScanTools Plus\Data Files\applicationxtender\000006abc.tif

@C:\Program Files\Scantron\ScanTools Plus\Data Files\applicationxtender\000006def.tif

@C:\Program Files\Scantron\ScanTools\Data Files\applicationxtender\000006ghi.tif

The index records in the example above use three data fields (last name, first name, and employee number) to access each clipped file in the applicationxtender subdirectory. Data fields John, Dale, and 021861 access clipped files 000004abc.tif, 000004def.tif, and 000004ghi.tif.

Example 2. The following is another sample index (.apx) file:

MARCH ,KIRSTIN ,0123456789,010239@\\6835bw43k870\c\Image File\000001lst.tif

@\\6835bw43k870\c\Image File\000001fst.tif

BARENS ,JOHN ,1345678910,010239@\\6835bw43k870\c\Image File\000002lst.tif

@\\6835bw43k870\c\Image File\000002fst.tif

The index records in the example above use four data fields (last name, first name, identification number, and date of birth) to access each clipped file in the Image File subdirectory. Data fields March, Kirstin, 0123456789, and 010239 access clipped files 000001lst.tif and 000001fst.tif. The image path fields use UNC names (\\…).