File Definition Statements
The statements in a file group are used to define a file within an information area.
micsrm140cd
Required roles: systems programmer, security administrator, database administrator |
|---|
One or more file groups may be contained within an information area definition.
A file group of component generation statements consists of all statements that are necessary define the file. These statements are the FILE and optional FOPT, CYCLES, and COMPRESS.
Grouping and Order
The grouping and order of the statements is important because of the hierarchical nature of MCG statements. This diagram illustrates the order of statements:
. . . +------------------------------ AREA ... | +------------------+- FILE ... | | +- FOPT ... | | +- CYCLES ... | | +- COMPRESS ... | | +---------- TYPE .... | | | +- ALIAS ... | | | D.E. | NAME ... | | | group -+ EXP 01 ... | | | | EXP 02 ... | | type | | EXP nn ... | | group -+ +- DEPEND ... | | | D.E. | file | | group -+- NAME ... | group -+ | +- EXP 01 ... info | | | area -+ | | D.E. +- NAME ... group | | | group -+ EXP 01 ... | | +------- +- DEPEND ... | | | | | | more TYPE ... | | type . . . | | groups - ... | | | +-------------------- last D.E. | | +------------------+- FILE ... | | +- FOPT ... | more | +- CYCLES ... | file -+ type +- COMPRESS ... | groups | groups - ... | | | +-------------------- last D.E. +------------------------------ last file
File Statement (FILE)
This statement defines a
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 diagram statement 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 the data elements that are 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 three characters or six character file ID.
A three character file ID denotes a standard
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 three 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 that is typically used during the DAILY process. Contact
Broadcom Support
before deactivating an interim work file.03
Defines a
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. If the file 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 depends 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 that is 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 FileFILE UDE 00 1 Y Y Y N N N Y N SYSLOG Device Error FileThis statement defines the "SYSLOG Device Error File" as a standard file (00) with the three 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 FileFILE _STPGM 50 1 Y N N Y N N N Y System Task Pgm ActivityThis statement defines the "System Task Pgm Activity" file as a parallel file (50) whose three 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.
File Option Statement (FOPT)
This optional statement defines the Essential and Derived data element options to be associated with a
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 diagram 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 that is defined in the preceding FILE statement.
ESSENTIAL
Defines the Essential data element option to be used for the file. The value that is specified for this option must be DEFAULT, INITIAL, ONLY, or ALL as described here.
DERIVED
Defines the Derived data element option to be used for the file. The value that is specified for this option must be DEFAULT, COMP, or DISK as described here.
TYPE
Controls the activation or deactivation of files in timespans. Valid values are:
- STD
- Does not deactivate the file in any timespan
- NONESSL
- Deactivates the file in all timespans
- APPL
- Deactivates the file in the WEEKS, MONTHS, and YEARS timespans
- USER
- Synonym for APPL
BYPASS
This optional parameter is typically left blank. There are safeguards in the evaluation of the Essential option that help prevent inadvertent data loss. If you want 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 detail:
- A derived data element is a data element that is 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.
- An essential data element is a data element that is 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 that are provided with the product
- The complex level, which applies to all products in the complex
- The product level, which applies to all files in the product
- 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 Options | COMPOPT Options | FOPT Options | Generated 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 are 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).
Database Cycle Retention Statement (Cycles)
The optional Database Cycle Retention statements define the default number of cycles that are retained for a file in each respective timespan if the DBMODEL FILE statement is missing or if a value has not been coded for a timespan.
Statement Format
If the CYCLES statement is present, it MUST follow the FILE or FOPT statement in cccGENIN.
The CYCLES statement is coded with the KEYWORD starting in column 1, free-form, and continuing through column 72. Continuation is not supported. The following diagram describes the format and coding rules for the CYCLES statement.
CYCLES retx retd retw retm rety rett hretw hretm | | | | | | | | | | | | | | | | | +-- Months | | | | | | | | History | | | | | | | | | | | | | | | +-- Weekly History | | | | | | | | | | | | | +-- Tables | | | | | | | | | | | +-- Years | | | | | | | | | +-- Months | | | | | | | +-- Weeks | | | | | +-- Days | | | +-- Detail | +-- CYCLES - statement identification.
Statement Option Definitions
See the FILE statement documentation in Section 2.3.4.1.2 of the PIOM for information about coding this statement. Section 4.3.13.2 of the PIOM contains additional information about the hretw and hretm parameters.
Compression Statement (COMPRESS)
The Compression statement defines whether the file is eligible to be compressed when the compression facility is activated. It is an optional statement; if it is not present, the file is not eligible for compression.
Statement Format
If the COMPRESS statement is present, it MUST follow the CYCLES statement in cccGENIN.
The COMPRESS statement is coded with the keywords starting in column 1. Parameters are free-form and can continue through column 72. Statement continuation is not supported. The following diagram describes the format and coding rules for the COMPRESS statement.
COMPRESS x d w m y (text) | | | | | | | | | | | | | +-- Never Compress | | | | | | Designation | | | | | | | | | | | +-- Years | | | | | | | | | +-- Months | | | | | | | +-- Weeks | | | | | +-- Days | | | +-- Detail | +-- COMPRESS - statement identification
Statement Option Definitions
Valid values for the keywords are Y (yes) and N (no) for the timespan keywords. A value of Y indicates that the file's data can be compressed in that timespan and a value of N indicates that the file's data cannot be compressed in that timespan.
If the file should not be compressed, then the timespan keywords are set to N and the never compress text is present.
Do not
override this designation because files are designated as not eligible for compression for the following reasons:- Compressing the file negatively affects performance.
- The file uses options that are not compatible with compression, such as POINT.
Sample Statements
The statement
COMPRESS Y Y Y Y N
means that the data in the file's DETAIL, DAYS, WEEKS, and MONTHS timespans is eligible for compression when the compression facility is activated. Data in the YEARS timespan files are not eligible for compression.
The statement
COMPRESS N N N N N (FILE COMPRESSION NOT SUPPORTED)
means that the file is not a candidate for compression. Its data should not be compressed, and this specification should not be changed.