Create PTF Group (QpzCreatePtfGroup) API


  Required Parameter Group:

1 PTF group information Input CHAR(*)
2 PTF group information format name Input CHAR(8)
3 Input variable Input CHAR(*)
4 Input variable format name Input CHAR(8)
5 Related PTF groups Input ARRAY(*) of CHAR(60)
6 Number of related PTF groups Input BINARY(4)
7 CCSID Input BINARY(4)
8 Error code I/O CHAR(*)

  Service Program Name: QPZGROUP

  Default Public Authority: *USE

  Threadsafe: No

The Create PTF Group (QpzCreatePtfGroup) API creates a PTF group.

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.


Authorities and Locks

Work with PTF Groups (WRKPTFGRP) command
*USE

File or User Space Authority
*USE

File or User Space Library Authority
*EXECUTE

File or User Space Lock
*EXCLRD

Lock conflicts may occur if this API is called while another PTF or PTF group operation is in progress.


Required Parameter Group

PTF group information
INPUT; CHAR(*)

Attributes of the PTF group to be created. The format of this information is described by the PTF group information format name parameter.

PTF group information format name
INPUT; CHAR(8)

The format of the information in the PTF group information parameter. The possible format names are:

GRPC0100 For details, see GRPC0100 Format.

Input variable
INPUT; CHAR(*)

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.

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.

For format GRPI0100, the input variable parameter will contain the qualified user space name in the following format:

Offset Type Field
Dec Hex
0 0 CHAR(10) User space name
10 A CHAR(10) Library name

For format GRPI0200, the input variable parameter will contain the physical file member name in the following format:

Offset Type Field
Dec Hex
0 0 CHAR(10) File name
10 A CHAR(10) Library name
20 14 CHAR(10) File member name


Input variable format name
INPUT; CHAR(8)

The format of the information in the input variable parameter. The possible format names are:

GRPI0000 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.
GRPI0100 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 GRPI0100 Format.
GRPI0200 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 GRPI0200 Format.


Related PTF groups
INPUT; ARRAY(*) of CHAR(60)

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.

Number of related PTF groups
INPUT; BINARY(4)

The number of related PTF groups listed in the related PTF groups parameter. This number must be in the range of 0 through 300.

CCSID.
INPUT; BINARY(4)

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.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.


GRPC0100

Describes the format of the information in the PTF group information parameter.

For detailed descriptions of each field, see the Field Descriptions.

Offset Type Field
Dec Hex
0 0 BINARY(4) Length of PTF group information
4 4 CHAR(60) PTF group name
64 40 CHAR(100) PTF group description
164 A4 BINARY(4) PTF group level
168 A8 CHAR(1) Replace group

GRPI0100 format

Describes the format of the PTF List in the user space specified in the input variable parameter.

For detailed descriptions of each field, see the Field Descriptions.

This format of the data that exists in the user space must be in the following format.

Offset Type Field
Dec Hex
0 0 BINARY(4) Offset to the first PTF record
4 4 BINARY(4) Number of PTF records
8 8 BINARY(4) Length of each PTF record
Note: The following fields are repeated for each PTF in the list.
  CHAR(7) PTF ID
CHAR(7) Product ID
CHAR(6) Release
CHAR(4) Product option
CHAR(4) Product load ID
CHAR(2) Minimum level
CHAR(2) Maximum level


GRPI0200 format

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.

The following fields in this file are required to contain valid information:

Start of change
SCPPID
Product ID
SCPTFID
PTF ID
SCPTFV
Release
SCOPTP
Product option
SCENLG
Product load ID. A special value of "CODE" indicates the PTF is for a feature type of *CODE.
SCMNLV
Minimum level.
SCMXLV
Maximum level.
End of change

Field Descriptions

File member name. 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.

File name. The name of the physical file that contains the list of PTFs to be included in this PTF group.

Library name. 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:

*CURLIB The job's current library.
*LIBL The library list.

Length of each PTF record. The length of the data in each PTF record in the user space. The only valid value is 32.

Length of PTF group information. The length of the data in the PTF group information format, including this field. The only valid value is 169.

Maximum level. 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.

Minimum level. 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.

Number of PTF records. The number of PTF records that exist in the user space.

Offset to the first PTF record. The byte offset from the beginning of the user space to the first PTF record.

Product ID. The product identifier of the PTF.

Product load ID. 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.

Product option. The option of the product for the PTF. Valid values are 0000 through 0099.

PTF ID. The identifier of the PTF to be included within the PTF group.

PTF group description. 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.

PTF group level. 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.

PTF group name. 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.

Release. The version, release, and modification of the PTF in the format VxRyMz. Valid values for x and y are 0 through 9, and valid values for z are 0 through 9 or A through Z.

Replace group. 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:

0 Do not replace an existing PTF group of the same name, regardless of the level of the PTF group.
1 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.
2 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.
3 Always replace an existing PTF group of the same name.

User space name. The name of the user space that contains the list of PTFs to be included in this PTF group.


Error Messages

Message ID Error Message Text
CPF0CEE E Unable to convert data to CCSID &1.
CPF24B4 E Severe error while addressing parameter list.
CPF3598 E PTF function already in progress.
CPF36AE E Duplicate related PTF group &1 not allowed.
CPF36AF E PTF group function already in progress.
CPF36A0 E Value for PTF group level &1 not valid.
CPF36A1 E No PTFs or related PTF groups specified.
CPF36A2 E Length of PTF group name or text too long.
CPF36A3 E PTF group already exists.
CPF36A6 E PTF group name &1 not valid.
CPF36A7 E PTF data for PTF group is not valid.
CPF36B0 E Field at offset &1 in user space &2 not valid.
CPF36B1 E Value for parameter &1 not valid.
CPF3BC7 E CCSID &1 outside of valid range.
CPF3CF1 E Error code parameter not valid.
CPF3CF2 E Error(s) occurred during running of &1 API.
CPF3C21 E Format name &1 is not valid.
CPF3C3C E Value for parameter &1 not valid.
CPF9801 E Object &2 in library &3 not found.
CPF9802 E Not authorized to object &2 in &3.
CPF9803 E Cannot allocate object &2 in library &3.
CPF9820 E Not authorized to use library &1.
CPF9848 E Cannot open file &1 in library &2 member &3.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V5R2
Top | Software Product APIs | APIs by category