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

164 lines
7.6 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>Reclaim Activation Group (RCLACTGRP)</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="RCLACTGRP.Top_Of_Page"></a>
<h2>Reclaim Activation Group (RCLACTGRP)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#RCLACTGRP.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RCLACTGRP.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RCLACTGRP.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RCLACTGRP"></a>
<p>The Reclaim Activation Group (RCLACTGRP) command deletes a specified activation group and frees the resources that are scoped to it. It does not reclaim resources scoped to the job or scoped to the default activation group. This command is normally used only in the controlling program of the application.
</p>
<p>An activation group is eligible to be reclaimed if it meets the following criteria:
</p>
<ul>
<li>The activation group is not the default activation group.
<p>The default activation group cannot be reclaimed.
</p>
</li>
<li>The activation group is not active.
<p>An activation group cannot be reclaimed if there are programs or procedures running within the activation group.
</p>
</li>
<li>The activation group is not one of the debug activation groups.
<p>When the job is in debug mode, the activation groups in use do not appear as active on the Call Stack or Display Activation Group displays.
</p>
</li>
<li>The activation group is not a shared activation group.
<p>A shared activation group cannot be reclaimed because it may be in use by another job.
</p>
</li>
</ul>
<p>When an activation group is reclaimed, all resources within the scope of the activation group are reclaimed. Resources within the scope of the activation group include static storage for programs in the activation group, open files, user interface manager (UIM) application resources, Common Programming Interface (CPI) Communications conversations, hierarchical file systems (HFS) resources, user-defined communications sessions, and pending changes for the commitment definition.
</p>
<p>A close option can be specified on this command, and is used when closing mixed, communications, binary synchronous (BSC), and intersystem communications function (ICF) files. If an activation group level commitment definition has been started for the activation group, and it has pending committable changes, the close option also indicates whether the system implicitly commits or rolls back the pending changes before ending the commitment definition. When specifying a close option of *NORMAL, and there are no errors when closing files using the activation group level commitment definition, a commit is performed. Otherwise, a rollback is performed. See the Backup and Recovery book, SC41-5304 book for information on how the system performs the rollback operation under commitment control.
</p>
<p>An activation group should only be reclaimed if it will never be needed again within the same job. Otherwise, errors and unpredictable results may occur if other programs later attempt to access the resources that were reclaimed. Therefore, this command should normally only be used in the controlling program of an application. Specifying ACTGRP(*ELIGIBLE) requires full knowledge of the job environment. Otherwise, unpredicable results can occur.
</p>
<p>For more information on the appropriate use of this command, see the IBM System Manager for i5/OS.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>This command is not threadsafe. This command fails in a job that allows multiple threads.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLACTGRP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RCLACTGRP.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="#RCLACTGRP.ACTGRP"><b>ACTGRP</b></a></td>
<td valign="top">Activation group</td>
<td valign="top"><i>Name</i>, *ELIGIBLE</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#RCLACTGRP.OPTION"><b>OPTION</b></a></td>
<td valign="top">Close option</td>
<td valign="top"><b><u>*NORMAL</u></b>, *ABNORMAL</td>
<td valign="top">Optional, Positional 2</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RCLACTGRP.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RCLACTGRP.ACTGRP"></a>
<h3>Activation group (ACTGRP)</h3>
<p>Specifies the activation group to be reclaimed.
</p>
<dl>
<dt><b>*ELIGIBLE</b></dt>
<dd>All eligible activation groups within the job are deleted.
</dd>
<dt><b><i>activation-group-name</i></b></dt>
<dd>Specify the activation group to be reclaimed. The activation group can only be reclaimed if it has no active calls. If active calls exist, a message is displayed informing the user that the request failed. If the activation group is not found, a message is displayed informing the user that the request failed because the activation group was not found.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLACTGRP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RCLACTGRP.OPTION"></a>
<h3>Close option (OPTION)</h3>
<p>Specifies whether to commit or roll back pending changes for an activation group level commitment definition, and whether a normal or abnormal close notification is sent to the attached host system when mixed, communications, BSC, and ICF files are closed. This parameter is ignored for all other files and objects within the scope of the activation group.
</p>
<dl>
<dt><b><u>*NORMAL</u></b></dt>
<dd>The changes pending for an activation group level commitment definition are committed (if there are no errors when closing files using the commitment definition), and a normal close notification is sent to the attached host system when mixed, communications, BSC, and ICF files are closed.
</dd>
<dt><b>*ABNORMAL</b></dt>
<dd>The changes pending for an activation group level commitment definition are rolled back and an abnormal close notification is sent to the attached host system when mixed, communications, BSC, and ICF files are closed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLACTGRP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RCLACTGRP.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
RCLACTGRP ACTGRP(MYGROUP)
</pre>
</p>
<p>This command reclaims the activation group MYGROUP.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLACTGRP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RCLACTGRP.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF1653</b></dt>
<dd>Activation group &amp;1 not found.
</dd>
<dt><b>CPF1654</b></dt>
<dd>Activation group &amp;1 cannot be deleted.
</dd>
<dt><b>CPF180C</b></dt>
<dd>Function &amp;1 not allowed.
</dd>
<dt><b>CPF1892</b></dt>
<dd>Function &amp;1 not allowed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RCLACTGRP.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>