LOCFILE Resource Table

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

The First key field for this resource 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 = (Required) Valid CVDA values for the file busy condition WAIT, NOWAIT or FORCE.
DISABLE
Disable a local file.
The parameter data for the DISABLE action is: 
   PARM('BUSY(cvda).')

     where:
     
     cvda = (Required) Valid CVDA values for the file busy condition WAIT, NOWAIT or FORCE.
DISCARD
Discard a local file.
ENABLE
Enable a local file.
OPEN
Open a local file.

External resource name(CMCI)
CICSLocalFile
Object type
CICS Resource
Length
368
Usage
API, WUI, CICS Management Client Interface(CMCI), EVALDEF
API view
Yes
CMAS context
No
SCOPE applies
Yes
Only query CMASs in workload
No
Copybook identifier
EYUt0009
Security Class
OPERATE.FILE
CICS Commands subject to CICS Security
EXTRACT STATISTICS
INQUIRE FILE
Unsupported CICS Releases
None
Table 1. Valid CPSM operations
Operations Actions Parameters Required
GET   None N/A
SET   None N/A
PERFORM SET, PERFORM OBJECT 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 CICS Source CICS Field Len Sum Set Description Default Value Range GraphQL Field
EYU_CICSNAME CHAR CPSM     8 DIFF No CICS System Name     regionName
EYU_CICSREL CHAR CPSM     4 DIFF No CICS Release     CICSRelease
EYU_RESERVED CHAR CPSM     4 N/A No Reserved      
 FILE-1  CHAR INQ     8 DIFF No File ID     name
ACCESSMETHOD CVDAS INQ FILE ACCESSMETHOD 4 LIKE No Access method     accessMethod
ACCESSMETHOD Output valid values
  • VSAM
  • BDAM
  • DB2
  • REMOTE
ADD CVDAS INQ FILE ADD 4 LIKE Yes Add option     add
ADD Input/output valid values
  • ADDABLE
  • NOTADDABLE
ADD Output valid values
  • NOTAPPLIC
ADDCNT BINARY STAT DFHA17DS A17DSWRA 4 AVG No Number of WRITE requests     addCount
BASDEFINEVER BINARY CPSM   Calculated 1 AVG No BAS resource definition version 0   basdefinever
BASEDSNAME CHAR INQ FILE BASEDSNAME 44 DIFF No Base data set name     baseDSName
BLOCKFORMAT CVDAS INQ FILE BLOCKFORMAT 4 LIKE No Block format (BDAM only)     blockFormat
BLOCKFORMAT Output valid values
  • BLOCKED
  • UNBLOCKED
  • NOTAPPLIC
BLOCKKEYLN CNUMERIC INQ FILE BLOCKKEYLEN 4 MAX No Block key length (BDAM only)     blockKeyLength
BLOCKSIZE CNUMERIC INQ FILE BLOCKSIZE 4 MAX No Block size (BDAM only)     blockSize
BROWSE CVDAS INQ FILE BROWSE 4 LIKE Yes Browse option     browse
BROWSE Input/output valid values
  • BROWSABLE
  • NOTBROWSABLE
BROWSE Output valid values
  • NOTAPPLIC
BROWSECNT BINARY STAT DFHA17DS A17DSBR 4 AVG No The number of READNEXT and READPREV requests     browseCount
BROWUPDCNT BINARY STAT DFHA17DS A17DSBRU 4 AVG No Number of browse for update requests     browseUpdateCount
CHANGEAGENT CVDAS INQ FILE CHANGEAGENT 4 LIKE No Last modification agent     changeAgent
CHANGEAGENT Input/output valid values
  • CSDAPI
  • CSDBATCH
  • DREPAPI
  • OVERRIDE
  • DREPBATCH
  • TABLE
  • SYSTEM
  • CREATESPI
  • NOTAPPLIC
  • N_A
CHANGEAGREL CHAR INQ FILE CHANGEAGREL 4 DIFF No Last modification agent release     changeAgentRelease
CHANGETIME DATETIME INQ FILE CHANGETIME 8 MAX No Last modification time     changeTime
CHANGEUSRID CHAR INQ FILE CHANGEUSRID 8 DIFF No Last modification user ID     changeUserID
DATASETTYPE CHAR STAT DFHA17DS A17DSTYP 1 DIFF No Data set type     DSRecordType
DEFINESOURCE CHAR INQ FILE DEFINESOURCE 8 DIFF No Source of the resource definition     defineSource
DEFINETIME DATETIME INQ FILE DEFINETIME 8 MAX No Creation time     defineTime
DELETE CVDAS INQ FILE DELETE 4 LIKE Yes Delete option     delete
DELETE Input/output valid values
  • DELETABLE
  • NOTDELETABLE
DELETE Output valid values
  • NOTAPPLIC
DEXCPCNT BINARY STAT DFHA17DS A17DSXCP 4 AVG No Number of I/O operations for data records     dataOperationCount
DISPOSITION CVDAS INQ FILE DISPOSITION 4 LIKE Yes Disposition of file     disposition
DISPOSITION Input/output valid values
  • OLD
  • SHARE
DISPOSITION Output valid values
  • NOTAPPLIC
DSNAME CHAR INQ FILE DSNAME 44 DIFF Yes Data set name     DSName
EMPTYSTATUS CVDAS INQ FILE EMPTYSTATUS 4 LIKE Yes Empty status     emptyStatus
EMPTYSTATUS Input/output valid values
  • EMPTYREQ
  • NOEMPTYREQ
EMPTYSTATUS Output valid values
  • NOTAPPLIC
ENABLESTATUS CVDAS INQ FILE ENABLESTATUS 4 LIKE Yes Enablement status     status
ENABLESTATUS Input/output valid values
  • ENABLED
  • DISABLED
ENABLESTATUS Output valid values
  • DISABLING
  • UNENABLED
  • UNENABLING
  • NOTAPPLIC
EXCLUSIVE CVDAS INQ FILE EXCLUSIVE 4 LIKE Yes BDAM exclusive control status     exclusive
EXCLUSIVE Input/output valid values
  • EXCTL
  • NOEXCTL
  • NOTAPPLIC
FWDRECSTATUS CVDAS INQ FILE FWDRECSTATUS 4 LIKE No Forward recovery option     forwardRecoveryStatus
FWDRECSTATUS Output valid values
  • FWDRECOVABLE
  • NOTFWDRCVBLE
  • NOTAPPLIC
GETCNT BINARY STAT DFHA17DS A17DSRD 4 AVG No Number of READ requests     readCount
GETUPDCNT BINARY STAT DFHA17DS A17DSGU 4 AVG No Number of READ UPDATE requests     readUpdateCount
GMTFILECLS TIMESTP STAT DFHA17DS A17GCLST 8 MAX No GMT file close time     GMTCloseTime
GMTFILEOPN TIMESTP STAT DFHA17DS A17GOPNT 8 MAX No GMT file open time     GMTOpenTime
IEXCPCNT BINARY STAT DFHA17DS A17DSIXP 4 AVG No Number of I/O operations against index component     indexOperationCount
INSTALLAGENT CVDAS INQ FILE INSTALLAGENT 4 LIKE No Installation agent     installAgent
INSTALLAGENT Input/output valid values
  • CSDAPI
  • CREATESPI
  • TABLE
  • SYSTEM
  • GRPLIST
  • BUNDLE
INSTALLTIME DATETIME INQ FILE INSTALLTIME 8 MAX No Installation time     installTime
INSTALLUSRID CHAR INQ FILE INSTALLUSRID 8 DIFF No Installation user ID     installUserID
JOURNALNUM BINARY INQ FILE JOURNALNUM 2 AVG No Journal number     journalID
KEYLENGTH BINARY INQ FILE KEYLENGTH 4 AVG No Key length     keyLength
KEYPOSITION BINARY INQ FILE KEYPOSITION 4 AVG No Key position     keyPosition
LOCDELCNT BINARY STAT DFHA17DS A17DSDEL 4 AVG No Number of DELETE requests     localDeleteCount
LSRPOOLID CNUMERIC INQ FILE LSRPOOLNUM 2 MAX Yes LSR Pool number   0-255 LSRPoolID
NUMACTSTRING BINARY STAT DFHA17DS A17DSASC 2 AVG No Number of active strings     activeStringCount
NUMDATBUFF BINARY STAT DFHA17DS A17DSDNB 2 AVG No Number of data buffers     dataBuffers
NUMINDEXBUFF BINARY STAT DFHA17DS A17DSINB 2 AVG No Number of index buffers     indexBuffers
NUMSTRINGWT BINARY STAT DFHA17DS A17DSASW 2 AVG No Current number of string waits     stringWaitCount
OBJECT CVDAS INQ FILE OBJECT 4 LIKE No Data set type (base or path)     DSType
OBJECT Output valid values
  • BASE
  • PATH
  • NOTAPPLIC
OPENSTATUS CVDAS INQ FILE OPENSTATUS 4 LIKE Yes Open status     openStatus
OPENSTATUS Input/output valid values
  • OPEN
  • CLOSED
OPENSTATUS Output valid values
  • OPENING
  • CLOSING
  • CLOSEREQUEST
  • NOTAPPLIC
RBATYPE CVDAS INQ FILE RBATYPE 4 LIKE No Type of VSAM extended addressing     RBAType
RBATYPE Output valid values
  • EXTENDED
  • NOTEXTENDED
  • NOTAPPLIC
READ CVDAS INQ FILE READ 4 LIKE Yes Read option     read
READ Input/output valid values
  • READABLE
  • NOTREADABLE
READ Output valid values
  • NOTAPPLIC
READINTEG CVDAS INQ FILE READINTEG 4 LIKE Yes Default level of read integrity     readIntegrity
READINTEG Input/output valid values
  • UNCOMMITTED
  • CONSISTENT
  • REPEATABLE
READINTEG Output valid values
  • NOTAPPLIC
RECORDFORMAT CVDAS INQ FILE RECORDFORMAT 4 LIKE No Record format     recordFormat
RECORDFORMAT Output valid values
  • FIXED
  • VARIABLE
  • UNDEFINED
  • NOTAPPLIC
RECORDSIZE BINARY INQ FILE RECORDSIZE 4 AVG No Record size     recordSize
RECOVSTATUS CVDAS INQ FILE RECOVSTATUS 4 LIKE No Recovery status     recoveryStatus
RECOVSTATUS Output valid values
  • RECOVERABLE
  • NOTRECOVABLE
  • NOTAPPLIC
RELTYPE CVDAS INQ FILE RELTYPE 4 LIKE No Relative addressing type (BDAM only)     relativeAddressingType
RELTYPE Output valid values
  • HEX
  • DEC
  • BLK
  • NOTAPPLIC
RLSACCESS CVDAS INQ FILE RLSACCESS 4 LIKE Yes Record level sharing (RLS) file access mode     RLSAccessType
RLSACCESS Input/output valid values
  • RLS
  • NOTRLS
RLSACCESS Output valid values
  • NOTAPPLIC
RLSREQWTTO BINARY STAT DFHA17DS A17RLSWT 4 AVG No Record level sharing (RLS) request wait timeouts     RLSTimeoutCount
STRINGS CNUMERIC INQ FILE STRINGS 4 MAX Yes Number of strings     stringCount
TIMECLOSE DECTSTP CPSM   Calculated 4 MAX No Local time file was closed     closeTime
TIMEOPEN DECTSTP CPSM   Calculated 4 MAX No Local time file was opened     openTime
UPDATE CVDAS INQ FILE UPDATE 4 LIKE Yes Update option     update
UPDATE Input/output valid values
  • UPDATABLE
  • NOTUPDATABLE
UPDATE Output valid values
  • NOTAPPLIC
UPDATECNT BINARY STAT DFHA17DS A17DSWRU 4 AVG No Number of REWRITE requests     updateCount
VSAMTYPE CVDAS INQ FILE TYPE 4 LIKE No Type of VSAM data set     VSAMType
VSAMTYPE Input/output valid values
  • NOTAPPLIC
VSAMTYPE Output valid values
  • ESDS
  • KSDS
  • RRDS
  • VRRDS
  • KEYED
  • NOTKEYED
WSTRCCURCNT BINARY STAT DFHA17DS A17DSHSW 2 AVG No Peak number of tasks waiting for a string     peakStringWaitCount
WSTRCNT BINARY STAT DFHA17DS A17DSTSW 4 AVG No Total requests queued because all strings in use     totalStringWaitCount