Create PTF Group (QpzCreatePtfGroup) API


  Required Parameter Group:


  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:


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:

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



Input variable format name
INPUT; CHAR(8)

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



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 Format

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

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



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.



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:

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.

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:

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 valid values are 169 or 179.

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. The release can be passed as one of the following formats:

Replace group. The action to take when a PTF group of the same name already exists on the system.

The number of different levels of a PTF group of the same name that can exist on the system is controlled by the PTF group levels (PTFGRPLVL) parameter of the Change Service Attributes (CHGSRVA) command. When creating a PTF group with a new level, the PTFGRPLVL value indicates the maximum number of different levels of the PTF group that can exist on the system. The lowest levels of the PTF group will automatically be deleted, leaving only the highest levels of the PTF group on the system after the PTF group is created.

Valid values for this field are:

Target release.The release of the operating system on which the PTF group is to be used. Specifying a value other than *NONE for this parameter will cause the PTF group to be automatically deleted when the system is at a higher release than the specified target release and the PTF group does not contain PTFs for any installed or supported products. The target release must be V6R1M0 or later. If this field is not specified, the default value used is *NONE.

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


Error Messages


API introduced: V5R2

[ Back to top | Software Product APIs | APIs by category ]