IBM for i, Version 7.1

Indexing parameters

Indexing parameters can contain indexing, conversion, and resource collection parameters, options, and values. For most reports, Content Manager OnDemand requires three indexing parameters to extract or generate index data:

TRIGGER Content Manager OnDemand uses triggers to determine where to locate data. A trigger instructs Content Manager OnDemand to look for certain information in a specific location in the report file. When Content Manager OnDemand finds a record in the data stream that contains the information specified in the trigger, it can begin to look for index information.
- Content Manager OnDemand compares data in the report file with the set of characters specified in a trigger, byte for byte.
- A maximum of 16 triggers can be specified.
- All fixed group triggers must match before Content Manager OnDemand can generate index information. However, floating triggers can occur anywhere in the data stream. That is, index data based on a floating trigger can be collected from any record in the report file.
FIELD The field parameter identifies the location, offset, and length of the data Content Manager OnDemand uses to create index values.
- Field definitions are based on TRIGGER1 by default, but can be based on any of 16 TRIGGER parameters.
- A maximum of 128 fields can be defined.
- A field can also specify all or part of the actual index value stored in the database.
INDEX The index parameter is where you specify the attribute name, identify the field or fields on which the index is based, and specify the type of index that Content Manager OnDemand generates. For the group-level indexes Content Manager OnDemand stores in the database, you should name the attributes the same as the application group database field names.
- Content Manager OnDemand can create indexes for a page, group of pages, and the first and last sorted values on a page or group of pages. Content Manager OnDemand stores group-level index values in the database. Users can search for items using group-level indexes. Page-level indexes are stored with the document (for example, a statement). After retrieving a document that contains page-level indexes, you can move to a specific page by using the page-level indexes.
  Content Manager OnDemand can only generate this type of page-level information when converting the input data to AFP. This type of page-level information is generated by specifying the CONVERT=YES and INDEXOBJ=ALL parameters, and by creating an index field with the TYPE=PAGE option.
- You can concatenate field parameters to form an index.
- A maximum of 128 index parameters can be specified.

Content Manager OnDemand creates a new group and extracts new index values when one or more of the fixed group index values change, or the GROUPMAXPAGES value is reached.

Figure 1. Indexing a report

  ----+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9
01                                                                       Page 0001
1
2                                        Jack Straw
3                                        4 Buxanchange Way
4                                        Wichitaw KS 99999-9999
5
6                                        Statement Date: 06/15/07
7                                        Account Number: 1234-5678-9876-0000
8
9                                        Balance: $2,984.17

The following indexing parameters can be used to generate index data for the report shown in Figure 1. The TRIGGER definitions tell Content Manager OnDemand how to identify the beginning of a group in the input. Content Manager OnDemand requires two TRIGGER definitions to identify the beginning of a group (statement) in the sample file. For example:

TRIGGER1 looks for a 1 in the first byte of each input record.
TRIGGER2 looks for the string Page 0001 in column 72 of the same record.

Together, the triggers uniquely identify the start of a statement in the report.

The FIELD definitions determine the location of the index values in a statement. Fields are based on the location of trigger records. For example:

FIELD1 identifies customer name index values, beginning in column 40 of the second record following the TRIGGER1 record.
FIELD2 identifies the statement date index values, beginning in column 56 of the sixth record following the TRIGGER1 record.
FIELD3 identifies the account number index values, beginning in column 56 of the seventh record following the TRIGGER1 record.

An INDEX definition identifies the attribute name of the index field. Indexes are based on one or more field definitions. For example:

INDEX1 identifies the attribute name custnam, for values extracted using FIELD1.
INDEX2 identifies the attribute name sdate, for values extracted using FIELD2.
INDEX3 identifies the attribute name acctnum, for values extracted using FIELD3.

The following table lists the maximum values for certain indexing attributes:

Indexing attribute	Maximum value
Maximum number of lines per spooled file page (greater than printer file maximum due to allowance for overprint lines)	510
Maximum page width (positions per line)	378
Maximum number of triggers per page (for documents not using multi-key)	16
Maximum number of index values per page (for documents not using multi-key)	128
Maximum number of fields per page (for documents not using multi-key)	128
Maximum number of triggers per page (for multi-key documents)	512
Maximum number of index values per page (for multi-key documents)	1024
Maximum number of fields per page (for multi-key documents)	1024
Maximum number of index values per group (document) (for multi-key documents)	9999
Maximum size of an AFP resource segment	16,000,000 bytes
Maximum size of any single AFP resource	16,000,000 bytes

Important: For the Maximum page width indexing attribute, when using the Print Text for OnDemand (PRTTXTOND) command with STMF(*NONE), which directs the output to a spooled file instead of a stream file, the maximum page width is 372.

Feedback