Previous Topic: 4.2.4.2 File Definition Statements

Next Topic: 4.2.4.2.2 File Option Statement (FOPT)

4.2.4.2.1 File Statement (FILE)

This statement defines a CA MICS database file identifying
the type of file, the timespans or areas, archive levels in
which the file is supported, and the name of the file.

STATEMENT FORMAT

This keyword is coded with the KEYWORD starting in column
1, free-form, and continuing through column 72.  Continuation
is not supported.  The following describes the format and
coding rules for the FILE Statement.

  FILE fff cc ll dt dy wk mn yr aa hw hm xxxxxxxxxxxxxxxxxxxx
        |  |  |  |  |  |  |  |  |  |  |  |
        |  |  |  |  |  |  |  |  |  |  |  +---FNAME - Filename
        |  |  |  |  |  |  |  |  |  |  |
        |  |  |  |  |  |  |  |  |  |  +---HISTM -Archive
        |  |  |  |  |  |  |  |  |  |      monthly history
        |  |  |  |  |  |  |  |  |  |      definition.
        |  |  |  |  |  |  |  |  |  |
        |  |  |  |  |  |  |  |  |  +---HISTW - Archive weekly
        |  |  |  |  |  |  |  |  |      history definition.
        |  |  |  |  |  |  |  |  |
        |  |  |  |  |  |  |  |  +---AUDIT - Archive audit
        |  |  |  |  |  |  |  |      definition.
        |  |  |  |  |  |  |  |
        |  |  |  |  |  |  |  +---YEARS - Years timespan
        |  |  |  |  |  |  |      definition.
        |  |  |  |  |  |  |
        |  |  |  |  |  |  +---MONTHS - Months timespan
        |  |  |  |  |  |      definition.
        |  |  |  |  |  |
        |  |  |  |  |  +---WEEKS - Weeks timespan
        |  |  |  |  |              definition.
        |  |  |  |  |
        |  |  |  |  +---DAYS - Days timespan definition.
        |  |  |  |
        |  |  |  +---DETAIL - Detail timespan definition.
        |  |  |
        |  |  +---LEVEL - File expansion level.
        |  |
        |  +---FCODE - File type code.
        |
        +---FID - File Identification (base and parallel IDs
                  if a parallel definition - FCODE >= 50).

STATEMENT OPTION DEFINITIONS

           FILE    - Defines a data file.  The file contains all of
            the data elements defined following this
            statement.  This statement defines the type of
            file, the timespans and areas, archive levels in
            which the file is supported, and the name of the
            file.

            FID     - A 3-character or 6-character file ID.

                      A 3-character file ID denotes a
                      standard CA MICS file.

                      A user file must have a 'U' or 'Z' as
                      its first letter to denote that it is a
                      user file and ensure uniqueness in the
                      file's identification.  Additionally,
                      MSI cannot be used as a file name.

                      A parallel file is a file that has the
                      same record structure as another file.
                      A parallel file's FID is two
                      3-character file identifications--the
                      first three characters are the ID of
                      the parallel file, and characters 4
                      through 6 are the ID of the database
                      file after which the parallel file is
                      patterned.

             FCODE   - Defines the type of file that is to be
                      processed using the following codes:

                      Standard File

                         00 - defines standard file for
                              DETAIL, DAYS, WEEKS, MONTHS,
                              and YEARS database timespans.

                         01 - defines a standard file for the
                              TABLES database area.

                         02 - defines an interim work file
                              typically used during the DAILY
                              process.  Contact CA MICS
                              Product Support before
                              deactivating an interim work
                              file.

                         03 - defines a CA MICS Accounting
                              and Chargeback Journal File.

                         04 - defines a standard file that is
                              processed as a spin file.

                              A spin file maintains
                              information spanning a
                              specified period of time.The
                              specified time period is
                              subtracted from the current
                              date during a DAILY update
                              cycle to determine a cutoff
                              date.  Data older than the
                              cutoff is dropped from the
                              file.  Only cycles 00 and 01
                              exist and are aged.

                         05 - defines a standard file that
                              exists only in the WEEKS,
                              MONTHS, and/or YEARS timespans.
                              It does not exist in DETAIL or
                              DAYS, and requires special
                              processing for the first
                              summarization.
                      Parallel File

                      A parallel file is a file that has the
                      same record structure as another file.

                         50 - defines parallel file for
                              DETAIL, DAYS, WEEKS, MONTHS,
                              and YEARS database timespans.

                         51 - defines a parallel file for the
                              TABLES database area.

                         52 - defines a parallel interim work
                              file.

            LEVEL   - Defines the level in which file
                      expansion takes place.  This option
                      defines that a file is dependent on a
                      file that precedes it in the expansion
                      process.  Valid values range from 1 to
                      n.

                      For example, if FileA must be processed
                      before FileB, FileA's level is set to 1
                      and FileB's level is set to 2.

            DETAIL   - Defines if the file is to be
                       maintained in the DETAIL timespan.  Y
                       if yes and N if no.

            DAYS     - Defines if the file is to be
                       maintained in the DAYS timespan.  Y
                       if standard support, N if no, and E
                       for special processing support.

            WEEKS    - Defines if the file is to be
                       maintained in the WEEKS timespan.
                       Y if standard support, N if no, and
                       E for special processing support.

            MONTHS   - Defines if the file is to be
                       maintained in the MONTHS timespan.
                       Y if standard support, N if no, and
                       E for special processing support.

            YEARS    - Defines if the file is to be
                       maintained in the YEARS timespan.
                       Y if standard support, N if no, and
                       E for special processing support.

            AUDIT    - Defines if the file is to be included
                       in the weekly audit archive.  Y if
                       yes and N if no.

            HISTW    - Defines if the file is to be included
                       in the weekly history archive.  Y if
                       yes and N if no.

            HISTM    - Defines if the file is to be included
                       in the monthly history archive.  Y if
                       yes and N if no.

            FNAME    - The 40-character name used to describe
                       the file.


Special consideration for online timespans:

A file is active in a timespan if its timespan
definition contains a Y or E and is inactive if its timespan
definition contains an N.

The difference between the Y and E options is that Y
results in standard summarization code being generated to
update the file, and E requires the use of an exit to perform
special processing on the file.  The exit member used with
these files is contained in sharedprefix.MICS.SOURCE members
named #ffftSUM, where "fff" is the three-character file
identifier and "t" is either X, D, W, M, or Y depending on
the timespan being processed.
STATEMENT DEFINITION EXAMPLE

  Standard Database File

    FILE UDE 00 1 Y Y Y N N N Y N SYSLOG Device Error File

This statement defines the "SYSLOG Device Error File" as
a standard file (00) with the 3-character file ID of "UDE".
The file is to be maintained in the DETAIL (Y), DAYS (Y), and
WEEKS (Y) timespans and is only supported in the archive
weekly history (Y).
  Parallel Database File

    FILE _STPGM 50 1 Y N N Y N N N Y System Task Pgm Activity

This statement defines the "System Task Pgm Activity"
file as a parallel file (50) whose 3-character file ID is
"_ST" and whose structure is patterned after "PGM" file.  The
_ST file is to be maintained in the DETAIL (Y), MONTHS (Y),
and archive monthly history (Y) timespans.