This is a detailed reference space that provides the information necessary for users to fully use the features of File-AID for IMS/FLEX 23.1.

This space is not intended as a learning tool for first time users of File-AID for IMS.

Document Format

This space uses special type fonts to define commands, keywords, and user entries. Some of these formatting structures are described below.

Special Fonts

Commands, keywords, screen names, field names, and column names appear in upper case. For example:

The COUNT primary command ...

Only one LANGUAGE keyword can be ...

The PRINT AUDIT TRAIL screen has ...

... in the LEVEL NUMBER/DATA NAME field

... in the FORMAT column

Enter the END command.

Section Organization

This space contains the following sections:

• Overview: Provides an overview of the File-AID for IMS/FLEX product.
• File-AID-for-IMS-FLEX-interface: Describes the screens associated with File-AID for IMS/FLEX.
• Command-statements: Describes the different commands and keywords used by File-AID for IMS/FLEX to update a database and to count and print segments in a database.
• Audit-trail-facility: Describes the File-AID for IMS/ISPF audit trail facility.
• Segment-layout-cross-reference: Describes the File-AID for IMS/ISPF segment/layout XREF function.
• FLEX-JCL: Provides the requirements for the JCL statements needed to execute File-AID for IMS/FLEX.
• Examples-to-demonstrate-the-capabilities-of-File-AID-for-IMS-FLEX: Provides four examples that demonstrate the capabilities of File-AID for IMS/FLEX.

Although File-AID for IMS supports both the COBOL and PL/I programming languages, much of its processing is unaffected by the language you use; therefore, much of the text in this reference manual is presented in a language-independent manner. In those instances where processing is affected by the language you use, the COBOL perspective is presented first under its own indented subheading, followed by the PL/I perspective. On many of the screens and reports in File-AID for IMS, occurrences of either the word COBOL or PL/I appear, depending on the language you use. However, most of the screen and report examples presented in this reference space use COBOL as a default.

Notation Rules

This space uses the following notation rules:

• Screen, field, and column names appear with initial caps. For example:
  • ...on the Extract specification screen
  • ...in the Region Type field
  • ...in the Line Cmd column
• Primary command names appear in all uppercase. For example, Enter the FIELD command to...

Reading the Syntax Diagrams

Syntax diagrams define primary command syntax.

A parameter is either a keyword or a variable.

All KEYWORDs are shown in uppercase characters and must be spelled exactly as shown. You cannot substitute another value. If any part of a KEYWORD is shown in lowercase characters, that part is optional.

Variables are user-specified values and are printed in lowercase italics. For example, dataset-name indicates you are to substitute a value.

The syntax for commands is described in diagrams that help you visualize parameter use.

Required parameters appear on the horizontal line (the main path). Optional parameters appear below the main path. Default parameters appear above the main path and are optional. The command executes the same regardless of whether the default parameter is included.

Vertically stacked parameters are mutually exclusive. If you must choose a parameter, one item of the stack appears on the main path. If the parameters are optional, the entire stack appears below the main path. If a parameter in a stack is the default, it appears above the main path.

If the same parameters are used with several commands, their syntax may be documented in a separate diagram. In the command syntax, these common parameters are indicated with separators before and after the parameter name.

An arrow returning to the left indicates a repeatable item. If the arrow contains a comma, separate the repeated items with a comma.