Skip to content

Change Library Administration

Serena XML supports the following change library administration tasks for general use:

  • List Baseline Library Datasets - BASELIB SERVICE LIST

  • List Promotion Library Datasets - PROMLIB LIBRARY LIST

  • List Promotion Site Configuration Records - PROMLIB SITE LIST

  • List Production Library Datasets - PRODLIB SERVICE LIST

The syntax that identifies these functions appears in the name attribute of the <service> tag, as follows:

<service name="BASELIB"> 
<service name="PROMLIB**>
<service name="PRODLIB">

List Baseline Library Datasets - BASELIB SERVICE LIST

The Serena XML function to list baseline library datasets returns the fully qualified dataset names for the current baseline library and up to nine physical back-level libraries associated with a named application. All baseline libraries at all defined sites are included in the scope of this function. If no baseline libraries are defined, no results are returned in the reply message.

The Serena XML service/scope/message tags and attributes for messages to list baseline library datasets are:

<service name="BASELIB">
<scope name="SERVICE">
<message name="LIST">

These tags appear in both requests and replies.

BASELIB SERVICE LIST — Requests

Serena XML can request all baseline library datasets for an application. Alternatively, you can restrict the list of datasets returned to those for a particular library type or a particular site.

Example XML — BASELIB SERVICE LIST Request

<?xml version="1.0"?>
<service name="BASELIB">
    <scope name="SERVICE">
        <message name="LIST">
            <header>
                <subsys>8</subsys>
                <product>CMN</product>
            </header>
            <request>
                <applName>IMSQ</applName>
            </request>
        </message>
    </scope>
</service>

Data structure details for the <request> data element appear in Exhibit 11-1.

Exhibit 11-1. BASELIB SERVICE LIST <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Required 1 String (4), variable ZMF application name for which baseline datasets are requested.
NOTE: OK to omit trailing blanks.
<libType> Optional 0 - 1 String (3), variable Library type for which baseline datasets are requested.
NOTE: Use asterisk (*) wildcard or omit tag to include all library types.
<siteName> Optional 0 - 1 String (8), variable ZMF name of site where baseline libraries reside.
NOTE: Use asterisk (*) wildcard or omit tag to include all sites.

BASELIB SERVICE LIST — Replies

The reply message for this function returns zero to many <result> data elements. Each <result> tag lists baseline library datasets for one library type at a single site. All results apply to the application named in the request message.

The standard <response> data element follows any <result> tags in the reply and indicates the success or failure of the list request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. Because it is the final data element in the XML reply message, the <response> tag serves as an end-of-list marker.

Example XML — BASELIB SERVICE LIST Reply

<?xml version="1.0"?>
<service name="BASELIB">
    <scope name="SERVICE">
        <message name="LIST">
            <result>
                <applName>IMSQ</applName>
                <libType>SRC</libType>
                <installInProdOption>2</installInProdOption>
                <baseLibStorageMeans>7</baseLibStorageMeans>
                <baseLibLevel>010</baseLibLevel>
                <baseLibs>CMNTP.SERT8.BASE.IMSQ.SRC</baseLibs>
                <baseLibs>CMNTP.SERT8.BASE.IMSQ.SRC.DELTA</baseLibs>
                <baseLibs></baseLibs>
                <baseLibs></baseLibs>
                <baseLibs></baseLibs>
                <baseLibs></baseLibs>
                <baseLibs></baseLibs>
                <baseLibs></baseLibs>
                <baseLibs></baseLibs>
                <baseLibs></baseLibs>
                <baseLibName00>CMNTP.SERT8.BASE.IMSQ.SRC</baseLibName00>
                <baseLibName01>CMNTP.SERT8.BASE.IMSQ.SRC.DELTA</baseLibName01>
                <baseLibName02></baseLibName02>
                <baseLibName03></baseLibName03>
                <baseLibName04></baseLibName04>
                <baseLibName05></baseLibName05>
                <baseLibName06></baseLibName06>
                <baseLibName07></baseLibName07>
                <baseLibName08></baseLibName08>
                <baseLibName09></baseLibName09> 
            </result>
            .
            .
            .
            <response>
                <statusMessage>CMN8700I - Baseline library service completed</statusMessage>
                <statusReturnCode>00</statusReturnCode>
                <statusReasonCode>8700</statusReasonCode>
            </response>
        </message>
    </scope>  
</service>

Data structure details for the <result> tag appear in Exhibit 11-2.

Exhibit 11-2. BASELIB SERVICE LIST <result> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 1 String (4), variable ZMF application name.
<baseLibLevel> Optional 0 - 1 String (3), variable Number of baseline library levels maintained.
<baseLibName00> Optional 0 - 1 String (44), variable Dataset name for baseline library level 0.
<baseLibName01> Optional 0 - 1 String (44), variable Dataset name for baseline library level -1.
NOTE: This dataset also includes all back-level baseline ripples if <baseLibStorageMeans> is 3 or 7.
<baseLibName02> Optional 0 - 1 String (44), variable Dataset name for baseline library level -2.
NOTE: Returned only if value in <baseLibStorageMeans> is not 3 or 7.
<baseLibName03> Optional 0 - 1 String (44), variable Dataset name for baseline library level -3.
NOTE: Returned only if value in <baseLibStorageMeans> is not 3 or 7.
<baseLibName04> Optional 0 - 1 String (44), variable Dataset name for baseline library level -4.
NOTE: Returned only if value in <baseLibStorageMeans> is not 3 or 7.
<baseLibName05> Optional 0 - 1 String (44), variable Dataset name for baseline library level -5.
NOTE: Returned only if value in <baseLibStorageMeans> is not 3 or 7.
<baseLibName06> Optional 0 - 1 String (44), variable Dataset name for baseline library level -6.
NOTE: Returned only if value in <baseLibStorageMeans> is not 3 or 7.
<baseLibName07> Optional 0 - 1 String (44), variable Dataset name for baseline library level -7.
NOTE: Returned only if value in <baseLibStorageMeans> is not 3 or 7.
<baseLibName08> Optional 0 - 1 String (44), variable Dataset name for baseline library level -8.
NOTE: Returned only if value in <baseLibStorageMeans> is not 3 or 7.
<baseLibName09> Optional 0 - 1 String (44), variable Dataset name for baseline library level -9.
NOTE: Returned only if value in <baseLibStorageMeans> is not 3 or 7.
<baseLibs> Optional 0 - 10 String (44), variable Local baseline library dsname 0 - 9.
NOTE: The <baseLibs> tags were replaced by the <baseLibNamenn> tags but have been temporarily retained to provide backward compatibility for customers’ existing applications (they will be removed in a future release of ChangeMan ZMF). The <baseLibNamenn> tags should be used unless you have an existing custom application that uses the <baseLibs> tags.
<baseLibStorageMeans> Optional 0 -1 String (1) Code for baseline library storage method & format. Values:
2 = Delta deck (Obsolete)
3 = Librarian Archie
4 = Librarian5
5 = Panvalet
6 = PDS
7 = Stacked reverse delta H = HFS (Hierarchical File System)
<installInProdOption> Optional 0 - 1 String (1) Code for production install option. Values:
1 = Install if production library exists
2 = Don’t install in production library
3 = Install in production library
<libType> Optional 1 String (3), variable Library type included in baseline library.
<siteName> Optional 1 String (8), variable ZMF name of site where baseline library resides.

List Promotion Library Datasets - PROMLIB LIBRARY LIST

The Serena XML function to list promotion library datasets returns the fully qualified dataset names for the up to three target promotion datasets and the promotion shadow library associated with a named application. All promotion libraries at all defined sites and promotion levels are included in the scope of this function. If no promotion libraries are defined, no results are returned in the reply message.

The Serena XML service/scope/message tags and attributes for messages to list promotion library records are:

<service name="PROMLIB">
<scope name="LIBRARY">
<message name="LIST">

These tags appear in both requests and replies.

PROMLIB LIBRARY LIST — Requests

Serena XML can request an application’s promotion library records for one or all library types in the application and one or all promotion levels and sites where the application resides. Site-specific setup information is omitted.

Example XML — PROMLIB LIBRARY LIST Request

<?xml version="1.0"?>
<service name="PROMLIB">
    <scope name="LIBRARY">
        <message name="LIST">
            <header>
                <subsys>8</subsys>
                <product>CMN</product>
            </header>
            <request>
                <applName>IMSQ</applName>
            </request>
        </message>
    </scope>
</service>

Data structure details for the <request> data element appear in Exhibit 11-3.

Exhibit 11-3. PROMLIB LIBRARY LIST <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Required 1 String (4), variable ZMF application name.
NOTE: OK to omit trailing blanks.
<excludeSysLib> Optional 0 - 1 String (1) Y = Include only datasets for libraries that exclude syslib processing N = Include only datasets for libraries that allow syslib processing
NOTE: Use asterisk (*) wildcard or omit tag to include all syslib options.
<libType> Optional 0 - 1 String (3), variable Library type for which promotion library datasets are requested.
NOTE: Use asterisk (*) wildcard or omit tag to include all library types.
<promotionLevel> Optional 0 - 1 Integer (2), fixed Numeric relative promotion level for which promotion library datasets are requested.
NOTE: Corresponds to nickname in <promotionName>.
NOTE: Leading zeroes required.
NOTE: Use asterisk (*) wildcard or omit tag to include all promotion levels.
<promotionName> Optional 0 - 1 String (8), variable ZMF nickname for promotion library function & level desired.
NOTE: Corresponds to code in <promotionLevel>.
NOTE: Use asterisk (*) wildcard or omit tag to include all promotion levels.
<siteName> Optional 0 - 1 String (8), variable ZMF name of site where promotion library resides.
NOTE: Use asterisk (*) wildcard or omit tag to include all sites for application.

PROMLIB LIBRARY LIST — Replies

The reply message for this function returns zero to many <result> data elements. Each <result> tag lists all the promotion library datasets defined at a particular promotion level for a particular application, site, and library type. The dataset name for the corresponding shadow library also is returned.

The standard <response> data element follows any <result> tags in the reply and indicates the success or failure of the list request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. Because it is the final data element in the XML reply message, the <response> tag serves as an end-of-list marker.

Example XML — PROMLIB LIBRARY LIST Reply

<?xml version="1.0"?>
<service name="PROMLIB">
    <scope name="LIBRARY">
        <message name="LIST">
            <result>
                <applName>IMSQ</applName>
                <siteName>SERT8</siteName>
                <promotionName>C001AQA</promotionName>
                <promotionLevel>20</promotionLevel>
                <libType>CPY</libType>
                <shadowLib>CMNTP.SERT8.PROM.IMSQ.C001AQA.CPY</shadowLib>
                <promoLib01>CMNTP.SERT8.PROM.IMSQ.C001AQA.CPY</promoLib01>
                <excludeSysLib>Y</excludeSysLib>
            </result>
            <result>
                <applName>IMSQ</applName>
                <siteName>SERT8</siteName>
                <promotionName>C001AQA</promotionName>
                <promotionLevel>20</promotionLevel>
                <libType>DBB</libType>
                <shadowLib>CMNTP.SERT8.PROM.IMSQ.C001AQA.DBB</shadowLib>
                <promoLib01>CMNTP.SERT8.PROM.IMSQ.C001AQA.DBB</promoLib01>
                <excludeSysLib>Y</excludeSysLib>
            </result>
            .
            .
            .
            <response>
                <statusMessage>CMN8700I - Promo Library service completed</statusMessage>
                <statusReturnCode>00</statusReturnCode>
                <statusReasonCode>8700</statusReasonCode>
            </response>
        </message>
    </scope>
</service>

Data structure details for the <result> tag appear in Exhibit 11-4.

Exhibit 11-4. PROMLIB LIBRARY LIST <result> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 1 String (4), variable ZMF application name.
<excludeSysLib> Optional 0 - 1 String (1) Y = Exclude promotion library from system processing for JCL file tailoring & audit
N = Don’t exclude library from system processing for JCL file tailoring & audit
<hfsLib> Optional 0 - 1 String (1) Does promotion library reside in the z/OS Unix Hierarchical File System?
Y = Yes, HFS promotion library
N = No, not HFS library
<libType> Optional 1 String (3), variable Library type included in promotion library.
<promoLib01> Optional 0 -1 String (44), variable Fully qualified dataset name of first target promotion library.
<promoLib02> Optional 0 - 1 String (44), variable Fully qualified dataset name of second target promotion library.
<promoLib03> Optional 0 - 1 String (44), variable Fully qualified dataset name of third target promotion library.
<promotionLevel> Optional 0 - 1 Integer (2), fixed Numeric relative promotion level of promotion library. Corresponds to nickname in <promotionName>.
<promotionName> Optional 0 - 1 String (8), variable ZMF nickname corresponding to code in <promotionLevel>.
<shadowLib> Optional 0 -1 String (44), variable Fully qualified dataset name of local promotion shadow library.
NOTE: Returned only for remote promotion libraries.
<siteName> Required 1 String (8), variable ZMF name of site where promotion library resides.

List Promotion Site Configuration Records - PROMLIB SITE LIST

This function lists promotion site configuration records for a named application. All defined promotion sites and promotion levels are included in the scope of this function. If no promotion sites are defined, no results are returned in the reply message.

The Serena XML service/scope/message tags and attributes for messages to list promotion site configuration records are:

<service name="PROMLIB">
<scope name="SITE">
<message name="LIST">

These tags appear in both requests and replies.

PROMLIB SITE LIST — Requests

Serena XML can request an application’s promotion site configuration records for one or all promotion levels defined for an application. Records can be requested for an individual named site or for all sites.

Data structure details for the <request> data element appear in Exhibit 11-5.

Exhibit 11-5. PROMLIB SITE LIST <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Required 1 String (4), variable ZMF application name for which promotion site records are requested.
NOTE: OK to omit trailing blanks.
<promotionLevel> Optional 0 - 1 Integer (2), fixed Numeric relative promotion level for which site records are requested.
NOTE: Corresponds to value in <promotionName>.
NOTE: Leading zeroes required.
NOTE: Use asterisk (*) wildcard or omit tag to include all promotion levels.
<promotionName> Optional 0 - 1 String (8), variable ZMF nickname for promotion level for which site records are requested.
NOTE: Corresponds to value in <promotionLevel>.
NOTE: Use asterisk (*) wildcard or omit to include all promotion levels.
<siteName> Optional 0 - 1 String (8), variable ZMF name of promotion site desired.
NOTE: Use asterisk (*) wildcard or omit tag to include all sites for application.

PROMLIB SITE LIST — Replies

The reply message for this function returns zero to many <result> data elements. Each <result> tag contains site configuration information for one promotion library at one site and level associated with the application named in the request.

The standard <response> data element follows any <result> tags in the reply and indicates the success or failure of the list request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. Because it is the final data element in the XML reply message, the <response> tag serves as an end-of-list marker.

Data structure details for the <result> tag appear in Exhibit 11-6.

Exhibit 11-6. PROMLIB SITE LIST <result> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 1 String (4), variable ZMF application name.
<forcePriorSiteDemotion> Optional 0 - 1 String (1) Y = Force demotion from prior promotion level before promoting to this library.
N = Don’t force demotion from prior promotion level before promoting to this library.
<localInternalReaderClass> Optional 0 - 1 String (1) Output class for JCL promote & demote jobs submitted to internal reader on the local LPAR where ZMF runs.
<promoBuildProc> Optional 0 -1 String (8), variable Name of promotion build procedure defined for this application, site, and promotion level.
<promoEntity> Optional 0 -1 String (8), variable TSO ID of security entity that promotes application packages to this site and promotion level.
<promotionLevel> Optional 0 - 1 Integer (2), fixed Numeric relative promotion level listed promotion library.
<promotionName> Optional 0 - 1 String (8), variable ZMF nickname for promotion level in <promotionLevel>.
<siteInternalReaderClass> Optional 0 - 1 String (1) Output class for JCL promote & demote jobs submitted to internal reader at this remote site.
<siteName> Optional 1 String (8), variable ZMF name of promotion site listed.

List Production Library Datasets - PRODLIB SERVICE LIST

This function returns a list of fully qualified dataset names for all production libraries used with a named application. All defined production sites and library types are included in the scope of this function. If no production libraries or sites are defined, no results are returned in the reply message.

The Serena XML service/scope/message tags and attributes for messages to list production library records are:

<service name="PRODLIB">
<scope name="SERVICE">
<message name="LIST">

These tags appear in both requests and replies.

PRODLIB SERVICE LIST — Requests

Serena XML can request production library dataset names for one or all production sites and for one or all library types associated with a named application. Data structure details for the <request> data element appear in Exhibit 11-7.

Exhibit 11-7. Production Library Dataset List <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Required 1 String (4), variable ZMF application name for which production datasets are requested.
NOTE: OK to omit trailing blanks.
<libType> Optional 0 - 1 String (3), variable Library type for which production datasets are requested.
NOTE: Use asterisk (*) wildcard or omit tag to include all library types.
<siteName> Optional 0 - 1 String (8), variable ZMF name of site where production library resides.
NOTE: Use asterisk (*) wildcard or omit tag to include all production sites.

PRODLIB SERVICE LIST — Replies

The reply message for this function returns zero to many <result> data elements. Each <result> tag contains the fully qualified dataset name of a production library which allows a specific library type at a specific production site. Also returned are the dataset names for associated temporary and backup libraries.

The standard <response> data element follows any <result> tags in the reply and indicates the success or failure of the list request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. Because it is the final data element in the XML reply message, the <response> tag serves as an end-of-list marker.

Data structure details for the <result> tag appear in Exhibit 11-8.

Exhibit 11-8. PRODLIB SERVICE LIST <result> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 1 String (4), variable ZMF application name supported by the production library.
<backupLib> Optional 0 - 1 String (44), variable Fully qualified dataset name of the backup library for this production library.
<hfsLib> Optional 0 - 1 String (1) Does promotion library reside in the z/OS Unix Hierarchical File System? Y = Yes, HFS promotion library N = No, not HFS library
<libType> Optional 0 - 1 String (3), variable Library type supported by this production library.
<prodLib> Optional 0 - 1 String (44), variable Full qualified dataset name for this production library.
<siteName> Optional 0 - 1 String (8), variable ZMF name of site where this production library resides.
<tempLib> Optional 0 - 1 String (44), variable Fully qualified dataset name of the temporary library used with this production library.