611 lines
16 KiB
HTML
611 lines
16 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>Work with Problem (QPDWRKPB) 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. -->
|
|
<!-- QPDWRKPB SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
|
|
<!-- at RCHVMW2 on 2 Oct 1978 at 16:52:30 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited April 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>Work with Problem (QPDWRKPB) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<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%">Display panels</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Problem ID number</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Origin system</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Current problem status</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">Requested problem statuses</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Array of Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Number of requested problem statuses</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Service provider network identifier</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">Service provider control point name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">Problem severity</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</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>
|
|
Optional Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">11</td>
|
|
<td align="left" valign="top" width="50%">Note text</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="left" valign="top">Length of note text</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Work with Problem (QPDWRKPB) API uses a problem log entry to
|
|
analyze and prepare a machine-detected hardware problem for reporting.
|
|
Only local machine-detected problems that have an OPEN, READY, PREPARED,
|
|
or SENT status can be analyzed and prepared for reporting. Remote problems
|
|
that have an OPEN, READY, PREPARED, or SENT status can be prepared for
|
|
reporting but cannot be analyzed. This API does not analyze or prepare
|
|
user-detected problems.</p>
|
|
|
|
<p>If a machine-detected problem is analyzed, the problem analysis program
|
|
associated with the problem is called to generate a problem analysis list
|
|
identifying all the possible causes for the problem.</p>
|
|
|
|
<br>
|
|
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Display panels</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>Whether or not displays are shown during problem analysis. Valid values
|
|
are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NO</em></td>
|
|
<td align="left" valign="top">No displays are shown.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"></td>
|
|
<td align="left" valign="top"><strong>Note:</strong> During problem analysis, if
|
|
displays are usually shown for the type of hardware associated with the
|
|
problem, then the Point of Failure list is saved. This list is only saved
|
|
if no other list of causes currently associated with the problem
|
|
exists.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*YES</em></td>
|
|
<td align="left" valign="top">All displays are shown. This value is not allowed if the
|
|
API is called in a batch job.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Problem ID number</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The number the system generates to identify a problem.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Origin system</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The node name of the origin system (the format is <em>
|
|
network-ID.control-point-name</em>).</p>
|
|
</dd>
|
|
|
|
<dt><strong>Current problem status</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The current status of the problem. If the problem is found to be in a
|
|
status other than what is indicated, an error occurs. Valid values
|
|
are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*OPENED</em></td>
|
|
<td align="left" valign="top">The problem was identified and a problem
|
|
record was created.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*READY</em></td>
|
|
<td align="left" valign="top">Problem analysis information has been added to the
|
|
problem record.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*PREPARED</em></td>
|
|
<td align="left" valign="top">The problem has been prepared for reporting.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*SENT</em></td>
|
|
<td align="left" valign="top">The problem record was sent to a service provider, and
|
|
the information needed to correct the problem was not returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ANSWERED</em></td>
|
|
<td align="left" valign="top">The problem has been answered.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Requested problem statuses</strong></dt>
|
|
|
|
<dd>INPUT; ARRAY of CHAR(10)
|
|
|
|
<p>The requested status for the problem.</p>
|
|
|
|
<p>Valid values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*READY</em></td>
|
|
<td align="left" valign="top">Analyze the problem. Valid for local
|
|
machine-detected problems only.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*PREPARED</em></td>
|
|
<td align="left" valign="top">Prepare the problem for reporting. The service provider
|
|
network identifier, service provider control point name, and problem
|
|
severity parameters and the default contact database are used.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"></td>
|
|
<td align="left" valign="top"><strong>Note:</strong> If you select *READY and
|
|
*PREPARED, the final status is *PREPARED.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Number of requested problem statuses</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of statuses entered for requested problem statuses
|
|
parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Service provider network identifier</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The network identifier of the service provider system where the problem
|
|
is to be sent.</p>
|
|
|
|
<p>Valid values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NETATR</em></td>
|
|
<td align="left" valign="top">The network identifier of this system. Use
|
|
*NETATR if the control point name is *IBMSRV.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Service provider control point name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The control point name of the service provider system where the problem
|
|
is to be sent.</p>
|
|
|
|
<p>Valid values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*IBMSRV</em></td>
|
|
<td align="left" valign="top">IBM service support. This value cannot be
|
|
used if the problem has an *OPENED status unless you also have a requested
|
|
problem status of *READY.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Name</em></td>
|
|
<td align="left" valign="top">The control point name.</td>
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Problem severity</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The severity of the problem.</p>
|
|
|
|
<p>Valid values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">A high severity level in which there is a
|
|
critical affect on operations. A severity 1 problem requires a service
|
|
representative at the site, and the person solving the problem must work
|
|
on the problem 24 hours a day until the problem is solved or circumvented.
|
|
If the problem needs more information, patching, or the problem must be
|
|
created again on the failing system, a service representative must be
|
|
available to do these tasks immediately. It is not a severity 1 if these
|
|
and any other tasks cannot be performed immediately.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">A medium severity level in which you are able to use the
|
|
system, but your operations are severely restricted by the problem.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">A low severity level in which you are able to continue
|
|
operations with some restrictions. The restrictions do not have a critical
|
|
effect on your operations.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">The severity level is minimal because the problem causes
|
|
little or no effect to your operation, or you have found a way to
|
|
circumvent the problem.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</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>Optional Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Note text</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The field used to include a note stating that a problem originated with
|
|
the service director. The note will be included when the API is
|
|
called.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of note text</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the text for the note text field. The text field for the
|
|
note text field can be up to 80 characters long.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="80%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C90 E</td>
|
|
<td width="85%" 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">CPF3CF2 E</td>
|
|
<td align="left" valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7AA7 E</td>
|
|
<td align="left" valign="top">Problem &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7A9C E</td>
|
|
<td align="left" valign="top">Cannot work with the problem log at this time.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7A9D E</td>
|
|
<td align="left" valign="top">Problem log object &1 is missing.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7A93 E</td>
|
|
<td align="left" valign="top">Problem &2 currently in use by job &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF8C09 E</td>
|
|
<td align="left" valign="top">&1 not defined as a service provider.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF8C24 E</td>
|
|
<td align="left" valign="top">Error occurred while processing request.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF8C87 E</td>
|
|
<td align="left" valign="top">Service provider &1.&2 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9308 E</td>
|
|
<td align="left" valign="top">Unable to complete problem analysis. Reason code
|
|
&1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF931C E</td>
|
|
<td align="left" valign="top">Problem analysis results not recorded in problem
|
|
log.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9310 E</td>
|
|
<td align="left" valign="top">Problem analysis procedure was exited before it had
|
|
completed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9313 E</td>
|
|
<td align="left" valign="top">Requested procedure is not allowed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF932A E</td>
|
|
<td align="left" valign="top">Number of requested statuses is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF932B E</td>
|
|
<td align="left" valign="top">*IBMSRV not allowed as service provider for problems in
|
|
OPENED status.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9320 E</td>
|
|
<td align="left" valign="top">&1 to display panels is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9321 E</td>
|
|
<td align="left" valign="top">Panels cannot be displayed in a batch job.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9322 E</td>
|
|
<td align="left" valign="top">Current status &3 does not match problem status
|
|
&4.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9323 E</td>
|
|
<td align="left" valign="top">Current status &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9324 E</td>
|
|
<td align="left" valign="top">Problems on a remote system cannot be analyzed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9325 E</td>
|
|
<td align="left" valign="top">Problem &1 has a status that is not allowed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9326 E</td>
|
|
<td align="left" valign="top">Problem selected not allowed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9327 E</td>
|
|
<td align="left" valign="top">Problem analysis procedure was exited before it had
|
|
completed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9328 E</td>
|
|
<td align="left" valign="top">Severity &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9329 E</td>
|
|
<td align="left" valign="top">Requested status &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7845 E</td>
|
|
<td align="left" valign="top">Error occurred while opening file &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7846 E</td>
|
|
<td align="left" valign="top">Error while processing file &1 in library
|
|
&2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7847 E</td>
|
|
<td align="left" valign="top">Error occurred while closing file &1 in library
|
|
&2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7872 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: V2R2
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#top_of_page">Top</a> | <a href=
|
|
"pm1.htm">Problem Management API list</a><br>
|
|
<a href=
|
|
"aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|