General Information

Statement DO INDEX enables the user to specify:

• a main index and optional subindexes for a CDAM file
• report locations (line and column ranges) of index values
• variable location (variable name) of index values
• an index mask and report location of a string that must match the mask
• whether the index is page level or record level
• whether or not the indexes remain resident on disk when the report migrates
• whether sections of reports corresponding to index values will be printed by a defined printing mission

After a report is decollated, report sections can be retrieved by specifying index and subindex values. Index values point to a section (one or more pages) of a report based on one of the following:

• a text string which occurs within a specified column range in a specified line (range) on the first page of the section
• the value of a variable that was set in other statements

Each DO INDEX statement defines a main index for the CDAM file selected by the current WHEN block. A maximum of nine main indexes can be created per report. A maximum of nine subindexes can be specified for each main index.

The status of a report processed with the STORED parameter set to Y is described in STORE: Mission-specific Parameter.

The index hierarchy can be horizontal (with all subindexes at level 02), or vertical (with each subindex at a different level), or any intermediate shape (such as those illustrated in examples 1 and 2 below). A subindex cannot be specified before specifying the chain of indexes above it in the hierarchy. As each index is specified, specify all subindexes below it in the hierarchy before specifying a subindex at the same or any higher level.

The presence of an indexable value on a page can optionally be validated by the presence of a similarly defined "mask" value on the same page. Any page without an indexable value is treated as a continuation of the previous pages in that section.

If the $MEMORY system variable is set to ABOVEBAR, Control-D will use storage above bar instead of virtual storage for internal index structures.