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

1850 lines
58 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>
<!-- Begin Header records -->
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Control PTF Order (QESCPTFO) API</title>
<!-- 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. -->
<!-- Created for V5R3 on 050222 by STL -->
<!-- Change history: -->
<!-- YYMMDD INITIALS change description -->
<!-- 050222 STL New API documentation -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2><img src="delta.gif" alt="Start of change">Control PTF Order (QESCPTFO) API</h2>
<div class="box" style="width: 90%;">
<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="50%">PTF order information</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">2</td>
<td align="left" valign="top">Length of PTF order information</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">Format of PTF order information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="left" valign="top" width="50%">Contact information</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">5</td>
<td align="left" valign="top">Length of contact information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Format of contact information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Receiver variable</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">8</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">9</td>
<td align="left" valign="top">Format of receiver variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</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>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No;<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>Control PTF Order (QESCPTFO) API</strong> allows you
to prepare an order for:</p>
<ul>
<li>Individual PTFs</li>
<li>Cumulative PTF package</li>
<li>PTF Group</li>
<li>Summary information for available PTFs</li>
<li>Preventive Service Planning (PSP) information</li>
</ul>
<p>This API is restricted to be used for PTFs for V5R3M0 and above.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Data Queue Authority</em></dt>
<dd>*OBJOPR and *ADD<br><br></dd>
<dt><em>Data Queue Library Authority</em></dt>
<dd>*EXECUTE<br><br></dd>
<dt><em>Directory Authority</em></dt>
<dd>Authority to the path and file are determined by the open() API. For
details, see the Authorities section of the <a href="open.htm">open()</a>--Open
File API for files opened with an access mode of O_WRONLY and O_TRUNC.</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>PTF order information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The information of the PTF order.
The format of this information depends on the specified Format of PTF order information.</p>
</dd>
<dt><strong>Length of PTF order information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The size of the PTF order information variable</p>
</dd>
<dt><strong> Format of PTF order information</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the PTF order information specified. You must use one of the following format names:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em><a href="#ptfo0100">PTFO0100</a></em></td>
<td align="left" valign="top">Process PTF order. The information of the PTF order is described
by <a href="#ptfo0100">PTFO0100 Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#ptfo0200">PTFO0200</a></em></td>
<td align="left" valign="top">Resume PTF order. The information of the PTF order is described
by <a href="#ptfo0200">PTFO0200 Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#ptfo0300">PTFO0300</a></em></td>
<td align="left" valign="top">Cancel PTF order. The information of the PTF order is described
by <a href="#ptfo0300">PTFO0300 Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Contact information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The contact information to be used by your service representative to contact
you or send you service information.
The format of this information depends on the specified Format of contact information.</p>
</dd>
<dt><strong>Length of contact information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The size of the contact information variable. If zero is specified, the existing contact
information in the system is passed to the service provider. Zero can only be specified
when <em>CNTC0000</em> is specified for the format of contact information.</p>
</dd>
<dt><strong> Format of contact information</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the contact information specified. You must use one of the following format names:</p>
<table cellpadding="5" width="80%">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>CNTC0000</em></td>
<td align="left" valign="top">No contact information is provided. The existing contact
information in the system is passed to the service provider. Length of contact information parameter
should be set to zero.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#cntc0100">CNTC0100</a></em></td>
<td align="left" valign="top">The contact information is described
by <a href="#cntc0100">CNTC0100 Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The variable that is to receive the actual list of PTFs delivered.
The format of this information depends on the specified Format of receiver variable.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The size of the receiver variable. If the receiver variable is
not large enough to hold the complete list of PTFs delivered,
the returned list is truncated. </p>
</dd>
<dt><strong> Format of receiver variable</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the returned information. You must use one of the following format names:</p>
<table cellpadding="5" width="50%">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em><a href="#ptfd0100">PTFD0100</a></em></td>
<td align="left" valign="top">The information returned is described
by <a href="#ptfd0100">PTFD0100 Format</a>.</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><a name="ptfo0100">PTFO0100 Format</a></h3>
<p>The following information is to be passed on PTF order information parameter
to process a new PTF order.
For a detailed description of each field, see <a href="#flddsc">Field
Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Length of fixed size order information</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to PTFs ordered</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of PTFs ordered</td>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of PTFs ordered entry</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum order size</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">PTF parts to order</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Delivery method</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Delivery format</td>
</tr>
<tr>
<td align="center" valign="top">50</td>
<td align="center" valign="top">32</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Requisites</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Reorder</td>
</tr>
<tr>
<td align="center" valign="top">70</td>
<td align="center" valign="top">46</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Check</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to image directory</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="center" valign="top">54</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of image directory</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="center" valign="top">58</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Image prefix</td>
</tr>
<tr>
<td align="center" valign="top">98</td>
<td align="center" valign="top">62</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Name of status data queue</td>
</tr>
<tr>
<td align="center" valign="top">108</td>
<td align="center" valign="top">6C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library of status data queue</td>
</tr>
<tr>
<td align="center" valign="top">118</td>
<td align="center" valign="top">76</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Update interval</td>
</tr>
<tr>
<td align="center" valign="top">124</td>
<td align="center" valign="top">7C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Wait time for order completion</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Image directory</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="3" width="20%" colspan="2">These fields
repeat for each PTF ordered.</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">PTF identifier ordered</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Product</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Release</td>
</tr>
</table>
<br>
<h3><a name="ptfo0200">PTFO0200 Format</a></h3>
<p>The following information is to be passed on PTF order information parameter
when resuming a PTF order. For
a detailed description of each field, see <a href="#flddsc">Field
Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(31)</td>
<td align="left" valign="top" width="60%">Order identifier</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="center" valign="top">1F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Wait time for order completion</td>
</tr>
</table>
<br>
<h3><a name="ptfo0300">PTFO0300 Format</a></h3>
<p>The following information is to be passed on PTF order information parameter
when cancelling a PTF order. For
a detailed description of each field, see <a href="#flddsc">Field
Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(31)</td>
<td align="left" valign="top" width="60%">Order identifier</td>
</tr>
</table>
<br>
<h3><a name="cntc0100">CNTC0100 Format</a></h3>
<p>Use this format to include contact information on the PTF order.
For detailed descriptions of the fields in this table,
see <a href="#flddsc">Field Descriptions</a></p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(36)</td>
<td align="left" valign="top" width="60%">Company name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">36</td>
<td align="center" valign="top" width="10%">24</td>
<td align="left" valign="top" width="20%">CHAR(36)</td>
<td align="left" valign="top" width="60%">Contact name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">72</td>
<td align="center" valign="top" width="10%">48</td>
<td align="left" valign="top" width="20%">CHAR(20)</td>
<td align="left" valign="top" width="60%">Primary telephone number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">92</td>
<td align="center" valign="top" width="10%">5C</td>
<td align="left" valign="top" width="20%">CHAR(20)</td>
<td align="left" valign="top" width="60%">Help Desk or Pager number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">112</td>
<td align="center" valign="top" width="10%">70</td>
<td align="left" valign="top" width="20%">CHAR(20)</td>
<td align="left" valign="top" width="60%">Primary fax number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">132</td>
<td align="center" valign="top" width="10%">84</td>
<td align="left" valign="top" width="20%">CHAR(20)</td>
<td align="left" valign="top" width="60%">Alternative Fax number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">152</td>
<td align="center" valign="top" width="10%">98</td>
<td align="left" valign="top" width="20%">CHAR(36)</td>
<td align="left" valign="top" width="60%">Street address line 1</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">188</td>
<td align="center" valign="top" width="10%">BC</td>
<td align="left" valign="top" width="20%">CHAR(36)</td>
<td align="left" valign="top" width="60%">Street address line 2</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">224</td>
<td align="center" valign="top" width="10%">E0</td>
<td align="left" valign="top" width="20%">CHAR(36)</td>
<td align="left" valign="top" width="60%">Street address line 3</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">260</td>
<td align="center" valign="top" width="10%">104</td>
<td align="left" valign="top" width="20%">CHAR(36)</td>
<td align="left" valign="top" width="60%">City or locality</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">296</td>
<td align="center" valign="top" width="10%">128</td>
<td align="left" valign="top" width="20%">CHAR(36)</td>
<td align="left" valign="top" width="60%">State or province</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">332</td>
<td align="center" valign="top" width="10%">14C</td>
<td align="left" valign="top" width="20%">CHAR(20)</td>
<td align="left" valign="top" width="60%">Country or region</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">352</td>
<td align="center" valign="top" width="10%">160</td>
<td align="left" valign="top" width="20%">CHAR(12)</td>
<td align="left" valign="top" width="60%">Postal code</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">364</td>
<td align="center" valign="top" width="10%">16C</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to primary electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">368</td>
<td align="center" valign="top" width="10%">170</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Length of primary electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">372</td>
<td align="center" valign="top" width="10%">174</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to alternative electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">376</td>
<td align="center" valign="top" width="10%">178</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Length of alternative electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">380</td>
<td align="center" valign="top" width="10%">17C</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Media for mailing PTFs</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">384</td>
<td align="center" valign="top" width="10%">180</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">National language version</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Primary electronic mail address</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Alternative electronic mail address</td>
</tr>
</table>
<br>
<h3><a name="ptfd0100">PTFD0100 Format</a></h3>
<p>The following information is to be returned in the receiver variable
on a process order request or on a resume order request.
For a detailed description of each field, see <a href="#flddsc">Field
Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(31)</td>
<td align="left" valign="top">Order identifier</td>
</tr>
<tr>
<td align="center" valign="top">39</td>
<td align="center" valign="top">27</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Delivery mode</td>
</tr>
<tr>
<td align="center" valign="top">49</td>
<td align="center" valign="top">31</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to PTFs being delivered</td>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of PTFs being delivered</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of PTF being delivered entry</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Order preparation time</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Order status</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="3" width="20%" colspan="2">These fields
repeat for each PTF being delivered.</td>
<td align="left" valign="top" width="20%">CHAR(7)</td>
<td align="left" valign="top" width="60%">PTF identifier sent</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Product</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Release</td>
</tr>
</table>
<br>
<h3><a name="flddsc">Field Descriptions</a></h3>
<p><strong>Alternative electronic mail address.</strong> The electronic mail (e-mail)
address for the contact person,
if the primary electronic mail address is not available.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The alternative electronic mail address in the contact
information of the system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No alternative e-mail address is provided for the contact person.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the alternative e-mail address of the contact person. For example, 'john.brown@mycompany.com'.</td>
</tr>
</table>
<p><strong>Alternative Fax number.</strong> The complete telephone number where information for the
contact can be faxed,
if the primary fax number is not available. This number should include the area code,
exchange numbers, and the extension.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The alternative fax number in the contact information of the
system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no alternative fax number for the contact person.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the alternative fax number.</td>
</tr>
</table>
<p><strong>Bytes available.</strong> The number of bytes of data available to be returned.
All available data is returned if enough space is provided.</p>
<p><strong>Bytes returned.</strong> The number of bytes of data returned.</p>
<p><strong>Check.</strong> Indicates whether checking is performed on the service
requester system
to determine if PTFs are ordered based on whether or not the PTF product
is installed or supported. Possible values are:</p>
<table cellpadding="5" width="80%">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">The PTFs specified on the PTF order list parameter are
ordered even when the PTF product is not installed or supported on the service requester.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">The PTFs specified on the PTF order list parameter are
ordered only if the PTF product is installed or supported on the service requester.</td>
</tr>
</table>
<dl>
<dd>
<p><strong>Note:</strong> <em>*NO</em> must be specified when <em>*CVRLTR</em> is
specified for PTF parts to order.</p>
</dd>
</dl>
<p><strong>City or locality.</strong> The city or locality name for the location to which you
want your service provider to send parts or assistance.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The city or locality in the contact information of the system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the city or locality.</td>
</tr>
</table>
<p><strong>Company name.</strong> The name of the organization that owns or is responsible for this system.
The name should appear in this field as it appears on a mailing label.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The company name in the contact information of the system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the company name.</td>
</tr>
</table>
<p><strong>Contact name.</strong> The name of the person in your organization who is responsible
for repairs and maintenance on the system. This person may be called by the service provider with information or assistance for a system problem. Also, parts or PTFs may be sent to this person.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The contact name in the contact information of the system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the contact person's name.</td>
</tr>
</table>
<p><strong>Country or region.</strong> The country or region where the company is located to which
the service provider should send parts or assistance.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The country or region in the contact information of the system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the country or region.</td>
</tr>
</table>
<p><strong>Delivery format.</strong> Specifies the format the PTFs are stored. Possible values are:</p>
<table cellpadding="5" width="80%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAVF</em></td>
<td align="left" valign="top"> PTFs are delivered electronically as save files. </td>
</tr>
<tr>
<td align="left" valign="top"><em>*IMAGE</em></td>
<td align="left" valign="top">PTFs are delivered electronically as virtual optical image files.
The optical image files will contain PTFs and cover letters.
The optical image files will be stored in the directory specified in the image directory field.</td>
</tr>
</table>
<p><strong>Delivery method.</strong> Specifies how the PTFs are delivered. Possible values are:</p>
<table cellpadding="5" width="80%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LINKONLY</em></td>
<td align="left" valign="top"> PTFs are delivered electronically only.
If the order size exceeds the value specified in the maximum order size field,
the API will fail.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">PTFs are delivered by any available method. The service link is
used for most PTFs.
PTFs that are too large for the service link are sent on the selected medium
on the media for mailing PTFs field.</td>
</tr>
</table>
<p><strong>Delivery mode.</strong> Specifies how the PTFs were delivered. Possible values are:</p>
<table cellpadding="5" width="80%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAVF</em></td>
<td align="left" valign="top"> PTFs were delivered electronically as save file objects. </td>
</tr>
<tr>
<td align="left" valign="top"><em>*MEDIA</em></td>
<td align="left" valign="top">PTFs were sent on the selected medium.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*IMAGE</em></td>
<td align="left" valign="top">PTFs were delivered electronically inside an optical image.
The optical image contains the save file object and the cover letter for each PTF.
The optical image is stored in the directory specified by image directory field. </td>
</tr>
</table>
<p><strong>Help desk or pager number.</strong> The complete Help desk or pager number.
This number should include the area code, exchange numbers, and the extension.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The help desk or pager number in the contact information of
the system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no Help desk telephone number.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the Help desk telephone number.</td>
</tr>
</table>
<p><strong>Image directory.</strong> The path name of the directory where optical image files will be saved.
For more information on specifying path names, refer to &quot;Object naming rules&quot;
in &quot;CL concepts and reference&quot;
in the CL reference information in the iSeries Information Center at http://www.iseries.ibm.com/infocenter.
The following special value is accepted: </p>
<table cellpadding="5" width="60%">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*DFT</em></td>
<td align="left" valign="top">The optical image files are stored in /QIBM/UserData/OS/Service/ECS
directory.</td>
</tr>
</table>
<p><strong>Image prefix.</strong> The prefix for the optical image file names.
If multiple images are received under one order, the files will be uniquely identified by a numerical suffix on the image name. This field must be set to blanks if *IMAGE is not
specified for delivery format.
The following special value is accepted:</p>
<table cellpadding="5" width="70%">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*DFT</em></td>
<td align="left" valign="top">No prefix will be added at the beginning of each optical image file name.
The files will be named by the service provider.</td>
</tr>
</table>
<p><strong>Length of alternative electronic mail address.</strong> The length of the alternative
electronic mail address.</p>
<p><strong>Length of fixed size order information.</strong> The length of the fixed portion of the
structure passed with the order information.</p>
<p><strong>Length of image directory.</strong> The length of the image directory, in bytes.
This field must be set to zero if *IMAGE is not specified for delivery format.</p>
<p><strong>Length of primary electronic mail address.</strong> The length of the primary
electronic mail address.</p>
<p><strong>Length of PTFs being delivered entry.</strong> The length of the information for each PTF
being delivered.</p>
<p><strong>Length of PTFs ordered entry.</strong> The length of the information required for each PTF
ordered.</p>
<p><strong>Library of status data queue.</strong> The library where the status data queue is located.
This field must be set to blanks if the name of status data queue field is set to blanks. </p>
<p><strong>Maximum order size.</strong> The maximum size in megabytes of the order to be
delivered electronically.
If the order size exceeds the specified value, the action to be taken depends on the value specified
in the delivery method field.
A value of 100 MB (MB equals approximately 1 000 000 bytes) is used if a lower value is specified.
If -1 is specified for this parameter, orders of any size can be
delivered electronically.</p>
<p><strong>Media for mailing PTFs.</strong> The media currently used for mailing program
temporary fixes (PTFs). The media options available are:</p>
<table cellpadding="5">
<!-- cols="20 80" -->
<tr>
<td align="left" valign="top"><em>0 = *SAME</em></td>
<td align="left" valign="top">The media for mailing PTFs in the contact information of the system
will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1 = *AUTOMATIC</em></td>
<td align="left" valign="top">The system will automatically select the media to be used for sending PTFs.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2 = *CDROM</em></td>
<td align="left" valign="top">PTFs will be sent on CD-ROM media.</td>
</tr>
</table>
<p><strong>Name of status data queue.</strong> The name of a FIFO (first-in first-out)
data queue where the download status is sent.
This field must be set to blanks if no status is necessary. See <a href="#usagenotes">Usage Notes</a> for
information about the status data queue.</p>
<p><strong>National language version.</strong> The national language version code currently
being used for PTF cover letters. If the cover letter you ordered has not been translated into this language the cover letter will be sent in U.S. English.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The national language version in the contact
information of the system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PRIMARY</em></td>
<td align="left" valign="top">The language version for the currently installed primary national language on the system is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the preferred language version code to be used for PTF cover letters.</td>
</tr>
</table>
<p><strong>Number of PTFs being delivered.</strong> The total number of PTFs being delivered.</p>
<p><strong>Number of PTFs ordered.</strong> The total number of PTFs in the order.
At least one PTF must be ordered.</p>
<p><strong>Offset to alternative electronic mail address.</strong> The offset to the alternative
electronic mail address.</p>
<p><strong>Offset to image directory.</strong> The offset to the image directory of the directory where optical images will be saved.
This field must be set to zero if *IMAGE is not specified for delivery format.</p>
<p><strong>Offset to primary electronic mail address.</strong> The offset to the primary electronic mail address.</p>
<p><strong>Offset to PTFs being delivered.</strong> The offset to the information of the first PTF being delivered.</p>
<p><strong>Offset to PTFs ordered.</strong> The offset to the information of the first PTF to be ordered.</p>
<p><strong>Order identifier.</strong> The unique identifier of the order.
This identifier is the same as the problem ID of the problem created when the order
was requested.</p>
<p><strong>Order preparation time.</strong> The time in minutes that the service provider
will take to prepare the order before it is available to be downloaded.</p>
<p><strong>Order status.</strong> Specifies the order status. Possible values are: </p>
<table cellpadding="5" width="70%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SENT</em></td>
<td align="left" valign="top">PTFs were delivered as specified by delivery mode field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*WAIT</em></td>
<td align="left" valign="top">The order is being prepared by the service provider and will be ready
to be downloaded at the time specified by order preparation time field.
A request to resume the order should be submitted at a later time.</td>
</tr>
</table>
<p><strong>Postal code.</strong> The Postal code for the location to which the service provider should
send parts or assistance.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The postal code in the contact information of the system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the postal code.</td>
</tr>
</table>
<p><strong>Primary electronic mail addresses.</strong> The electronic mail (e-mail) address for the contact person.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The primary electronic mail address in the contact
information of the system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No primary e-mail address is provided for the contact person.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the primary e-mail address of the contact person.</td>
</tr>
</table>
<p><strong>Primary fax number.</strong> The complete telephone number where information for the
contact can be faxed. This number should include the area code, exchange numbers, and the extension.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The primary fax number in the contact information of the system
will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no primary fax number for the contact person.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the primary fax number.</td>
</tr>
</table>
<p><strong>Primary telephone number.</strong> The complete telephone number where the person
named for the Contact may be reached most often. This number should include the area code, exchange numbers, and the extension.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The primary telephone number in the contact information of the
system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the primary telephone number.</td>
</tr>
</table>
<p><strong>Product.</strong> The 7-character product identifier of the product that the
PTF is associated with. If the PTF identifier is associated with more than one product,
the PTF order is limited to the product specified.
The following special value is accepted if this is an input field: </p>
<table cellpadding="5" width="80%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ONLY</em></td>
<td align="left" valign="top">The PTF identifier is associated with only one product.
If this value and *REQUIRED for the order parameter are specified,
requisites are sent for only that product that is installed or
supported on your system.
*ONLY should be specified for the product if *ONLY is specified for the release field.</td>
</tr>
</table>
<p><strong>PTF identifier ordered.</strong> The PTF identifier. Some PTFs must be ordered
individually or within a list of PTFs with the same prefix and
not as part of a general list.</p>
<p>A cumulative PTF package (CUM) is specified using the format SF99vrm and the Preventive Service
Planning (PSP) format is SF98vrm, where vrm is version-release-modification. </p>
<p>The following special values are accepted if this is an input field:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CUMPKG</em></td>
<td align="left" valign="top">Order the latest level of the cumulative PTF package (SF99vrm) for
the operating system release that is installed on the system. HIPER
and DB2 Univeral Database (UDB) group PTFs are automatically
requested with this order.
It cannot be ordered with any other PTF identifier or special value.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CUMONLY</em></td>
<td align="left" valign="top">Order the latest level of the cumulative PTF package (SF99vrm) for
the operating system release that is installed on the system but without HIPER
and DB2 Univeral Database (UDB) group PTFs.
It cannot be ordered with any other PTF identifier or special value.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*HIPERGRP</em></td>
<td align="left" valign="top">Order the latest level of HIPER PTF group for the operating
system release that is installed on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DB2GRP</em></td>
<td align="left" valign="top">Order the latest level of DB2 UDB PTF group for the operating
system release that is installed on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*BRSGRP</em></td>
<td align="left" valign="top">Order the latest level of Backup Recovery Solutions PTF group
for the operating system release that is installed on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*HTTPGRP</em></td>
<td align="left" valign="top">Order the latest level of IBM HTTP Server PTF group for the
operating system release that is installed on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*JVAGRP</em></td>
<td align="left" valign="top">Order the latest level of Java PTF group for the operating
system release that is installed on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PFRGRP</em></td>
<td align="left" valign="top">Order the latest level of Performance Tools PTF group for the
operating system release that is installed on the system.</td>
</tr>
</table>
<p><strong>PTF identifier sent.</strong> The PTF identifier.</p>
<p><strong>PTF parts to order.</strong> Indicates whether PTFs or cover letters are being ordered.
Possible values are:</p>
<table cellpadding="5" width="50%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">PTFs and cover letters are being ordered.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CVRLTR</em></td>
<td align="left" valign="top">Cover letters only are being ordered.</td>
</tr>
</table>
<p><strong>Release.</strong> The 6-character release level in VxRyMz format where Vx is
the version number, Ry is the release number, and Mz is the
modification level. The variables x and y can be a number from 0
through 9, and the variable z can be a number from 0 through 9 or a
letter from A through Z.
The following special value is accepted if this is an input field: </p>
<table cellpadding="5" width="80%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ONLY</em></td>
<td align="left" valign="top">The PTF identifier is associated with only one release.
If this value and *REQUIRED for the order parameter are specified,
requisites are sent for only that release level that is
installed or supported on your system.
*ONLY should be specified for the release if *ONLY is specified for the product field.</td>
</tr>
</table>
<p><strong>Reorder.</strong> Indicates whether a PTF that is currently loaded, applied,
or on order should be ordered again.
Possible values are:</p>
<table cellpadding="5" width="50%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">PTFs that are already loaded, applied, or on order are not reordered.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">PTFs that are already loaded, applied, or on order are reordered.</td>
</tr>
</table>
<dl>
<dd>
<p><strong>Note:</strong> A PTF is not reordered if the *SAVF delivery format is specified
and a save file is available on the system.</p>
</dd>
</dl>
<p><strong>Requisites.</strong> The level of fixes that are being requested. Possible values are:</p>
<table cellpadding="5" width="70%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*REQUIRED</em></td>
<td align="left" valign="top">The PTF ordered and its requisites are being requested.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PTFID</em></td>
<td align="left" valign="top">The specific PTF ordered is the one being requested.
No requisites are sent.</td>
</tr>
</table>
<p><strong>Reserved.</strong> A reserved field. Should be set to null (x'00').</p>
<p><strong>State or province.</strong> The state or province names for the location to which you want your service provider to send parts or assistance.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The state or province in the contact information of the
system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">There is no State or province.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the State or province.</td>
</tr>
</table>
<p><strong>Street address lines 1, 2 and 3.</strong> The postal number and street name of the location to which you want your service provider to send parts or assistance for the problem. This should not be a post office box.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The street address in the contact information of the
system will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No additional street address information is provided. This value is valid for lines 2 and 3, but not for line 1.</td>
</tr>
<tr>
<td align="left" valign="top"><em>character-value</em></td>
<td align="left" valign="top">Specify the street address. Up to three lines of street address information can be specified. Each line is a separate parameter element, which can be up to 36 characters long.</td>
</tr>
</table>
<p><strong>Update interval.</strong> The time in seconds that indicates how often download status is
updated in the data queue when PTFs are being downloaded.
This field must be set to zero if the name of status data queue field is set to blanks.
See <a href="#usagenotes">Usage Notes</a> for information about the status data queue.</p>
<p><strong>Wait time for order completion.</strong> The time in minutes that the connection
with the service provider should remain active while the order is being prepared for download.
If this value is greater than or equal to the order preparation time field, the connection will remain active
and the download process will be started automatically when the order is ready.
Otherwise, the connection with the service provider will be closed and a request to resume the order
should be submitted at a later time. If -1 is specified, the connection will remain active
as much time as necessary while the order is being prepared.</p>
<br>
<h3><a name="usagenotes">Usage Notes</a></h3>
<ol type="1">
<li>Only one job on the system can invoke QESCPTFO API at a time.</li>
<li>When processing a PTF order, and the delivery format is *SAVF, the API will
return control to the caller when all PTF save files are delivered.
When the delivery format is *IMAGE, the API will return control to the caller
depending on the order preparation time and the wait time for order completion fields.
If the order preparation time is greater than the wait time for order completion,
the order is set to *WAIT status, the API will return control to the caller and a request
to resume the order should be submitted after the time indicated by order preparation time field.
Otherwise, the API will return control to the caller when the optical image files are delivered.</li>
<li> Information about the download status is sent to the status data queue specified and updated at
intervals specified in the update interval field. The download progress can be checked by
monitoring the status data queue in a different thread or process.
The following table shows the format for the status data.
For a detailed description of each field, see <a href="#flddsc2">Field
Descriptions</a>.
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Message identifier</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">10</td>
<td align="center" valign="top" width="10%">A</td>
<td align="left" valign="top" width="20%">CHAR(2)</td>
<td align="left" valign="top" width="60%">Message format</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">12</td>
<td align="center" valign="top" width="10%">C</td>
<td align="left" valign="top" width="20%">CHAR(*)</td>
<td align="left" valign="top" width="60%">Message status data</td>
</tr>
</table>
</ol>
<br>
<br>
<h3><a name="flddsc2">Field Descriptions</a></h3>
<p><strong>Message identifier.</strong> The identifier of the message sent to the queue.
Possible values are:</p>
<table cellpadding="5" width="60%">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*PTFDWNL</em></td>
<td align="left" valign="top">This message was sent by the Control PTF Order (QESCPTFO) API.</td>
</tr>
</table>
<p><strong>Message format.</strong> The format of the message data in the queue.
Possible values are:</p>
<table cellpadding="5" width="80%">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>01</em></td>
<td align="left" valign="top"> The message contains the information of the order to be delivered.
This message format is sent when the actual list of PTFs to be delivered is gotten.</td>
</tr>
<tr>
<td align="left" valign="top"><em>02</em></td>
<td align="left" valign="top">The message contains the download status.
This message format is sent at intervals as specified in the update interval field.</td>
</tr>
</table>
<p><strong>Message status data.</strong> The information of the data sent to the queue.
This information depends on the message format field.
If the message status data exceeds the maximum entry length of the data queue, the
information is truncated.</p>
<p>If the message format field is '01', then the message status data has the following format:</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Receiver format name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">8</td>
<td align="center" valign="top" width="10%">8</td>
<td align="left" valign="top" width="20%">CHAR(*)</td>
<td align="left" valign="top" width="60%">Receiver variable structure</td>
</tr>
</table>
<p>If the message format field is '02', then the message status data has the following format:</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(31)</td>
<td align="left" valign="top" width="60%">Order identifier</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">31</td>
<td align="center" valign="top" width="10%">1F</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">32</td>
<td align="center" valign="top" width="10%">20</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Order size</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">36</td>
<td align="center" valign="top" width="10%">24</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes downloaded</td>
</tr>
</table>
<p><strong>Bytes downloaded.</strong> The number of bytes that has been already downloaded.</p>
<p><strong>Order size.</strong> The number of bytes to be delivered
for the order.</p>
<p><strong>Order identifier.</strong> The unique identifier of the order this message is
associated with.
This identifier is the same as the problem ID of the problem created when the order
was requested.</p>
<p><strong>Receiver format name.</strong> The format specified for the format of receiver
variable parameter.</p>
<p><strong>Receiver variable structure.</strong> The actual list of PTFs delivered as specified by
the format of receiver variable.</p>
<br>
<h3><a name="errmsg">Error Messages</a></h3>
<p>The following messages may be sent from this function:</p>
<table width="100%">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td valign="top" width="15%">CPFA0AE</td>
<td valign="top" width="85%">An error occurred while trying to resolve object name.</td>
</tr>
<tr>
<td valign="top">CPFA0A9</td>
<td valign="top">Object not found. Object is &amp;1.</td>
</tr>
<tr>
<td valign="top">CPFA0DE</td>
<td valign="top">Object type not valid for request. Object is &amp;1.</td>
</tr>
<tr>
<td valign="top">CPFA09C</td>
<td valign="top">Not authorized to object. Object is &amp;1.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF3CF1</td>
<td width="85%" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF3CF2</td>
<td width="85%" valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF3C1E</td>
<td width="85%" valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td valign="top">CPF3C21</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C3A</td>
<td valign="top">Value for parameter &amp;2 for API &amp;1 not valid.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF3C39</td>
<td width="85%" valign="top">Value for reserved field not valid.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF7A86</td>
<td width="85%" valign="top">Problem log services already started.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF8C01</td>
<td width="85%" valign="top">Cannot connect to IBM service system. One session allowed.</td>
</tr>
<tr>
<td valign="top">CPF8C16</td>
<td valign="top">Error occurred while processing request.</td>
</tr>
<tr>
<td valign="top">CPF8C17</td>
<td valign="top">Sign-on failed.</td>
</tr>
<tr>
<td valign="top">CPF8C19</td>
<td valign="top">Remote support application failed.</td>
</tr>
<tr>
<td valign="top">CPF8C2A</td>
<td valign="top">Cannot connect to IBM service system.</td>
</tr>
<tr>
<td valign="top">CPF8C24</td>
<td valign="top">Error occurred while processing request.</td>
</tr>
<tr>
<td valign="top">CPF8C27</td>
<td valign="top">Alternate load device not found.</td>
</tr>
<tr>
<td valign="top">CPF8C32</td>
<td valign="top">PTF order cannot be processed.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF8C9A</td>
<td width="85%" valign="top">Check PTF must be set to *NO when *CVRLTR is specified
for PTF parts.</td>
</tr>
<tr>
<td valign="top">CPF8C99</td>
<td valign="top">PTF &amp;2-&amp;1 &amp;3 not ordered.</td>
</tr>
<tr>
<td valign="top">CPF9801</td>
<td valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF9802</td>
<td width="85%" valign="top">Not authorized to object &amp;1 in &amp;2 type *&amp;3.</td>
</tr>
<tr>
<td valign="top">CPF9810</td>
<td valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td valign="top">CPF9820</td>
<td valign="top">Not authorized to use library &1.</td>
</tr>
</table>
<br>
<img src="deltaend.gif" alt="End of change">
<hr>
API introduced: V5R4
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sw1.htm">Software Product APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>