friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qszpkgpo.htm

722 lines
18 KiB
HTML
Raw Permalink Blame History

<!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>Package Product Option (QSZPKGPO) 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. -->
<!-- QSZPKGPO SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 7 Oct 1998 at 19:48:14 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Jan 02 -->
<!--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>Package Product Option (QSZPKGPO) API</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="50%">Product option information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(35)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Repackage</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Allow object change</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(5)</td>
</tr>
<tr>
<td align="center" valign="top">4</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: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Package Product Option (QSZPKGPO) API packages one or more product loads
for a specified product option. This enables the loads to be saved using the
Save Licensed Program (SAVLICPGM) command. Object lists are added to the
product load (*PRDLOD) object when the product load is packaged. In order to
package a product load, all development libraries for the load must exist and
all development folders for the load must exist. Also, all objects to be
packaged must exist and all objects except folders and documents must have the
following correct information in the object description:</p>
<ul>
<li>Product ID.</li>
<li>Release level.</li>
<li>Product option.</li>
<li>Load ID.</li>
</ul>
<p>The object description can be changed using the Change Object Description
(QLICOBJD) API.</p>
<p>To package a product load that has folders, the user must be enrolled in the
system distribution directory and have *ALL authority to the folders.</p>
<p>Other than these restrictions, a user who has authority to this API can
package any product load created in either of the following ways. This is
regardless of whether the user has authority to the objects for the product
load.</p>
<ul>
<li>The Create Product Load (QSZCRTPL) API</li>
<li>System Manager for i5/OS licensed program</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Authority to Folders</em></dt>
<dd>*ALL<br>
<br>
</dd>
<dt><em>Authority to Objects Packaged</em></dt>
<dd>None<br>
<br>
</dd>
<dt><em>Document Lock</em></dt>
<dd>*SHRRD. A lock of *SHRNUP is obtained on each document's
attributes.<br>
<br>
</dd>
<dt><em>Table of Contents for Subordinate Folders Lock</em></dt>
<dd>*SHRNUP<br>
<br>
</dd>
<dt><em>Folder Lock</em></dt>
<dd>*SHRUPD<br>
<br>
</dd>
<dt><em>Object Lock</em></dt>
<dd>*EXCLRD. If *NO is specified for the allow object change parameter, each
object packaged is locked *EXCLRD.<br>
<br>
</dd>
<dt><em>Product Availability Lock</em></dt>
<dd>*SHRRD<br>
<br>
</dd>
<dt><em>Product Definition Lock</em></dt>
<dd>*EXCLRD<br>
<br>
</dd>
<dt><em>Product Load Lock</em></dt>
<dd>*EXCLRD<br>
<br>
</dd>
<dt><em>Object Lock</em></dt>
<dd>Each object in each of the product load's libraries is locked as
follows:
<ul>
<li>Message queues are locked *EXCLRD.</li>
<li>All other object types are locked *SHRRD.</li>
</ul>
</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Product option information</strong></dt>
<dd>INPUT;CHAR(35)
<p>The product loads to be packaged. For more information, see <a href=
"#HDRPKGPVOL">Product Option Information Format</a>.</p>
</dd>
<dt><strong>Repackage</strong></dt>
<dd>INPUT; CHAR(4)
<p>Whether or not to package product loads that were already packaged.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Packages product loads that have not already been
packaged.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Packages all specified product loads, regardless
of whether they are already packaged.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Allow object change</strong></dt>
<dd>INPUT; CHAR(5)
<p>Whether to prevent changes to the product information in the object
description of each object added to an object list. You can change the allow
change by program attribute by using the allow change by program field of the
Change Object Description (QLICOBJD) API. See the allow change by program field
in the QLICOBJD API for more information.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">Does not change the allow change by program
attribute of the objects being packaged.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Changes the allow change by program attribute of
the objects being packaged so that the product information in the object
description cannot be changed by the Change Object Description (QLICOBJD)
API.</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="HDRPKGPVOL">Product Option Information Format</a></h3>
<p>The following describes the product option information parameter. For a
detailed description of the fields in this table, see <a href=
"#HDRFDPPINF">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(4)</td>
<td align="left" valign="top" width="60%">Product option</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Product ID</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">B</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Release level</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Load ID</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="center" valign="top">19</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFDPPINF">Field Descriptions</a></h3>
<p><strong>Load ID.</strong> Specifies which loads to package. Load IDs are 4
characters in length; for example, 2924 is the load ID for an English National
Language Version (NLV).</p>
<p>The following special values are valid:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CODEDFT</em></td>
<td align="left" valign="top">The default code load ID, 5001, is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">For the specified product ID, release level, and
product option, all product loads for which a product load object exists are
packaged. If only a code load exists, the code load is packaged.</td>
</tr>
</table>
<p><strong>Product ID.</strong> The product ID of the product option to be
packaged.</p>
<p><strong>Product option.</strong> The product option to be packaged. Use 0000
for the base option. Valid values are 0000 through 0099, where each character
is a digit.</p>
<p><strong>Release level.</strong> The version, release, and modification level
of the product option to be packaged. The release level must be a valid special
value or it must be in the form of VxRyMz. Valid entries for x and y are 0
through 9. Valid entries for z is 0 through 9 or A through Z.</p>
<p>The following special value is valid:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*ONLY</em></td>
<td align="left" valign="top">The release level is determined by searching the
system for a product definition (*PRDDFN) for the specified product ID. The
release level is taken from the product definition. This value is not valid if
there are product definitions for two or more release levels of the product on
the system.</td>
</tr>
</table>
<p><strong>Reserved.</strong> This field must contain blanks; otherwise, an
error occurs.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" 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">CPF0CB2 E</td>
<td width="85%" valign="top">Product identifier &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CEA E</td>
<td align="left" valign="top">Loads not packaged for product &amp;1 release
&amp;2 option &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CEB E</td>
<td align="left" valign="top">Product loads not packaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CEC E</td>
<td align="left" valign="top">Code load has no folders.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CED E</td>
<td align="left" valign="top">Reserved fields in parameter 1 are not
blank.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CE0 E</td>
<td align="left" valign="top">Message file &amp;5 in library &amp;6 not
found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CE1 E</td>
<td align="left" valign="top">&amp;1 not valid for repackage parameter.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CE3 E</td>
<td align="left" valign="top">&amp;9 product loads packaged, &amp;10 product
loads not packaged. See job log.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CE4 E</td>
<td align="left" valign="top">Secondary language product load not
packaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CE5 E</td>
<td align="left" valign="top">&amp;1 not valid for allow change parameter.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CE6 E</td>
<td align="left" valign="top">Public authority for library &amp;6 not valid for
packaging.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CE7 E</td>
<td align="left" valign="top">Product &amp;1 release &amp;2 not packaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CE8 E</td>
<td align="left" valign="top">Primary folder list not correct.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CE9 E</td>
<td align="left" valign="top">Development folder list not correct.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CFA E</td>
<td align="left" valign="top">Load &amp;4 for option &amp;3 not in product
definition.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CFB E</td>
<td align="left" valign="top">Language load not packaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CFC E</td>
<td align="left" valign="top">Product definition not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CFD E</td>
<td align="left" valign="top">Code load not found for product &amp;1 release
&amp;2 option &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CFE E</td>
<td align="left" valign="top">Object &amp;5 type *&amp;7 in &amp;6 not in
development library &amp;8.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CFF E</td>
<td align="left" valign="top">Multiple releases available.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CF1 E</td>
<td align="left" valign="top">Object &amp;5 in &amp;6 type *&amp;7 associated
with PTF &amp;8.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CF4 E</td>
<td align="left" valign="top">Object description not correct.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CF5 E</td>
<td align="left" valign="top">Exit program &amp;5 in library &amp;6 not
found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CF6 E</td>
<td align="left" valign="top">Packaging operation failed for &amp;5 in &amp;6
type *&amp;7.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0CF7 E</td>
<td align="left" valign="top">Product &amp;1 release &amp;2 option &amp;3 load
&amp;4 already packaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0C4B E</td>
<td align="left" valign="top">Product availability object &amp;2/&amp;1
recovery required.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0C4C E</td>
<td align="left" valign="top">Cannot allocate object &amp;1 in library
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0C4D E</td>
<td align="left" valign="top">Error occurred while processing object &amp;1 in
library &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0C8A E</td>
<td align="left" valign="top">Product option &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0C84 E</td>
<td align="left" valign="top">Load identifier &amp;4 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2150 E</td>
<td align="left" valign="top">Object information function failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2151 E</td>
<td align="left" valign="top">Operation failed for &amp;2 in &amp;1 type
*&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2225 E</td>
<td align="left" valign="top">Not able to allocate internal system object.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2352 E</td>
<td align="left" valign="top">Program &amp;1 in &amp;2 received wrong
parameters.</td>
</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">CPF2451 E</td>
<td align="left" valign="top">Message queue &amp;1 is allocated to another
job.</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">CPF358A E</td>
<td align="left" valign="top">Release not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF7304 E</td>
<td align="left" valign="top">File &amp;1 in &amp;2 not changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8A06 E</td>
<td align="left" valign="top">Document &amp;2 or folder &amp;3 partially
created in folder &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8A75 E</td>
<td align="left" valign="top">Not authorized to access folder &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8A77 E</td>
<td align="left" valign="top">Folder &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8A78 E</td>
<td align="left" valign="top">Folder &amp;1 in use.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8A79 E</td>
<td align="left" valign="top">Folder &amp;1 is logically damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8100 E</td>
<td align="left" valign="top">All CPF81xx messages could be returned. xx is
from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9012 E</td>
<td align="left" valign="top">Start of document interchange session not
successful for &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9804 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9806 E</td>
<td align="left" valign="top">Cannot perform function for object &amp;2 in
library &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9809 E</td>
<td align="left" valign="top">Library &amp;1 cannot be accessed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9811 E</td>
<td align="left" valign="top">Program &amp;1 in library &amp;2 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9812 E</td>
<td align="left" valign="top">File &amp;1 in library &amp;2 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9814 E</td>
<td align="left" valign="top">Device &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9830 E</td>
<td align="left" valign="top">Cannot assign library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9831 E</td>
<td align="left" valign="top">Cannot assign device &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R3
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<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>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink