Parameters

The parameters are explained as follows:

name

An optional symbol, starting in column 1, that is the name on the IWMDINST macro invocation. The name must conform to the rules for an ordinary assembler language symbol.

,COND=YES

,COND=NO

A required parameter, which indicates whether checking is performed prior to the install, to determine if the service definition that the input definition was based on is still the currently installed service definition (i.e. another user has not made updates).

,COND=YES

indicates that the input service definition should only be installed if the identifier of currently installed service definition matches the base identifier passed on IN_BASEID keyword. This allows the user to detect changes in the installed service definition, since the last extract was done, and allows the user to confirm whether the install should still occur.

,COND=NO

indicates that the input service definition should be installed unconditionally.

,IN_BASEID=in_baseid

When COND=YES is specified, a required input parameter, variable specifying an area that contains the identifier of the service definition that was used as a base for the service definition being installed. This area is mapped by the SVIDSSVD DESCT in macro IWMSVIDS.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,MF=S

,MF=(L,list addr)

,MF=(L,list addr,attr)

,MF=(L,list addr,0D)

,MF=(E,list addr)

,MF=(E,list addr,COMPLETE)

An optional input parameter that specifies the macro form.

Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service. MF=S is the default.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter may be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form of the macro stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,list addr

The name of a storage area to contain the parameters. For MF=S and MF=E, this can be an RS-type address or an address in register (1)-(12).

,attr

An optional 1- to 60-character input string that you use to force boundary alignment of the parameter list. Use a value of 0F to force the parameter list to a word boundary, or 0D to force the parameter list to a doubleword boundary. If you do not code attr, the system provides a value of 0D.

,COMPLETE

Specifies that the system is to check for required parameters and supply defaults for omitted optional parameters.

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

,PLISTVER=1

An optional input parameter that specifies the version of the macro. PLISTVER determines which parameter list the system generates. PLISTVER is an optional input parameter on all forms of the macro, including the list form. When using PLISTVER, specify it on all macro forms used for a request and with the same value on all of the macro forms. The values are:

• IMPLIED_VERSION, which is the lowest version that allows all parameters specified on the request to be processed. If you omit the PLISTVER parameter, IMPLIED_VERSION is the default.
• MAX, if you want the parameter list to be the largest size currently possible. This size might grow from release to release and affect the amount of storage that your program needs.

  If you can tolerate the size change, IBM® recommends that you always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is always long enough to hold all the parameters you might specify on the execute form; in this way, MAX ensures that the parameter list does not overwrite nearby storage.

• 0, which supports all parameters except those specifically referenced in higher versions.
• 1, which supports the following parameters and those from version 0:
  TYPE
  XML_LEN
  

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0, or 1

,PRODUCT_ID=product_id

A required input parameter, variable specifying an area that contains an identifier of the product (application) performing the install. The identifier should include information like product name, a unique version/release identifier, and any other information that can help identify your product. This area is mapped by the SVIDSPRD DSECT in the IWMSVIDS macro.

To code: Specify the RS-type address, or address in register (2)-(12), of a 32-character field.

,QRY_BASEID=qry_baseid

An optional output parameter, variable specifying an area to contain the identifier of the service definition that is currently installed on the WLM couple data set. This area is mapped by the SVIDSSVD DSECT in macro IWMSVIDS. When this keyword is specified, the data is returned when the return code indicates successful completion (return code 0) regardless of whether COND(YES) or COND(NO) was specified. In addition, this data is returned on a conditional request (COND(YES)) if the return and reason code indicate that specified IN_BASEID does not match the baseid of the installed service definition (return code 4, reason code '0413'X).

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15.

To code: Specify the RS-type address of a fullword field, or register (2)-(12).

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0.

To code: Specify the RS-type address of a fullword field, or register (2)-(12).

,TYPE=HEX

,TYPE=XML

An optional parameter indicating in which format the service definition will be extracted. The default is TYPE=HEX.

,TYPE=HEX

The service definition will be returned in HEX format mapped by IWMSERVD (default).

,TYPE=XML

The service definition will be returned in XML format.

SERVD_AREA=servd_area

A required input parameter, variable specifying an area that contains the service definition data to be installed. When TYPE=HEX is specified, this area is defined by the IWMSERVD macro. When TYPE=XML is specified, it is the area where the service definition XML stream is to be stored.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,VALCHECK_OFFSET=valcheck_offset

A required output parameter. The variable will contain the offset identifying the specific error in the input service definition found during validity checking. If the primary reason code is xxxx083D and the service definition type is HEX, the variable contains the offset from the beginning of the service definition (IWMSERVD) to the section of the input service definition where validity check processing found an error described by the reason code returned in VALCHECK_RSN. If the primary reason code is xxxx083D and the service definition type is XML, the VALCHECK_OFFSET has no meaning. If the primary reason code is xxxx08B2 or xxx08B5, the variable contains the offset from the beginning of the service definition in XML format. This offset is returned under the same conditions as when VALCHECK_RSN is returned.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.

,VALCHECK_RSN=valcheck_rsn

A required output parameter. The variable will contain the reason code identifying the specific error in the input service definition found during validity checking. This reason code is only returned if validation of the input service definition fails and a primary return code of 8 and reason code of xxxx083D, xxxx08B2, or xxxx08B5 is returned. If reason codes xxxx083D and xxxx08B5 are issued, refer to Appendix B. Application Validation Reason Codes for an explanation. If the primary reason code is xxxx08B2, refer to "XML System Services Users Guide and Reference" for an explanation.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.

,XML_LEN=xml_len

When TYPE=XML is specified, a required input parameter. The variable contains the length of the area specified on the SERVD_AREA keyword to contain the service definition data in XML format.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.