Local files - LOCFILE

The local files (LOCFILE) views display information about local files in active CICS systems being managed by CICSPlex SM.

Supplied views

To access from the main menu, click:

CICS operations views > File operations views > Local files

Table 1. Views in the supplied **Local files** (LOCFILE) view set
View	Notes
Local files EYUSTARTLOCFILE.CLOSE	Close a local file. You can set the Busy value to WAIT, NOWAIT or FORCE.
Local files EYUSTARTLOCFILE.DETAIL3	Detailed information about the resource signature.
Local files EYUSTARTLOCFILE.DETAILED	Detailed information about a selected local file.
Local files EYUSTARTLOCFILE.DISABLE	Disable a local file.
Local files EYUSTARTLOCFILE.DISCARD	Discard a local file.
Local files EYUSTARTLOCFILE.ENABLE	Enable a local file.
Local files EYUSTARTLOCFILE.OPEN	Open a local file.
Local files EYUSTARTLOCFILE.SET	Set attributes according to the new values specified in input fields.
Local files EYUSTARTLOCFILE.TABULAR	Tabular information about local files in CICS systems.

Actions

Table 2. Actions available for LOCFILE views
Action	Description
CLOSE	Close a local file. You can set the Busy value to WAIT, NOWAIT or FORCE.
DISABLE	Disable a local file.
DISCARD	Discard a local file.
ENABLE	Enable a local file.
OPEN	Open a local file.
SET	Set attributes according to the new values specified in input fields.

Fields

Table 3. Fields in LOCFILE views
Field	Attribute name	Description
Access method	ACCESSMETHOD	The access method used for this file: BDAM, VSAM, DB2 or REMOTE
Add option	ADD	Indicates whether new records can be added to the file Input Values: ADDABLE, NOTADDABLE Output Values: NOTAPPLIC
Number of WRITE requests	ADDCNT	The number of PUT requests issued against this local file.
BAS resource definition version	BASDEFINEVER	The BAS version number of this definition.
Base data set name	BASEDSNAME	For a file defined to CICS as a path, the name of the VSAM base data set. For a file defined as a base, this name is the same as the primary data set name.
Block format (BDAM only)	BLOCKFORMAT	Indicates whether records on the file are blocked or unblocked
Block key length (BDAM only)	BLOCKKEYLN	For BDAM files, the physical block key length as a decimal number in the range 1 - 255. A value of N/A means the file is not a BDAM file.
Block size (BDAM only)	BLOCKSIZE	For BDAM files, the length of a block in bytes. If the blocks are variable-length or are undefined, the value displayed is the maximum block size. A value of N/A means the file is not a BDAM file.
Browse option	BROWSE	Indicates whether records can be sequentially retrieved from the file. Input Values: BROWSABLE, NOTBROWSABLE
The number of READNEXT and READPREV requests	BROWSECNT	The number of READNEXT and READPREV requests issued against the file.
Number of browse for update requests	BROWUPDCNT	The number of GET NEXT, GET PREV, and PUT UPDATE requests issued against this local file.
Last modification agent	CHANGEAGENT	The change agent identifier that made the last modification. CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command. CSDBATCH - The resource was last changed by a DFHCSDUP job. DREPAPI - The resource was last changed by a CICSPlex SM BAS API command. DREPBATCH - The resource was last changed by a CICSPlex SM utility. TABLE - The resource was last changed by a CICSPlex table definition. SYSTEM - The resource was last changed by the CICS or CICSPlex SM system. CREATESPI - The resource was last changed by an EXEC CICS CREATE command. NOTAPPLIC - This is not applicable for this resource. OVERRIDE - Resource was last changed by resource overrides. N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
Last modification agent release	CHANGEAGREL	The CICS release level of the agent that made the last modification to the resource definition.
Last modification time	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 to the resource definition.
Data set type	DATASETTYPE	Indicates how the records are organized in the data set associated with the file. For VSAM files, the type is identified as one of the following: ESDS - Entry-sequenced data set KSDS - Key-sequenced data set RRDS - Relative record data set For BDAM files, the type is either KEYED or NOTKEYED. A value of NOTAPPLIC is returned if the file is not open
Source of the resource definition	DEFINESOURCE	The source of the definition, depending on which agent made the last change.
Creation time	DEFINETIME	The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
Delete option	DELETE	For VSAM files, indicates whether records can be deleted from the file. Input Values: DELETABLE, NOTDELETABLE Output Values: NOTAPPLIC
Number of I/O operations for data records	DEXCPCNT	For VSAM files, the number of I/O operations on the file for data records.
Disposition of file	DISPOSITION	The disposition of the file. Input Values: OLD, SHARE
Data set name	DSNAME	The name of the data set
Empty status	EMPTYSTATUS	For VSAM files, indicates whether the data set is to be made empty the next time a file that references it is opened (EMPTYREQ or NOEMPTYREQ). This option is valid only for data sets that have been defined as reusable and defined to be used in non-RLS mode. Input Values: EMPTYREQ, NOEMPTYREQ
Enablement status	ENABLESTATUS	Indicates whether the local file is available for access by application programs. The status will be one of the following: ENABLED - Available for access. DISABLED - Unavailable as a result of a SET DISABLED command. DISABLING - Still being accessed after a SET DISABLED or SET CLOSED command. UNENABLED - Unavailable as a result of a SET CLOSED command. UNENABLING - A request to close the file has been received, but tasks are executing that had previously accessed the file. These tasks are allowed to complete their use of the file, but new tasks are not allowed access. Input Values: ENABLED, DISABLED
BDAM exclusive control status	EXCLUSIVE	For BDAM files, indicates whether records on the file are placed under exclusive control when a read for update is issued Input Values: EXCTL, NOEXCTL, NOTAPPLIC
File ID	FILE	The name of the file.
Forward recovery option	FWDRECSTATUS	Indicates, for VSAM files, whether the file is forward-recoverable (FWDRECOVABLE or NOTFWDRCVBLE).
Number of READ requests	GETCNT	The number of GET requests issued against this local file.
Number of READ UPDATE requests	GETUPDCNT	The number of GET UPDATE requests issued against this local file.
GMT file close time	GMTFILECLS	The time at which the file was closed.
GMT file open time	GMTFILEOPN	The time at which the file was opened.
Number of I/O operations against index component	IEXCPCNT	For VSAM files, the number of I/O operations on the file for index records.
Installation agent	INSTALLAGENT	The install agent identifier that made the installation. CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command. CREATESPI - The resource was installed by an EXEC CICS CREATE command. TABLE - The resource was last installed by a CICSPlex table definition. SYSTEM - The resource was last installed by the CICS system. GRPLIST - The resource was installed by GRPLIST INSTALL. BUNDLE - The resource was installed by a bundle.
Installation time	INSTALLTIME	The local date and time when the definition was installed.
Installation user ID	INSTALLUSRID	The user ID that installed the resource definition.
Journal number	JOURNALNUM	The ID of the journal associated with this file, in the range 1 - 99. An ID of 1 identifies the CICS system log. A value of 0 means no automatic journaling is being done because JID=NO was specified in the FCT entry.
Key length	KEYLENGTH	For local files associated with a VSAM KSDS, the length of the key. For local files associated with a BDAM data set, the length of the logical key used for deblocking. A value of 0 is returned if the file is not open.
Key position	KEYPOSITION	The starting position of the key field in each record relative to the beginning of the record. A value of 0 is returned if the file is not open.
Number of DELETE requests	LOCDELCNT	The number of DELETE requests issued against this local file.
LSR Pool number	LSRPOOLID	For VSAM files, the number of the LSR pool associated with the file. A value of 0 means the file must not share buffers. A value of N/A means the file is not a VSAM file. Input Values: 0 - 255
Number of active strings	NUMACTSTRING	The current number of updates to the file.
Number of data buffers	NUMDATBUFF	The number of buffers to be used for data.
Number of index buffers	NUMINDEXBUFF	The number of buffers to be used for the index.
Current number of string waits	NUMSTRINGWT	The current number of requests that are queued because all the strings available to the file were in use
Data set type (base or path)	OBJECT	For VSAM files, indicates whether the file is related to a base data set (BASE) or is defined as a path that is accessed by means of an alternate index (PATH).
Open status	OPENSTATUS	Indicates whether the file is open, closed, or in transition. The values are: OPEN, CLOSED, OPENING, CLOSING, CLOSEREQUEST. Input Values: OPEN, CLOSED
Type of VSAM extended addressing	RBATYPE	Indicates whether, for VSAM files, the data set uses extended addressing. The values are: EXTENDED - This VSAM data set uses extended relative byte addressing and therefore can hold more than 4 gigabytes of data. NOTAPPLIC - One of the following is true: The data set is BDAM. The file is remote. The file is not open. NOTEXTENDED - This VSAM data set does not use extended relative byte addressing and therefore cannot hold more than 4 gigabytes of data.
Read option	READ	Indicates whether records can be read from the file. Input Values: READABLE, NOTREADABLE Output Values: NOTAPPLIC
Default level of read integrity	READINTEG	The default level of read integrity active for the file, if a read integrity option is not explicitly coded on an API FILE READ command. The levels are: UNCOMMITTED - There is no read integrity specified for this file. CONSISTENT - Read requests for this file are subject to consistent read integrity (unless otherwise specified on the read request). REPEATABLE - Read Requests for this file are subject to repeatable read integrity (unless otherwise specified on the read request). NOTAPPLIC - Read integrity is not applicable for this file.
Record format	RECORDFORMAT	The format of the records on the file (FIXED, VARIABLE, or UNDEFINED).
Record size	RECORDSIZE	For fixed-length records, the actual size of a record. For variable-length records, the maximum size of a record. A value of 0 is returned if the file is not open.
Recovery status	RECOVSTATUS	Indicates whether the file is recoverable (RECOVERABLE or NOTRECOVABLE).
Relative addressing type (BDAM only)	RELTYPE	For BDAM files, indicates whether relative or absolute addressing is used to access the file, and if relative, what type of relative addressing is being used in the block reference portion of the file's record identification field. The type is identified as one of the following: BLK - Relative block addressing DEC - Zoned decimal format HEX - Hexadecimal relative track and record format NOTAPPLIC - Absolute addressing is being used or the file is a VSAM file
Record level sharing (RLS) file access mode	RLSACCESS	Indicates whether a file is accessed in RLS mode. The values are: RLS - The file refers to a data set accessed in RLS mode. NOTRLS - The file refers to a data set accessed in non-RLS mode. NOTAPPLIC - The file is not eligible to be accessed in RLS mode. Input Values: RLS, NOTRLS
Record level sharing (RLS) request wait timeouts	RLSREQWTTO	The number of RLS file requests that have timed out while awaiting request completion from the VSAM RLS server.
Number of strings	STRINGS	For VSAM files, the number of concurrent operations that can be performed on the file. A value of N/A means the file is not a VSAM file. Input Values: 1 - 255
Local time file was closed	TIMECLOSE	The local time at which the file was closed.
Local time file was opened	TIMEOPEN	The local time at which the file was opened.
Update option	UPDATE	Indicates whether records in the file can be updated. Input Values: UPDATABLE, NOTUPDATABLE
Number of REWRITE requests	UPDATECNT	The number of PUT UPDATE requests issued against this local file.
Type of VSAM data set	VSAMTYPE	Indicates how the records are organized in the data set associated with this file. For VSAM files, the type is identified as one of the following: ESDS - Entry-sequenced data set KSDS - Key-sequenced data set RRDS - Relative record data set VRRDS - Variable relative record data set For BDAM files, the type is either KEYED or NOTKEYED. A value of NOTAPPLIC is returned if the file is not open.
Peak number of tasks waiting for a string	WSTRCCURCNT	The peak number of requests that were queued at any one time because all the strings available to the file were in use.
Total requests queued because all strings in use	WSTRCNT	The total number of requests that were queued because all the strings available to the file were in use.