IWMDEXTR – Extracting WLM Service Definition

The extract service definition routine is given control from the IWMDEXTR macro. The extract service definition macro will complete the parameter list with caller provided data and generate a stacking, program call to the extract service.

The purpose of this routine is to return a representation of the Workload Management service definition currently installed in the WLM couple data set for the current sysplex. The service definition returned contains all the policies that are currently eligible to be activated in the sysplex.

The information returned can be used by an application to be presented and manipulated by an end user. The install service definition macro IWMDINST, may be used to install a service definition into the WLM couple data set.

The service definition can be extracted either in XML format, or as a data area mapped by the IWMSERVD mapping macro. The XML structure is defined by the DTD described in Appendix C. Structure of the XML Service Definition (DTD). The IWMSERVD mapping is a single logical entity described by the service definition descriptor element, defined by IWMSERVD. The service definition descriptor element contains offsets to the 5 distinct areas that comprise the service definition:

• The general service definition data area.

  This data area contains general service definition information like the service definition name and description along with more detailed information like the policy, workload, service class and resource group information. This area is mapped by IWMSVDEF.

• The service definition classification rules data area.

  This data area contains the definitions of the classification rules and classification groups that define which service and report classes are associated with incoming work when the work enters MVS™. This area is mapped by IWMSVDCR.

• The notepad data area.

  This data area contains any comments (or change history) that an installation chooses to associate with the service definition. This area is mapped by IWMSVNPA.

• The service definition application environment data area.

  This data area contains the definitions of the application environments. This area is mapped by IWMSVAEA.

• The service definition scheduling environment data area.

  This data area contains the definitions of the scheduling environments. This area is mapped by IWMSVSEA.

The caller must provide sufficient storage to contain the service definition data requested. If insufficient storage is passed, no data is returned, an appropriate return and reason code is set, and the length required is returned in the variable specified in the QUERYLEN keyword.

Because the data returned is not serialized against future installs, the length returned may still change before the extract is issued again. Therefore, the caller must issue the extract service in a loop, checking return and reason codes, and obtaining a larger storage area as necessary.

The extract service definition macro is provided in list, execute, and standard form. The list form accepts no variable parameters and is used only to reserve space for the extract parameter list. The standard form is provided for use with routines which do not require reentrant code. The execute form is provided for use with the list format for reentrant routines. The extract macro is provided in PL/AS and assembler formats.

The parameter list must be in the caller's primary address space or be addressable by the dispatchable unit access list.