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

784 lines
23 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>Create PTF Group (QpzCreatePtfGroup) 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. -->
<!-- Created for V5R2 by (Ron Haugen) -->
<!-- Change history -->
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Create PTF Group (QpzCreatePtfGroup) 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%">PTF group 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">PTF group information format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Input variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Input variable format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Related PTF groups</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">ARRAY(*) of CHAR(60)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Number of related PTF groups</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">CCSID</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">BINARY(4)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program Name: QPZGROUP<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Create PTF Group (QpzCreatePtfGroup) API creates a PTF group.</p>
<p>A PTF group consists of a number of program temporary fixes (PTFs) for the
purpose of managing those PTFs as one entity. After creating the PTF group you
can use the Work with PTF Groups (WRKPTFGRP) command or the List PTF Group
Details (QpzListPtfGroupDetails) API to view the PTF group. PTF groups can also
be managed using Management Central.</p>
<br>
<h3><a name="HDRPZCRTGRP_2">Authorities and Locks</a></h3>
<dl>
<dt><em>Work with PTF Groups (WRKPTFGRP) command</em></dt>
<dd>*USE<br>
<br>
</dd>
<dt><em>File or User Space Authority</em></dt>
<dd>*USE<br>
<br>
</dd>
<dt><em>File or User Space Library Authority</em></dt>
<dd>*EXECUTE<br>
<br>
</dd>
<dt><em>File or User Space Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<p>Lock conflicts may occur if this API is called while another PTF or PTF
group operation is in progress.</p>
<br>
<h3><a name="HDRPZCRTGRP_3">Required Parameter Group</a></h3>
<dl>
<dt><strong>PTF group information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Attributes of the PTF group to be created. The format of this information is
described by the PTF group information format name parameter.</p>
</dd>
<dt><strong>PTF group information format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the information in the PTF group information parameter. The
possible format names are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>GRPC0100</em></td>
<td align="left" valign="top">For details, see <a href= "#HDRPZCRTGRP_C100">GRPC0100 Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Input variable</strong></dt>
<dd>INPUT; CHAR(*)
<p>The name of the user space or file that contains the list of PTFs to be
included in this PTF group. The format of the name is defined by the input
variable format name parameter.</p>
<p>For format GRPI0000, the input variable parameter should be specified as a
CHAR(10) field with a value of *NONE, or the parameter should be a null
pointer.</p>
<p>For format GRPI0100, the input variable parameter will contain the qualified
user space name in 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(10)</td>
<td align="left" valign="top" width="60%">User space name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library name</td>
</tr>
</table>
<p>For format GRPI0200, the input variable parameter will contain the physical
file member name in 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(10)</td>
<td align="left" valign="top" width="60%">File name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library name</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">File member name</td>
</tr>
</table>
<br>
<br>
</dd>
<dt><strong>Input variable format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the information in the input variable parameter. The possible
format names are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>GRPI0000</em></td>
<td align="left" valign="top">There are no PTFs to be included in this PTF
group. You must include at least one related PTF group in order to create this
PTF group.</td>
</tr>
<tr>
<td align="left" valign="top"><em>GRPI0100</em></td>
<td align="left" valign="top">The input variable parameter defines the name and
format of a user space that contains the list of PTFs to be included in this
PTF group. For details, see <a href="#HDRPZCRTGRP_I100">GRPI0100
Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>GRPI0200</em></td>
<td align="left" valign="top">The input variable parameter defines the name and
format of a physical file member that contains the list of PTFs to be included
in this PTF group. For details, see <a href="#HDRPZCRTGRP_I200">GRPI0200
Format</a>.</td>
</tr>
</table>
<br>
<br>
</dd>
<dt><strong>Related PTF groups</strong></dt>
<dd>INPUT; ARRAY(*) of CHAR(60)
<p>The name of the PTF groups that are related to this PTF group. Related PTF
groups are included by specifying the PTF group name only, not by level.
Related PTF groups are used when determining the overall status of this PTF
group and are also included when the PTF group is distributed and installed
using Management Central.</p>
</dd>
<dt><strong>Number of related PTF groups</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of related PTF groups listed in the related PTF groups parameter.
This number must be in the range of 0 through 300.</p>
</dd>
<dt><strong>CCSID.</strong></dt>
<dd>INPUT; BINARY(4)
<p>The coded character set ID for the PTF group name, description, and related
PTF group names. Valid values are 0 through 65533. If a value of 0 is
specified, the names and description are assumed to be in the CCSID of the
job.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRPZCRTGRP_C100">GRPC0100</a></h3>
<p>Describes the format of the information in the PTF group information
parameter.</p>
<p>For detailed descriptions of each field, see the <a href=
"#HDRPZCRTGRP_FD">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 PTF group information</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(60)</td>
<td align="left" valign="top">PTF group name</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">CHAR(100)</td>
<td align="left" valign="top">PTF group description</td>
</tr>
<tr>
<td align="center" valign="top">164</td>
<td align="center" valign="top">A4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">PTF group level</td>
</tr>
<tr>
<td align="center" valign="top">168</td>
<td align="center" valign="top">A8</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Replace group</td>
</tr>
</table>
<br>
<h3><a name="HDRPZCRTGRP_I100">GRPI0100 format</a></h3>
<p>Describes the format of the PTF List in the user space specified in the
input variable parameter.</p>
<p>For detailed descriptions of each field, see the <a href=
"#HDRPZCRTGRP_FD">Field Descriptions</a>.</p>
<p>This format of the data that exists in the user space must be in 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%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to the first PTF record</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">Number of PTF records</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">Length of each PTF record</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The following
fields are repeated for each PTF in the list.</td>
</tr>
<tr>
<td align="center" valign="top" rowspan="8" colspan="2">&nbsp;</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">PTF ID</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Product ID</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Release</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Product option</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Product load ID</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Minimum level</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Maximum level</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRPZCRTGRP_I200">GRPI0200 format</a></h3>
<p>Defines the format of the PTF List in the physical file member specified in
the input variable parameter. The data in this file must be in the format
defined by file QADSPPTF in library QSYS. This file format is used when
specifing OUTPUT(*OUTFILE) on the Display PTF (DSPPTF) command or by using the
Create PTF Package(CRTPTFPKG) command in the System Manager licensed
product.</p>
<p>The following fields in this file are required to contain valid
information:</p>
<img src="delta.gif" alt="Start of change">
<dl>
<dt>SCPPID</dt>
<dd>Product ID</dd>
<dt>SCPTFID</dt>
<dd>PTF ID</dd>
<dt>SCPTFV</dt>
<dd>Release</dd>
<dt>SCOPTP</dt>
<dd>Product option</dd>
<dt>SCENLG</dt>
<dd>Product load ID. A special value of "CODE" indicates the PTF is for a feature type of *CODE.</dd>
<dt>SCMNLV</dt>
<dd>Minimum level.</dd>
<dt>SCMXLV</dt>
<dd>Maximum level.</dd>
</dl>
<img src="deltaend.gif" alt="End of change">
<br>
<h3><a name="HDRPZCRTGRP_FD">Field Descriptions</a></h3>
<p><strong>File member name.</strong> The name of the physical file member that
contains the list of PTFs to be included in this PTF group. The data in this
member must be in the format defined by file QADSPPTF in library QSYS.</p>
<p><strong>File name.</strong> The name of the physical file that contains the
list of PTFs to be included in this PTF group.</p>
<p><strong>Library name.</strong> The name of the library where the user space
or physical file can be located. You can use these special values for the
library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list.</td>
</tr>
</table>
<p><strong>Length of each PTF record.</strong> The length of the data in each
PTF record in the user space. The only valid value is 32.</p>
<p><strong>Length of PTF group information.</strong> The length of the data in
the PTF group information format, including this field. The only valid value is
169.</p>
<p><strong>Maximum level.</strong> The indicator of the highest level of the
product on which this PTF can be installed. If the minimum and maximum levels
are the same, then this PTF can only be installed on one level of the product.
The level can be AA to 99. If the PTF has no maximum level, this field should
be blanks.</p>
<p><strong>Minimum level.</strong> The indicator of the lowest level of the
product on which this PTF can be installed. If the minimum and maximum levels
are the same, then this PTF can only be installed on one level of the product.
The level can be AA to 99. If the PTF has no minimum level, this field should
be blanks.</p>
<p><strong>Number of PTF records.</strong> The number of PTF records that exist
in the user space.</p>
<p><strong>Offset to the first PTF record.</strong> The byte offset from the
beginning of the user space to the first PTF record.</p>
<p><strong>Product ID.</strong> The product identifier of the PTF.</p>
<p><strong>Product load ID.</strong> The load ID of the product load for the
PTF. A special value of "CODE" indicates the PTF is for a feature type of
*CODE. For language loads, you must specify a valid national language
version.</p>
<p><strong>Product option.</strong> The option of the product for the PTF.
Valid values are 0000 through 0099.</p>
<p><strong>PTF ID.</strong> The identifier of the PTF to be included within the
PTF group.</p>
<p><strong>PTF group description.</strong> The text description of the PTF
group. The description must be able to be contained in a 50-byte EBCDIC field.
For example, 50 single-byte characters or 24 double-byte characters with one
shift-out character and one shift-in character.</p>
<p><strong>PTF group level.</strong> The level of the PTF group. The level can
be in the range 1 through 99999. When creating a different version of a PTF
group, the new level specified should be higher. A higher level is considered
to be a more recent version of the PTF group.</p>
<p><strong>PTF group name.</strong> The name of the PTF group you are creating.
The first character must be numeric in the range 0 through 9. The remaining
characters cannot contain imbedded blanks or an asterisk(*). The name must be
able to be contained in a 30-byte EBCDIC field. For example, a name with
single-byte characters must be a maximum of 30 characters and be padded with
blanks. For names with double-byte characters, the name must begin with a
numeric character followed by one shift-out character, then a maximum of 13
double-byte characters followed by one shift-in character.</p>
<p><strong>Release.</strong> The version, release, and modification of the PTF
in the format V<em>x</em>R<em>y</em>M<em>z</em>. Valid values for <em>x</em>
and <em>y</em> are 0 through 9, and valid values for <em>z</em> are 0 through 9
or A through Z.</p>
<p><strong>Replace group.</strong> The action to take when a PTF group of the
same name already exists on the system. Only one level of a PTF group can exist
on the system. Valid values for this field are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not replace an existing PTF group of the same
name, regardless of the level of the PTF group.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Replace an existing PTF group of the same name
only when the of the level of the PTF group being created is higher than the
level of the existing PTF group.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Replace an existing PTF group of the same name
only when the of the level of the PTF group being created is equal to or higher
than the level of the existing PTF group.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Always replace an existing PTF group of the same
name.</td>
</tr>
</table>
<p><strong>User space name.</strong> The name of the user space that contains
the list of PTFs to be included in this PTF group.</p>
<br>
<h3><a name="HDRPZCRTGRP_9">Error Messages</a></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">CPF0CEE E</td>
<td width="85%" valign="top">Unable to convert data to CCSID &amp;1.</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">CPF3598 E</td>
<td align="left" valign="top">PTF function already in progress.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36AE E</td>
<td align="left" valign="top">Duplicate related PTF group &amp;1 not
allowed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36AF E</td>
<td align="left" valign="top">PTF group function already in progress.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36A0 E</td>
<td align="left" valign="top">Value for PTF group level &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36A1 E</td>
<td align="left" valign="top">No PTFs or related PTF groups specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36A2 E</td>
<td align="left" valign="top">Length of PTF group name or text too long.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36A3 E</td>
<td align="left" valign="top">PTF group already exists.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36A6 E</td>
<td align="left" valign="top">PTF group name &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36A7 E</td>
<td align="left" valign="top">PTF data for PTF group is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36B0 E</td>
<td align="left" valign="top">Field at offset &amp;1 in user space &amp;2 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF36B1 E</td>
<td align="left" valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3BC7 E</td>
<td align="left" valign="top">CCSID &amp;1 outside of valid range.</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 &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C3C E</td>
<td align="left" valign="top">Value for parameter &amp;1 not valid.</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">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</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">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9848 E</td>
<td align="left" valign="top">Cannot open file &amp;1 in library &amp;2 member
&amp;3.</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: V5R2
<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>