Index definition table - file format

The index definition table is used where dynamic item index data (coded data) is needed. It allows the index data to be built up by using different attributes such as Site ID, Process Date, and Entry Number. You can also place filler data between each attribute. The index definition is defined by using an index definition table file. During initialization, the application reads an index definition table file that defines how the index data is formatted.

The index definition table file is a comma-delimited ASCII file with a maximum of 256 characters for each line. Each line defines a single attribute of index data. Six fields can be put on each line. Each field is separated by a comma and a space or by spaces.

The following table shows the fields for the index definition table.
Table 1. Fields for the index definition table
Field number Field name Description
1 id Attribute ID
2 name Name of the attribute. For specific IDs, the name field has a special meaning. For more information, see Table 2, specifically for the ID that is called filler.
3 type This field defines how the information that is used for each attribute is formatted or placed in the resulting index data. The values for this field are shown in the following list.
C
The source string is copied to the target string with a size of length. If the source is greater than the target, the leftmost characters are truncated. If the source is smaller than the target, the target is right-aligned and padded with blanks. Blanks and dashes are removed.
N
The source string is copied to the target string with a size of length. If the source is greater than the target, the leftmost digits are truncated. If the source is smaller than the target, the target is right-aligned and padded with zeros. Blanks are converted to zeros and dashes are removed.
Z
The source string is copied to the target string with a size of length. If the source is greater than the target, the leftmost digits are truncated. If the source is smaller than the target, the target is right-aligned and padded with zeros. No conversion is done.
4 length The maximum length that is used for the attribute.
5 modifier Specifies extra formatting for some of the attributes.
6 description This field is freeform text that describes the attribute.
The following table shows the possible ID fields and the valid types and modifiers for the field. If a field list has a modifier other than 0 (zero), see Table 3.
Table 2. Index definition IDs
Index definition IDs
ID Data element that is used Type Modifier
MicrFld1 - MicrFld16 or 1 - 16 MICR fields 1 through 16. C, N 9, 8 MicrFld5 only.
OrigFld1 - OrigFld16 Original MICR fields 1 through 16. C, N 9, 8 MicrFld5 only.
Filler Returns n blanks, where n is equal to the value that is in the length field. This ID can also be used to return the text in the name field based on the modifier. C, N 1
ProcessDate The processing date of the entry. C 1
CycleDate Cycle date at which the entry was processed. C 1
CycleID Cycle ID C 0
SiteID Entry Site ID N 0
ProcessSite Entry Site ID N 0
SortType The sort type of the entry. C, N 0
Entry Entry ID N 0
Tracer The number for the current item. C, N  
ISN Item Sequence Number N 0
UserByte SCI Work Byte 2 (If the length is 2, the value is returned in hexadecimal; otherwise, it is returned in decimal.) N 0
Pocket7780 7780 pocket number N 0
Pocket3890 3890 pocket number N 0
ImageSegment **************************************** C 0
ISN12 12-digit ISN N  
ImageSegmentLen Image segment length N 0, 1, 2, 3
FBW_ImageMissing Returns YES or Y if the FBW image segment is missing and NO or N if it is present. To use Y or N, set the length field to 1. To use YES or NO, set the length field to 3. C 0
RBW_ImageMissing Returns YES or Y if the RBW image segment is missing and NO or N if it is present. To use Y or N, set the length field to 1. To use YES or NO, set the length field to 3. C 0
FGS_ImageMissing Returns YES or Y if the FGS image segment is missing and NO or N if it is present. To use Y or N, set the length field to 1. To use YES or NO, set the length field to 3. C 0
RGS_ImageMissing Returns YES or Y if the RGS image segment is missing and NO or N if it is present. To use Y or N, set the length field to 1, To use YES or NO, set the length field to 3. C 0
DebitCreditInd Returns debit or credit indicator. If the field type is set to C, 1 = Credit; 8 = Debit; 0 = Any other type of item. If the field type is set to N, C = Credit; D = Debit, Blank = Any other type of item. C, N 0
Custom1 - Custom99 Custom fields available on an application-by-application basis.    
ImageShareInd Image Share Ind for VP-ISIX C 0
MissingImageInd Missing Image Inds C 0
The following table shows the specification of IDs that support modifier values. This table shows which index definition IDs have modifier values that are associated with them, and the modifier value range and its meaning.
Table 3. Index definition ID and modifier results
Index definition ID and modifier results
ID Modifier Result
MicrFld5
OrigFld5
 9 Returns a nine-digit RT field with a hyphen. And, if the supplied RT is less than 9, a check digit is computed for the ninth digit. Conversion is from left to right, for example:
In
Out
1234-5678
123456780
12345678
123456780
123456789
123456789
MicrFld5
OrigFld5
 8 Returns an eight-digit RT field without a hyphen. Conversion is from left to right, for example:
In
Out
1234-5678
12345678
12345678
12345678
123456789
12345678
MicrFld5
OrigFld5
 Blank Returns the RT field based on type field only
Filler 1 Returns the text in the name field, based on the type field
Filler Blank Returns n blanks, where n is equal to the value in the length field.
ProcessDate
CycleDate
 1
Field length
Data format
10
yyyy/mm/dd
8
yyyymmdd
6
yymmdd
4
mmdd
ProcessDate
CycleDate
 Blank
Field length
Data format
10
mm/dd/yyyy
8
mmddyyyy
6
mmddyy
4
ddmm
ImageSegmentLen 0 FBW image segment length
ImageSegmentLen 1 RBW image segment length
ImageSegmentLen 2 FGS image segment length
ImageSegmentLen 3 RGS image segment length
The following table shows information about the tasks that are supported for a specific index definition ID.
Table 4. Index definition ID and supported tasks
Index definition ID and supported tasks
ID Tasks that support the ID
MicrFld1 - MicrFld16 or 1 - 16 CIFF, Titan, NCR, OnDmd
OrigFld1 - OrigFld16 or 1 - 16 CIFF, Titan, NCR
Filler CIFF, Titan, NCR
ProcessDate CIFF, Titan, NCR, OnDmd
CycleDate CIFF, Titan, NCR, OnDmd
CycleId Titan, NCR, OnDmd
TracerNum None
SiteID Titan, NCR
ProcessSite CIFF
SortType CIFF, NCR
Entry CIFF
Tracer CIFF
OnUsInd None
ISN CIFF, Titan, NCR, OnDmd
UserByte CIFF, Titan, NCR, OnDmd
Pocket7780 CIFF, Titan, NCR
Pocket3890 CIFF, Titan, NCR
ImageSegment Titan
ISN12 Titan
ImageSegmentLen NCR
FBW_ImageLen None
RBW_ImageLen None
FGS_ImageLen None
RGS_ImageLen None
FBW_ImageMissing None
RBW_ImageMissing None
FGS_ImageMissing None
RGS_ImageMissing None
DebitCreditInd None
OrigISN None