Add CICS FCT Entry (ADDCICSFCT)

Where allowed to run:

Batch job (*BATCH)
Interactive job (*INTERACT)
Batch program (*BPGM)
Interactive program (*IPGM)
Batch REXX procedure (*BREXX)
Interactive REXX procedure (*IREXX)
Using QCMDEXEC, QCAEXEC, or QCAPCMD API (*EXEC)

Threadsafe: No

Parameters
Examples
Error messages

Use the Add CICS File Control Table (ADDCICSFCT) command to add an entry to the file control table (FCT). The FCT defines all the files, both local and remote, that are used either by CICS or by application programs. All files must conform to one of the VSAM file types:

Key-sequence data set (KSDS), that is each record is accessed by predefined keys
Entry-sequence data set (ESDS), that is each record is accessed by its relative byte address
Relative-record data set (RRDS), that is each record is accessed by its record number

Parameters

Keyword	Description	Choices	Notes
LIB	Library	Communications name, LIBL, CURLIB	Required, Positional 1
GROUP	Group	Communications name	Required, Positional 2
FILEID	CICS file	Communications name	Required, Positional 3
SYSID	Remote CICS system	Communications name, *NONE	Optional, Positional 4
RMTFILE	Remote CICS file	Communications name, *FILEID	Optional, Positional 5
RMTKEYLEN	Remote maximum key length	0-32767, 0	Optional, Positional 6
RMTLENGTH	Remote maximum record length	1-32767, 1	Optional, Positional 7
FILE	File	Qualified object name	Optional, Positional 8
	Qualifier 1: File	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
MBR	Member	Name, *FIRST	Optional, Positional 9
RCDFMT	Record format	FIXED, VARIABLE	Optional, Positional 10
FILESTS	Status	ENABLED, DISABLED, *CLOSED	Optional, Positional 11
ACCMTH	Access method	KEY, ENTRY, *REL	Optional, Positional 12
RECOVER	Recoverable	YES, NO	Optional, Positional 13
CLRFILE	Clear file	NO, YES	Optional, Positional 14
ACCPTH	Access path	FILE, ARRIVAL	Optional, Positional 15
RCDACT	File processing	Element list	Optional, Positional 16
	Element 1: Add allowed	NOADD, ADD
	Element 2: Browse allowed	NOBROWSE, BROWSE
	Element 3: Delete allowed	NODLT, DLT
	Element 4: Read allowed	NOREAD, READ
	Element 5: Update allowed	NOUPD, UPD
JRNCTL	Journal processing	Element list	Optional, Positional 17
	Element 1: Number	0-99, 0
	Element 2: READ ONLY operations	NOREADONLY, READONLY
	Element 3: READ UPDATE operations	NOREADUPD, READUPD
	Element 4: WRITE NEW operations	WRTNEW, NOWRTNEW
	Element 5: WRITE UPDATE operations	WRTUPD, NOWRTUPD

Library (LIB)

Enter the name of the library that contains the group. Possible values are:

*LIBL: The library list is used to locate the first library that contains the group.
*CURLIB: The current library contains the group. If no current library is specified, the QGPL library is used.
library-name: The name of the library that contains the group.

Group (GROUP)

Enter the name of the group to which this FCT entry is to be added.

group-name: The group name may have a maximum length of 10 characters. The first character must be alphabetic, or one of the special characters, $, @, or #. The remaining characters can be alphanumeric or one of the special characters, $, @, or #.

CICS file (FILEID)

Enter the name by which this file is known. This is the name that will be used in EXEC CICS file control commands. This name is also used to identify this FCT entry.

file-identifier: The file identifier may have a maximum length of 8 characters. The first character must be alphabetic, or one of the special characters, $, @, or #. The remaining characters can be alphanumeric or one of the special characters, $, @, or #.

Remote CICS system (SYSID)

This field is only required for remote files.

Enter the identifier of the system where the file is located. The system identifier must have a Terminal Control System Table entry. If this field contains the id of the local system, the entry will be treated as if *NONE had been entered.

Possible values are:

*NONE: The file is held on the local system.
system-identifier: The system identifier may have a maximum length of 4 characters. The first character must be alphabetic, or one of the special characters, $, @, or #. The remaining characters can be alphanumeric or one of the special characters, $, @, or #.

Remote CICS file (RMTFILE)

Enter the identifier by which the file is known on the remote system. This field is not valid for a local file, that is when the system identifier field contains *NONE.

Possible values are:

*FILEID: The name entered in the file identifier field will be used as the remote file name.
remote-file: A file identifier up to 8 characters in length. The first character must be alphabetic, or one of the special characters, $, @, or #. The remaining characters can be alphanumeric or one of the special characters, $, @, or #.

Remote maximum key length (RMTKEYLEN)

Enter the length in bytes of the key field for the file. This field is valid for key-sequenced data sets only. The value must be the same as that specified in the FCT entry on the remote system.

This field is not valid for a local file, that is when the system identifier field contains *NONE.

Possible values are:

0: File does not have a key field. This is the value that should be entered for entry-sequenced data sets and relative record data sets.
remote-key-length: A number in the range 0 through 32767. Zero (0) should be specified for entry-sequenced and relative-record data sets.

Remote maximum record length (RMTLENGTH)

Enter the length in bytes of the maximum record size for the file. The value specified must correspond to the size of the record associated with the file, in the remote system. This field is not valid for the local system, that is when the system identifier field contains *NONE.

Possible values are:

1: File has a record length of one.
remote-record-length: A number in the range 1 through 32767.

File (FILE)

Enter the library and file name of the file that will be utilized by this file identifier. This field is valid only for a local file, that is when the system identifier field contains *NONE.

Specify one of the following library values:
- *LIBL: The library list for the job that is associated with the CICS control region is used to locate the file.
- *CURLIB: The current library for the job that is associated with the CICS control region is used to locate the file. If no library is specified as the current library, the QGPL library is used.
- library-name: Specify the name of the library where the file is located.
file-name: Specify the name of the file.

Member (MBR)

Enter the name of the member in the file that will be utilized by this file identifier. This field is valid only for a local file, that is when the system identifier field contains *NONE.

Possible values are:

*FIRST: No file member is specified. The first member in the file is used.
member-name: Specify the name of the file member.

Record format (RCDFMT)

Indicates whether the record format of the file is fixed length or variable length. This field is valid only for local files, that is when the system identifier field contains *NONE.

Possible values are:

*FIXED: All records in the file have the same length.
*VARIABLE: The records in the file are of variable lengths.

Status (FILESTS)

Indicates whether or not the file identifier can be used. This field is valid only for local files, that is when the system identifier field contains *NONE.

Possible values are:

*ENABLED: The file can be used.
*DISABLED: The file cannot be used until it has been enabled.
*CLOSED: The file cannot be used until it has be opened.

Access method (ACCMTH)

Enter the method that is to be used to access the file. This field is valid only for local files, that is when the system identifier field contains *NONE.

Possible values are:

*KEY: The records in the file will be accessed by key. The file must be a KSDS.
*ENTRY: The records in the file will be accessed by entry-sequence number. The file must be an ESDS.
*REL: The records in the file will be accessed by relative-record number. The file must be an RRDS.

Note: This field is ignored if you enter *ARRIVAL in the access path field.

Recoverable (RECOVER)

Indicates whether or not the file associated with the file identifier is recoverable or not recoverable. This field is valid only for a local file, that is when the system identifier field contains *NONE.

Possible values are:

*YES: The file is recoverable.
*NO: The file is not recoverable.

Clear file (CLRFILE)

Indicates whether or not the file is to be cleared when this file identifier is first opened. This field is valid only for a local file, that is when the system identifier field contains *NONE.

Possible values are:

*NO: Do not clear the file when opened.
*YES: Clear the file when opened.

Access path (ACCPTH)

Indicates whether the file associated with the file identifier should be processed in arrival sequence (sequential) or in accordance with the value in the access method field (that is by key, entry-sequence number, or relative-record number). This field is valid only for a local file, that is when the system identifier field contains *NONE.

Note: ACCPTH(*ARRIVAL) is not valid when ACCMTH(*KEY) is specified.

Possible values are:

*FILE: The file will be processed in accordance with the value in the access method field.
*ARRIVAL: The file will be processed in the arrival sequence (sequentially), regardless of the value in the access method field.

File processing (RCDACT)

Indicates whether or not records in the file can be added, browsed, deleted, read or updated. This field is not valid for a local file, that is when the system identifier field contains *NONE.

There are 5 elements to this field. Possible values are:

Element 1: Add allowed
Indicates whether or not records can be added to the file.
- *NOADD: Records cannot be added.
- *ADD: Records can be added.
Element 2: Browse allowed
Indicates whether or not records can be browsed.
- *NOBROWSE: Records cannot be browsed.
- *BROWSE: Records can be browsed.
Element 3: Delete allowed
Indicates whether or not records can be deleted.
- *NODLT: Records cannot be deleted.
- *DLT: Records can be deleted.
Element 4: Read allowed
Indicates whether or not records can be read.
- *NOREAD: Records cannot be read. (This is the default, unless either the browse or update capability is specified.)
- *READ: Records can be read.
Element 5: Update allowed
Indicates whether or not records can be updated.
- *NOUPD: Records cannot be updated.
- *UPD: Records can be updated.

Journal processing (JRNCTL)

Specifies the number of the journal file to be used with this file and which READ and WRITE operations are to be journaled. This field is valid only for a local file, that is when the system identifier field contains *NONE.

There are 5 elements to this field. Possible values are:

Element 1: Journal number
The journal number to be used for recording READ and WRITE activity on this file. The journal number must be associated with a file through a Journal Control Table entry.
- 0: No journaling is to occur for this file identifier.
- journal-number: A number in the range 1 through 99.
Element 2: READ ONLY operations
Indicates whether or not READ ONLY operations will be journaled.
- *NOREADONLY: READ ONLY operations will not be journaled.
- *READONLY: READ ONLY operations will be journaled.
Element 3: READ UPDATE operations
Indicates whether or not READ UPDATE operations will be journaled.
- *NOREADUPD: READ UPDATE operations will not be journaled.
- *READUPD: READ UPDATE operations will be journaled.
Element 4: WRITE NEW operations
Indicates whether or not WRITE NEW operations will be journaled.
- *WRTNEW: WRITE NEW operations will be journaled.
- *NOWRTNEW: WRITE NEW operations will not be journaled.
Element 5: WRITE UPDATE operations
Indicates whether or not WRITE UPDATE operations will be journaled.
- *WRTUPD: WRITE UPDATE operations will be journaled.
- *NOWRTUPD: WRITE UPDATE operations will not be journaled.

Examples

None

Error messages

Unknown