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

353 lines
14 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 PPT Entry (ADDCICSPPT)</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="ADDCICSPPT.Top_Of_Page"></a>
<h2>Add CICS PPT Entry (ADDCICSPPT)</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="#ADDCICSPPT.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDCICSPPT.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDCICSPPT.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDCICSPPT"></a>
<p>Use the Add CICS Processing Program Table (ADDCICSPPT) command to add an entry to the PPT.
</p>
<p>The Processing Program Table (PPT) defines the programs that may be invoked by the transaction identifiers held in the PCT. You need to create entries for:
</p>
<ul>
<li>All programs invoked by a local transaction id. These programs may be local or remote.
</li>
<li>All programs that are invoked by either the EXEC CICS LINK or the EXEC CICS XCTL commands.
</li>
<li>All BMS map sets and user spaces used on the local system.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDCICSPPT.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="#ADDCICSPPT.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="#ADDCICSPPT.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="#ADDCICSPPT.PGMID"><b>PGMID</b></a></td>
<td valign="top">CICS program</td>
<td valign="top"><i>Communications name</i></td>
<td valign="top">Required, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSPPT.CICSMAP"><b>CICSMAP</b></a></td>
<td valign="top">BMS map set</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSPPT.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 5</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSPPT.RMTPGMID"><b>RMTPGMID</b></a></td>
<td valign="top">Remote CICS program</td>
<td valign="top"><i>Communications name</i>, <b><u>*PGMID</u></b></td>
<td valign="top">Optional, Positional 6</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDCICSPPT.PGMOBJ"><b>PGMOBJ</b></a></td>
<td valign="top">Program object</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional, Positional 7</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Program object</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="#ADDCICSPPT.CICSDEBUG"><b>CICSDEBUG</b></a></td>
<td valign="top">CICS debug</td>
<td valign="top"><b><u>*DEBUG</u></b>, *NODEBUG</td>
<td valign="top">Optional, Positional 10</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSPPT.APISET"><b>APISET</b></a></td>
<td valign="top">API commands</td>
<td valign="top"><b><u>*FULLAPI</u></b>, *DPLSUBSET</td>
<td valign="top">Optional, Positional 11</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSPPT.TRANSID"><b>TRANSID</b></a></td>
<td valign="top">Transaction</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 12</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSPPT.PGMSTS"><b>PGMSTS</b></a></td>
<td valign="top">Status</td>
<td valign="top"><b><u>*ENABLED</u></b>, *DISABLED</td>
<td valign="top">Optional, Positional 8</td>
</tr>
<tr>
<td valign="top"><a href="#ADDCICSPPT.PGMLNG"><b>PGMLNG</b></a></td>
<td valign="top">Calling convention</td>
<td valign="top"><b><u>*COBOL</u></b>, *C</td>
<td valign="top">Optional, Positional 9</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDCICSPPT.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="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.GROUP"></a>
<h3>Group (GROUP)</h3>
<p>The name of the group to which this PPT 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="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.PGMID"></a>
<h3>CICS program (PGMID)</h3>
<p>Enter the program identifier used to initiate an iSeries program object. This field is also used to identify this PPT entry.
</p>
<ul>
<li><b>program-identifier:</b> The program 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="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.CICSMAP"></a>
<h3>BMS map set (CICSMAP)</h3>
<p>Indicates if the program identified in the PGMID field is a BMS map set or a user space.
</p>
<p>Possible values are:
</p>
<ul>
<li>*NO: The program identifier is not a BMS map set or user space; it is an application program.
</li>
<li><b>*YES:</b> The program identifier is a BMS map set or a user space.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.SYSID"></a>
<h3>Remote CICS system (SYSID)</h3>
<p>Enter the identifier of the system owning the program. The system should have a TCS entry. This field is valid only for PPT entries defining application programs, that is the CICSMAP field should contain *NO.
</p>
<p>Possible values are:
</p>
<ul>
<li>*NONE: The program 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="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.RMTPGMID"></a>
<h3>Remote CICS program (RMTPGMID)</h3>
<p>Enter the identifier by which the program is known on the remote system. This field is not valid for local systems, that is when the system identifier field contains *NONE.
</p>
<p>Possible values are:
</p>
<ul>
<li>*PGMID: The local and remote program identifiers are the same. The local identifier will be used to access the remote program.
</li>
<li><b>remote-pgm-identifier:</b> The program 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="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.PGMOBJ"></a>
<h3>Program object (PGMOBJ)</h3>
<p>Enter the name of the iSeries program object or user space object that will be utilized by the program identifier. This field is valid only for local systems, that is when the system identifier field contains *NONE.
</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 iSeries program object or user space object.
</li>
<li><b>*CURLIB:</b> The current library for the job that is associated to the CICS control region is used to locate the iSeries program object or user space object. 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 iSeries program object or user space object is located.
</li>
</ul>
<p><b>object-name:</b> Specify the name of the iSeries program object or user space object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.CICSDEBUG"></a>
<h3>CICS debug (CICSDEBUG)</h3>
<p>Indicates whether or not the CICS-supplied transaction CEDF can be used when running an iSeries program object. This field is valid only when the CICSMAP field is referencing an application program held on the local system, that is when the CICSMAP field contains *NO and the system identifier field contains *NONE.
</p>
<p>Possible values are:
</p>
<ul>
<li>*DEBUG: CEDF can be used with the iSeries program object.
</li>
<li><b>*NODEBUG:</b> CEDF cannot be used with the iSeries program object.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.APISET"></a>
<h3>API commands (APISET)</h3>
<p>Indicates which of the EXEC CICS commands can be executed in an application program. This field is valid only when the CICSMAP field references an application program held on the local system, that is when the CICSMAP field contains *NO and the system identifier field contains *NONE.
</p>
<p>
<b>Note: </b>If the program identifier starts with AEG, then this field must contain *FULLAPI.
</p>
<p>Possible values are:
</p>
<ul>
<li>*FULLAPI: All the EXEC CICS commands can be used in application programs.
</li>
<li><b>*DPLSUBSET:</b> Only the EXEC CICS commands specified in the distributed progamming link subset can be used in application programs.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.TRANSID"></a>
<h3>Transaction (TRANSID)</h3>
<p>Enter the overriding transaction identifier under which the server program runs during a distributed program link. This transaction identifier should have its own PPT entry. This parameter is not valid for the local system, that is when the system identifier field contains *NONE.
</p>
<p>Possible values are:
</p>
<ul>
<li>*NONE: There is no overriding transaction identifier to be used.
</li>
<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="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.PGMSTS"></a>
<h3>Status (PGMSTS)</h3>
<p>Indicates whether or not the program identifier can be used.
</p>
<p>Possible values are:
</p>
<ul>
<li>*ENABLED: This program identifier can be used.
</li>
<li><b>*DISABLED:</b> This program identifier cannot be used.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDCICSPPT.PGMLNG"></a>
<h3>Calling convention (PGMLNG)</h3>
<p>Enter the program language convention used to call the OS/400 program object. This determines how CICS passes parameters to the program object.
</p>
<ul>
<li>*COBOL: CICS uses the CICS COBOL calling convention to invoke the OS/400 program object
</li>
<li><b>*C:</b> CICS uses the CICS C calling convention to invoke the OS/400 program object
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDCICSPPT.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDCICSPPT.ERROR.MESSAGES">Error messages</a></h3>Unknown
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDCICSPPT.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>