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

167 lines
6.4 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>End CICS User (ENDCICSUSR)</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="ENDCICSUSR.Top_Of_Page"></a>
<h2>End CICS User (ENDCICSUSR)</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="#ENDCICSUSR.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ENDCICSUSR.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ENDCICSUSR.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ENDCICSUSR"></a>
<p>The end CICS user (ENDCICSUSR) command shuts down a CICS shell and specifies what happens to active work being processed by that CICS shell.
</p>
<p>Only the OS/400 job associated with the CICS shell is ended; the underlying OS/400 job will still be active. As an example, if an OS/400 user issued the STRCICSUSR command from the main menu, and then issued ENDCICSUSR from another OS/400 session, the OS/400 session that was used to issue the STRCICSUSR would be returned to the main menu.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDCICSUSR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ENDCICSUSR.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" rowspan="4"><a href="#ENDCICSUSR.JOB"><b>JOB</b></a></td>
<td valign="top">Job name</td>
<td valign="top"><i>Qualified job name</i></td>
<td valign="top" rowspan="4">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Job name</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: User</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 3: Number</td>
<td valign="top">000000-999999</td>
</tr><tr>
<td valign="top"><a href="#ENDCICSUSR.CTLRGN"><b>CTLRGN</b></a></td>
<td valign="top">Control region</td>
<td valign="top"><i>Communications name</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ENDCICSUSR.OPTION"><b>OPTION</b></a></td>
<td valign="top">How to end</td>
<td valign="top"><b><u>*CNTRLD</u></b>, *IMMED</td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#ENDCICSUSR.DELAY"><b>DELAY</b></a></td>
<td valign="top">Delay time, if *CNTRLD</td>
<td valign="top">1-99999, <b><u>30</u></b></td>
<td valign="top">Optional, Positional 4</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ENDCICSUSR.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ENDCICSUSR.JOB"></a>
<h3>Job name (JOB)</h3>
<p>The name of the OS/400 job associated with the CICS shell that is to be shut down. If no CICS shell job qualifier is given, all of the OS/400 jobs currently in the OS/400 are searched for the simple OS/400 job name. If more than one of the specified OS/400 job names is found, a message is issued and a qualified OS/400 job name must be specified.
</p>
<p>The possible JOB values are:
</p>
<ul>
<ul>
<li><b>job-name:</b> The name of the OS/400 job associated with the CICS shell that is to be shut down.
</li>
<li><b>user-name:</b> The name of the OS/400 user associated with the CICS shell that is to be shut down.
</li>
<li><b>job-number:</b> The number of the OS/400 job that is associated with the CICS shell that is to be shut down.
</li>
</ul>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDCICSUSR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDCICSUSR.CTLRGN"></a>
<h3>Control region (CTLRGN)</h3>
<p>The name of the CICS control region associated with the CICS shell. The name of the control region is also known as the CICS system ID.
</p>
<ul>
<li><b>control-region:</b> The length is four characters. The first character must be alphabetic, or one of the special characters, $, @, or #. The remaining characters can be alphanumeric or $, @, or #.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDCICSUSR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDCICSUSR.OPTION"></a>
<h3>How to end (OPTION)</h3>
<p>Identifies the method used to shut down the CICS shell.
</p>
<p>The possible OPTION values are:
</p>
<ul>
<li>*CNTRLD: The CICS shell will be shut down if it is idle or when the CICS transaction that is currently being executed is completed.
</li>
<li>*IMMED: The CICS shell is shut down immediately. Any CICS transaction that is being executed is not allowed to perform any cleanup. This option might cause undesirable results and, therefore, should be used only after a controlled shutdown has been unsuccessful.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDCICSUSR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDCICSUSR.DELAY"></a>
<h3>Delay time, if *CNTRLD (DELAY)</h3>
<p>Indicates the amount of time (in seconds) that is allowed to complete the controlled CICS shell shutdown. If this amount of time is exceeded and the CICS shell shutdown is not complete, the CICS shell is shut down immediately.
</p>
<ul>
<li><b>time-delay:</b> Valid values are in the range 1 through 99999.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDCICSUSR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ENDCICSUSR.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDCICSUSR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ENDCICSUSR.ERROR.MESSAGES">Error messages</a></h3>Unknown
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDCICSUSR.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>