Index definitions for lists

Index Name

Max. 16 characters, identifier of index

Note: If you need several index definitions for one index (for example, because the values to be indexed are located next to different identifiers), use the same index name with different instance numbers. The combination of index name and instance number must be unique.

Instance No.

Allowed values: 0..999

Use the instance number to:

• Make the combination of index name and instance number unique if you must define several index definitions under the same index name
• Determine the order in which index fields are displayed on the query panel (display order from lowest instance number to highest instance number)

Index Level

Determines the index type

Allowed values:

For more information, see "Index types".

Format

Permissible values are:

• String (default)
• Decimal

  Specify Decimal in this field if you want to index numeric values. Decimal indexes do not support search according to masks. Normally the value Yes is entered in the Enable Range Selection field for decimal indexes. You can specify the decimal character and the number of decimal positions on page 3 of the panel.

• TOD-Bin (time-of-day token binary)

  Token with date/time value in STCK format in binary presentation (16 digits)

• TOD-Hex (time-of-day token hexadecimal)

  Token with date/time value in STCK format in hexadecimal presentation (16 digits)

Scan Argument

The scan argument may be one of the following:

• A GFFT identifier, which identifies the indexed field via the global format ID (GFID) and the two-digit field ID (FID)

  A GFFT identifier has the following syntax:

  GFFT:gfid-fid

  Example:

  GFFT:CLIENT-UF

• A string or pattern, which finds the information to be indexed by scanning the contents of the list

  The string or pattern can represent the indexed value directly or an identifier that helps locate the indexed value on the page. Define one of the following or a combination thereof:

  • 'string'  or  string
  • P'picture'
  • X'hex_string'

  Scan arguments are case sensitive, which means that Adabas Audit Data Retrieval distinguishes between uppercase and lowercase letters.

  For more information on defining scan arguments, see "Picture strings for scan arguments".

Extract String Relative to Scan Argument:

Column

Length

If scan argument is a GFFT identifier:

Only the Length field is honored. Adabas Audit Data Retrieval uses the actual length of the field if the specified value is greater than the field length.

If scan argument is a string or pattern:

Each time the scan argument is found on the page, a value is extracted at the specified location relative to the scan argument. The maximum length of indexed values is 42 bytes.

If the scan argument is the value that is to be extracted for the index, enter:

• 0 (zero) in the Column field
• The length of the scan argument in the Length field

If the scan argument is merely used to locate the value that is to be extracted for the index, enter:

• The number of columns to the left (negative value) or to the right (positive value) from the first character of the scan argument in the Column field
• The length of the string to be indexed in the Length field

Scan List/Report for Scan Argument:

From Column

To Column

From Row

To Row

If scan argument is a string or pattern:

You can use these fields to define a window on the page where the scan argument should be searched. Enter 0 (zero) in all four fields to search the entire page.

Important: When you define a window on the page, the first character of the scan argument must be within the window defined by the values in the From/To Column and the From/To Row fields, not the entire scan argument. If you know the exact location of the searched string, specify the same value in the From Column and the To Column field.

Scan List/Report for Scan Argument:

From Page

To Page

If scan argument is a string or pattern:

Enter a numeric value or Last to search the scan argument on certain pages only. Enter 1 in the From Page field and Last in the To Page field to search the entire list.

Scan List/Report for Scan Argument:

From Date

To Date

Enter a date if the definition is valid only during the specified period.

Note: We strongly recommend using four-digit year date masks. If you use a two-digit year date mask, 00 through 33 will be read as 2000 through 2033 and 34 through 99 will be read as 1934 through 1999.

Line Number

If the list includes overlaid lines, define:

• Any to search all lines
• Merge to search the merged line

  When lines are merged, the merged line contains the first non-blank character (if available) at each column position, for example:

  Line 1: aaa aaa aaa aaa
  Line 2: bbbbb bbbbb bbbbb
  Merged line: aaabaaabaaa aaabb

• Last to search the last line only
• A numeric value to search this line only

Occurrence

Legal values are:

• First
  If the scan argument occurs more than once on the same page or in the same window, only the first occurrence is indexed.
• Last
  If the scan argument occurs more than once on the same page or in the same window, only the last occurrence is indexed.
• Any (default)
  All occurrences are indexed.

Warning Level

Determines the behavior of the Reader if an index cannot be created or can only be created in an incomplete manner:

Ignore

Processing continues.

Warning

The message IRM1725W is output. Processing continues.

Error

The message IRM1725E is output and the list is not read-in.

Input Required

If Yes, then the respective input field is a required field, i.e. a value must be entered in this field (the entered value must not begin with a mask).

The entry is valid if the query mask is created dynamically. Use the respective field in the layout definition for a user-defined query mask (layout).

Enable Range Selection

If Yes, two input fields are displayed for this index, in order to enable a search according to range.

The entry is valid if the query mask is created dynamically. Use the respective field in the layout definition for a user-defined query mask (layout).

Decimal Positions
Decimal Character

If Format = Decimal:

Decimal character and the number of places after the decimal character

Input string ...
Substituted by ...

Before being processed further, each value extracted for this index passes through each substitution rule specified here (string is replaced by another string or a zero string; masks are not supported).

Example: For generating a decimal index, D for Debit should be replaced by a Minus ( ‑ ) and C for Credit respectively by a Plus ( + ).

Execution Order

Filter Search Argument Formula

Filter search argument formulas are not used by Adabas Audit Data Retrieval.