LOCFILE Resource Table

A CICS® Resource that describes a local file in an active CICS system being managed by CICSPlex® SM.

The Primary key field for this resource class is FILE.

The following actions are supported:
CLOSE
Close a local file.
The parameter data for the CLOSE action is:
   PARM('BUSY(cvda).')
where cvda is required and is one of the following valid CVDA values for the file busy condition:
  • WAIT
  • NOWAIT
  • FORCE
DISABLE
Disable a local file.
The parameter data for the DISABLE action is:
   PARM('BUSY(cvda).')
where cvda is required and is one of the following valid CVDA values for the file busy condition:
  • WAIT
  • NOWAIT
  • FORCE
DISCARD
Discard a local file.
ENABLE
Enable a local file.
OPEN
Open a local file.

External resource name
CICSLocalFile
Length
368
Usage
API or WUI or CICS Management Client Interface or EVALDEF
API view
Yes
CMAS context
No
SCOPE applies
Yes
Only query CMASs in workload
No
Object type
CICS Resource
Copybook identifier
EYUt0009
Table 1. Valid CPSM operations
Operations Actions Parameters Required
GET   None N/A
SET   None N/A
PERFORM SET CLOSE BUSY(WAIT, NOWAIT, FORCE) Yes
  DISABLE BUSY(WAIT, NOWAIT, FORCE) Yes
  DISCARD None N/A
  ENABLE None N/A
  OPEN None N/A
Table 2. LOCFILE resource table attributes
Name Datatype Source Len Sum Set Description Default Get Invalid Attr ID
EYU_CICSNAME CHAR CPSM 8 DIF No CICS System Name      
EYU_CICSREL CHAR CPSM 4 DIF No CICS Release    
EYU_RESERVED CHAR CPSM 4 N/A No Reserved    
ACCESSMETHOD CVDAS INQ 4 LIKE No Access method     2
ACCESSMETHOD Output valid values VSAM, BDAM, DB2
ADD CVDAS INQ 4 LIKE Yes Add option     3
ADD Input/output valid values ADDABLE, NOTADDABLE
ADDCNT BINARY STAT 4 AVG No Number of WRITE requests     33
BASDEFINEVER BINARY CPSM 1 AVG Yes BAS resource definition version 0 E640 E650 64
BASEDSNAME CHAR INQ 44 DIFF No Base data set name     4
BLOCKFORMAT CVDAS INQ 4 LIKE No Block format (BDAM only)     5
BLOCKFORMAT Output valid values BLOCKED, UNBLOCKED
BLOCKKEYLN CNUMERIC INQ 4 MAX No Block key length (BDAM only)     6
BLOCKSIZE CNUMERIC INQ 4 MAX No Block size (BDAM only)     7
BROWSE CVDAS INQ 4 LIKE Yes Browse option     8
BROWSE Input/output valid values BROWSABLE, NOTBROWSABLE
BROWSECNT BINARY STAT 4 AVG No The number of READNEXT and READPREV requests     32
BROWUPDCNT BINARY STAT 4 AVG No Number of browse for update requests     50
CHANGEAGENT CVDAS INQ 4 LIKE No Last modification agent   E640 E650 56
CHANGEAGENT Input/output valid values CSDAPI, CSDBATCH, DREPAPI, DREPBATCH, TABLE, SYSTEM, CREATESPI, NOTAPPLIC
CHANGEAGREL CHAR INQ 4 DIFF No Last modification agent release   E640 E650 57
CHANGETIME DATETIME INQ 8 MAX No Last modification time   E640 E650 58
CHANGEUSRID CHAR INQ 8 DIFF No Last modification user ID   E640 E650 55
DATASETTYPE CHAR STAT 1 DIFF No Data set type     48
DEFINESOURCE CHAR INQ 8 DIFF No Source of the resource definition   E640 E650 59
DEFINETIME DATETIME INQ 8 MAX No Creation time   E640 E650 60
DELETE CVDAS INQ 4 LIKE Yes Delete option     9
DELETE Input/output valid values DELETABLE, NOTDELETABLE
DEXCPCNT BINARY STAT 4 AVG No Number of I/O operations for data records     36
DISPOSITION CVDAS INQ 4 LIKE Yes Disposition of file     10
DISPOSITION Input/output valid values OLD, SHARE
DSNAME CHAR INQ 44 DIFF Yes Data set name     11
EMPTYSTATUS CVDAS INQ 4 LIKE Yes Empty status     12
EMPTYSTATUS Input/output valid values EMPTYREQ, NOEMPTYREQ
ENABLESTATUS CVDAS INQ 4 LIKE Yes Enablement status     13
ENABLESTATUS Input/output valid values ENABLED, DISABLED
ENABLESTATUS Output valid values DISABLING, UNENABLED, UNENABLING
EXCLUSIVE CVDAS INQ 4 LIKE Yes BDAM exclusive control status     14
EXCLUSIVE Input/output valid values EXCTL, NOEXCTL, NOTAPPLIC
 FILE-1  CHAR INQ 8 DIFF Yes File ID     1
FWDRECSTATUS CVDAS INQ 4 LIKE No Forward recovery option     15
FWDRECSTATUS Output valid values FWDRECOVABLE, NOTFWDRCVBLE
GETCNT BINARY STAT 4 AVG No Number of READ requests     30
GETUPDCNT BINARY STAT 4 AVG No Number of READ UPDATE requests     31
GMTFILECLS TIMESTP STAT 8 MAX No GMT file close time     46
GMTFILEOPN TIMESTP STAT 8 MAX No GMT file open time     45
IEXCPCNT BINARY STAT 4 AVG No Number of I/O operations against index component     37
INSTALLAGENT CVDAS INQ 4 LIKE No Installation agent   E640 E650 63
INSTALLAGENT Input/output valid values CSDAPI, CREATESPI, TABLE, SYSTEM, GRPLIST
INSTALLTIME DATETIME INQ 8 MAX No Installation time   E640 E650 62
INSTALLUSRID CHAR INQ 8 DIFF No Installation user ID   E640 E650 61
JOURNALNUM BINARY INQ 2 AVG No Journal number     39
KEYLENGTH BINARY INQ 4 AVG No Key length     16
KEYPOSITION BINARY INQ 4 AVG No Key position     17
LOCDELCNT BINARY STAT 4 AVG No Number of DELETE requests     35
LSRPOOLID BINARY INQ 2 MAX Yes LSR Pool number     41
NUMACTSTRING BINARY STAT 2 AVG No Number of active strings     44
NUMDATBUFF BINARY STAT 2 AVG No Number of data buffers     42
NUMINDEXBUFF BINARY STAT 2 AVG No Number of index buffers     43
NUMSTRINGWT BINARY STAT 2 AVG No Current number of string waits     47
OBJECT CVDAS INQ 4 LIKE No Data set type (base or path)     18
OBJECT Output valid values BASE, PATH
OPENSTATUS CVDAS INQ 4 LIKE Yes Open status     19
OPENSTATUS Input/output valid values OPEN, CLOSED
OPENSTATUS Output valid values OPENING, CLOSING, CLOSEREQUEST
RBATYPE CVDAS INQ 4 LIKE No Type of VSAM extended addressing   E640 54
RBATYPE Output valid values EXTENDED, NOTEXTENDED, NOTAPPLIC
READ CVDAS INQ 4 LIKE Yes Read option     20
READ Input/output valid values READABLE, NOTREADABLE
READINTEG CVDAS INQ 4 LIKE Yes Default level of read integrity     51
READINTEG Input/output valid values UNCOMMITTED, CONSISTENT, REPEATABLE
READINTEG Output valid values NOTAPPLIC
RECORDFORMAT CVDAS INQ 4 LIKE No Record format     21
RECORDFORMAT Output valid values FIXED, VARIABLE, UNDEFINED
RECORDSIZE BINARY INQ 4 AVG No Record size     22
RECOVSTATUS CVDAS INQ 4 LIKE No Recovery status     23
RECOVSTATUS Output valid values RECOVERABLE, NOTRECOVABLE
RELTYPE CVDAS INQ 4 LIKE No Relative addressing type (BDAM only)     24
RELTYPE Output valid values HEX, DEC, BLK, NOTAPPLIC
RLSACCESS CVDAS INQ 4 LIKE Yes Record level sharing (RLS) file access mode     52
RLSACCESS Input/output valid values RLS, NOTRLS
RLSACCESS Output valid values NOTAPPLIC
RLSREQWTTO BINARY STAT 4 AVG No Record level sharing (RLS) request wait timeouts     53
STRINGS CNUMERIC INQ 4 MAX Yes Number of strings     25
TIMECLOSE DECTSTP STAT 4 MAX No Local time file was closed     29
TIMEOPEN DECTSTP STAT 4 MAX No Local time file was opened     28
UPDATE CVDAS INQ 4 LIKE Yes Update option     27
UPDATE Input/output valid values UPDATABLE, NOTUPDATABLE
UPDATECNT BINARY STAT 4 AVG No Number of REWRITE requests     34
VSAMTYPE CVDAS INQ 4 LIKE No Type of VSAM data set     26
VSAMTYPE Input/output valid values NOTAPPLIC
VSAMTYPE Output valid values ESDS, KSDS, RRDS, VRRDS
WSTRCCURCNT BINARY STAT 2 AVG No Peak number of tasks waiting for a string     40
WSTRCNT BINARY STAT 4 AVG No Total requests queued because all strings in use     38


LOCFILEtab.html | Timestamp icon Last updated: Thursday, 27 June 2019