Copy Program Temporary Fix to Save File (QPZCPYSV) API


  Required Parameter Group:

1 Product information Input Char(*)
2 Product information format name Input Char(8)
3 Device name Input Char(10)
4 Error code I/O Char(*)

  Default Public Authority: *EXCLUDE

  Threadsafe: No

The Copy Program Temporary Fix to Save File (QPZCPYSV) API allows you to copy all program temporary fixes (PTFs) for the selected product from the media and store them in *SERVICE. The PTFs can then be displayed, loaded, or copied using the PTF commands. PTF group information can also be copied in addition to the PTFs.

A save file is created in library QGPL for each PTF that is copied. You can use the Retrieve Program Temporary Fix Information (QPZRTVFX) API to obtain the name of the save file.

If the PTF already exists in *SERVICE, the PTF is not copied.

Cover letters are copied to file QAPZCOVER in library QGPL.


Authorities and Locks

Device
*USE

Library QGPL
*USE

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


Required Parameter Group

Product information
INPUT; CHAR(*)

The information needed to put the PTF into the *SERVICE device.

Product information format name
INPUT; CHAR(8)

The name of the format that describes the product information. The only format name supported is:

PTFV0100 See PTFV0100 Format.

Device name
INPUT; CHAR(10)

The name of the optical device or tape device that contains the PTFs to be copied.

Error code
I/O; CHAR(*)

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


PTFV0100 Format

The following table describes the format for the product information parameter. The format identifies the product of the PTFs to be copied. For detailed descriptions of the fields, see Field Descriptions.

Offset Type Field
Dec Hex
0 0 BINARY(4) Length of product information
4 4 CHAR(7) Product ID
11 B CHAR(6) Release
17 11 CHAR(1) Automatically support product
18 12 CHAR(1) Copy PTFs
19 13 CHAR(1) Copy PTF Groups


Field Descriptions

Automatically support product. Indicates that when a PTF for a product currently not supported or installed on the system is found on the media, the product automatically will be marked as supported and the PTF will be copied. If the PTF affects a National Language Version, only the primary language of the system will be supported automatically. You can use the Add or Remove Product Support (QSZSPTPR) API to add support for additional languages.

This field is ignored when *SUPPTD is specified in the product ID field.

0 Do not automatically support the product
1 Automatically support the product

Copy PTFs. Indicates which PTFs to copy. If this field is not specified, a value of 0 is assumed.

0 Copy all PTFs regardless of their status.
1 Copy save files only for PTFs that do not have a status of superseded, temporarily applied, or permanently applied on your system.

Copy PTF Groups. Indicates if the information for PTF groups are to be copied in addition to the PTFs. The PTF groups can then be displayed using the WRKPTFGRP command or retrieved using the QpzListPtfGroupDetails API. Note this field only applies when the Product ID field specifies *ALL or *SUPPTD.

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 copying 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 copied.

If this field is not specified, a value of 0 is assumed.

0 Do not copy the PTF group information.
1 Copy an existing PTF group of the same name only when the level of the PTF group being copied is greater than the highest level of the PTF group on the system.
2 Copy an existing PTF group of the same name only when the level of the PTF group being copied is equal to or greater than the highest level of the PTF group on the system.
3 Always copy the PTF group information regardless of the existing levels of the PTF group of the same name. If the level of the PTF group being copied is lower than all other existing levels of the PTF group, it may be automatically deleted if the number of levels of the PTF group on the system exceeds value of the PTFGRPLVL parameter of the CHGSRVA command.

Length of product information. The length of data in the product information format, including this field. The only valid values for this field are 18 or 20.

Product ID. The name of the licensed products for which PTFs are to be copied. You can use the following special values for the product ID:

*ALL PTFs for all products, releases, options, and languages that are either supported or installed on this system are copied from the media.

Caution should be used when specifying this value and indicating automatic support for the product. PTF media frequently contains PTFs for all products available from your service provider. If you specify these values together, all PTFs from the media are copied on to your system.

*SUPPTD PTFs for all products, releases, options, and languages that are currently supported on this system are copied. PTFs for products that are installed but not supported are not copied.

Release. The version, release, and modification of the product. The release must be in the format VxRyMz. Valid values for x and y are 0 through 9. Valid values for z are 0 through 9 or A through Z. You can use the following special value for the release:

*ALL PTFs for all releases of the product will be copied.

A value other than *ALL is allowed only when a particular product is specified for the product ID field.


Error Messages

CPF24B4 E Severe error while addressing parameter list.
CPF35BE E Product &1 &3 not supported or installed.
CPF35CC E Library required for building PTFs already exists.
CPF35E0 E Error occurred copying PTF information.
CPF3C21 E Format name &1 is not valid.
CPF3C4B E Value not valid for field &1.
CPF3C4C E Value not valid for field &1.
CPF3CF1 E Error code parameter not valid.
CPF358A E Release not valid.
CPF3598 E PTF operation already in progress.
CPF36AF E PTF group operation already in progress.
CPF9814 E Device &1 not found.
CPF9820 E Not authorized to use library &1.
CPF9825 E Not authorized to device &1.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V4R4

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