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

525 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 DCT Entry (ADDCICSDCT)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="ADDCICSDCT.Top_Of_Page"></a>
<h2>Add CICS DCT Entry (ADDCICSDCT)</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="#ADDCICSDCT.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDCICSDCT.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDCICSDCT.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDCICSDCT"></a>
<p>Use the Add CICS Destination Control Table (ADDCICSDCT) command to add an entry to the DCT.
</p>
<p>Each DCT entry defines a destination to which data may be sent. In CICS systems, a destination is a transient data (TD) queue. There are four types of destination:
</p>
<ul>
<li>Intrapartition, which exists in the local CICS region
</li>
<li>Extrapartition, which exists outside the local CICS region
</li>
<li>Remote, which exists on another CICS system
</li>
<li>Indirect, which points to a destination controlled by another DCT entry
</li>
</ul>
<p>Create one DCT entry for each transient data queue.
</p>
<p>Also use the DCT to define whether or not an intrapartition TD queue may be used for automatic transaction initiation (ATI).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDCICSDCT.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="#ADDCICSDCT.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="#ADDCICSDCT.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="#ADDCICSDCT.DEST"><b>DEST</b></a></td>
<td valign="top">Destination</td>
<td valign="top"><i>Communications name</i></td>
<td valign="top">Required, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.TYPE"><b>TYPE</b></a></td>
<td valign="top">Type</td>
<td valign="top">*EXTERNAL, *INDIRECT, *INTERNAL, *REMOTE</td>
<td valign="top">Required, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.DESTSTS"><b>DESTSTS</b></a></td>
<td valign="top">Status</td>
<td valign="top"><b><u>*ENABLED</u></b>, *DISABLED</td>
<td valign="top">Optional, Positional 5</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.RECOVER"><b>RECOVER</b></a></td>
<td valign="top">Recoverable</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional, Positional 6</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.TRGLVL"><b>TRGLVL</b></a></td>
<td valign="top">ATI trigger level</td>
<td valign="top">0-32767, <b><u>0</u></b></td>
<td valign="top">Optional, Positional 7</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.TRANSID"><b>TRANSID</b></a></td>
<td valign="top">Transaction</td>
<td valign="top"><i>Character value</i>, <b><u>'&nbsp;&nbsp;&nbsp;&nbsp;'</u></b></td>
<td valign="top">Optional, Positional 8</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.DEVTYPE"><b>DEVTYPE</b></a></td>
<td valign="top">CICS device indicator</td>
<td valign="top"><b><u>*TERMINAL</u></b>, *FILE</td>
<td valign="top">Optional, Positional 9</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.CICSDEV"><b>CICSDEV</b></a></td>
<td valign="top">CICS device</td>
<td valign="top"><i>Communications name</i>, <b><u>*DEST</u></b></td>
<td valign="top">Optional, Positional 10</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDCICSDCT.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 11</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="#ADDCICSDCT.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 12</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.OPENOPTION"><b>OPENOPTION</b></a></td>
<td valign="top">File processing</td>
<td valign="top"><b><u>*INPUT</u></b>, *OUTPUT, *READBACK</td>
<td valign="top">Optional, Positional 13</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.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 14</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.STGDEV"><b>STGDEV</b></a></td>
<td valign="top">Device</td>
<td valign="top"><b><u>*DASD</u></b>, *TAPE, *DISKETTE, *PRINTER</td>
<td valign="top">Optional, Positional 15</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.RMTDEST"><b>RMTDEST</b></a></td>
<td valign="top">Remote destination</td>
<td valign="top"><i>Communications name</i>, <b><u>*DEST</u></b></td>
<td valign="top">Optional, Positional 16</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.SYSID"><b>SYSID</b></a></td>
<td valign="top">Remote CICS system</td>
<td valign="top"><i>Communications name</i></td>
<td valign="top">Optional, Positional 17</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.LENGTH"><b>LENGTH</b></a></td>
<td valign="top">Maximum record length</td>
<td valign="top">0-32767, <b><u>0</u></b></td>
<td valign="top">Optional, Positional 18</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSDCT.PHYDEST"><b>PHYDEST</b></a></td>
<td valign="top">Indirect destination</td>
<td valign="top"><i>Communications name</i></td>
<td valign="top">Optional, Positional 19</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDCICSDCT.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="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.GROUP"></a>
<h3>Group (GROUP)</h3>
<p>Enter the name of the group to which this destination control table 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="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.DEST"></a>
<h3>Destination (DEST)</h3>
<p>Enter the destination identifier. This identifier will be used in EXEC CICS commands to access transient data queues. This identifier is also the name that will be used to identify this DCT entry.
</p>
<ul>
<li><b>destination:</b> The destination 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="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.TYPE"></a>
<h3>Type (TYPE)</h3>
<p>Enter the type of the transient data queue.
</p>
<p>Possible values are:
</p>
<ul>
<li><b>*INTERNAL:</b> Indicates an intrapartition destination, that is a destination that is within the CICS control region.
</li>
<li><b>*INDIRECT:</b> Indicates an indirect destination, that is a logical destination that points to another destination, which is defined in the DCT as an internal, external, or remote destination. This allows several logical destinations to be merged into one physical destination.
</li>
<li><b>*EXTERNAL:</b> Indicates an extrapartition destination, that is a destination that is outside, but allocated to, the CICS control region.
</li>
<li><b>*REMOTE:</b> Indicates a remote destination, that is a destination on another system or region, where it is defined in the DCT as an internal destination.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.DESTSTS"></a>
<h3>Status (DESTSTS)</h3>
<p>Indicates whether or not the destination identifier can be used. This parameter is not valid for internal destinations, that is when the type field contains *INTERNAL.
</p>
<p>Possible values are:
</p>
<ul>
<li>*ENABLED: This destination identifier can be used. If the type field contains *EXTERNAL, then this transient data queue will be opened when the run time system is installed.
</li>
<li><b>*DISABLED:</b> This destination identifier cannot be used. If the type field contains *EXTERNAL, then this transient data queue will not be opened when the run time system is installed.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.RECOVER"></a>
<h3>Recoverable (RECOVER)</h3>
<p>Indicates whether or not the transient data queue associated with the destination identifier is recoverable or not recoverable. The field is valid only for an internal destination, that is when the type field contains *INTERNAL.
</p>
<p>
<b>Note: </b>If this DCT entry is defining CSMT, this field must be *NO.
</p>
<p>Possible values are:
</p>
<ul>
<li>*NO: The transient data queue is not recoverable.
</li>
<li><b>*YES:</b> The transient data queue is recoverable.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.TRGLVL"></a>
<h3>ATI trigger level (TRGLVL)</h3>
<p>Enter the number of records to accumulate in the queue in order to start automatically the transaction to process them. This is known as automatic transaction initiation (ATI). This field is valid only for internal destinations, that is when the type field contains *INTERNAL.
</p>
<p>The transaction identifier is specified in the transaction identifier field.
</p>
<p>Possible values are:
</p>
<ul>
<li>0: There is no ATI for this destination.
</li>
<li><b>trigger-level:</b> Enter a number in the range 0 through 32767.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.TRANSID"></a>
<h3>Transaction (TRANSID)</h3>
<p>Enter the name of the transaction to be started when the number of records in the queue reaches the trigger level. This field is not valid if the trigger level field contains 0.
</p>
<ul>
<li><b>transaction-identifier:</b> The transaction identifier may have a maximum length of 4 characters. Any characters on the keyboard can be entered, but lowercase letters and special characters should be enclosed in apostrophes.
<p>When there is not enough space to enter the apostrophes, then enter an ampersand (&amp;) in the first character position to get an extended field size that allows for the entry of additional characters. Blanks are accepted but, when the entry is defined to a control region, anything after the blank is ignored. For example, 'ab g' will be treated as 'ab' in the control region.
</p>
<p>Hexadecimal characters should be enclosed in apostrophes and preceded by an uppercase X, for example X'A1A2A3A4'. Any hexadecimal value will be accepted, but, if the value is not a printable character, the entry will be rejected when it is defined to a control region.
</p>
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.DEVTYPE"></a>
<h3>CICS device indicator (DEVTYPE)</h3>
<p>Indicates whether or not a terminal identifier is to be associated with the ATI transaction identifier. This parameter is not valid if the trigger level field contains 0.
</p>
<p>Possible values are:
</p>
<ul>
<li>*TERMINAL: A terminal identifier will be associated with the transaction identifier.
</li>
<li><b>*FILE:</b> No terminal identifier will be associated to the CICS transaction identifier.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.CICSDEV"></a>
<h3>CICS device (CICSDEV)</h3>
<p>Enter the identifier of the terminal to be used to run the ATI transaction. This field is valid only when the device type field contains *TERMINAL.
</p>
<p>Possible values are:
</p>
<ul>
<li>*DEST: The identifier entered in the destination field will be used as the terminal identifier.
</li>
<li><b>terminal-identifier:</b> The terminal 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="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.FILE"></a>
<h3>File (FILE)</h3>
<p>Enter the name of the file that will be used by the destination identifier. This field is valid only for an extrapartition destination, that is when the type field contains *EXTERNAL.
</p>
<p>Possible library values are:
</p>
<ul>
<li>*LIBL: The library list for the job that is associated to the CICS control region is used to locate the file.
</li>
<li><b>*CURLIB:</b> The current library for the job that is associated to 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>
<p><b>file-name:</b> Specify the name of the file.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.MBR"></a>
<h3>Member (MBR)</h3>
<p>Enter the name of the member that will be used by the destination identifier. This field is valid only for extrapartition destinations, that is when the type field contains *EXTERNAL.
</p>
<p>Possible values are:
</p>
<ul>
<li>*FIRST: No member is specified. The first member is used.
</li>
<li><b>member-name:</b> Specify the name of the member.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.OPENOPTION"></a>
<h3>File processing (OPENOPTION)</h3>
<p>Indicates how the file is to be processed, namely:
</p>
<ul>
<li>A read-forwards only input file
</li>
<li>A write-only output file
</li>
<li>A read-backwards only input file.
</li>
</ul>
<p>This parameter is valid only for extrapartition destinations, that is when the type field contains *EXTERNAL.
</p>
<p>Possible values are:
</p>
<ul>
<li>*INPUT: The file is to be used for input that will only be read forward.
</li>
<li><b>*OUTPUT:</b> The file is used for output.
</li>
<li><b>*READBACK:</b> The file is used for input that will only be read backwards.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.RCDFMT"></a>
<h3>Record format (RCDFMT)</h3>
<p>Indicates the record format of the file. This field is valid only for extrapartition destinations, that is when the type field contains *EXTERNAL.
</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="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.STGDEV"></a>
<h3>Device (STGDEV)</h3>
<p>Indicates the storage medium of the file. This parameter is valid only for extrapartition destinations, that is when the type field contains *EXTERNAL.
</p>
<p>Possible values are:
</p>
<ul>
<li>*DASD: The file is located on disk storage.
</li>
<li><b>*TAPE:</b> The file is located on magnetic tape.
</li>
<li><b>*DISKETTE:</b> The file is located on diskette.
</li>
<li><b>*PRINTER:</b> The file is written to a printer.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.RMTDEST"></a>
<h3>Remote destination (RMTDEST)</h3>
<p>Enter the identifier by which the destination is known on the remote system. This field is valid only for remote destinations, that is when the type field contains *REMOTE.
</p>
<p>Possible values are:
</p>
<ul>
<li>*DEST: The identifier entered in the destination identifier field will be used.
</li>
<li><b>remote-destination:</b> The destination 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="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.SYSID"></a>
<h3>Remote CICS system (SYSID)</h3>
<p>Enter the remote system identifier. The system must have an entry in the remote TCS. This field is valid only for a remote destination, that is when the type field contains *REMOTE.
</p>
<ul>
<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="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.LENGTH"></a>
<h3>Maximum record length (LENGTH)</h3>
<p>Enter the maximum length in bytes of the records in the transient data queue. This value must be the same as that specified for the queue in the remote system. This field is valid only for remote queues, that is when the type field contains *REMOTE.
</p>
<p>Possible values are:
</p>
<ul>
<li>0: The LENGTH parameter will be specified in EXEC CICS READQ TD or WRITEQ TD commands within an application program.
</li>
<li><b>length:</b> Enter a number in the range 0 through 32767.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSDCT.PHYDEST"></a>
<h3>Indirect destination (PHYDEST)</h3>
<p>Enter the identifier of the destination to which this DCT entry points. This identifier should have a DCT entry defining the queue as *INTERNAL, *EXTERNAL, or *REMOTE. This field is valid only for indirect destinations, that is when the type field contains *INDIRECT.
</p>
<ul>
<li><b>indirect-destination:</b> The 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="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDCICSDCT.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDCICSDCT.ERROR.MESSAGES">Error messages</a></h3>Unknown
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSDCT.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>