ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/addcicsfct.htm

612 lines
21 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Add CICS FCT Entry (ADDCICSFCT)</title>
</head>
<body bgcolor="white">
<a name="ADDCICSFCT.Top_Of_Page"></a>
<h2>Add CICS FCT Entry (ADDCICSFCT)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>
<ul><li>Batch job (*BATCH)</li>
<li>Interactive job (*INTERACT)</li>
<li>Batch program (*BPGM)</li>
<li>Interactive program (*IPGM)</li>
<li>Batch REXX procedure (*BREXX)</li>
<li>Interactive REXX procedure (*IREXX)</li>
<li>Using QCMDEXEC, QCAEXEC, or QCAPCMD API (*EXEC)</li>
</ul><b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#ADDCICSFCT.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDCICSFCT.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDCICSFCT.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDCICSFCT"></a>
<p>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:
</p>
<ul>
<li>Key-sequence data set (KSDS), that is each record is accessed by predefined keys
</li>
<li>Entry-sequence data set (ESDS), that is each record is accessed by its relative byte address
</li>
<li>Relative-record data set (RRDS), that is each record is accessed by its record number
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDCICSFCT.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.LIB"><b>LIB</b></a></td>
<td valign="top">Library</td>
<td valign="top"><i>Communications name</i>, *LIBL, *CURLIB</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.GROUP"><b>GROUP</b></a></td>
<td valign="top">Group</td>
<td valign="top"><i>Communications name</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.FILEID"><b>FILEID</b></a></td>
<td valign="top">CICS file</td>
<td valign="top"><i>Communications name</i></td>
<td valign="top">Required, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.SYSID"><b>SYSID</b></a></td>
<td valign="top">Remote CICS system</td>
<td valign="top"><i>Communications name</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.RMTFILE"><b>RMTFILE</b></a></td>
<td valign="top">Remote CICS file</td>
<td valign="top"><i>Communications name</i>, <b><u>*FILEID</u></b></td>
<td valign="top">Optional, Positional 5</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.RMTKEYLEN"><b>RMTKEYLEN</b></a></td>
<td valign="top">Remote maximum key length</td>
<td valign="top">0-32767, <b><u>0</u></b></td>
<td valign="top">Optional, Positional 6</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.RMTLENGTH"><b>RMTLENGTH</b></a></td>
<td valign="top">Remote maximum record length</td>
<td valign="top">1-32767, <b><u>1</u></b></td>
<td valign="top">Optional, Positional 7</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDCICSFCT.FILE"><b>FILE</b></a></td>
<td valign="top">File</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional, Positional 8</td>
</tr>
<tr>
<td valign="top">Qualifier 1: File</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#ADDCICSFCT.MBR"><b>MBR</b></a></td>
<td valign="top">Member</td>
<td valign="top"><i>Name</i>, <b><u>*FIRST</u></b></td>
<td valign="top">Optional, Positional 9</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.RCDFMT"><b>RCDFMT</b></a></td>
<td valign="top">Record format</td>
<td valign="top"><b><u>*FIXED</u></b>, *VARIABLE</td>
<td valign="top">Optional, Positional 10</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.FILESTS"><b>FILESTS</b></a></td>
<td valign="top">Status</td>
<td valign="top"><b><u>*ENABLED</u></b>, *DISABLED, *CLOSED</td>
<td valign="top">Optional, Positional 11</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.ACCMTH"><b>ACCMTH</b></a></td>
<td valign="top">Access method</td>
<td valign="top"><b><u>*KEY</u></b>, *ENTRY, *REL</td>
<td valign="top">Optional, Positional 12</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.RECOVER"><b>RECOVER</b></a></td>
<td valign="top">Recoverable</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional, Positional 13</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.CLRFILE"><b>CLRFILE</b></a></td>
<td valign="top">Clear file</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional, Positional 14</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSFCT.ACCPTH"><b>ACCPTH</b></a></td>
<td valign="top">Access path</td>
<td valign="top"><b><u>*FILE</u></b>, *ARRIVAL</td>
<td valign="top">Optional, Positional 15</td>
</tr>
<tr>
<td valign="top" rowspan="6"><a href="#ADDCICSFCT.RCDACT"><b>RCDACT</b></a></td>
<td valign="top">File processing</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="6">Optional, Positional 16</td>
</tr>
<tr>
<td valign="top">Element 1: Add allowed</td>
<td valign="top">
<b><u>*NOADD</u></b>, *ADD</td>
</tr>
<tr>
<td valign="top">Element 2: Browse allowed</td>
<td valign="top">
<b><u>*NOBROWSE</u></b>, *BROWSE</td>
</tr>
<tr>
<td valign="top">Element 3: Delete allowed</td>
<td valign="top">
<b><u>*NODLT</u></b>, *DLT</td>
</tr>
<tr>
<td valign="top">Element 4: Read allowed</td>
<td valign="top">
<b><u>*NOREAD</u></b>, *READ</td>
</tr>
<tr>
<td valign="top">Element 5: Update allowed</td>
<td valign="top">
<b><u>*NOUPD</u></b>, *UPD</td>
</tr>
<tr>
<td valign="top" rowspan="6"><a href="#ADDCICSFCT.JRNCTL"><b>JRNCTL</b></a></td>
<td valign="top">Journal processing</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="6">Optional, Positional 17</td>
</tr>
<tr>
<td valign="top">Element 1: Number</td>
<td valign="top">
0-99, <b><u>0</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: READ ONLY operations</td>
<td valign="top">
<b><u>*NOREADONLY</u></b>, *READONLY</td>
</tr>
<tr>
<td valign="top">Element 3: READ UPDATE operations</td>
<td valign="top">
<b><u>*NOREADUPD</u></b>, *READUPD</td>
</tr>
<tr>
<td valign="top">Element 4: WRITE NEW operations</td>
<td valign="top">
<b><u>*WRTNEW</u></b>, *NOWRTNEW</td>
</tr>
<tr>
<td valign="top">Element 5: WRITE UPDATE operations</td>
<td valign="top">
<b><u>*WRTUPD</u></b>, *NOWRTUPD</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDCICSFCT.LIB"></a>
<h3>Library (LIB)</h3>
<p>Enter the name of the OS/400 library that contains the group. Possible values are:
</p>
<ul>
<li><b>*LIBL:</b> The library list is used to locate the first OS/400 library that contains the group.
</li>
<li><b>*CURLIB:</b> The current library contains the group. If no current library is specified, the QGPL library is used.
</li>
<li><b>library-name:</b> The name of the OS/400 library that contains the group.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.GROUP"></a>
<h3>Group (GROUP)</h3>
<p>Enter the name of the group to which this FCT entry is to be added.
</p>
<ul>
<li><b>group-name:</b> 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 #.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.FILEID"></a>
<h3>CICS file (FILEID)</h3>
<p>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.
</p>
<ul>
<li><b>file-identifier:</b> 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 #.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.SYSID"></a>
<h3>Remote CICS system (SYSID)</h3>
<p>This field is only required for remote files.
</p>
<p>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.
</p>
<p>Possible values are:
</p>
<ul>
<li>*NONE: The file is held on the local system.
</li>
<li><b>system-identifier:</b> 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 #.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.RMTFILE"></a>
<h3>Remote CICS file (RMTFILE)</h3>
<p>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.
</p>
<p>Possible values are:
</p>
<ul>
<li>*FILEID: The name entered in the file identifier field will be used as the remote file name.
</li>
<li><b>remote-file:</b> 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 #.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.RMTKEYLEN"></a>
<h3>Remote maximum key length (RMTKEYLEN)</h3>
<p>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.
</p>
<p>This field is not valid for a local file, that is when the system identifier field contains *NONE.
</p>
<p>Possible values are:
</p>
<ul>
<li>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.
</li>
<li><b>remote-key-length:</b> A number in the range 0 through 32767. Zero (0) should be specified for entry-sequenced and relative-record data sets.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.RMTLENGTH"></a>
<h3>Remote maximum record length (RMTLENGTH)</h3>
<p>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.
</p>
<p>Possible values are:
</p>
<ul>
<li>1: File has a record length of one.
</li>
<li><b>remote-record-length</b>: A number in the range 1 through 32767.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.FILE"></a>
<h3>File (FILE)</h3>
<p>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.
</p>
<ul>
<li>Specify one of the following library values:
<ul>
<li>*LIBL: The library list for the job that is associated with the CICS control region is used to locate the file.
</li>
<li>*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.
</li>
<li><b>library-name:</b> Specify the name of the library where the file is located.
</li>
</ul>
</li>
<li><b>file-name:</b> Specify the name of the file.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.MBR"></a>
<h3>Member (MBR)</h3>
<p>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.
</p>
<p>Possible values are:
</p>
<ul>
<li>*FIRST: No file member is specified. The first member in the file is used.
</li>
<li><b>member-name:</b> Specify the name of the file member.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.RCDFMT"></a>
<h3>Record format (RCDFMT)</h3>
<p>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.
</p>
<p>Possible values are:
</p>
<ul>
<li>*FIXED: All records in the file have the same length.
</li>
<li><b>*VARIABLE:</b> The records in the file are of variable lengths.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.FILESTS"></a>
<h3>Status (FILESTS)</h3>
<p>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.
</p>
<p>Possible values are:
</p>
<ul>
<li>*ENABLED: The file can be used.
</li>
<li>*DISABLED: The file cannot be used until it has been enabled.
</li>
<li>*CLOSED: The file cannot be used until it has be opened.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.ACCMTH"></a>
<h3>Access method (ACCMTH)</h3>
<p>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.
</p>
<p>Possible values are:
</p>
<ul>
<li>*KEY: The records in the file will be accessed by key. The file must be a KSDS.
</li>
<li>*ENTRY: The records in the file will be accessed by entry-sequence number. The file must be an ESDS.
</li>
<li>*REL: The records in the file will be accessed by relative-record number. The file must be an RRDS.
</li>
</ul>
<p>
<b>Note: </b>This field is ignored if you enter *ARRIVAL in the access path field.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.RECOVER"></a>
<h3>Recoverable (RECOVER)</h3>
<p>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.
</p>
<p>Possible values are:
</p>
<ul>
<li>*YES: The file is recoverable.
</li>
<li>*NO: The file is not recoverable.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.CLRFILE"></a>
<h3>Clear file (CLRFILE)</h3>
<p>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.
</p>
<p>Possible values are:
</p>
<ul>
<li>*NO: Do not clear the file when opened.
</li>
<li>*YES: Clear the file when opened.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.ACCPTH"></a>
<h3>Access path (ACCPTH)</h3>
<p>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.
</p>
<p>
<b>Note: </b>ACCPTH(*ARRIVAL) is not valid when ACCMTH(*KEY) is specified.
</p>
<p>Possible values are:
</p>
<ul>
<li>*FILE: The file will be processed in accordance with the value in the access method field.
</li>
<li>*ARRIVAL: The file will be processed in the arrival sequence (sequentially), regardless of the value in the access method field.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.RCDACT"></a>
<h3>File processing (RCDACT)</h3>
<p>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.
</p>
<p>There are 5 elements to this field. Possible values are:
</p>
<ul>
<li><b>Element 1: Add allowed</b>
<p>Indicates whether or not records can be added to the file.
</p>
<ul>
<li>*NOADD: Records cannot be added.
</li>
<li>*ADD: Records can be added.
</li>
</ul>
</li>
<li><b>Element 2: Browse allowed</b>
<p>Indicates whether or not records can be browsed.
</p>
<ul>
<li>*NOBROWSE: Records cannot be browsed.
</li>
<li>*BROWSE: Records can be browsed.
</li>
</ul>
</li>
<li><b>Element 3: Delete allowed</b>
<p>Indicates whether or not records can be deleted.
</p>
<ul>
<li>*NODLT: Records cannot be deleted.
</li>
<li>*DLT: Records can be deleted.
</li>
</ul>
</li>
<li><b>Element 4: Read allowed</b>
<p>Indicates whether or not records can be read.
</p>
<ul>
<li>*NOREAD: Records cannot be read. (This is the default, unless either the browse or update capability is specified.)
</li>
<li>*READ: Records can be read.
</li>
</ul>
</li>
<li><b>Element 5: Update allowed</b>
<p>Indicates whether or not records can be updated.
</p>
<ul>
<li>*NOUPD: Records cannot be updated.
</li>
<li>*UPD: Records can be updated.
</li>
</ul>
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSFCT.JRNCTL"></a>
<h3>Journal processing (JRNCTL)</h3>
<p>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.
</p>
<p>There are 5 elements to this field. Possible values are:
</p>
<ul>
<li><b>Element 1: Journal number</b>
<p>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.
</p>
<ul>
<li>0: No journaling is to occur for this file identifier.
</li>
<li><b>journal-number:</b> A number in the range 1 through 99.
</li>
</ul>
</li>
<li><b>Element 2: READ ONLY operations</b>
<p>Indicates whether or not READ ONLY operations will be journaled.
</p>
<ul>
<li>*NOREADONLY: READ ONLY operations will not be journaled.
</li>
<li>*READONLY: READ ONLY operations will be journaled.
</li>
</ul>
</li>
<li><b>Element 3: READ UPDATE operations</b>
<p>Indicates whether or not READ UPDATE operations will be journaled.
</p>
<ul>
<li>*NOREADUPD: READ UPDATE operations will not be journaled.
</li>
<li>*READUPD: READ UPDATE operations will be journaled.
</li>
</ul>
</li>
<li><b>Element 4: WRITE NEW operations</b>
<p>Indicates whether or not WRITE NEW operations will be journaled.
</p>
<ul>
<li>*WRTNEW: WRITE NEW operations will be journaled.
</li>
<li>*NOWRTNEW: WRITE NEW operations will not be journaled.
</li>
</ul>
</li>
<li><b>Element 5: WRITE UPDATE operations</b>
<p>Indicates whether or not WRITE UPDATE operations will be journaled.
</p>
<ul>
<li>*WRTUPD: WRITE UPDATE operations will be journaled.
</li>
<li>*NOWRTUPD: WRITE UPDATE operations will not be journaled.
</li>
</ul>
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDCICSFCT.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDCICSFCT.ERROR.MESSAGES">Error messages</a></h3>Unknown
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSFCT.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>