CICSplex File Control Details attribute group

The CICSplex File Control Details attribute group retrieves information about VSAM, BDAM, and remote files. It includes the number of adds, browses, updates, and deletes for each file.

If this is a heavily used file and transactions accessing it are suffering from poor response time, select the record to obtain details for the disk device. If the total number of open DCBs suggests that contention can be a problem, or the device has a high 'Percentage busy' value, consider moving this data set to an alternate volume on a less busy channel.

Active Strings Is the current number of updates against the file.

Add Request Allowed Indicates whether a file add request allowed. Values are:

Yes
New records can be added to the file.
No
New records cannot be added to the file.

Browse Request Allowed Indicates whether a file browse request allowed. Values are:

Yes
You can browse the records in the file.
No
You cannot browse the records in the file.

CICS Region Name Indicates the job name or modify ID of the CICS region being monitored. Each CICS region in a z/OS operating system has a unique name. This name is an alphanumeric string, with a maximum of eight characters, and case-sensitive. CICS region names are always in uppercase characters.

Data set Available Indicates whether a BDAM data set or VSAM object is associated with the FILE definition. Values are: Yes or No.

Data set Name Is the 44-character name defining the physical data set to the system.

You can have specified this in:

If no data set is currently allocated to the file, this field is blank.

If the file is remote, no data set name is printed but the word " remote" is substituted for the data set name.

Delete Request Allowed Indicates whether a file delete request allowed. Values are:

Yes
You can delete the records from the file.
No
You cannot delete the records from the file.

Enable Status Indicates whether application programs can access the file. The values are:

DISABLED
The file is not available for use by transactions except for those that are currently using it. If there are any such users, 'BEING DISABLED' is also displayed. The file can be re-enabled by a SET FILE ENABLED command. It is not possible to disable a remote file.
ENABLED
The file is available for use by transactions and, if closed, it is opened on the first request.
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.

Exclusive Control Allowed Returns a value identifying whether records on this file are to be placed under exclusive control when a read for update is issued (BDAM only). Values are:

Yes
A record on this file is placed under exclusive control of the reading task when it is read for update.
No
A record on this file is not placed under exclusive control when it is read for update.

File Access Method Returns a value identifying the access method used with this data set. Values are:

BDAM
The access method is direct.
NOTAPPLIC
The data set has not been opened by the CICS region in which the command is issued.
VSAM
The access method is VSAM. Access to a data table (except while it is being loaded or, for a CICS-maintained data table, when the source data set is being updated or searched for a record that is not in the table), is through CICS data table services. Because this access is still based on VSAM keys, CICS returns VSAM as the access method for any kind of data table.
Data Table
This files represents a data table.
Remote
The file is defined as remote, and therefore the access method is not known to the local CICS system.

File Attributes Specifies whether the file is to be accessed in RLS mode. The file must be closed, and either disabled or unenabled, to change the access mode to RLS access or to non-RLS access. The non-RLS mode becomes either LSR or NSR, depending on the value specified for LSRPOOLID in the file resource definition.

File Block Size Indicates the length in bytes of a block. If the blocks are of variable length or are undefined, the value returned is the maximum.

File Disposition Indicates the value of the DISPOSITION option for the file. It is defined in the DISPOSITION option in the FILE definition. Values are OLD and SHARE.

File Format Indicates the type of data set that corresponds to this file. The data set must be open to return the type of data set. Values are:

KSDS
The data set is a key-sequenced data set or the file refers to a data table.
ESDS
The data set is an entry-sequenced data set.
RRDS
The data set is a relative record data set.
Keyed
The data set is addressed by physical keys.

File Logical Record Length Indicates the actual size of fixed-length records, or the maximum size of variable-length records.

File Name Is the name of the file.

File Record Format Is the format of the records on the file. Values are:

FB
The records are of fixed length.
U
The format of records on the file is undefined. The Undefined value is possible for BDAM data sets only.
VB
The records are of variable length. If the file is associated with a user-maintained data table, the record format is always variable length, even if the source data set contains fixed-length records.

File Relative Key Position Indicates the starting position of the key field in each record relative to the beginning of the record. The start is made at position 0. If there is no key, or if the file is not open, CICS returns a value of zero for the key position.

Key Request Allowed Indicates whether a file key request allowed. Values are:

Yes
A file key request is allowed.
No
A file key request is not allowed.

Local File Key Length Indicates the length of the record key for a file associated with a VSAM KSDS or a file associated with a coupling facility data table. If the file is associated with a BDAM data set, the value is the length of the logical key used for deblocking.

If the file is closed and the key length is not defined in the file definition, the value returned is 0 (zero).

If the file is closed and a key length is defined on the file definition, CICS returns the value from the file definition.

If the file is open, most files get their key length from the associated data set, in which case CICS returns the value from the data set. However, files that refer to coupling facility data tables defined with LOAD(NO) must get their keylength from the file definition, in which case CICS returns the value from the file definitions for such files. This value must also match that of the coupling facility data table if it has already been created.

Number of Data Buffers Is the number of buffers to be used for data. For RLS, BUFND is ignored and the value specified in the ACB is returned. This parameter has no effect for hierarchical file systems (HFS) files.

Number of Index Buffers Is the number of buffers to be used for index. For RLS, BUFNI is ignored and the value specified in the ACB is returned. This parameter has no effect for hierarchical file systems (HFS) files.

Number of Strings Is the maximum permissible number of concurrent updates. For RLS, the value specified in the ACB macro is ignored. After OPEN a value of 1024 is returned, indicating the maximum number of strings allowed.

Open Status Indicates whether the file is open, closed, or in a transitional state.

Close
The file is closed.
Close in progress
The file is in the process of being closed. Closing a file can require dynamic deallocation of data sets and deletion of shared resources, in which case close processing can last a significant length of time.
Notapplic
The OPENSTATUS value does not apply to this type of file. For example, it does not apply to a remote file.
Open
The file is open.
Open in progress
The file is in the process of being opened.

Origin Node The combination of z/OS System ID (SMFID) and CICS region name. The value format is an alphanumeric string, maximum 32 bytes, and case-sensitive.

When a situation is true, the system compares the origin node name in the attribute to the names of managed systems assigned to the item. If the origin node name matches the name of a managed system, the status of the item changes accordingly. If the names of the origin node and the managed systems do not match, the status of the item remains unchanged.

Read Request Allowed Indicates whether a file read request allowed. Values are:

Yes
You can read the records in this file.
No
You cannot read the records in this file.

Read Update Request Allowed Indicates whether a file read or update request allowed. Values are:

Yes
You can read or update the records in this file.
No
You cannot read or update the records in this file.

Remote File Key Length Indicates the length of the record key for a remote file associated with a VSAM KSDS or a file associated with a coupling facility data table. For more details, see Local File Key length.

Remote File Name Is the name by which the file is known in the CICS region named in the REMOTESYSTEM option of its FILE definition. Blanks are returned if the file is not remote.

Remote File Record Length Is the record length of the remote file.

Remote System Name Is the name of the CICS region in which the file is defined (from the REMOTESYSTEM value in the FILE definition). Blanks are returned if the file is not remote.

Resource Security Level Indicates whether the file is defined to be opened in RLS mode. Values are:

n/a
The file is not eligible to be accessed in RLS mode because either it is a remote file, or it refers to a BDAM data set.
Public
The file refers to a data set defined to be accessed in non-RLS mode.
RLS
The file refers to a data set defined to be accessed in RLS mode.

System ID Indicates the 4-character name that uniquely identifies an active z/OS operating system within a given CICSplex. The value format is an alphanumeric string, maximum 4 characters, and case-sensitive. z/OS System IDs are always in uppercase characters.

Time File Opened Is the time of day file opened.

Update Request Allowed Indicates whether a file update request allowed. Values are:

Yes
You can update the records in this file.
No
You cannot update the records in this file.