Previous Topic: 4.2.4.2.1 File Statement (FILE)

Next Topic: 4.2.4.2.3 Database Cycle Retention Statement(Cycles)

4.2.4.2.2 File Option Statement (FOPT)

This optional statement defines the Essential and Derived
data element options to be associated with a CA MICS database
file.  Defaults are used when the statement is absent.  If
the statement is present, it must immediately follow the FILE
statement.


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 FOPT Statement.

  FOPT  eeeeeeee dddddddd tttttttt xxxxxxxx
           |        |        |        |
           |        |        |        |
           |        |        |        |
           |        |        |        +---BYPASS -Optional
           |        |        |            protection bypass
           |        |        |
           |        |        +---TYPE - File option type
           |        |
           |        +---DERIVED - Derived data element
           |            option
           |
           +---ESSENTIAL - Essential data element option



STATEMENT OPTION DEFINITIONS

  FOPT    - Defines the Essential and Derived data element
            options to be used for the database file defined
            in the preceding FILE statement.

          ESSENTIAL - Defines the Essential data element
                      option to be used for the file.  The
                      value specified for this option must be
                      DEFAULT, INITIAL, ONLY, or ALL as
                      described below.

          DERIVED   - Defines the Derived data element
                      option to be used for the file.  The
                      value specified for this option must be
                      DEFAULT, COMP, or DISK as described
                      below.

          TYPE      - Controls the activation or deactivation
                      of files in timespans.  Valid values
                      are:

                      o STD - does not deactivate the file in
                              any timespan

                      o NONESSL - deactivates the file in all
                                  timespans

                      o APPL - deactivates the file in the
                               WEEKS, MONTHS, and YEARS
                               timespans

                      o USER - synonym for APPL

          BYPASS    - This optional parameter is normally
                      left blank.  There are safeguards in
                      the evaluation of the Essential option
                      that help prevent inadvertent data
                      loss.  If you wish to bypass these
                      safeguards and force the Essential
                      option for all files in a component to
                      a value of INITIAL or ONLY unless
                      overridden on the FOPT statement, code
                      the word BYPASS in this position on the
                      COMPOPT statement.  Otherwise, for the
                      protection of the data on an existing
                      database, do not code this parameter.


Actions of the Specifications

    Definitions necessary for the discussion:

    o A derived data element is a data element defined in a
      TYPE group whose DATATYPE (as defined in the TYPE
      statement documentation that follows) is C, CN, XC, or
      XCN.  Its value results from a calculation.

    o An essential data element is a data element defined in
      a TYPE group by a NAME statement.  (Data elements that
      are not essential are defined by the NAMX statement.)
      "Essential" indicates that the element is needed either
      to calculate the values of other elements or is used in
      the standard reports provided with the product.

+--------------+--------------------------------------------+
|If ESSENTIAL  |                                            |
|is set to ... | then ...                                   |
+--------------+--------------------------------------------+
|              |                                            |
| ALL          | all data elements defined in the           |
|              | component's cccGENIN member on             |
|              | sharedprefix.MICS.GENLIB are stored on the |
|              | disk (when DERIVED is DISK) or are         |
|              | available through the derived element      |
|              | macros (when DERIVED is COMP).             |
|              |                                            |
| ONLY         | only the data elements essential for file  |
|              | key structures, standard reports, and      |
|              | CA MICS management support applications are|
|              | stored on disk.  (These data elements are  |
|              | defined using NAME statements.)  All other |
|              | data elements are dropped from CA MICS     |
|              | processing and are not available without   |
|              | reprocessing raw DETAIL data.              |
|              |                                            |
|              | When ONLY is specified, the DERIVED option |
|              | determines whether essential computed      |
|              | elements are stored on disk (when DERIVED  |
|              | is DISK) or are available through the      |
|              | derived element macros (when DERIVED is    |
|              | COMP).                                     |
|              |                                            |
| INITIAL      | only essential data elements are stored on |
|              | disk, which is similar to the ONLY option. |
|              |                                            |
|              | What differs between ONLY and INITIAL is   |
|              | that INITIAL forces the DERIVED            |
|              | statement's value to COMP, meaning         |
|              | essential computed elements are available  |
|              | only through the derived element macros.   |
|              | Moreover, the WEEKS, MONTHS, and YEARS     |
|              | timespans of all user and application      |
|              | unit identified files are disabled.        |
|              |                                            |
| DEFAULT      | essential data element values are taken    |
|              | from the definition in the CPLXDEF member  |
|              | of the sharedprefix.MICS.PARMS library.    |
+--------------+--------------------------------------------+

+--------------+--------------------------------------------+
|If DERIVED    |                                            |
|is set to ... | then ...                                   |
+--------------+--------------------------------------------+
|              |                                            |
| DISK         | derived data element values are stored on  |
|              | auxiliary storage.                         |
|              |                                            |
| COMP         | derived data element values are            |
|              | recalculated when needed rather than being |
|              | stored on auxiliary storage.               |
|              |                                            |
| DEFAULT      | derived data element values are taken from |
|              | the definition in sharedprefix.MICS.PARMS  |
|              | member CPLXDEF.                            |
+--------------+--------------------------------------------+

Essential and Derived data element option values can be
specified at three levels:

    o the complex level, which applies to all products in the
      complex

    o the product level, which applies to all files in the
      product

    o the file level, which applies to a single file

Normal specifications for the component and file option
values are "DEFAULT", indicating that the complex definitions
found in sharedprefix.MICS.PARMS(CPLXDEF) are to be used.
This relationship is illustrated by the following table:

 CPLXDEF     COMPOPT          FOPT              Generated
 Options     Options          Options           File Options
 ----------  ---------------  ---------------   --------
 ALL DISK    DEFAULT DEFAULT  DEFAULT DEFAULT   ALL DISK
 ALL COMP    DEFAULT DEFAULT  DEFAULT DEFAULT   ALL COMP
 ONLY DISK   DEFAULT DEFAULT  DEFAULT DEFAULT   ONLY DISK
 ONLY COMP   DEFAULT DEFAULT  DEFAULT DEFAULT   ONLY COMP
 INITIAL     DEFAULT DEFAULT  DEFAULT DEFAULT   INITIAL
 any         ALL DISK         DEFAULT DEFAULT   ALL DISK
 any         ALL COMP         DEFAULT DEFAULT   ALL COMP
 any         ONLY DISK        DEFAULT DEFAULT   ONLY DISK
 any         ONLY COMP        DEFAULT DEFAULT   ONLY COMP
 any         INITIAL          DEFAULT DEFAULT   INITIAL
 any         any              ALL DISK          ALL DISK
 any         any              ALL COMP          ALL COMP
 any         any              ONLY DISK         ONLY DISK
 any         any              ONLY COMP         ONLY COMP
 any         any              INITIAL           INITIAL

STATEMENT DEFINITION EXAMPLE

  Standard Database File

    FOPT DEFAULT DEFAULT STD

This statement defines that the file to which this file
option statement belongs uses standard (STD) Essential data
element options, and the Essential and Derived data element
options will be taken from previous specifications (either
the COMPOPT statement in the cccGENIN member itself, or from
the CPLXDEF parameter member specifications as generated by
the CPLXGEN job).