ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/sm1notification.htm

351 lines
8.3 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">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Notification Exit Program</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Notification Exit Program</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="40%">Change request</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="30%">CHAR(10)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Sequence number</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">BINARY(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Activity</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Activity type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Transport type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Change management verb</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Global name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(64)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Destinations</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Array of CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">Number of destinations</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Array of BINARY(4)</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="left" valign="top">User profile</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="left" valign="top">Activity results</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">BINARY(4)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Exit point name: QIBM_QNS_SDDSTNTFY<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Exit point format name: NTFY0100<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Notification exit program notifies a user program of a change
management activity result.</p>
<p>The exit program is registered using the Add Exit Program (QUSADDEP) API and
using QIBM_QNS_SDDSTNTFY as the exit point name, with format NTFY0100.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Change request</strong></dt>
<dd>INPUT; CHAR(10)<br>
Change request name<br>
<br>
</dd>
<dt><strong>Sequence number</strong></dt>
<dd>INPUT; BINARY(4)<br>
Sequence number of the change request<br>
<br>
</dd>
<dt><strong>Activity</strong></dt>
<dd>INPUT; CHAR(10)<br>
Activity name<br>
<br>
</dd>
<dt><strong>Activity type</strong></dt>
<dd>INPUT; CHAR(10)<br>
The type of activity that is being performed; for example, *OBJ or *PTF.<br>
<br>
</dd>
<dt><strong>Transport type</strong></dt>
<dd>INPUT; CHAR(10)<br>
The method by which the object or request is sent to the managed system.<br>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Value</th>
<th align="left" valign="top">Description</th>
</tr>
<tr>
<td align="left" valign="top"><em>*SVDS</em></td>
<td align="left" valign="top">SNA/Distribution Services, queue type = *SVDS, is
used to send the object or request when distributing using Change
Management.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SNADS</em></td>
<td align="left" valign="top">SNA/Distribution Services, queue type = *SNADS,
is used to send the object or request when distributing using the Object
Distribution Facility (ODF).</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Change management verb</strong></dt>
<dd>INPUT; CHAR(10)<br>
The function to be performed by the managed system.<br>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Value</th>
<th align="left" valign="top">Description</th>
</tr>
<tr>
<td align="left" valign="top"><em>*ACC</em></td>
<td align="left" valign="top">Accept</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ACT</em></td>
<td align="left" valign="top">Activate</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DLT</em></td>
<td align="left" valign="top">Delete</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INI</em></td>
<td align="left" valign="top">Initiate</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INS</em></td>
<td align="left" valign="top">Install</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RMV</em></td>
<td align="left" valign="top">Remove</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RTV</em></td>
<td align="left" valign="top">Retrieve</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SND</em></td>
<td align="left" valign="top">Send</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SNDINI</em></td>
<td align="left" valign="top">Send and initiate</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SNDINS</em></td>
<td align="left" valign="top">Send and install</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Global name</strong></dt>
<dd>INPUT; CHAR(64)<br>
The global name of the object that is to be manipulated.<br>
<br>
</dd>
<dt><strong>Destinations</strong></dt>
<dd>INPUT; Array of CHAR(*)<br>
The destinations for the request. If the transport type is *SVDS or SNADS, each
destination element has the following format:<br>
<table cellpadding="3">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>APPN Network ID</em></td>
<td align="left" valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="left" valign="top"><em>APPN Control point name</em></td>
<td align="left" valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="left" valign="top"><em>Reserved</em></td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Number of destinations</strong></dt>
<dd>INPUT; BINARY(4)<br>
The number of destinations for the distribution request.<br>
<br>
</dd>
<dt><strong>User profile</strong></dt>
<dd>INPUT; CHAR(10)<br>
The user profile for which the distribution is being performed.<br>
<br>
</dd>
<dt><strong>Activity result</strong></dt>
<dd>OUTPUT; Array of CHAR(4)<br>
The end status for each destination node. It indicates whether the change
management activity completed successfully.<br>
<br>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Successful</td>
</tr>
<tr>
<td align="left" valign="top"><em>0-9</em></td>
<td align="left" valign="top">Successful with warnings</td>
</tr>
<tr>
<td align="left" valign="top"><em>10-89</em></td>
<td align="left" valign="top">Failed</td>
</tr>
<tr>
<td align="left" valign="top"><em>90-99</em></td>
<td align="left" valign="top">Did not run due to conditions or schedules</td>
</tr>
</table>
</dd>
</dl>
<br>
<h3>Usage Notes:</h3>
<p>Since activities may complete at different times for different nodes, this
exit program may be called many times for different nodes.</p>
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="sm1.htm">SM1 Exit Programs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>