File definitions - FILEDEF
The File definition (FILEDEF) views display information about the physical and operational characteristics of file definitions.
Supplied views
To access from the main menu, click:
| View | Notes |
|---|---|
| File definitions EYUSTARTFILEDEF.ADDTOGRP |
Add one or more File definitions to a resource group. |
| File definitions EYUSTARTFILEDEF.CREATE |
Create a file definition and add it to the data repository. |
| File definitions EYUSTARTFILEDEF.DETAILED |
Detailed information about a selected File definition. |
| File definitions EYUSTARTFILEDEF.INSTALL |
Install a File definition in an active system. |
| File definitions EYUSTARTFILEDEF.REMOVE |
Remove a File definition from the data repository. |
| File definitions EYUSTARTFILEDEF.TABULAR |
Tabular information about all File definitions for the current context. |
Actions
| Action | Description |
|---|---|
| ADDTOGRP | Add one or more File definitions to a resource group. |
| CREATE | Create a file definition and add it to the data repository. |
| CSDCOPY | Copy a CICS CSD resource definition. |
| CSDINSTALL | Install a CICS CSD resource definition into an active system. |
| INSTALL | Install a File definition in an active system. |
| REMOVE | Remove a File definition from the data repository. |
| UPDATE | Update a File definition in the data repository. |
Fields
| Field | Attribute name | Description |
|---|---|---|
| File access method | ACCESSMETH | Identifies the access method for this file (CICS for OS/2 only). Values are:
|
| Add option | ADD | Specifies whether records can be added to the file. |
| CICS VSAM file backup type | BACKUPTYPE | CICS VSAM files can be defined as eligible for backup while open for update. Possible values are:
|
| Base data set name | BASENAME | The 44-character name of the base cluster associated with a VSAM path, if the object associated with the file is a path. If the object is other than a path, this option returns the same value as the DSNAME option. (CICS for OS/2 only) |
| Browse option | BROWSE | Specifies whether records can be retrieved sequentially from the file. |
| VSAM catalog name | CATNAME | The name of the VSAM catalog. |
| Last modification agent | CHANGEAGENT | The change agent identifier that made the last modification.
|
| Last modification agent release | CHANGEAGREL | The CICS release level of the agent that made the last modification. |
| Last modification | CHANGETIME | The local date and time when the definition was last changed. |
| Last modification user ID | CHANGEUSRID | The user ID that made the last modification. |
| Control interval size | CNTLINTRVAL | The last value encountered for the size of the control interval, expressed in bytes. (CICS for OS/2 only) |
| Time created | CREATETIME | The local date and time when the definition was created. |
| CSD group | CSDGROUP | The name of the CSD group for this CICS resource definition. This field is ignored for BAS definitions. |
| Number of data buffers | DATABUFFERS | The number of buffers to be used for data. Use a value in the range 2 (the default) through 32767. The minimum value you may specify is one more than the number of strings defined in the STRINGS attribute. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one. |
| Version | DEFVER | The version number of the BAS resource definition, from 1 to 15. This field is ignored for CICS CSD resource definitions. |
| Delete option | DELETE | Specifies whether records can be deleted from the file. |
| Description code page | DESCCODEPAGE | The code page of the description field. This field is ignored for CICS CSD resource definitions. |
| Description | DESCRIPTION | A description of the file definition. |
| Disposition of file | DISPOSITION | The disposition of this file:
|
| Data set name | DSNAME | The data set name (as known to the operating system) to be used for this file. DSNAME can be 1 through 44 characters, conforming to the rules for MVS data set names. |
| VSAM data set name sharing | DSNSHARING | Specifies whether VSAM data set name sharing is used for the VSAM file. The possible values are:
|
| Use external file manager | EXTFILEMGR | Specifies whether to use an external file manager. (CICS for OS/2 only) |
| Access method | FILEACCESS | The access method for this file (CICS for OS/2 only). The values are:
|
| File enabled status | FILENABLED | Identifies whether transactions can access the file (CICS for OS/2 only). The values are:
|
| File open status | FILEOPEN | The open status of the file (CICS for OS/2 only). The values are:
|
| Data set type | FILETYPE | The data set type (CICS for OS/2 only). Values are:
|
| File segment definition name | FSEGDEFNAME | The 1- to 8-character name for the file key segment definition (CICS for OS/2 only) |
| File segment definition version | FSEGDEFVER | Optional.) An integer in the range 1 through 15. Specify 0 or leave blank for CICSPlex SM to assign the first available version ID in the range 1 through 15. (CICS for OS/2 only) |
| Journal number used for forward recovery | FWDRECOVLOG | The journal that corresponds to the MVS system logger log stream that is to be used for forward recovery. This
attribute is ignored for coupling facility data tables and, if there are any recovery attributes defined in the ICF catalog
for a source data set associated with the table, these also are ignored. A CFDT is not forward recoverable.
|
| Number of index buffers | INDEXBUFFERS | The number of buffers to be used for the index. Use a value in the range 1 through 32767. The minimum value you may specify is the number of strings defined in the STRINGS attribute. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one. |
| Add operations recorded on journal | JNLADD | The add operations you want recorded on the journal nominated by the JOURNAL attribute. Possible values are:
|
| Read operations recorded on journal | JNLREAD | The read operations you want recorded on the journal nominated by the JOURNAL attribute. Possible values are:
|
| Synchronous auto journaling for input | JNLSYNCREAD | Specifies whether you want the automatic journaling records, written for READ operations to the journal specified by JOURNAL, to be written synchronously or asynchronously. |
| Synchronous auto journaling for output | JNLSYNCWRITE | Specifies whether you want the automatic journaling records, written for WRITE operations to the journal specified by JOURNAL, to be written synchronously or asynchronously. |
| Rewrite/delete operations recorded on journal | JNLUPDATE | Specifies whether you want REWRITE and DELETE operations recorded on the journal nominated by the JOURNAL attribute. |
| Journal number | JOURNAL | Specifies whether you want automatic journaling for this file. The journaled data is in the format of the VSAM record
and is used for user controlled journaling. The data to be journaled is identified by the JNLADD, JNLREAD, JNLSYNCREAD, JNLSYNCWRITE,
and JNLUPDATE attributes. Possible values are:
|
| Key length | KEYLENGTH | The length in bytes of the logical key of records in remote files, and in coupling facility data tables that are specified with LOAD(NO). If KEYLENGTH is not defined here, the KEYLENGTH option must be specified on file control commands in the application programs that refer to this file. If KEYLENGTH is not defined here and not specified in the application program, and the key is longer than 4 characters, the default value is 4. |
| Key number | KEYNUMBER | The number, as a halfword binary value, of the index to be used to locate the record. (CICS for OS/2 only) |
| Load type | LOADTYPE | The load type for a coupling facility data table. The values are:
|
| Automatic logging | LOG | Specifies whether you want automatic logging for this file. |
| LSR Pool number | LSRPOOLID | The identity of the local shared resource pool. The default value for LSR Pool number is 1, unless a value
has been specified for the NSRGROUP attribute, in which case the default value for LSR Pool number is NONE. Options
are:
|
| Maximum number of records in data table | MAXNUMRECS | For CICS and USER tables, the maximum number of entries in the data table, in the range 1 through 99999999. If NOLIMIT is specified the number of entries is unlimited. NOLIMIT is the default value. |
| Maximum record length | MAXRECORDLEN | The maximum length, in bytes, of records in the file. Input Values: 1 - 32767 |
| Minimum record length | MINRECORDLEN | The minimum length, in bytes, of records in the file. Input Values: 1 - 4090 (CICS for OS/2 only) |
| Name | NAME | The name of the file definition. |
| Non-shared resources (NSR) group name | NSRGROUP | For files referencing data sets that use VSAM non-shared resources (NSR), a 1- to 8-character symbolic name to group together file definitions that refer to the same VSAM base data set. |
| File open time | OPENTIME | Specifies when the file is opened. Possible values are
|
| User access password | PASSWORD | The 1-to 8-character password that is used to verify user access to the file. This attribute is obsolete from CICS Transaction Server 5.3 onwards. |
| Coupling facility data table (CFDT) pool name | POOLNAME | The name of the coupling facility data table pool in which the coupling facility data table resides. |
| Read option | READ | Specifies whether records on this file can be read. |
| Default level of read integrity | READINTEG | The level of read integrity required for files defined with RLSACCESS(YES):
|
| Record format | RECORDFORMAT | The format of the records on the file:
|
| Record size | RECORDSIZE | The maximum length in bytes of records in a remote file . The size specified can be in the range 1 through 32767. |
| Type of recovery | RECOVERY | The type of recovery required for the file:
|
| Remote file name | REMOTENAME | (Optional.) Specifies, if the file resides on a remote system, the name by which this file is known in the system or region in which it is resident. The name can be up to eight characters in length. |
| Remote system name | REMOTESYSTEM | (Optional.) Specifies, if the file resides on a remote system, the name of the connection that links the target (local) system to the related (remote) system where the file resides. If this attribute is not supplied, this is derived directly from the CICS system ID of the related system. The connection that links the target system to the related system must have the same name as the CICS system ID of the related system. |
| Relative key position | RKP | The starting position of the key field in the record relative to the beginning of the record. With variable-length records, this operand must include space for the 4-byte LLbb field at the beginning of each logical record. This must always be coded for data sets that have keys within each logical record, or when browsing. |
| Record level sharing (RLS) file access mode | RLSACCESS | Specifies whether CICS is to open the file in RLS mode:
|
| Resource security value | RSL | This attribute is obsolete, but is supported to provide compatibility with earlier releases of CICS. |
| VSAM share access | SHR4ACCESS | (CICS/VSE only) VSAM share access. |
| Initial status | STATUS | The initial status of the file following a CICS initialization with START=COLD or START=INITIAL. Options are:
|
| Maximum concurrent requests against file | STRINGS | The number, in the range 1 through 255, of concurrent requests that can be processed against the file. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one. |
| Data table type | TABLE | Indicates whether a file represents a data table: Values are:
|
| Table name | TABLENAME | The 8-character table name specified for the coupling facility data table on the file resource definition or the file name if the table name is omitted from the file resource definition. This is blank if the file does not refer to a coupling facility data table. |
| Update option | UPDATE | Specifies whether records on this file can be updated. |
| Update model | UPDATEMODEL | The type of update model to be used for a coupling facility data table:
|
| User data area 1 | USERDATA1 | Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions. |
| User data area 2 | USERDATA2 | Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions. |
| User data area 3 | USERDATA3 | Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions. |