A CICS® Definition that describes the physical and operational characteristics of a file.
The Primary key field for this resource class is NAME .
The following actions are supported:
The parameter data for the INSTALL action is described in Parameters for installing CICS Definitions.
API Actions
PARM(' [NOTIFY(value)] USAGE(value) [FORCEINS(value)] [STATECHK(value)] [MODE(value)] [OVERTYPE(value)] [OVERRIDE(override)] TARGET(value) [RELATED(value)] .')
PARM(' [ERRQUEUE] RESGROUP(value) .')
Code | Description | Code | Description |
DIFF_VERSION | Different version | INV_RESTYPE | Invalid resource type |
EARLY_NAMELIST_END | Early name list end | INV_RSCOPE | Invalid related scope |
INCONSISTENT_SET | Inconsistent set condition | INV_STATECHK | Invalid state check |
INV_ACTION | Invalid action | INV_STRNGTERM | Invalid string term |
INV_ATTRIBUTE | Invalid attribute | INV_TSCOPE | Invalid target scope |
INV_CONTEXT | Context not found | INV_USAGE | Invalid usage |
INV_DATA | Attribute data invalid | INV_VER | Invalid resource version |
INV_EMBEDTERM | Invalid embedded terminator | MISSING_RELSYSID | Missing related system identifier |
INV_FORCEINS | Invalid force install | MORE_THAN_1_RELSYS | More than one related system |
INV_LITERAL | Invalid literal | NODEFS_SELECTED | No definitions selected |
INV_MINNAME | Invalid minor name | NON_MP | Maintenance point CMAS not available |
INV_MODE | Invalid mode | NOTHING_INSTALLED | Nothing installed |
INV_NAME | Invalid name | NOTIFY | Notify |
INV_NAMELIST | Invalid name list | NO_RELATED | No related systems |
INV_NOTIFY | Invalid notify | NO_TARGETS | No targets |
INV_ORSTGNA | Invalid override string | PARTIAL_INSTALL | Partial install |
INV_ORSTRING | Invalid override string | REC_CHANGED | Resource definition already changed |
INV_OVERTYPE | Invalid override type | REC_EXISTS | Resource already exists |
INV_OVRBLOCK | Invalid override block | REC_NOT_FOUND | Requested resource not found |
INV_RECADDR | Invalid record address | SCOPE_CONFLICT | Scope conflict |
INV_RECLEN | Invalid record length | SCOPE_REQUIRED | Scope required |
INV_RESGROUP | Resource group not found | USAGE_CONFLICT | Usage conflict |
Name | Datatype | Source | Len | Req | Sum | Description | Default | Value Range | Attr ID |
---|---|---|---|---|---|---|---|---|---|
CHANGETIME | DATETIME | CPSM | 8 | Yes | MAX | Last time the definition was changed | 1 | ||
DEFVER-2 | BINARY | CPSM | 1 | Yes | AVG | Definition version | 0 | 0-15 | 5 |
NAME-1 | CHAR | CPSM | 8 | Yes | DIF | File definition name | 7 | ||
ADD | EYUDA | CPSM | 4 | Yes | LIKE | Add option | NO | 8 | |
ADD Input/Output Valid Values | YES NO | ||||||||
BROWSE | EYUDA | CPSM | 4 | Yes | LIKE | Browse option | NO | 9 | |
BROWSE Input/Output Valid Values | YES NO | ||||||||
DELETE | EYUDA | CPSM | 4 | Yes | LIKE | Delete option | NO | 10 | |
DELETE Input/Output Valid Values | YES NO | ||||||||
READ | EYUDA | CPSM | 4 | Yes | LIKE | Read option | YES | 11 | |
READ Input/Output Valid Values | YES NO | ||||||||
UPDATE | EYUDA | CPSM | 4 | Yes | LIKE | Update option | NO | 12 | |
UPDATE Input/Output Valid Values | YES NO | ||||||||
BACKUPTYPE | CVDAS | CPSM | 4 | Yes | LIKE | CICS VSAM file backup type | STATIC | 13 | |
BACKUPTYPE Input/Output Valid Values | STATIC DYNAMIC | ||||||||
DATABUFFERS | CHAR | CPSM | 8 | No | DIF | Number of data buffers | 2 | 2-32767 | 14 |
DISPOSITION | CVDAS | CPSM | 4 | Yes | LIKE | Disposition of file | SHARE | 15 | |
DISPOSITION Input/Output Valid Values | SHARE OLD | ||||||||
DSNSHARING | EYUDA | CPSM | 4 | Yes | LIKE | VSAM data set name sharing | ALLREQS | 16 | |
DSNSHARING Input/Output Valid Values | ALLREQS MODIFYREQS | ||||||||
FWDRECOVLOG | CHAR | CPSM | 4 | No | DIF | Journal number used for forward recovery | NO | 1-99 | 17 |
FWDRECOVLOG Input/Output Valid Values | NO | ||||||||
INDEXBUFFERS | CHAR | CPSM | 8 | No | DIF | Number of index buffers | 1 | 1-32767 | 18 |
JNLADD | EYUDA | CPSM | 4 | Yes | LIKE | Add operations recorded on journal | NONE | 19 | |
JNLADD Input/Output Valid Values | NONE AFTER ALL BEFORE | ||||||||
JNLREAD | EYUDA | CPSM | 4 | Yes | LIKE | Read operations recorded on journal | NONE | 20 | |
JNLREAD Input/Output Valid Values | NONE ALL READONLY UPDATEONLY | ||||||||
JNLSYNCREAD | EYUDA | CPSM | 4 | Yes | LIKE | Synchronous auto journaling for input | NO | 21 | |
JNLSYNCREAD Input/Output Valid Values | YES NO | ||||||||
JNLSYNCWRITE | EYUDA | CPSM | 4 | Yes | LIKE | Synchronous auto journaling for output | YES | 22 | |
JNLSYNCWRITE Input/Output Valid Values | YES NO | ||||||||
JNLUPDATE | EYUDA | CPSM | 4 | Yes | LIKE | Rewrite/delete operations recorded on journal | NO | 23 | |
JNLUPDATE Input/Output Valid Values | YES NO | ||||||||
JOURNAL | CHAR | CPSM | 4 | No | DIF | Journal number | NO | 1-99 | 25 |
JOURNAL Input/Output Valid Values | NO | ||||||||
KEYLENGTH | CHAR | CPSM | 4 | No | DIF | Key length | 1-255 | 26 | |
LSRPOOLID | CHAR | CPSM | 4 | No | DIF | Local shared resources pool ID | 1 | 1-8 | 27 |
LSRPOOLID Input/Output Valid Values | NONE | ||||||||
MAXNUMRECS | CHAR | CPSM | 8 | No | DIF | Maximum number of records in data table | NOLIMIT | 1-99999999 | 28 |
MAXNUMRECS Input/Output Valid Values | NOLIMIT | ||||||||
NSRGROUP | CHAR | CPSM | 8 | No | DIF | Non-shared resources (NSR) group name | 29 | ||
OPENTIME | EYUDA | CPSM | 4 | Yes | LIKE | File open time | FIRSTREF | 30 | |
OPENTIME Input/Output Valid Values | FIRSTREF STARTUP | ||||||||
PASSWORD | HIDCHAR | CPSM | 8 | No | DIF | User access password | 31 | ||
READINTEG | CVDAS | CPSM | 4 | Yes | LIKE | Default level of read integrity | UNCOMMITTED | 32 | |
READINTEG Input/Output Valid Values | UNCOMMITTED CONSISTENT REPEATABLE | ||||||||
RECORDFORMAT | CVDAS | CPSM | 4 | Yes | LIKE | Record format | VARIABLE | 33 | |
RECORDFORMAT Input/Output Valid Values | VARIABLE FIXED | ||||||||
RECORDSIZE | CHAR | CPSM | 8 | No | DIF | Record size | 1-32767 | 34 | |
RECOVERY | EYUDA | CPSM | 4 | Yes | LIKE | Type of recovery | NONE | 35 | |
RECOVERY Input/Output Valid Values | NONE ALL BACKOUTONLY | ||||||||
REMOTENAME | CHAR | CPSM | 8 | No | DIF | Remote file name | 36 | ||
REMOTESYSTEM | CHAR | CPSM | 4 | No | DIF | Remote system name | 37 | ||
RLSACCESS | EYUDA | CPSM | 4 | Yes | LIKE | Record level sharing (RLS) file access mode | NO | 38 | |
RLSACCESS Input/Output Valid Values | YES NO | ||||||||
STATUS | CVDAS | CPSM | 4 | Yes | LIKE | Initial status | ENABLED | 39 | |
STATUS Input/Output Valid Values | ENABLED DISABLED UNENABLED | ||||||||
STRINGS | CHAR | CPSM | 4 | No | DIF | Maximum concurrent requests against file | 1 | 1-255 | 40 |
TABLE | EYUDA | CPSM | 4 | Yes | LIKE | Data table type | NO | 41 | |
TABLE Input/Output Valid Values | NO CICS USER CF | ||||||||
BASENAME | CHAR | CPSM | 8 | No | DIF | Base data set name | 43 | ||
MINRECORDLEN | CHAR | CPSM | 4 | No | DIF | Minimum record length | 1-4090 | 44 | |
CNTLINTRVAL | CHAR | CPSM | 4 | No | DIF | Control interval size | 512-4096 | 45 | |
RSL | CHAR | CPSM | 8 | No | DIF | Resource security value | 0 | 0-24 | 46 |
RSL Input/Output Valid Values | PUBLIC | ||||||||
ACCESSMETH | CVDAS | CPSM | 4 | Yes | LIKE | File access method | VSAM | 47 | |
ACCESSMETH Input/Output Valid Values | ESDS KSDS RRDS KEYED BDAM VSAM NOTAPPLIC | ||||||||
LOG | EYUDA | CPSM | 4 | Yes | LIKE | Automatic logging | NO | 50 | |
LOG Input/Output Valid Values | YES NO | ||||||||
DSNAME | CHAR | CPSM | 60 | Yes | DIF | Data set name | 51 | ||
CREATETIME | DATETIME | CPSM | 8 | Yes | MAX | Definition create time | 52 | ||
USERDATA1 | CHAR | CPSM | 8 | No | DIF | User data area 1 | 53 | ||
USERDATA2 | CHAR | CPSM | 8 | No | DIF | User data area 2 | 54 | ||
USERDATA3 | CHAR | CPSM | 8 | No | DIF | User data area 3 | 55 | ||
DESCRIPTION | CHAR | CPSM | 58 | No | DIF | Definition description | 56 | ||
FILEOPEN | CHAR | CPSM | 1 | No | DIF | File open status | Y | 57 | |
FILEOPEN Input/Output Valid Values | N Y | ||||||||
FILENABLED | CHAR | CPSM | 1 | No | DIF | File enabled status | Y | 58 | |
FILENABLED Input/Output Valid Values | N Y U | ||||||||
FILETYPE | CHAR | CPSM | 1 | No | DIF | Data set type | K | 59 | |
FILETYPE Input/Output Valid Values | A E K R | ||||||||
FILEACCESS | CHAR | CPSM | 1 | No | DIF | Access method | R | 60 | |
FILEACCESS Input/Output Valid Values | O R U | ||||||||
MAXRECORDLEN | CHAR | CPSM | 6 | No | DIF | Maximum record length | 1-32767 | 61 | |
KEYNUMBER | CHAR | CPSM | 2 | No | DIF | Key number | 1-99 | 62 | |
EXTFILEMGR | CHAR | CPSM | 4 | No | DIF | Use external file manager | N | 63 | |
EXTFILEMGR Input/Output Valid Values | N Y | ||||||||
FSEGDEFNAME | CHAR | CPSM | 8 | No | DIF | File segment definition name | 64 | ||
FSEGDEFVER | CHAR | CPSM | 2 | No | DIF | File segment definition version | 1-15 | 65 | |
POOLNAME | CHAR | CPSM | 8 | No | DIF | Coupling facility data table (CFDT) pool name | 66 | ||
TABLENAME | CHAR | CPSM | 8 | No | DIF | Table name | 67 | ||
UPDATEMODEL | CVDAS | CPSM | 4 | No | LIKE | Update model | LOCKING | 68 | |
UPDATEMODEL Input/Output Valid Values | LOCKING CONTENTION | ||||||||
LOADTYPE | EYUDA | CPSM | 4 | No | LIKE | Load type | NO | 69 | |
LOADTYPE Input/Output Valid Values | YES NO | ||||||||
CATNAME | CHAR | CPSM | 7 | No | DIF | VSAM catalog name | 70 | ||
SHR4ACCESS | EYUDA | CPSM | 4 | No | LIKE | VSAM share access | KEY | 72 | |
SHR4ACCESS Input/Output Valid Values | KEY RBA |