350 lines
9.9 KiB
HTML
350 lines
9.9 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>Generate Alert (QALGENA) API</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. -->
|
||
|
|
<!-- COMM4 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB at -->
|
||
|
|
<!-- RCHVMW2 on 1 Jun 1999 at 17:32:50 -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!--File Edited December, 2001 =========================================== -->
|
||
|
|
<!--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>Generate Alert (QALGENA) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 65%;">
|
||
|
|
<br>
|
||
|
|
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="50%">Receiver variable</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Length of receiver variable</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">Size of alert</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Qualified alert table (message file) name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(20)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Message ID</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(7)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">Message data</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">Length of message data</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">Error code</td>
|
||
|
|
<td align="left" valign="top">I/O</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Generate Alert (QALGENA) API, an alert API, creates an alert for a
|
||
|
|
particular message ID. The alert is then returned to the calling program.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Alert Table Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*USE</dd>
|
||
|
|
|
||
|
|
<dt><em>Message File Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*READ</dd>
|
||
|
|
|
||
|
|
<dt><em>Library Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*USE</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Receiver variable (alert major vector)</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The variable that receives the generated alert, in the format of an SNA
|
||
|
|
alert major vector. This area must be large enough to hold the alert. If the
|
||
|
|
area is too small, the alert is not returned. A suggested size is 512 bytes
|
||
|
|
because alerts cannot exceed 512 bytes for the i5/OS licensed program.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the receiver variable parameter. If this is too small, no data
|
||
|
|
is returned, and the API ends with an exception.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Size of alert</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The size of the successfully generated alerts. If the size of the alert is
|
||
|
|
smaller than the length of receiver variable, the alert is returned in the
|
||
|
|
receiver variable. If the size of the alert is greater than the length of
|
||
|
|
receiver variable, the alert is not returned.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Qualified alert table (message file) name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(20)
|
||
|
|
|
||
|
|
<p>The name of the alert table where the alert description defining the alert
|
||
|
|
is stored, and the name of the library in which it resides. This parameter also
|
||
|
|
identifies the name of the message file to use because the alert table and
|
||
|
|
message file must have the same name.</p>
|
||
|
|
|
||
|
|
<p>The first 10 characters contain the alert table name, and the second 10
|
||
|
|
characters contain the name of the library.</p>
|
||
|
|
|
||
|
|
<p>Valid values for the library name are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
||
|
|
<td valign="top">The job's current library. The alert table and message file
|
||
|
|
must both be in this library.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
||
|
|
<td valign="top">The library list. The alert table and message file can be in
|
||
|
|
different libraries, but the libraries must both be in the library list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" nowrap><em>Specific library</em></td>
|
||
|
|
<td valign="top">The alert table and message file must be in the same
|
||
|
|
library.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Message ID</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(7)
|
||
|
|
|
||
|
|
<p>The message ID of the alert description defining the alert. This parameter
|
||
|
|
also identifies the message ID of the corresponding message description. The
|
||
|
|
message does not need to be an alertable message. The ALROPT parameter of the
|
||
|
|
Display Message Description (DSPMSGD) command is ignored and an alert is always
|
||
|
|
returned, provided that an alert description with the given message ID exists
|
||
|
|
in the given alert table.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Message data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The message data to use for message substitution on the alert description
|
||
|
|
and message description. The format of the message data is the same as used for
|
||
|
|
the Send Program Message (SNDPGMMSG) command and the Send Program Message
|
||
|
|
(QMHSNDPM) API. See the <a href="../rbam6/clpro.htm">CL Programming</a> topic for more
|
||
|
|
information about message data in general and the online help for details about
|
||
|
|
the SNDPGMMSG command.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of message data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the message data provided by the message data parameter
|
||
|
|
above.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; CHAR(*)
|
||
|
|
|
||
|
|
<p>The structure in which to return error information. For the format of the
|
||
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Handling</h3>
|
||
|
|
|
||
|
|
<p>Some of the QALGENA API errors allow an alert to be returned to the
|
||
|
|
application. An alert is returned to the application in these cases:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The user is not authorized to the message file.</li>
|
||
|
|
|
||
|
|
<li>A message cannot be added to the alert because the message or message file
|
||
|
|
cannot be found.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>No alert is returned to the application in these cases:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The user is not authorized to the alert table.<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>i5/OS alert support cannot build an alert because no message ID is given,
|
||
|
|
the alert table is missing or damaged, or no alert description is found. In
|
||
|
|
this case, the alert generated could only be a cause-undetermined alert of
|
||
|
|
little or no value.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="3">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
||
|
|
<td align="left" valign="top">Severe error while addressing parameter
|
||
|
|
list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
||
|
|
<td align="left" valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
||
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF7B01 E</td>
|
||
|
|
<td align="left" valign="top">Receiver variable too small to hold alert.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF7B02 E</td>
|
||
|
|
<td align="left" valign="top">Message ID not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF7B03 E</td>
|
||
|
|
<td align="left" valign="top">Alert table &2/&1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF7B04 E</td>
|
||
|
|
<td align="left" valign="top">Alert description &1 not found in alert table
|
||
|
|
&4/&3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF7B05 E</td>
|
||
|
|
<td align="left" valign="top">Message file &2/&1 not available for
|
||
|
|
alert processing.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF7B06 E</td>
|
||
|
|
<td align="left" valign="top">Message &1 not found in message file
|
||
|
|
&4/&3 for alert processing.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF7B10 E</td>
|
||
|
|
<td align="left" valign="top">Length parameter &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9802 E</td>
|
||
|
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9872 E</td>
|
||
|
|
<td align="left" valign="top">Program or service program &1 in library
|
||
|
|
&2 ended. Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V2R1
|
||
|
|
|
||
|
|
<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=
|
||
|
|
"netmg.htm">Network Management APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|