IWMDINST – Installing Service Definition

The Install Service Definition routine is given control from the IWMDINST macro. The Install Service Definition macro will complete the parameter list with caller provided data and generate a stacking, program call to the install service.

The purpose of this routine is to install the WLM service definition supplied into the WLM couple data set for the current sysplex. After this service definition is installed in the couple data set all policies contained in it are eligible to be activated in the sysplex.

The service definition can be installed 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: 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 the IWMSVDEF.
• The service definition classification rules data area: Contains the definitions of the classification rules and classification groups that govern 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: 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: Contains the definitions of the application environments. This area is mapped by IWMSVAEA.
• The service definition scheduling environment data area: Contains the definitions of the scheduling environments. This area is mapped by IWMSVSEA.

The service definition descriptor element and all five data areas of the service definition must be passed as input to the install service definition service. Even if certain data areas are non-applicable, for example no notepad information exists, the data area header information must still be completely filled in and pointed to by the descriptor element.

All input data areas must represent a valid service definition in order for the install to occur. If validity checking for any section of the service definition fails, the entire install process is aborted and a return and reason code indicating that validation of the service definition failed is returned. In addition, a reason code describing the specific error detected is returned in the variable specified on keyword VALCHECK_RSN and an offset to the specific section of the service definition where the error was detected is returned in the variable specified on the VALCHECK_OFFSET keyword. Validity check processing occurs until the first error is detected and only a single error is identified on an invocation of this macro.

The caller can also request that the install occurs only if the service definition that was used as a base for the definition being installed is still the currently installed service definition in the WLM couple data set. This allows the caller the ability to prevent inadvertent overwrites of service definition updates that some other user (caller) made in the window, from when the service definition was initially read, to when the current install with the updated service definition was issued. For more details, refer to the description of the COND keyword.

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