IMS Development and Administration
Serena XML supports the following IMS database tasks for general use:
| *IMS Control Region Package Records - PACKAGE IMS_CRGN LIST | *IMS PSB Application Overrides - IMSOVRD APL_PSB LIST |
| *Package IMS ACB List - PACKAGE IMS_ACB LIST | *IMS DBD Global Overrides - IMSOVRD GBL_DBD LIST |
| *IMS DBD Package Overrides - IMSOVRD PKG_DBD LIST | *IMS PSB Global Overrides - IMSOVRD GBL_PSB LIST |
| *IMS PSB Package Overrides - IMSOVRD PKG_PSB LIST | *IMS Control Region Application Defaults - IMSCRGN APL LIST |
| *IMS DBD Application Overrides - IMSOVRD APL_DBD LIST | *IMS Control Region Global Defaults - IMSCRGN GBL LIST |
Much of the information presented in this chapter can also be obtained via the QP (Query Package) function, as shown in the following panels:
CMNLIST0 Package List Parameters
Command ===>
Package . . . . . . . . . . ACTP* (Full name or pattern; blank for list,
or '*' for all packages)
Package status . . . . . . ._____ (Dev, Frz, Dfz, Apr, Rej, Dis, Ins,
Bas, Bak, Opn, Clo, Tcc or Del)
Creator . . . . . . . . . . _______
Work request . . . . . . . ____________
Department . . . . . . . . _____
Package level . . . . . . . __ (1-Simple, 2-Complex,
3-Super, 4-Participating)
Package type . . . . . . . ___________ (Planned or Unplanned)
Package time span . . . . ______ (Permanent or Temporary)
Install date: from . . . . ___________ (yyyymmdd)
to . . . . . ___________ (yyyymmdd)
Creation date: from . . . ___________ (yyyymmdd)
to . . . . ___________ (yyyymmdd)
Enter "/" to select option
__ Other parameters
...
CMNLIST3 Change Package List Row 1 to 8 of 8
Command ===> _______________________________________________ Scroll ===> CSR
Package Sta Install Lvl Type Work request Dept Promote Aud Creator
QP ACTP000060 DEV 20150418 SMP PLN/PRM IDD 00 USER016
__ ACTP000061 BAS 20150324 SMP PLN/PRM 100001000106 IDD 00 00 USER015
__ ACTP000062 DEV 20150630 SMP PLN/PRM 100001000106 IDD 00 12 USER015
__ ACTP000063 BAS 20150324 SMP PLN/PRM 100001000106 IDD 00 00 USER015
__ ACTP000064 DEV 20150630 SMP PLN/PRM 100001000106 IDD 00 USER015
__ ACTP000065 DEV 20150405 SMP PLN/PRM IDD 00 USER016
__ ACTP000066 DEV 20150405 SMP PLN/PRM IDD 00 USER016
__ ACTP000067 DEV 20150428 SMP PLN/PRM IDD 00 USER016
****************************** Bottom of data *******************************
CMNQRY03 Package Information Categories Row 1 to 20 of 20
Command ===> _______________________________________________ Scroll ===> CSR
Package: ACTP000060 Status: DEV Install date: 20150418
__ General
__ Non-Source
__ Source
__ Source and Load Relationship
__ Renames and Scratches
__ Approval List
__ Site/Install Date Information
__ Site Activities Date and Time
__ Online Forms
__ Participating Package(s)
__ Status Start Date and Time
__ Revert Reasons
__ Backout Reasons
__ Promotion History
__ Promotion Libraries
__ Development Staging Libraries
__ Production Staging Libraries
__ Production Libraries
__ Baseline Libraries
S IMS Information
******************************* Bottom of data ******************************
CMNQRY32 IMS Package Options
Option ===>
Package: ACTP000060 Status: DEV Install date: 20150418
1. IMS Regions Display IMS Control Regions
2. ACB Statements Display ACB Build Statements
3. DBD Overrides Display DBD Override Statements
4. PSB Overrides Display PSB Override Statements
IMS Control Region Package Records - PACKAGE IMS_CRGN LIST
This function lists IMS control region information associated with a change package. The desired package name is required in the request message. Each returned record includes the control region ID, associated library names, the ZMF site name where the appropriate IMS subsystem resides, and package-level IMS override settings for building install jobs at staging and for generating IMS ACBs, DBDs, PSBs, and MFS source files at promotion. If no package-level overrides have been defined, application defaults are returned.
The Serena XML service/scope/message tags and attributes for messages to list IMS control region records for a package are:
<service name="PACKAGE">
<scope name="IMS_CRGN">
<message name="LIST">
These tags appear in both requests and replies.
PACKAGE IMS_CRGN LIST — Requests
Serena XML supports three types of IMS control region lists for a package:
-
Comprehensive List — Enter the name of the desired package in the <package> tag and omit all other tags to list all IMS control regions defined for the named package.
-
Selected Site — Enter the name of the desired package in the <package> tag. Also identify the desired IMS site in either <imsSiteName> (using the ZMF remote site name where the IMS subsystem executes) or in <imsLogicalSite> (using the ZMF name of the logical change library associated with the corresponding baseline or promotion site). The function returns all IMS control regions for the named package and desired site.
-
Selected Control Region — Enter the name of the desired package in the <package> tag and the 4-byte ID of the IMS control region of interest in the <imsControlRegion> tag to retrieve control region specifications for the named package and control region.
...
Example XML — PACKAGE IMS_CRGN LIST Request
<?xml version="1.0"?>
<service name="PACKAGE">
<scope name="IMS_CRGN">
<message name="LIST">
<header>
<subsys>8</subsys>
<product>CMN</product>
</header>
<request>
<package>IMSQ000012</package>
</request>
</message>
</scope>
</service>
Data structure details for the <request> data element appear in Exhibit 9-1
Exhibit 9-1 PACKAGE IMS_CRGN LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 0 - 1 | String (4), variable | ZMF application name. Same as first 4 bytes of package name. NOTE: OK to omit trailing blanks. NOTE: Not recommended as replacement for <package> tag. Use <package> instead of <applName> & <packageId>. |
| <imsControlRegion> | Optional | 0 - 1 | String (4), variable | IMS control region ID desired. NOTE: Use asterisk (*) wildcard or omit tag to request all IMS control regions for named package. |
| <imsLogicalSite> | Optional | 0 - 1 | String (8), variable | ZMF baseline or promotion library name corresponding to IMS site name in <imsSiteName>. NOTE: Value may be BASELINE (all caps) or the name of any promotion library defined in ZMF. NOTE: Use asterisk (*) wildcard or omit tag to request all IMS change library site names for package. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of remote site where IMS subsystem is running. NOTE: Use asterisk (*) wildcard or omit tag to request all IMS subsystem sites for package. |
| <package> | Required | 1 | String (10), variable | Fixed-format ZMF package name. |
| <packageId> | Optional | 0 - 1 | Integer (6), variable | ZMF package ID number. Same as last 6 bytes of package name. NOTE: Leading zeroes required. NOTE: Not recommended. Use <package> instead of <applName> & <packageId>. |
PACKAGE IMS_CRGN LIST — Replies
The reply message for a package-level IMS control region list returns zero to many <result> data elements. Each <result> tag contains information about one IMS control region associated with the package 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 — PACKAGE IMS_CRGN LIST Reply
<?xml version="1.0"?>
<service name="PACKAGE">
<scope name="IMS_CRGN">
<message name="LIST">
<result>
<package>IMSQ000012</package>
<applName>IMSQ</applName>
<packageId>000012</packageId>
<isDbdAlwaysGenerated>N</isDbdAlwaysGenerated>
<isPsbAlwaysGenerated>N</isPsbAlwaysGenerated>
<isMfsAlwaysGenerated>Y</isMfsAlwaysGenerated>
<isAcbAlwaysCreatedForPcbs>Y</isAcbAlwaysCreatedForPcbs>
<isImsGlobalActivationEnabled>Y</isImsGlobalActivationEnabled>
<imsControlRegion>C113</imsControlRegion>
<imsSiteName>SERT8</imsSiteName>
<imsLogicalSite>BASELINE</imsLogicalSite>
<imsDevCharSuffix>0</imsDevCharSuffix>
<imsResLib>SYS2.IMS910.SDFSRESL</imsResLib>
<imsMacLib>SYS2.IMS910.SDFSMAC</imsMacLib>
<imsModStatLib>CMNTP.SERT8.IMSC113.MODSTAT</imsModStatLib>
<imsGenMacroStageLib>USER24.SETQUERY.WORKLOAD</imsGenMacroStageLib>
<imsGenMacroComponent>STAGEII</imsGenMacroComponent>
<imsPsbLib>CMNTP.SERT8.IMSC113.PSBLIB</imsPsbLib>
<imsDbdLib>CMNTP.SERT8.IMSC113.DBDLIB</imsDbdLib>
<imsAcbLib>CMNTP.SERT8.IMSC113.ACBLIB</imsAcbLib>
<imsFmtLib>CMNTP.SERT8.IMSC113.FORMAT</imsFmtLib>
<imsRefLib>CMNTP.SERT8.IMSC113.REFERAL</imsRefLib>
<imsBackupModelLib>BACKUPMODEL</imsBackupModelLib>
</result>
<response>
<statusMessage>CMN8600I - The package IMS control region list is complete.</ statusMessage>
<statusReturnCode>00</statusReturnCode>
<statusReasonCode>8600</statusReasonCode>
</response>
</message>
</scope>
</service>
If option 1 from above PANEL CMNQRY32 is selected, information similar to that returned via a PACKAGE IMSCRGN LIST request is shown in panel CMNQRY33:
CMNQRY33 IMS System Definitions Row 1 to 20 of 20
Command ===> _______________________________________________ Scroll ===> CSR
Package: ACTP000060 Status: DEV Install date: 20150418
IMS Site Logical Active Devchar MFSgen PSBgen DBDgen ACB
id site y/n suffix y/n y/n y/n y/n
C113 SERT8 BASELINE Y 0 Y N N Y
Data structure details for the <result> tag appear in Exhibit 9-2.
Exhibit 9-2 PACKAGE IMS_CRGN LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 0 - 1 | String (4), fixed | ZMF application name. Same as first 4 bytes of package name. |
| <imsAcbLib> | Optional | 0 - 1 | String (44), variable | Name of dataset containing all prebuilt ACBs used by IMS control region in <imsControlRegion>. |
| <imsBackupModelLib> | Optional | 0 - 1 | String (25), variable | High-level node pattern for backups of IMS system libraries during ZMF promotion and install. |
| <imsControlRegion> | Optional | 0 - 1 | String (4), variable | SSID of IMS control region. |
| <imsDbdLib> | Optional | 0 - 1 | String (44), variable | Name of dataset containing all DBDs defined to IMS. |
| <imsDevCharSuffix> | Optional | 0 - 1 | String (1) | 1-byte suffix appended to name of IMS module that generates MFS source code. Sets 3270 or SLU2 device characteristics. |
| <imsFmtLib> | Optional | 0 - 1 | String (44), variable | Data set with all DIF/DOF and MID/ MOD control blocks used by control region in <imsControlRegion>. |
| <imsGenMacroComponent> | Optional | 0 - 1 | String (8), variable | Name of member containing source code that generated the IMS control region, databases, programs, & terminals. Member of <imsGenMacroStageLib>. |
| <imsGenMacroStageLib> | Optional | 0 - 1 | String (44), variable | Name of IMS system generation dataset containing the system generation member name. |
| <imsLogicalSite> | Optional | 0 - 1 | String (8), variable | IMS logical site. |
| <imsMacLib> | Optional | 0 - 1 | String (44), variable | Name of dataset with all IMS macros for system, PSB, DBD, ACB, & MFS generation. |
| <imsModStatLib> | Optional | 0 - 1 | String (44), variable | Name of sequential dataset containing active library information for MODBLKS, IMSACB, and FORMAT. |
| <imsPsbLib> | Optional | 0 - 1 | String (44), variable | Name of dataset containing all PSBs defined to IMS. |
| <imsRefLib> | Optional | 0 - 1 | String (44), variable | Name of referral library for MFS generation. Contains intermediate text block stored between steps in generation process. |
| <imsResLib> | Optional | 0 - 1 | String (44), variable | Name of APF-authorized IMS system library. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF ID for IMS site. |
| <isAcbAlwaysCreatedForPcbs> | Optional | 0 - 1 | String (1) | Y = Yes, ACB always generated for PSBs. N = No, generate ACB for PSBs only if needed. NOTE: ACB is always generated for DBDs. |
| <isDbdAlwaysGenerated> | Optional | 0 - 1 | String (1) | Y = Yes, DBD always generated. N = No, generate DBD only if override specified. |
| <isImsGlobalActivationEnabled> | Optional | 0 - 1 | String (1) | Y = Yes, global IMS package activation enabled N = No, global IMS package activation disabled |
| <isMfsAlwaysGenerated> | Optional | 0 - 1 | String (1) | Y = Yes, MFS always generated N = No, generate MFS only if <imsDevCharSuffix> value differs from IMS setup. |
| <isPsbAlwaysGenerated> | Optional | 0 - 1 | String (1) | Y = Yes, PSB always generated. N = No, generate PSB only if override specified. |
| <package> | Optional | 1 | String (10), variable | Fixed-format ZMF package name. |
| <packageId> | Optional | 0 - 1 | Integer (6), fixed | ZMF package ID number. Same as last 6 bytes of package name. |
Package IMS ACB List - PACKAGE IMS_ACB LIST
This function lists the IMS access method control block (ACB) build statements needed by a particular change package. The desired package name is required in the request message. Each returned record includes generation specifications for one ACB build statement associated with a specific IMS-enabled promotion site and a specific ACB source component. If no ACB build statements are defined for the package, no results are returned.
The Serena XML service/scope/message tags and attributes for messages to list IMS ACB build statements for a package are:
<service name="PACKAGE">
<scope name="IMS_ACB">
<message name="LIST">
These tags appear in both requests and replies.
PACKAGE IMS_ACB LIST — Request
Serena XML supports four types of IMS ACB record lists for a package:
-
Comprehensive List — Enter the name of the desired package in the <package> tag and omit all other tags to list all IMS ACB records defined for the named package.
-
Selected Site — Enter the name of the desired package in the <package> tag. Also identify the desired IMS site in either the <imsSiteName> tag (using the ZMF remote site name where the IMS subsystem executes) or in the <imsLogicalSite> tag (using the ZMF name of the logical change library associated with the corresponding baseline or promotion site). The function returns all IMS ACB records for the named package and desired site.
-
Selected Control Region — Enter the name of the desired package in the <package> tag and the 4-byte ID of the IMS control region of interest in the <imsSiteId> tag to retrieve IMS ACB records for the named package and control region.
-
Selected Source Component — Enter the name of the desired package in the <package> tag. Also enter the name of the desired ACB source component for the package from the relevant DBD library or PSB library in the <component> tag. If known, enter the source component library type in the <componentType> tag. The function returns a list of ACB records, including package-specific ACB target component names, associated with the identified ACB source component.
Example XML — PACKAGE IMS_ACB LIST Request
<?xml version="1.0"?>
<service name="PACKAGE">
<scope name="IMS_ACB">
<message name="LIST">
<header>
<subsys>8</subsys>
<product>CMN</product>
</header>
<request>
<package>IMSQ000012</package>
</request>
</message>
</scope>
</service>
Data structure details for the <request> data element appear in Exhibit 9-3.
Exhibit 9-3 PACKAGE IMS_ACB LIST <request>
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 0 - 1 | String (4), variable | ZMF application name. Same as first 4 bytes of package name. NOTE: OK to omit trailing blanks. NOTE: Not recommended as replacement for <package> tag. Use <package> instead of <applName> & <packageId>. |
| <component> | Optional | 0 - 1 | String (256), variable | Name of ACB source component in DBD library or PSB library used when generating a target ACB component. NOTE: Typically 8 bytes max. |
| <componentType> | Optional | 0 - 1 | String (3), variable | Library type for ACB source component named in <component> tag. |
| <imsLogicalSite> | Optional | 0 - 1 | String (8), variable | ZMF change library name corresponding to ZMF site name in <imsSiteName> tag. NOTE: Value may be BASELINE or the nickname of any promotion library defined in ZMF. |
| <imsSiteId> | Optional | 0 - 1 | String (4), variable | ZMF ID of IMS control region desired. NOTE: Every IMS control region is associated with a site. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of site where IMS subsystem executes. |
| <package> | Required | 1 | String (10), variable | Fixed-format ZMF package name. NOTE: May be masked using asterisk (*) wildcard character. |
| <packageId> | Optional | 0 - 1 | Integer (6), variable | ZMF package ID number. Same as last 6 bytes of package name. NOTE: Leading zeroes required. NOTE: Not recommended. Use <package> instead of <applName> & <packageId>. |
PACKAGE IMS_ACB LIST — Reply
The reply message for this function returns zero to many <result> data elements. Each <result> contains generation specifications for the IMS ACB build statements needed by a package. The standard <response> data element follows to indicate 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 follows the final <result> data structure in the reply, the <response> tag also serves as and end-of-list marker.
Example XML — PACKAGE IMS_ACB LIST Reply
<?xml version="1.0"?>
<service name="PACKAGE">
<scope name="IMS_ACB">
<message name="LIST">
<result>
<package>IMSQ000012</package>
<applName>IMSQ</applName>
<packageId>000012</packageId>
<isAcbGenerated>N</isAcbGenerated>
<acbGenStatementType>B</acbGenStatementType>
<acbStatementType>P</acbStatementType>
<imsSiteId>C113</imsSiteId>
<imsSiteName>SERT8</imsSiteName>
<imsLogicalSite>BASELINE</imsLogicalSite>
<targetComponent>IM2Q101</targetComponent>
<targetComponentType>PSL</targetComponentType>
<component>IM2Q101</component>
<componentType>PSB</componentType>
</result>
<response>
<statusMessage>CMN8600I - The package ACB Statement list is complete.</ statusMessage>
<statusReturnCode>00</statusReturnCode>
<statusReasonCode>8600</statusReasonCode>
</response>
</message>
</scope>
</service>
If option 2 from above PANEL CMNQRY32 is selected, information similar to that returned via a PACKAGE IMSACB LIST request is shown in panel CMNQRY34 below:
CMNQRY34 ACB Build Statements
Command ===> _______________________________________________ Scroll ===> CSR
Package: ACTP000060 Status: DEV Install date: 20150418
IMS Site Logical ACB Control PSB/DBD PSB/DBD Library
id site type statement source target type
C113 SERT8 BASELINE PSB BUILD IM2Q101 IM2Q101 PSB
Data structure details for the <result> tag appear in Exhibit 9-4.
Exhibit 9-4 PACKAGE IMS_ACB LIST <result>
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <acbGenStatementType> | Optional | 0 - 1 | String (1) | Code for type of ACB generation statement. Values: B = ACB Build Statement D = ACB Delete Statement |
| <acbStatementType> | Optional | 0 - 1 | String (1) | Code for type of ACB statement. Values: P = ACB PSB Statement D = ACB DBD Statement |
| <applName> | Optional | 0 - 1 | String (4), variable | ZMF application name. Same as first 4 bytes of package name. NOTE: OK to omit trailing blanks. NOTE: Not recommended as replacement for <package> tag. Use <package> instead of <applName> & <packageId>. |
| <component> | Optional | 0 - 1 | String (256), variable | Name of IMS source component for package ACB generation. Component located in IMS PSB library or DBD library defined in control region identified in <imsSiteId>. NOTE: Typically 8 bytes max. |
| <componentType> | Optional | 0 - 1 | String (3), variable | Library type for component named in <component> tag. |
| <imsLogicalSite> | Optional | 0 - 1 | String (8), variable | ZMF change library name corresponding to site name in <imsSiteName> tag. NOTE: Value may be BASELINE or the nickname of any promotion library defined in ZMF. |
| <imsSiteId> | Optional | 0 - 1 | String (4), variable | ZMF ID of IMS control region associated with <imsSiteName>. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of site where IMS subsystem executes. |
| <isAcbGenerated> | Optional | 0 - 1 | String (1) | Y = Yes, ACB always generated for both PSBs & DBDs N = No, generate ACB for PSBs only if needed. (ACB for DBDs always generated.) |
| <package> | Required | 1 | String (10), variable | Fixed-format ZMF package name. |
| <packageId> | Optional | 0 - 1 | Integer (6), variable | ZMF package ID number. Same as last 6 bytes of package name. NOTE: Leading zeroes required. NOTE: Not recommended. Use <package> instead of <applName> & <packageId>. |
| <targetComponent> | Optional | 0 - 1 | String (256), variable | Name of ACB target component generated at package promotion. NOTE: Typically 8 bytes max. |
| <targetComponentType> | Optional | 0 - 1 | String (3), variable | Library type for ACB target component named in <targetComponent> tag. |
IMS DBD Package Overrides - IMSOVRD PKG_DBD LIST
This function lists package-level overrides to the IMS database description (DBD) records associated with a specific component in the IMS DBD library. Values returned include the DBD source component, IMS control statement type, the original DBD control statement contents, and the override content for that DBD statement. If no DBD overrides are defined for a package, no results are returned.
The Serena XML service/scope/message tags and attributes for messages to list IMS DBD overrides for a package are:
<service name="IMSOVRD">
<scope name="PKG_DBD">
<message name="LIST">
These tags appear in both requests and replies.
IMSOVRD PKG_DBD LIST — Requests
Serena XML supports five types of DBD override lists for a package:
-
Comprehensive List — Enter the name of the desired package in the <package/> tag and omit all other tags to list all IMS DBD overrides defined for the named package.
-
Selected Site — Enter the name of the desired package in the <package/> tag. Also identify the desired IMS site in either the <imsSiteName/> tag (using the ZMF remote site name where the IMS subsystem executes) or in the <imsLogicalSite/> tag (using the ZMF nickname of the change library associated with the corresponding baseline or promotion site). The function returns all IMS DBD override statements for the named package and desired site.
-
Selected Control Region — Enter the name of the desired package in the <package/> tag and the 4-byte ID of the IMS control region of interest in the <imsSiteId/> tag to retrieve IMS DBD overrides for the named package and control region.
-
Selected Source Component — Enter the name of the desired package in the <package/> tag. Also enter the name of the desired DBD library source component to override in the <component/> tag. If known, enter the source component library type in the <componentType> tag. The function returns a list of DBD control statement overrides for the named package and source component.
-
Selected Control Statement Type — Enter the name of the desired package in the <package/> tag and the IMS keyword for the desired control statement type in the <controlStatement> tag. The function returns all DBD overrides of the desired type.
Example XML — IMSOVRD PKG_DBD LIST Request
<?xml version="1.0"?>
<service name="IMSOVRD">
<scope name="PKG_DBD">
<message name="LIST">
<header>
<subsys>8</subsys>
<product>CMN</product>
</header>
<request>
<package>IMSQ000012</package>
</request>
</message>
</scope>
</service>
Data structure details for the <request> data element appear in Exhibit 9-5. Note that the identical <request> syntax is used with both DBD and PSB override lists.
Exhibit 9-5 IMSOVRD PKG_DBD LIST <request>
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 0 - 1 | String (4), variable | ZMF application name. Same as first 4 bytes of package name. NOTE: OK to omit trailing blanks. NOTE: Not recommended as replacement for <package> tag. Use <package> instead of <applName> & <packageId>. |
| <component> | Optional | 0 - 1 | String (256), variable | Name of source component in IMS DBD (or PSB) library. NOTE: Use asterisk (*) wildcard or omit tag include all IMS source components referenced by a package. |
| <componentType> | Optional | 0 - 1 | String (3), variable | Library type for component named in <component> tag. NOTE: Use asterisk (*) wildcard or omit tag to include all IMS component library types. |
| <controlStatement> | Optional | 0 - 1 | String (8), variable | IMS keyword for type of IMS control statement being overridden. NOTE: Use asterisk (*) wildcard or omit tag to include all statement types. |
| <imsLogicalSite> | Optional | 0 - 1 | String (8), variable | ZMF change library nickname for site in <imsSiteName> tag. NOTE: Value may be BASELINE or the name of any promotion library defined in ZMF. NOTE: Use asterisk (*) wildcard or omit tag to include all change libraries for named package. |
| <imsSiteId> | Optional | 0 - 1 | String (4), variable | IMS control region ID associated with site in <imsSiteName>. NOTE: Use asterisk (*) wildcard or omit tag to include all IMS control regions for package. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of site where IMS subsystem executes. NOTE: Use asterisk (*) wildcard or omit tag to list all ZMF sites for package. |
| <package> | Required | 1 | String (10), variable | Fixed-format ZMF package name. |
| <packageId> | Optional | 0 - 1 | Integer (6), variable | ZMF package ID number. Same as last 6 bytes of package name. NOTE: Leading zeroes required. NOTE: Not recommended. Use <package> instead of <applName> & <packageId>. |
IMSOVRD PKG_DBD LIST — Replies
The reply message for a package-level IMS DBD override list returns zero to many <result> data elements. Each <result> contains package-level override information for one IMS database description (DBD) control statement associated with one IMS source component in an associated DBD library. If no DBD overrides are defined for the package, no <result> tags are returned in the reply.
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 — IMSOVRD PKG_DBD LIST Reply
<?xml version="1.0"?>
<service name="IMSOVRD">
<scope name="PKG_DBD">
<message name="LIST">
<result>
<package>IMSQ000012</package>
<applName>IMSQ</applName>
<packageId>000012</packageId>
<imsSiteId>C113</imsSiteId>
<imsSiteName>SERT8</imsSiteName>
<imsLogicalSite>BASELINE</imsLogicalSite>
<component>CUSEDBD</component>
<componentType>DBD</componentType>
<controlStatement>DATASET</controlStatement>
<overrideStatement>DATASET DD1=CUSEDD2,DEVICE=3390</overrideStatement>
<originalStatement>DATASET DD1=CUSEDD1,DEVICE=3390</originalStatement>
</result>
<response>
<statusMessage>CMN8600I - The package DBD overrides list is complete.</ statusMessage>
<statusReturnCode>00</statusReturnCode>
<statusReasonCode>8600</statusReasonCode>
</response>
</message>
</scope>
</service>
Some of the same information is presented in panel CMNQRY35:
CMNQRY35 DBD Override Control Statements
Command ===> _______________________________________________ Scroll ===> CSR
Package: ACTP000060 Status: DEV Install date: 20150418
IMS Site Logical Control DBD Library
id site statement name type
C113 SERT8 BASELINE DATASET CUSEDBD DBD
ORG DATASET DD1=CUSEDD1,DEVICE=3390
NEW DATASET DD1=CUSEDD2,DEVICE=3390
Data structure details for the <result> tag appear in Exhibit 9-6. Note that the identical <result> syntax is used with both DBD and PSB override lists.
Exhibit 9-6 IMSOVRD PKG_DBD LIST <result>
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 0 - 1 | String (4), variable | ZMF application name. Same as first 4 bytes of package name. |
| <component> | Optional | 0 - 1 | String (256), variable | Name of IMS source component to override in IMS DBD (or PSB) library. NOTE: Typically 8 bytes max. |
| <componentType> | Optional | 0 - 1 | String (3), variable | Library type for component named in <component> tag. |
| <controlStatement> | Optional | 0 - 1 | String (8), variable | IMS keyword for type of IMS control statement being overridden. |
| <imsLogicalSite> | Optional | 0 - 1 | String (8), variable | ZMF change library nickname for site in <imsSiteName> tag. NOTE: Value may be BASELINE or the name of any promotion library defined in ZMF. |
| <imsSiteId> | Optional | 0 - 1 | String (4), variable | IMS control region associated with site in <imsSiteName>. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of site where IMS subsystem executes. |
| <originalStatement> | Optional | 0 - 1 | String (64), variable | Contents of the original DBD (or PSB) control statement. |
| <overrideStatement> | Optional | 0 - 1 | String (64), variable | Contents of the DBD (or PSB) override statement for package. |
| <package> | Optional | 0 - 1 | String (10), variable | Fixed-format ZMF package name. |
| <packageId> | Optional | 0 - 1 | Integer (6), variable | ZMF package ID number. Same as last 6 bytes of package name. |
IMS PSB Package Overrides - IMSOVRD PKG_PSB LIST
This function lists package-level overrides to the IMS program specification block (PSB) control statements associated with a specific source component in the IMS PDB library. Values returned include the PSB source component, IMS control statement type, the original PSB control statement contents, and the override content for that PSB statement. If no PSB overrides are defined for a package, no results are returned.
The Serena XML service/scope/message tags and attributes for messages to list IMS PSB overrides for a package are:
These tags appear in both requests and replies.
IMSOVRD PKG_PSB LIST — Requests
Serena XML supports five types of PSB override lists for a package:
-
Comprehensive List — Enter the name of the desired package in the <package> tag and omit all other tags to list all IMS PSB overrides defined for the named package.
-
Selected Site — Enter the name of the desired package in the <package> tag. Also identify the desired IMS site in either the <imsSiteName> tag (using the ZMF remote site name where the IMS subsystem executes) or in the <imsLogicalSite> tag (using the ZMF nickname of the change library associated with the corresponding baseline or promotion site). The function returns all IMS PSB override statements for the named package and desired site.
-
Selected Control Region — Enter the name of the desired package in the <package> tag and the 4-byte ID of the IMS control region of interest in the <imsSiteId> tag to retrieve IMS PSB overrides for the named package and control region.
-
Selected Source Component — Enter the name of the desired package in the <package> tag. Also enter the name of the desired PSB library source component to override in the <component> tag. If known, enter the source component library type in the <componentType> tag. The function returns a list of PSB control statement overrides for the named package and source component.
-
Selected Control Statement Type — Enter the name of the desired package in the <package> tag and the IMS keyword for the desired control statement type in the <controlStatement> tag. The function returns all PSB overrides of the desired type.
The Serena XML syntax to request a list of package-level IMS PSB overrides is identical to that for DBD overrides. Data structure details for the <request> data element appear in Exhibit 9-5 of the previous section.
Example XML — IMSOVRD PKG_PSB LIST Request
<?xml version="1.0"?>
<service name="IMSOVRD">
<scope name="PKG_PSB">
<message name="LIST">
<header>
<subsys>8</subsys>
<product>CMN</product>
</header>
<request>
<package>IMSQ000012</package>
</request>
</message>
</scope>
</service>
IMSOVRD PKG_PSB LIST — Replies
The reply message for a package-level IMS PSB override list returns zero to many <result> data elements. Each <result> contains package-level override information for one IMS program specification block (PSB) control statement associated with one IMS source component in an associated PSB library. If no PSB overrides are defined for the package, no <result> tags are returned in the reply.
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.
The Serena XML reply syntax for a package-level IMS PSB override list is identical to that for a package-level DBD override list. Details for the <result> tag appear in Exhibit 9-6 of the previous section.
Example XML — IMSOVRD PKG_PSB LIST Reply
<?xml version="1.0"?>
<service name="IMSOVRD">
<scope name="PKG_PSB">
<message name="LIST">
<result>
<package>IMSQ000012</package>
<applName>IMSQ</applName>
<packageId>000012</packageId>
<imsSiteId>C113</imsSiteId>
<imsSiteName>SERT8</imsSiteName>
<imsLogicalSite>BASELINE</imsLogicalSite>
<component>IM2Q101</component>
<componentType>PSB</componentType>
<controlStatement>PSBGEN</controlStatement>
<overrideStatement>PSBGEN PSBNAME=IM2Q101,LANG=COBOL,CMPAT=YES</ overrideStatement>
<originalStatement>PSBGEN PSBNAME=IM2Q101,LANG=ASSEM,CMPAT=YES</ originalStatement>
</result>
<response\>
<statusMessage>CMN8600I - The package PSB overrides list is complete.</ statusMessage>
<statusReturnCode>00</statusReturnCode>
<statusReasonCode>8600</statusReasonCode>
</response>
</message>
</scope>
</service>
IMS DBD Application Overrides - IMSOVRD APL_DBD LIST
This function lists application-level overrides to the IMS database description (DBD) records in a specific source component in the IMS DBD library. Values returned include the DBD source component, IMS control statement type, the original DBD control statement contents, and the override content for that DBD statement. If no DBD overrides are defined for the application, no results are returned.
To retrieve APPLication level overrides and control region information via the ChangeMan ZMF started task, you can go to the application administration panels. In order to access these menus, you will need UPDATE authority to the APPLication’s security entity, as well as local admin authority.
IMSOVRD APL_DBD LIST
The Serena XML service/scope/message tags and attributes for messages to list IMS DBD overrides for an application are:
<service name="IMSOVRD">
<scope name="APL_DBD">
<message name="LIST">
These tags appear in both requests and replies.
IMSOVRD APL_DBD LIST — Requests
Serena XML supports five types of DBD override lists for an application:
-
Comprehensive List — Enter the name of the desired application in the <applName> tag and omit all other tags to list all IMS DBD overrides defined for that application.
-
Selected Site — Enter the name of the desired application in the <applName> tag. Also identify the desired IMS site in either the <imsSiteName> tag (using the ZMF remote site name where the IMS subsystem executes) or in the <imsLogicalSite> tag (using the ZMF nickname of the change library associated with the corresponding baseline or promotion site). The function returns all IMS DBD override statements for the named application and site.
-
Selected Control Region — Enter the name of the desired application in the <applName> tag and the 4-byte ID of the IMS control region of interest in the <imsSiteId> tag. The function returns IMS DBD overrides for the named application and control region.
-
Selected Source Component — Enter the name of the desired application in the <applName> tag. Also enter the name of the desired DBD library source component to override in the <component> tag. If known, enter the source component library type in the <componentType> tag. The function returns a list of DBD control statement overrides for the named application and source component.
-
Selected Control Statement Type — Enter the name of the desired application in the <applName> tag and the IMS keyword for the desired control statement type in the <controlStatement> tag. The function returns all DBD overrides of the desired type.
Example XML — IMSOVRD APL_DBD LIST Request
<?xml version="1.0"?>
<service name="IMSOVRD">
<scope name="APL_DBD">
<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 9-7. Note that the identical <request> syntax is used with both DBD and PSB record lists.
Exhibit 9-7 IMSOVRD APL_DBD LIST <request>
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Required | 1 | String (4), variable | ZMF application name. NOTE: OK to omit trailing blanks. |
| <component> | Optional | 0 - 1 | String (256), variable | Name of source component to override in IMS DBD (or PSB) library. NOTE: Use asterisk (*) wildcard or omit tag include all IMS source components referenced by an application. NOTE: Typically 8 bytes max. |
| <componentType> | Optional | 0 - 1 | String (3), variable | Library type for component named in <component> tag. NOTE: Use asterisk (*) wildcard or omit tag to include all IMS component library types. |
| <controlStatement> | Optional | 0 - 1 | String (8), variable | IMS keyword for type of IMS control statement being overridden. NOTE: Use asterisk (*) wildcard or omit tag to include all statement types. |
| <imsLogicalSite> | Optional | 0 - 1 | String (8), variable | ZMF change library nickname for site in <imsSiteName> tag. NOTE: Value may be BASELINE or the name of any promotion library defined in ZMF. NOTE: Use asterisk (*) wildcard or omit tag to include all change libraries for named application. |
| <imsSiteId> | Optional | 0 - 1 | String (4), variable | IMS control region ID associated with site in <imsSiteName>. NOTE: Use asterisk (*) wildcard or omit tag to include all IMS control regions for application. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of site where IMS subsystem executes. NOTE: Use asterisk (*) wildcard or omit tag to list all ZMF sites for application. |
IMSOVRD APL_DBD LIST — Replies
The reply message for this function returns zero to many <result> data elements. Each <result> contains application-level override information for one IMS database description (DBD) control statement in one IMS source component located in the IMS DBD library.
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 — IMSOVRD APL_DBD LIST Reply
<?xml version="1.0"?>
<service name="IMSOVRD">
<scope name="APL_DBD">
<message name="LIST">
<result>
<applName>IMSQ</applName>
<imsSiteId>C113</imsSiteId>
<imsSiteName>SERT8</imsSiteName>
<imsLogicalSite>BASELINE</imsLogicalSite>
<component>CUSEDBD</component>
<componentType>DBD</componentType>
<controlStatement>DATASET</controlStatement>
<overrideStatement>DATASET DD1=CUSEDD2,DEVICE=3390</overrideStatement>
<originalStatement>DATASET DD1=CUSEDD1,DEVICE=3390</originalStatement>
</result>
<response>
<statusMessage>CMN8600I - The IMS DBD Override list is complete.</statusMessage>
<statusReturnCode>00</statusReturnCode>
<statusReasonCode>8600</statusReasonCode>
</response>
</message>
</scope>
</service>
Data structure details for the <result> tag appear in Exhibit 9-8. Note that the identical <result> syntax is used with both DBD and PSB override lists.
Exhibit 9-8 IMSOVRD APL_DBD LIST <result>
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 0 - 1 | String (4), variable | ZMF application name. |
| <component> | Optional | 0 - 1 | String (256), variable | Name of IMS source component to override in IMS DBD (or PSB) library. NOTE: Typically 8 bytes max. |
| <componentType> | Optional | 0 - 1 | String (3), variable | Library type for component named in <component> tag. |
| <controlStatement> | Optional | 0 - 1 | String (8), variable | IMS keyword for type of IMS control statement being overridden. |
| <imsLogicalSite> | Optional | 0 - 1 | String (8), variable | ZMF change library nickname for site in <imsSiteName> tag. NOTE: Value may be BASELINE or the name of any promotion library defined in ZMF. |
| <imsSiteId> | Optional | 0 - 1 | String (4), variable | IMS control region associated with site in <imsSiteName>. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of site where IMS subsystem executes. |
| <originalStatement> | Optional | 0 - 1 | String (64), variable | Contents of the original DBD (or PSB) control statement. |
| <overrideStatement> | Optional | 0 - 1 | String (64), variable | Contents of the DBD (or PSB) override statement for package. |
IMS PSB Application Overrides - IMSOVRD APL_PSB LIST
This function lists application-level overrides to the IMS program specification block (PSB) control statements associated with a specific source component in the IMS PSB library. Values returned include the PSB source component, IMS control statement type, the original PSB control statement contents, and the override content for that PSB statement. If no PSB overrides are defined for the application, no results are returned.
The Serena XML service/scope/message tags and attributes for messages to list IMS PSB overrides for an application are:
<service name="IMSOVRD">
<scope name="APL_PSB">
<message name="LIST">
These tags appear in both requests and replies.
IMSOVRD APL_PSB LIST — Requests
Serena XML supports five types of PSB override lists for an application:
-
Comprehensive List — Enter the name of the desired application in the <applName> tag and omit all other tags to list all IMS PSB overrides defined for the application.
-
Selected Site — Enter the name of the desired application in the <applName> tag. Also identify the desired IMS site in either the <imsSiteName> tag (using the ZMF remote site name where the IMS subsystem executes) or in the <imsLogicalSite> tag (using the ZMF nickname of the change library associated with the corresponding baseline or promotion site). The function returns all IMS PSB override statements for the named application and site.
-
Selected Control Region — Enter the name of the desired application in the <applName> tag and the 4-byte ID of the IMS control region of interest in the <imsSiteId> tag. The function returns IMS PSB control statement overrides for the named application and control region.
-
Selected Source Component — Enter the name of the desired application in the <applName> tag. Also enter the name of the desired PSB library source component to override in the <component> tag. If known, enter the source component library type in the <componentType> tag. The function returns a list of PSB control statement overrides for the named application and source component.
-
Selected Control Statement Type — Enter the name of the desired application in the <applName> tag and the IMS keyword for the desired control statement type in the <controlStatement> tag. The function returns all PSB overrides of the desired type.
The Serena XML syntax for a request to list application-level IMS PSB overrides is identical to that for DBD overrides. Data structure details for the <request> data element appear in Exhibit 9-7 of the previous section.
IMSOVRD APL_PSB LIST — Replies
The reply message for this function returns zero to many <result> data elements. Each
<result> contains application-level overrides for one IMS program specification block (PSB) control statement in a specific PSB library source component. If no PSB overrides are defined for an application, no <result> tags are returned in the reply.
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.
The Serena XML reply syntax for an application-level IMS PSB override list is identical to that for application-level DBD overrides. Details for the <result> tag appear in Exhibit 9-8 of the previous section.
IMS DBD Global Overrides - IMSOVRD GBL_DBD LIST
To retrieve GLOBAL overrides and control region information via the ChangeMan ZMF started task, you can go to the GLOBAL administration panels. In order to access these menus, you will need GLOBAL admin authority.
IMSOVRD GBL_DBD LIST
This function lists ChangeMan ZMF global overrides to the IMS database description (DBD) records in a specific source component in the IMS DBD library. Values returned include the DBD source component, IMS control statement type, the original DBD control statement contents, and the override content for that DBD statement. If no DBD overrides are defined for at the global level, no results are returned.
The Serena XML service/scope/message tags and attributes for messages to list global IMS DBD overrides are:
<service name="IMSOVRD">
<scope name="GBL_DBD">
<message name="LIST">
These tags appear in both requests and replies.
IMSOVRD GBL_DBD LIST — Requests
Serena XML supports five types of DBD override lists at the global level:
-
Comprehensive List — Submit an empty <request> data element (that is, one that contains no subtags) in the XML request message. The <request> tag itself is required in the message to distinguish a request from a reply. All globally defined DBD overrides are returned in the reply message.
Note
XML syntax allows both a long form and a short form for empty tags. An empty <request> tag can therefore be coded in one of two ways.
Long form:
Equivalent short form:<request> </request><request/> -
Selected Site — Identify the desired IMS site in either the <imsSiteName> tag (using the ZMF remote site name where the IMS subsystem executes) or in the <imsLogicalSite> tag (using the ZMF nickname of the change library associated with the corresponding baseline or promotion site). The function returns all globally defined IMS DBD override statements for the named site.
-
Selected Control Region — Enter the 4-byte ID of the IMS control region of interest in the <imsSiteId> tag. The function returns all global IMS DBD overrides for the named control region.
-
Selected Source Component — Enter the name of the desired DBD library source component to override in the <component> tag. If known, enter the source component library type in the <componentType> tag. The function returns a list of global DBD control statement overrides for the named source component.
-
Selected Control Statement Type — Enter the IMS keyword for the desired control statement type in the <controlStatement> tag. The function returns all global DBD overrides of the desired type.
Data structure details for the <request> data element appear in Exhibit 9-9. Note that the identical <request> syntax is used with both DBD and PSB override lists.
Exhibit 9-9 IMSOVRD GBL_DBD, GBL_PSB LIST <request>
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <component> | Optional | 0 - 1 | String (256), variable | Name of source component to override in IMS DBD (or PSB) library. NOTE: Use asterisk (*) wildcard or omit tag to include all IMS source components with global ZMF overrides. NOTE: Typically 8 bytes max. |
| <componentType> | Optional | 0 - 1 | String (3), variable | Library type for component named in <component> tag. NOTE: Use asterisk (*) wildcard or omit tag to include all IMS component library types. |
| <controlStatement> | Optional | 0 - 1 | String (8), variable | IMS keyword for type of IMS control statement being overridden. NOTE: Use asterisk (*) wildcard or omit tag to include all statement types. |
| <imsSiteId> | Optional | 0 - 1 | String (4), variable | IMS control region ID associated with site in <imsSiteName>. NOTE: Use asterisk (*) wildcard or omit tag to include all IMS control regions. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of site where IMS subsystem executes. NOTE: Use asterisk (*) wildcard or omit tag to list all ZMF sites. |
Global IMS DBD Override List — Replies
The reply message for this function returns zero to many <result> data elements. Each <result> contains global override information for one IMS database description (DBD) control statement in one IMS source component located in the IMS DBD library.
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 9-10. Note that the identical <result> syntax is used with both DBD and PSB override lists.
Exhibit 9-10 Global IMS DBD and PSB Override List <result>
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <component> | Optional | 0 - 1 | String (256), variable | Name of IMS component in baseline library. NOTE: Typically 8 bytes max. |
| <componentType> | Optional | 0 - 1 | String (3), variable | Library type for component named in <component> tag. |
| <controlStatement> | Optional | 0 - 1 | String (8), variable | The type of DBD (or PSB) control statement that has the IMS override. |
| <imsSiteId> | Optional | 0 - 1 | String (4), variable | Name of IMS control region as specified by system programmer when IMS system was generated. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of site where IMS subsystem is running. May be D, P, or DP site. |
| <originalStatement> | Optional | 0 - 1 | String (64), variable | Contents of the original DBD (or PSB) control statement. |
| <overrideStatement> | Optional | 0 - 1 | String (64), variable | Contents of the DBD (or PSB) override statement. |
IMS PSB Global Overrides - IMSOVRD GBL_PSB LIST
This function lists ChangeMan ZMF global overrides to the IMS program specification block (PSB) control statements associated with a specific source component in the IMS PSB library. Values returned include the PSB source component, IMS control statement type, the original PSB control statement contents, and the override content for that PSB statement. If no global PSB overrides are defined, no results are returned.
The Serena XML service/scope/message tags and attributes for messages to list global IMS PSB overrides are:
<service name="IMSOVRD">
<scope name="GBL_PSB">
<message name="LIST">
These tags appear in both requests and replies.
IMSOVRD GBL_PSB LIST — Requests
Serena XML supports five types of PSB override lists at the global level:
-
Comprehensive List — Submit an empty <request> data element (that is, one that contains no subtags) in the XML request message. The <request> tag itself is required in the message to distinguish a request from a reply. All globally defined PSB overrides are returned in the reply message.
Note
XML syntax allows both a long form and a short form for empty tags. An empty <request> tag can therefore be coded in one of two ways.
Long form:
Equivalent short form:<request> </request><request/> -
Selected Site — Identify the desired IMS site in either the <imsSiteName> tag (using the ZMF remote site name where the IMS subsystem executes) or in the <imsLogicalSite> tag (using the ZMF nickname of the change library associated with the corresponding baseline or promotion site). The function returns all globally defined IMS PSB override statements for the named site.
-
Selected Control Region — Enter the 4-byte ID of the IMS control region of interest in the <imsSiteId> tag. The function returns all global IMS PSB overrides for the named control region.
-
Selected Source Component — Enter the name of the desired PSB library source component to override in the <component> tag. If known, enter the source component library type in the <componentType> tag. The function returns a list of global PSB control statement overrides for the named source component.
-
Selected Control Statement Type — Enter the IMS keyword for the desired control statement type in the <controlStatement> tag. The function returns all global PSB overrides of the desired type.
The Serena XML syntax for a request to list global IMS PSB records is identical to that for DBD overrides. Data structure details for the <request> data element appear in Exhibit 9-9 of the previous section.
IMSOVRD GBL_PSB LIST — Replies
The reply message for this function returns zero to many <result> data elements. Each <result> contains global override information for one IMS program specification block (PSB) control statement in one IMS source component located in the IMS PSB library.
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.
The Serena XML syntax for a message to list global IMS PSB records is identical to that for DBD overrides. Details for the <result> tag appear in Exhibit 9-10 of the previous section.
IMS Control Region Application Defaults - IMSCRGN APL LIST
This function lists IMS control region information associated with an application. The desired application name is required in the request message. Each returned record includes the control region ID, associated library names, the ZMF site name where the appropriate IMS subsystem resides, and application-level IMS override settings for building install jobs at staging and for generating IMS ACBs, DBDs, PSBs, and MFS source files at promotion.
The Serena XML service/scope/message tags and attributes for messages to list IMS control region records for an application are:
<service name="IMSCRGN">
<scope name="APL">
<message name="LIST">
These tags appear in both requests and replies.
IMSCRGN APL LIST — Requests
Serena XML supports three types of IMS control region lists for an application:
-
Comprehensive List — Enter the name of the desired application in the <applName> tag and omit all other tags to list all IMS control regions defined for the named application.
-
Selected Site — Enter the name of the desired application in the <applName> tag. Also identify the desired IMS site in either <imsSiteName> (using the ZMF remote site name where the IMS subsystem executes) or in <imsLogicalSite> (using the ZMF name of the logical change library associated with the corresponding baseline or promotion site). The function returns all IMS control regions for the named application and desired site.
-
Selected Control Region — Enter the name of the desired application in the <applName> tag and the 4-byte ID of the IMS control region of interest in the <imsControlRegion> tag to retrieve control region specifications for the named application and control region.
Example XML — IMSCRGN APL LIST Request
<?xml version="1.0"?>
<service name="IMSCRGN">
<scope name="APL">
<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 9-11.
Exhibit 9-11 IMSCRGN APL LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Required | 0 - 1 | String (4), variable | ZMF application name. NOTE: OK to omit trailing blanks. |
| <imsControlRegion> | Optional | 0 - 1 | String (4), variable | IMS control region ID. NOTE: Use asterisk (*) wildcard or omit tag to request all IMS control regions for named application. |
| <imsLogicalSite> | Optional | 0 - 1 | String (8), variable | ZMF baseline or promotion library name corresponding to IMS site name in <imsSiteName>. NOTE: Value may be BASELINE (all caps) or the name of any promotion library defined in ZMF. NOTE: Use asterisk (*) wildcard or omit tag to request all IMS change library site names for application. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of remote site where IMS subsystem is running. NOTE: Use asterisk (*) wildcard or omit tag to request all IMS subsystem sites for application. |
IMSCRGN APL LIST — Replies
The reply message for an application-level IMS control region list returns zero to many <result> data elements. The <result> subtags are similar to those of the PACKAGE IMS_CRGN LIST reply; the only difference is that the <applName>, <package>, and <packageId> tags are omitted in the IMSCRGN APL LIST reply. Refer to Exhibit 9-2 for data structure details.
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.
IMS Control Region Global Defaults - IMSCRGN GBL LIST
This function lists global IMS control region information. Each returned record includes the control region ID, associated library names, the ZMF site name where the appropriate IMS subsystem resides, and global-level IMS override settings for building install jobs at staging and for generating IMS ACBs, DBDs, PSBs, and MFS source files at promotion.
The Serena XML service/scope/message tags and attributes for messages to list global IMS control region records are:
<service name="IMSCRGN">
<scope name="GBL">
<message name="LIST">
These tags appear in both requests and replies.
IMSCRGN GBL LIST — Requests
Serena XML supports three types of IMS control region lists at the global level:
-
Comprehensive List — Submit an empty <request> data element (that is, one that contains no subtags) in the XML request message. The <request> tag itself is required in the message to distinguish a request from a reply. All globally-defined IMS control regions are returned in the reply message.
Note
XML syntax allows both a long form and a short form for empty tags. An empty <request> tag can therefore be coded in one of two ways.
Long form:
Equivalent short form:<request> </request><request/>- Selected Site — Identify the desired IMS site in the <imsSiteName> tag (using the ZMF remote site name where the IMS subsystem executes). The function returns all globallydefined IMS control regions for the named site.
-
Selected Control Region — Enter the 4-byte ID of the IMS control region of interest in the <imsControlRegion> tag. The function returns all global control region specifications for the named control region.
Data structure details for the <request> data element appear in Exhibit 9-12.
Exhibit 9-12 IMSCRGN GBL LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <imsControlRegion> | Optional | 0 - 1 | String (4), variable | IMS control region ID. NOTE: Use asterisk (*) wildcard or omit tag to request all IMS control regions. |
| <imsSiteName> | Optional | 0 - 1 | String (8), variable | ZMF name of remote site where IMS subsystem is running. NOTE: Use asterisk (*) wildcard or omit tag to request all IMS subsystem sites. |
IMSCRGN GBL LIST — Replies
The reply message for a global-level IMS control region list returns zero to many <result> data elements. The <result> subtags are similar to those of the PACKAGE IMS_CRGN
LIST reply; the only difference is that the <applName>, <imsLogicalSite>, <package>, and <packageId> tags are omitted in the IMSCRGN GBL LIST reply. Refer to Exhibit 9-2 for data structure details.
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.