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:

Administration views > CICS resource definitions > File definitions

Table 1. Views in the supplied File definitions (FILEDEF) view set
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

Table 2. Actions available for FILEDEF views
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

Table 3. Fields in FILEDEF views
Field Attribute name Description
File access method ACCESSMETH Identifies the access method for this file (CICS for OS/2 only). Values are:
  • ESDS
  • KSDS
  • RRDS
  • KEYED
  • BDAM
  • VSAM
  • NOTAPPLIC
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:
  • DYNAMIC - Specify this along with the RECOVERY attribute of ALL to make the file eligible for backup while open for update.
  • STATIC - The file is not eligible for backup while open for update.
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.
  • DREPAPI - Resource was last changed by a CICSPlex SM API command.
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:
  • OLD - Equivalent to the DISP=OLD parameter in JCL.
  • SHARE - Equivalent to the DISP=SHR parameter in JCL.
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:
  • ALLREQS - Data set name sharing is set in the ACB when the file is opened and is therefore used for all file requests.
  • MODIFYREQS - Data set name sharing is set in the ACB when the file is opened only if an operation of DELETE, ADD, or UPDATE is set for the file.
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:
  • O
  • R
  • U
File enabled status FILENABLED Identifies whether transactions can access the file (CICS for OS/2 only). The values are:
  • Y - Enabled - The file is available for use by transactions and, if closed, it is opened on the first request.
  • U - Unenabled - The file is not available for use by transactions except for those that are currently using it. If there are any such users, 'BEING CLOSED' is also displayed. This status is the same as DISABLED except that it occurs implicitly when a SET FILE CLOSE is requested. The file is enabled implicitly by a SET FILE OPEN command.
  • N - Disabled - The file is not available for use by transactions except for those that are currently using it.
File open status FILEOPEN The open status of the file (CICS for OS/2 only). The values are:
  • Y - The file is open.
  • N - The file is closed.
Data set type FILETYPE The data set type (CICS for OS/2 only). Values are:
  • A
  • E - Standard ESDS
  • K - KSDS
  • R - RRDS
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.
  • NO - Forward recovery logging is not required for this file.
  • journal - The number that identifies the journal that CICS is to use for the forward recovery log. CICS journal names are of the form DFHJnn where nn is in the range 1 through 99. The after images for forward recovery are written to the MVS log stream that corresponds to journal name DFHJnn.
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:
  • AFTER - Journal the file control write operation after the VSAM I/O operation.
  • ALL - Journal the file control write operation both before and after the VSAM I/O operation has completed.
  • BEFORE - Journal the file control write operation before the VSAM I/O operation.
  • NONE - Do not journal add operations.
Read operations recorded on journal JNLREAD The read operations you want recorded on the journal nominated by the JOURNAL attribute. Possible values are:
  • ALL - Journal all read operations.
  • NONE - Do not journal read operations.
  • READONLY - Journal only READ ONLY operations (not READ UPDATE operations).
  • UPDATEONLY - Journal only READ UPDATE operations (not READ ONLY operations).
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:
  • NO - No automatic journaling is to take place for this file.
  • number - The number that identifies the journal that CICS is to use for the autojournal. CICS journal names are of the form DFHJnn, where nn is in the range 1 through 99.
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:
  • Load - The coupling facility data table is, or is to be, preloaded from a source data set.
  • Noload - The coupling facility data table is not preloaded from a source data set.
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:
  • NONE - Specifies that the data set associated with this file uses VSAM nonshared resources (NSR).
  • number - The value, in the range 1 through 255, identifies the number of the VSAM shared resource pool that is used by the VSAM data set associated with this file. The data set is defined as using VSAM local shared resources (LSR). You are recommended to define the buffers, strings, and other resources explicitly in an LSRPOOL resource definition that corresponds to this LSR Pool number.
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
  • FIRSTREF - The file remains closed until a request is made to open it by: a master terminal command, an EXEC CICS SET FILE OPEN command in an application program, or an implicit open.
  • STARTUP - The file is opened immediately after CICS initialization by an automatically initiated CICS transaction (CSFU), unless the status of the file is UNENABLED, in which case the file is left closed.
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):
  • CONSISTENT - The record is read with consistent read integrity. CONSISTENT is valid only if you also specify RLSACCESS(YES)-the resource definition is rejected with an error if you specify CONSISTENT for a non-RLS file.
  • REPEATABLE - The record is read with repeatable read integrity.
  • UNCOMMITTED - The record is read without read integrity. UNCOMMITTED is the same level of integrity that is provided by those releases of CICS that do not support the READINTEG attribute.
Record format RECORDFORMAT The format of the records on the file:
  • Fixed - The records are fixed length.
  • Variable - The records are variable length.
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:
  • ALL - Before images are recorded in the system log, and after images in the journal specified in the FWDRECOVLOG attribute.
  • BACKOUTONLY - Before images are recorded in the system log.
  • NONE - There is no recovery logging for this 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:
  • NO - The file is not to be opened in RLS mode.
  • YES - The file is to be opened 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:
  • DISABLED - Any request against this file from a command-level application program causes the DISABLED condition to be passed to the program.
  • ENABLED - Normal processing is allowed against this file.
  • UNENABLED - This prevents the file being opened by an implicit open from an application program. Any such attempt to access the file raises the NOTOPEN condition. By contrast, an explicit request to open the file (for example, a CEMT or EXEC CICS SET FILE OPEN command) changes the status to ENABLED before attempting to open the file.
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:
  • NO - The file does not represent a data table.
  • CICS - The file represents a CICS-maintained data table.
  • USER - The file represents a user-maintained data table.
  • CF - The file represents a coupling facility data table.
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:
  • LOCKING - specifies that the CFDT is updated using the locking model.
  • CONTENTION - specifies that the CFDT is updated using the contention model.
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.


eyua7cpy.html | Timestamp icon Last updated: Sunday, 4 June 2017