| 1 | Product information | Input | Char(*) |
| 2 | Length of product information | Input | Binary(4) |
| 3 | Product information format name | Input | Char(8) |
| 4 | Requested action | Input | Binary(4) |
| 5 | Error Code | I/O | Char(*) |
The Add or Remove Product Support (QSZSPTPR) API adds or removes support to a product. The action is performed by specifying a product ID, release, option number, and load ID. When you are adding support to a product, you indicate that you want to be able to order and receive program temporary fixes (PTFs) to maintain that product. An information entry is also created for that product.
Removing product support does not remove related PTF save files or PTF information. PTFs for products that are not supported, however, cannot be distributed using the IBM® System Manager for i licensed program.
The product for which support is to be added or removed. For the structure of this parameter, see Format of Product Information Parameter.
The length of the product information parameter in bytes. The value specified must be at least 53.
The content and format of the product information. The possible format name is:
| SPTP0100 | The product information needed to add or remove support. |
The action to be performed against each of the products in the list. Valid values are:
| 1 | Adds support to the product passed in the first
parameter. When you use this value, you indicate that you want to provide
service support. If a product or product option contains information that is
translated to other languages, language support is automatically added for that
product or product option. The language supported is either the language for
the installed product or, if the product is not installed on this system, the
primary language that is installed for IBM i on this system. |
| 0 | Remove the current support information from the system. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table shows the format of the product information parameter. For a description of the fields in this format, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(7) | Product ID |
| 7 | 7 | CHAR(6) | Release |
| 13 | D | CHAR(4) | Product option |
| 17 | 11 | CHAR(10) | Load ID |
| 27 | 1B | CHAR(10) | Library |
| 37 | 25 | CHAR(2) | Registration type |
| 39 | 27 | CHAR(14) | Registration value |
Library. The name of the principal or main library of the product to be supported. This value is optional. If support is being removed or no library is specified when adding support, this field should contain blanks.
Load ID. The load ID of the product for which support is being added or removed. Load IDs are 4 characters in length; for example, 2924 is the load ID for an English national language version (NLV).
You can use this special value for the load ID:
| *CODE | The load ID of the code load for the given product ID, release, and option. |
Product ID. The 7-character ID for the product for which support is being added or removed.
Product option. The option number of the product for which support is being added or removed. Use 0000 for the base option. Valid values are 0000 through 0099, where each character is a digit.
Registration type. The registration type associated with the product. This value is optional. If the registration type is not specified, this field should contain blanks. Together, the registration type and registration value make up the registration identifier for the product.
The possible values are:
| 02 | The registration containing a country or region code, city
code, and telephone number. All values are 14 characters. This value is the
same as specifying *PHONE as the registration type when a product load or
product definition is created. |
| 04 | The registration value is the same as the
registration value for IBM i. The registration value field will be
ignored. |
| 08 | The registration containing a country or region code and IBM customer number. This value is the same as specifying *CUSTOMER as the registration type when a product load or product definition is created. |
Registration value. The registration value associated with the product. This is a 14-character value. If the registration type is not specified, this field should contain blanks. Together, the registration type and registration value make up the registration ID for the product.
Release. The version, release, and modification level of the product for which support is being added or removed. 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. For example, V2R1M0 is Version 2, Release 1, Modification 0.
| Message ID | Error Message Text |
|---|---|
| CPF0C1D E | Load ID &1 not valid. |
| CPF0C2A E | Error occurred while processing QSZSPTPR API. |
| CPF0C2B E | Code load ID &1 not valid. |
| CPF0C23 E | Support could be lost for some products. |
| CPF0C26 E | Length of product information not valid. |
| CPF0C27 E | Product identifier &1 not valid. |
| CPF0C28 E | Registration identifier not valid. |
| CPF0C29 E | Requested action not valid. |
| CPF0C4A E | Product record not found. |
| CPF0C4C E | Cannot allocate object &1 in library &2. |
| CPF0C4E E | Requested product already supported. |
| CPF0C4F E | Product &1 release &4 option &3 code load must be supported before a language can be supported. |
| CPF0C50 E | Requested product not supported. |
| CPF0C8A E | Product option &1 not valid. |
| CPF0C87 E | Library &1 not allowed. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C29 E | Object name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF358A E | Release not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |