Developer Environment Administration
For administrators of the ChangeMan ZMF developer environment, Serena XML supports the following tasks for general use:
| List Global Library Types - LIBTYPE GBL LIST | List Application Build Procedures - PROCS APL LIST |
| List Application Library Types - LIBTYPE APL LIST | List Global Parameters - PARMS GBL LIST |
| List Global Language Parsers - LANGUAGE GBL LIST | Parameters Application List - PARMS APL LIST |
| List Application Language Parsers - LANGUAGE APL LIST | List Global Reason Codes - REASONS SERVICE LIST |
| List Global Build Procedures - PROCS GBL LIST |
The syntax that identifies these functions appears primarily in the name attribute of the <service> tag, as follows:
<service name="LIBTYPE">
<service name="LANGUAGE">
<service name="PROCS">
<service name="PARMS">
<service name="REASONS">
In addition, the name attribute of the <scope> tag is one of the following:
<service name="GBL">
<service name="APL">
List Global Library Types - LIBTYPE GBL LIST
LIBTYPE GBL LIST
This Serena XML function requests a list of all globally defined library types known to this instance of ChangeMan ZMF. Also returned with the library type is its "like-library" type, library type description, library-level options for staging versions and DBMS support, and dataset configuration settings.
The Serena XML service/scope/message tags and attributes for messages to list the globally library types are:
<service name="LIBTYPE">
<scope name="GBL">
<message name="LIST">
These tags appear in both requests and replies.
LIBTYPE GBL LIST — Request
This function supports four kinds of library type list requests:
-
All Library Types — Enter a "match-all" (asterisk) wild card in <libType> or omit this tag altogether to retrieve all globally defined library types and their specifications.
-
All "Like-Library" Library Types — Lists all physical library types assigned to the "likelibrary" category identified by code in the <likeType> tag of your request.
-
All DB2 Library Types — To list all DB2 library types, enter "Y" in the <isDb2LibType> tag of your request.
-
ChangeMan ZMF Settings for a Named Library Type — Lists the "like-library" type, library type description, library-level support options, and dataset configuration for the library type named in the <libType> tag of your request.
If you omit the <libType> tag from your request, you must still submit an empty <request> data element to identify the message as a request rather than a reply.
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:
<request>
</request>
<request\>
Data structure details for the <request> data element appear in Exhibit 11-16.
Exhibit 11-16 LIBTYPE GBL LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <isDb2LibType> | Optional | 0 - 1 | String (1) | Y = Include only DB2 libraries. N = Omit all DB2 libraries. NOTE: Omit tag or use asterisk (*) wildcard to request both DB2 and nonDB2 library types. |
| <libType> | Optional | 0 - 1 | String (3), variable | Name of physical library type. NOTE: Use asterisk (*) wildcard or omit tag to request all library types. |
| <likeType> | Optional | 0 - 1 | String (1) | Code for "like-library" type assigned to library type name. Values: 1 = Like Copy Library 2 = Like Load Library 3 = Like Other Library 4 = Like PDS Library 5 = Like Source Library 6 = Like Ncal Library 7 = Like Object Library |
| <userFunction> | Optional | 0 - 1 | String (1), variable | User function related to the service request. This modifies the behavior of the service. Values: 1 = Browse 2 = Checkout 3 = Create 4 = Delete 5 = Edit 6 = Edit and stage 7 = Recompile 8 = Relink 9 = Stage A = Update B = Checkin C = Build D = Browse listing E = Compare F = Scan G = Scratch/rename |
LIBTYPE GBL LIST — Reply
The reply message for this function returns zero to many <result> data elements. Each <result> tag contains the name and specifications for one globally defined library type.
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-17.
Exhibit 11-17 LIBTYPE GBL LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <apsDevLib> | Optional | 0 - 1 | String (44), variable | Fully qualified dataset name of APS development library associated with library type named in <libType>. NOTE: Required if <isApsLibType> value is Y. |
| <apsEntity> | Optional | 0 - 1 | String (8), variable | Name of APS security entity used to access APS development library. NOTE: Required if <isApsLibType> value is Y. |
| <bindControlSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 bind ctrl plan subtype N = Not DB2 bind ctrl plan subtype NOTE: Required if <isDb2LibType> value is Y. |
| <blockSize> | Optional | 0 - 1 | String (6), variable | Size of DASD block in bytes to use with staging library allocations for library type named in <libType>. |
| <chkOutActivityFile> | Optional | 0 - 1 | String (1) | Y = Yes, copy component to activity file at checkout. N = Don’t make activity file copy. |
| <chkOutComponentGenDesc> | Optional | 0 - 1 | String (1) | Y = Yes, copy component general description to staging change description at check-out. N = No, leave component change description blank in staging at check-out. |
| <db2SqlTerminationChar> | Optional | 0 - 1 | String (1) | DB2 SQL sentence termination character. |
| <dbrmSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DBRM subtype N = Not DBRM subtype |
| <ddlSqlSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 DDL/SQL subtype N = Not DB2 DDL/SQL subtype NOTE: Required if <isDb2LibType> value is Y. |
| <deferStageLibCreation> | Optional | 0 - 1 | String (1) | Y = Yes, defer allocation of library type in staging library until first component check-out to library type in <libType>. N = No, don’t defer library type creation, even if empty. |
| <dirBlocks> | Optional | 0 - 1 | String (6), variable | Blocks allocated in staging library to directory for this library type. NOTE: Size of block defined in <blockSize> tag. |
| <displayOrderNo> | Optional | 0 - 1 | Integer (undefined) | Display order number. This numeric value dictates the default order in which a list of items is displayed. |
| <eAttr> | Optional | 0 - 1 | String (1) | Extended attribute option. Values: N = Dataset cannot have extended attributes or reside in EAS. O = Dataset can have extended attributes and reside in EAS. blank = Default based on data type. |
| <imsEntity> | Optional | 0 - 1 | String (1) | IMS entity class for library type, if applicable. Values: 1 = PSB source 2 = DBD source 3 = MFS source 4 = PSB target 5 = DBD target 6 = FMT target 7 = REF target NOTE: Required if <isImsLibType> value is Y. |
| <includeUtilityInfo> | Optional | 0 - 1 | String (1) | Y = Yes, track scratch/rename utility activity for library type in <libType>. N = No, omit scratch/rename activity. |
| <isApsLibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is APS N = Not APS |
| <isDb2LibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is DB2 N = Not DB2 |
| <isHfsLibType> | Optional | 0 - 1 | String (1) | Y = Yes, this is HFS library type N = No, not HFS library type |
| <isImsLibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is IMS N = Not IMS |
| <isPdsLibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is PDS N = Not PDSE |
| <isPdseLibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is PDSE N = Not PDSE |
| <isPdseObject> | Optional | 0 - 1 | String (1) | Y = Yes, library type is PDSE Object N = Not PDSE Object |
| <isSsvAllowed> | Optional | 0 - 1 | String (1) | Y = Yes, SSV allowed N = No, SSV is not allowed |
| <isSsvEnforced> | Optional | 0 - 1 | String (1) | Y = Yes, SSV enforced N = No, SSV is not enforced |
| <isSysManaged> | Optional | 0 - 1 | String (1) | Y = Yes, System Managed N = No, not System Managed |
| <libType> | Optional | 0 - 1 | String (3), variable | Name of physical library type. |
| <libTypeDesc> | Optional | 0 - 1 | String (44), variable | Global description of library type. |
| <librarySequenceNo> | Optional | 0 - 1 | Integer (1), fixed | Syslib Concatenation Seq. No. |
| <likeType> | Optional | 0 - 1 | String (1) | Code for "like-library" type assigned to library type name. Values: 1 = Like Copy Library 2 = Like Load Library 3 = Like Other Library 4 = Like PDS Library 5 = Like Source Library 6 = Like Ncal Library 7 = Like Object Library |
| <packagBindControlSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 pkg bind control subtype N = Not DB2 pkg bind control subtype NOTE: Required if <isDb2LibType> value is Y. |
| <primarySpace> | Optional | 0 - 1 | String (8), variable | Minimum DASD space allocation in staging library for this library type. NOTE: Given in units defined by <spaceType> tag. |
| <recordFormat> | Required | 1 | String(3), variable | Code for logical record format. Values: F = Fixed FA = Fixed ASA FM = Fixed Machine FB = Fixed Block FBA = Fixed Block ASA FBM = Fixed Block Machine FBS = Fixed Block Standard FS = Fixed Standard FSA = Fixed Standard ASA FSM = Fixed Standard Machine V = Variable VA = Variable ASA VM = Variable Machine VB = Variable Block VBA = Variable Block ASA VBM = Variable Block Machine VS = Variable Spanned VSA = Variable Spanned ASA |
| VSM =Variable Spanned Machine U = Undefined UA = Undefined ASA UM = Undefined Machine UB = Undefined Block UBA = Undefined Block ASA UBM = Undefined Block Machine US = Undefined Spanned USA = Undefined Spanned ASA USM =Undefined Spanned Machine |
||||
| <recordLength> | Optional | 0 - 1 | String (6), variable | Length of data set record in bytes. |
| <secondarySpace> | Optional | 0 - 1 | String (8), variable | DASD allocation for extents in staging library for this library type. NOTE: Given in units defined by <spaceType> tag. |
| <spaceType> | Optional | 0 - 1 | String (3), variable | DASD space allocation unit in staging library for this library type. Values: Blk = Blocks Cyl = Cylinders Trk = Tracks |
| <sqlStoredProcDefinition> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 SQL stored procedure definition subtype N = Not DB2 SQL stored procedure NOTE: Required if <isDb2LibType> value is Y. |
| <ssvOption> | Optional | 0 - 1 | String (8), variable | Global option to save staging versions for library type named in <libType>. YES = Save staging versions. NO = Don’t save staging versions. OPT = Optional; save staging versions enabled by application. |
| <storedProcSubtype> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 stored procedure subtype N = Not DB2 stored procedure subtype NOTE: Required if <isDb2LibType> value is Y. |
| <targetActivityFile> | Optional | 0 - 1 | String (3), variable | Library type for check-out activity file associated with the library type named in <libType>. |
| <targetLoadLibtype> | Optional | 0 - 1 | String (3), variable | The "like-load" target library type associated with source library type in <libType>. NOTE: Required if library type is likesource, i.e. <likeType> value = 5. |
| <triggerSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 trigger subtype N = Not DB2 trigger subtype NOTE: Required if <isDb2LibType> value is Y. |
| <unitName> | Optional | 0 - 1 | String (8), variable | Logical unit name for DASD volume assigned to library type. |
| <volume> | Optional | 0 - 1 | String (6), variable | DASD reference volume serial ID. |
List Application Library Types - LIBTYPE APL LIST
This function requests a list of all library types defined for a named application. Also returned with the library type is its "like-library" type, library type description, library-level options for staging versions and DBMS support, and dataset configuration settings. Values not overridden at the application level are not returned in the results of this function. The global defaults used in place of such overrides are outside the scope of this function.
The Serena XML service/scope/message tags and attributes for messages to list the library type records for an application are:
<service name="LIBTYPE">
<scope name="APL">
<message name="LIST">
These tags appear in both requests and replies.
LIBTYPE APL LIST — Requests
This Serena XML function requests a list of library types defined for use with a named application. The application name is required in the request. The function supports four kinds of requests:
-
All Library Types — Name the application for which library types and their specifications are desired in the <applName> tag. Enter a "match-all" (asterisk) wild card in <libType> or omit this tag altogether. This retrieves a list of all library types defined for the application.
-
All "Like-Library" Library Types — Name the application for which library types and their specifications are desired in the <applName> tag. Enter a code corresponding to the "like-library" type of interest in the <likeType> tag. This requests a list of all physical library types assigned to the "like-library" category identified in the <likeType> tag and defined for the named application.
-
All DB2 Library Types — Name the application for which library types and their specifications are desired in the <applName> tag. Enter "Y" in the <isDb2LibType> tag. This requests all DB2 library types and specifications defined for the named application.
-
ChangeMan ZMF Settings for a Named Library Type — Name the application for which library type specifications are desired in the <applName> tag. Name the particular library type of interest in <libType>. The function lists the "like-library" type, library type description, library-level support options, and dataset configuration for the named library type as they are defined for the named application.
Data structure details for the <request> data element appear in Exhibit 11-18.
Exhibit 11-18 LIBTYPE APL 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. |
| <isDb2LibType> | Optional | 0 - 1 | String (1) | Y = Include only DB2 libraries. N = Omit all DB2 libraries. NOTE: Omit tag or use asterisk (*) wildcard to request both DB2 and nonDB2 library types. |
| <libType> | Optional | 0 - 1 | String (3), variable | Name of desired library type. NOTE: Use asterisk (*) wildcard or omit tag to request all library types. |
| <likeLibType> | Optional | 0 - 1 | String (1) | Code for "like-library" type assigned to library type name. Values: 1 = Like Copy Library 2 = Like Load Library 3 = Like Other Library 4 = Like PDS Library 5 = Like Source Library 6 = Like Ncal Library 7 = Like Object Library |
| <userFunction> | Optional | 0 - 1 | String (1), variable | User function related to the service request. This modifies the behavior of the service. Values: 1 = Browse 2 = Checkout 3 = Create 4 = Delete 5 = Edit 6 = Edit and stage 7 = Recompile 8 = Relink 9 = Stage |
| A = Update B = Checkin C = Build D = Browse listing E = Compare F = Scan G = Scratch/rename |
LIBTYPE APL LIST — Replies
The reply message for this function returns zero to many <result> data elements. Each <result> tag contains information about one library type defined for the named application.
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-19.
Exhibit 11-19 LIBTYPE APL LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 0 - 1 | String (4), variable | ZMF application name. NOTE: OK to omit trailing blanks. |
| <apsDevLib> | Optional | 0 - 1 | String (44), variable | Fully qualified dataset name of APS development library associated with library type named in <libType>. NOTE: Required if <isApsLibType> value is Y. |
| <apsEntity> | Optional | 0 - 1 | String (8), variable | Name of APS security entity used to access APS development library. NOTE: Required if <isApsLibType> value is Y. |
| <blockSize> | Optional | 0 - 1 | String (6), variable | Size of DASD block in bytes to use with staging library allocations for library type named in <libType>. |
| <chkOutActivityFile> | Optional | 0 - 1 | String (1) | Y = Yes, copy component to activity file at checkout. N = Don’t make activity file copy. |
| <chkOutComponentGenDesc> | Optional | 0 - 1 | String (1) | Y = Yes, copy component general description to staging change description at check-out. N = No, leave component change description blank in staging at check-out. |
| <db2SqlTerminationChar> | Optional | 0 - 1 | String (1) | DB2 SQL sentence termination character. |
| <dbrmSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DBRM subtype N = Not DBRM subtype |
| <ddlSqlSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 DDL/SQL subtype N = Not DB2 DDL/SQL subtype NOTE: Required if <isDb2LibType> value is Y. |
| <deferStageLibCreation> | Optional | 0 - 1 | String (1) | Y = Yes, defer allocation of library type in staging library until first component check-out to library type in <libType>. N = No, don’t defer library type creation, even if empty. |
| <dirBlocks> | Optional | 0 - 1 | String (6), variable | Blocks allocated in staging library to directory for this library type. NOTE: Size of block defined in <blockSize> tag. |
| <displayOrderNo> | Optional | 0 - 1 | Integer (undefined) | Display order number. This numeric value dictates the default order in which a list of items is displayed. |
| <eAttr> | Optional | 0 - 1 | String (1) | Extended attribute option. Values: N = Dataset cannot have extended attributes or reside in EAS. O = Dataset can have extended attributes and reside in EAS. blank = Default based on data type. |
| <imsEntity> | Optional | 0 - 1 | String (1) | IMS entity class for library type, if applicable. Values: 1 = PSB source 2 = DBD source 3 = MFS source 4 = PSB target 5 = DBD target 6 = FMT target 7 = REF target NOTE: Required if <isImsLibType> value is Y. |
| <includeUtilityInfo> | Optional | 0 - 1 | String (1) | Y = Yes, track scratch/rename utility activity for library type in <libType>. N = No, omit scratch/rename activity. |
| <includeUtilityInfo> | Optional | 0 - 1 | String (1) | Y = Include utility comp info. N = Do not include utility comp info. |
| <isApsLibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is APS N = Not APS |
| <isDb2LibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is DB2 N = Not DB2 |
| <isHfsLibType> | Optional | 0 - 1 | String (1) | Y = Yes, this is HFS library type N = No, not HFS library type |
| <isImsLibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is IMS N = Not IMS |
| <isPdsLibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is PDS N = Not PDS |
| <isPdseLibType> | Optional | 0 - 1 | String (1) | Y = Yes, library type is PDSE N = Not PDSE |
| <isPdseObject> | Optional | 0 - 1 | String (1) | Y = PDSE Object lib N = Not PDSE Object lib |
| <isSsvAllowed> | Optional | 0 - 1 | String (1) | Y = SSV allowed N = SSV not allowed |
| <isSsvEnforced> | Optional | 0 - 1 | String (1) | Y = SSV enforced N = SSV not enforced |
| <isSysManaged> | Optional | 0 - 1 | String (1) | Y = System Managed N = Not System Managed |
| <libType> | Optional | 0 - 1 | String (3), variable | Name of physical library type. |
| <libTypeDesc> | Optional | 0 - 1 | String (44), variable | Global description of library type. |
| <librarySequenceNo> | Optional | 0 - 1 | String (3) | SYSLIB concatenation sequence number. |
| <likeType> | Optional | 0 - 1 | String (1) | Code for "like-library" type assigned to library type name. Values: 1 = Like Copy Library 2 = Like Load Library 3 = Like Other Library 4 = Like PDS Library 5 = Like Source Library 6 = Like Ncal Library 7 = Like Object Library |
| <packagBindControlSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 pkg bind control subtype N = Not DB2 pkg bind control subtype NOTE: Required if <isDb2LibType> value is Y. |
| <planBindControlSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 bind ctrl plan subtype N = Not DB2 bind ctrl plan subtype NOTE: Required if <isDb2LibType> value is Y. |
| <primarySpace> | Optional | 0 - 1 | String (8), variable | Minimum DASD space allocation in staging library for this library type. NOTE: Given in units defined by <spaceType> tag. |
| <recordFormat> | Optional | 0 - 2 | String(3), variable | Code for logical record format. Values: F = Fixed FA = Fixed ASA FM = Fixed Machine FB = Fixed Block FBA = Fixed Block ASA FBM = Fixed Block Machine FBS = Fixed Block Standard FS = Fixed Standard FSA = Fixed Standard ASA FSM = Fixed Standard Machine V = Variable VA = Variable ASA VM = Variable Machine VB = Variable Block |
| VBA = Variable Block ASA VBM = Variable Block Machine VS = Variable Spanned VSA = Variable Spanned ASA VSM =Variable Spanned Machine U = Undefined UA = Undefined ASA UM = Undefined Machine |
||||
| UB = Undefined Block UBA = Undefined Block ASA UBM = Undefined Block Machine US = Undefined Spanned USA = Undefined Spanned ASA USM =Undefined Spanned Machine |
||||
| <recordLength> | Optional | 0 - 1 | String (6), variable | Length of data set record in bytes. |
| <secondarySpace> | Optional | 0 - 1 | String (8), variable | DASD allocation for extents in staging library for this library type. NOTE: Given in units defined by <spaceType> tag. |
| <spaceType> | Optional | 0 - 1 | String (3), variable | DASD space allocation unit in staging library for this library type. Values: Blk = Blocks Cyl = Cylinders Trk = Tracks |
| <sqlStoredProcDefinition> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 SQL stored procedure definition subtype N = Not DB2 SQL stored procedure NOTE: Required if <isDb2LibType> value is Y. |
| <ssvOption> | Optional | 0 - 1 | String (8), variable | Application-level option to save staging versions for library type in <libType>. Always = Always save staging version Prompt = Prompt to save staging version None = No staging version option set; take global default |
| <storedProcSubtype> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 stored procedure subtype N = Not DB2 stored procedure subtype NOTE: Required if <isDb2LibType> value is Y. |
| <targetActivityFile> | Optional | 0 - 1 | String (3), variable | Library type for check-out activity file associated with the library type named in <libType>. |
| <targetLoadLibtype> | Optional | 0 - 1 | String (3), variable | The "like-load" target library type associated with source library type in <libType>. NOTE: Required if library type is likesource, i.e. <likeType> value = 5. |
| <triggerSubType> | Optional | 0 - 1 | String (1) | Y = Yes, DB2 trigger subtype N = Not DB2 trigger subtype NOTE: Required if <isDb2LibType> value is Y. |
| <unitName> | Optional | 0 - 1 | String (8), variable | Logical unit name for DASD volume assigned to library type. |
| <volume> | Optional | 0 - 1 | String (6), variable | DASD reference volume serial ID. |
List Global Language Parsers - LANGUAGE GBL LIST
This function lists the parsers assigned to each globally defined programming language in ChangeMan ZMF. If no languages have been defined at the global level, no results are returned by this function.
The Serena XML service/scope/message tags and attributes for messages to list globally defined programming language parsers are:
<service name="LANGUAGE">
<scope name="GBL">
<message name="LIST">
These tags appear in both requests and replies.
LANGUAGE GBL LIST — Requests
The request message for this function identifies one or all globally defined programming languages whose parsers are of interest. To list all globally defined languages and their parsers, use a "match-all" (asterisk) wildcard character in the <language> tag, or omit this tag altogether and submit an empty <request>. Enter a specific language name to retrieve the parser for that language.
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:
<request>
</request>
Equivalent short form:
<request\>
Data structure details for the <request> data element appear in Exhibit 11-20.
Exhibit 11-20 LANGUAGE GBL LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <language> | Optional | 1 | String (8), variable | Programming language desired. NOTE: Use asterisk (*) wildcard or omit tag to request parsers for all languages. |
LANGUAGE GBL LIST — Replies
The reply message for this function returns zero to many <result> data elements. Each <result> tag contains one globally defined language and parser combination.
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-21.
Exhibit 11-21 LANGUAGE GBL LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <displayOrderNo> | Optional | 0 - 1 | Integer (undefined) | Display order number. This numeric value dictates the default order in which a list of items is displayed. |
| <language> | Optional | 0 - 1 | String (8), variable | Name of programming language. |
List Application Language Parsers - LANGUAGE APL LIST
This function lists application-level parser overrides for the programming languages used in a named application. If no language parser is defined at the application level, no results are returned. Global parser defaults for languages without an application-level override are outside the scope of this function.
The Serena XML service/scope/message tags and attributes for messages to list the programming language parsers for an application are:
<service name="LANGUAGE">
<scope name="APL">
<message name="LIST">
These tags appear in both requests and replies.
LANGUAGE APL LIST — Requests
The request message for this function requires the name of the desired application in the
Data structure details for the <request> data element appear in Exhibit 11-22.
Exhibit 11-22 LANGUAGE APL LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Required | 1 | String (4), variable | ZMF application name desired. NOTE: OK to omit trailing blanks. |
| <language> | Optional | 0 - 1 | String (8), variable | Programming language desired. NOTE: Use asterisk (*) wildcard or omit tag to request all languages. |
LANGUAGE APL LIST — Replies
The reply message for this function returns zero to many <result> data elements. Each <result> tag contains information about one language and parser combination defined to override global defaults for the named application.
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-23.
Exhibit 11-23 LANGUAGE APL LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 0 - 1 | String (4), variable | ZMF application name. |
| <displayOrderNo> | Optional | 0 - 1 | Integer (undefined) | Display order number. This numeric value dictates the default order in which a list of items is displayed. |
| <language> | Optional | 0 - 1 | String (8), variable | Name of programming language with application-level parser override. |
| <parser> | Optional | 0 - 1 | String (8), variable | Name of language parsing routine defined for application. |
List Global Build Procedures - PROCS GBL LIST
This function lists globally defined build procedures, their descriptions, and their associated programming languages and parsers. If no build procedures are defined at the global level, no results are returned.
The Serena XML service/scope/message tags and attributes for messages to list globally defined build procedures are:
<service name="PROCS">
<scope name="GBL">
<message name="LIST">
These tags appear in both requests and replies.
PROCS GBL LIST — Requests
Request messages for the global build procedure list take one of three forms:
-
All Build Procedures — To request all globally defined build procedures, enter a "matchall" (asterisk) wildcard character in both the <procName> and <language> tags. Alternatively, omit both tags and submit and empty <request> data structure.
-
Build Procedures Defined for Named Language — Name the language of interest in the <language> tag to request all build procedures that support that language.
-
Language Defined for Named Build Procedure — Name the build procedure of interest in the <procName> tag to request its description, language, and parser definition.
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:
<request>
</request>
<request\>
Data structure details for the <request> data element appear in Exhibit 11-24.
Exhibit 11-24 PROCS GBL LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <language> | Optional | 0 - 1 | String (8), variable | Programming language desired. NOTE: Use asterisk (*) wildcard or omit tag to request all languages. |
| <procName> | Optional | 0 - 1 | String (8), variable | Name of build procedure desired. NOTE: Use asterisk (*) wildcard or omit tag to request all build procedures. |
PROCS GBL LIST — Replies
The reply message for this function returns zero to many <result> data elements. Each <result> tag contains information about one globally defined build procedure.
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-25.
Exhibit 11-25 PROCS GBL LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <displayOrderNo> | Optional | 0 - 1 | String (1) | This numeric value dictates the default order in which a list of items is displayed. |
| <language> | Optional | 0 - 1 | String (8), variable | Name of programming language supported by build procedure in <procName>. |
| <parser> | Optional | 0 - 1 | String (8), variable | Name of language parsing routine defined for build procedure in <procName>. |
| <procDesc> | Optional | 0 - 1 | String (44), variable | Global description of build procedure named in <procName>. |
| <procName> | Optional | 0 - 1 | String (8), variable | Name of globally defined build procedure. |
This function lists application build procedures, their descriptions, and their associated programming languages and parsers. If no build procedures are defined at the application level, no results are returned. Global build procedure defaults are outside the scope of this function.
The Serena XML service/scope/message tags and attributes for messages to list application build procedures are:
<service name="PROCS">
<scope name="APL">
<message name="LIST">
These tags appear in both requests and replies.
PROCS APL LIST — Requests
Request messages for the application build procedure list take one of three forms:
-
All Build Procedures — To request all build procedures defined for an application, name the desired application in the
tag and omit all other tags from the request. -
Build Procedures Defined for Named Language — Name the application of interest in the <applName> tag and the language of interest in the
tag to request all application build procedures that support that language. -
Language Defined for Named Build Procedure — Name the application of interest in the <applName> tag and the build procedure of interest in the <procName> tag to request the description, language, and parser definition for that build procedure.
Data structure details for the <request> data element appear in Exhibit 11-26.
Exhibit 11-26 PROCS APL LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Required | 1 | String (4), variable | ZMF application name desired. NOTE: OK to omit trailing blanks. |
| <language> | Optional | 0 - 1 | String (8), variable | Programming language desired. NOTE: Use asterisk (*) wildcard or omit tag to request all languages. |
| <procName> | Optional | 0 - 1 | String (8), variable | Name of build procedure desired. NOTE: Use asterisk (*) wildcard or omit tag to request all build procedures. |
PROCS APL LIST — Replies
The reply message for this function returns zero to many <result> data elements. Each <result> tag contains information about one application build procedure.
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-27.
Exhibit 11-27 PROCS APL LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 0 - 1 | String (4), variable | Name of ZMF application listed. |
| <displayOrderNo> | Optional | 0 - 1 | String (1) | This numeric value dictates the default order in which a list of items is displayed. |
| <language> | Optional | 0 - 1 | String (8), variable | Name of programming language supported by build procedure in <procName>. |
| <parser> | Optional | 0 - 1 | String (8), variable | Name of language parsing routine defined for build procedure in <procName>. |
| <procDesc> | Optional | 0 - 1 | String (44), variable | Application-level description of build procedure named in <procName>. |
| <procName> | Optional | 0 - 1 | String (8), variable | Name of application-level build procedure. |
List Global Parameters - PARMS GBL LIST
The global parameter list reports global settings in ChangeMan ZMF that enforce the business rules for software change management at your installation. If you have not customized your global parameters, the default values are reported.
The Serena XML service/scope/message tags and attributes for messages to list global parameters are:
<service name="PARMS">
<scope name="GBL">
<message name="LIST">
These tags appear in both requests and replies.
PARMS GBL LIST — Request
Global parameter list requests take no parameters and contain an empty <request> data element. The <request> tag is required to identify the message as a request rather than a reply.
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:
<request>
</request>
<request\>
PARMS GBL LIST — Reply
The reply message for this function exactly one <result> data element containing the global parameter settings for this instance of ChangeMan ZMF.
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-28.
Exhibit 11-28 PARMS GBL LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <addUsrVarsToPkgLst> | Optional | 0 - 1 | String (1) | Y = Yes, add user variables to pkg list. N = No, Don’t add user variables to pkg list. |
| <allocRetryCount> | Optional | 0 - 1 | String (6), variable | The number of times to retry failed allocation attempts. Failed allocation attempts are retried when generating package installation JCL. Value range: 0 to 65535. |
| <allocRetryWait> | Optional | 0 - 1 | String (6), variable | The time in seconds to wait between allocation retry attempts. Value range: 0 to 65535. |
| <allowAssignedProcOverride> | Optional | 0 - 1 | String (1) | Y = Yes, allow designated PROC override. N = Don’t allow designated PROC override. |
| <allowChkOutToDevLib> | Optional | 0 - 1 | String (1) | Y = Yes, allow checkout to personal development library outside ZMF. N = Don’t allow checkout to personal development library outside ZMF. |
| <allowCompMultAppl> | Optional | 0 - 1 | String (1) | Y = Yes, allow component in multiple applications. N = Don’t allow component in multiple applications. |
| <allowGnfLocalUpdate> | Optional | 0 - 1 | String (1) | Y = Yes, allow application admin to update global notification file. N = No, don’t allow application admin to update global notification file. |
| <allowLinkPackages> | Optional | 0 - 1 | String (1) | Y = Yes, allow external package linking. N = No, don’t allow package linking. |
| <allowOnlyOneApproval> | Optional | 0 - 1 | String (1) | Y = Yes, allow install after only one approval. N = No, don’t allow install if only one approval received. |
| <allowStageOverlay> | Optional | 0 - 1 | String (1) | Y = Yes, allow staged component to be overlaid by later check-in. N = No, don’t allow staging overlays. |
| <allowTempChange> | Optional | 0 - 1 | String (1) | Y = Yes, allow temp change packages. N = No temp change packages allowed. |
| <apsConfigLib> | Optional | 0 - 1 | String (44), variable | Fully qualified dataset name of APS configuration library. |
| <apsHighLevelNode> | Optional | 0 - 1 | String (32), variable | Global default high-level node for APS datasets. |
| <apsRule> | Optional | 0 - 1 | String (1) | Code for APS processing rule. Values: 0 = No APS processing; standard ZMF. 1 = Explicit Mode. APS operates on physical dataset or component. 2 = Implicit Mode, Level 2. APS operates t level of application (AP), scenario (CN), data structure (DS), program (PG), online express (OX), report mockup (RP), & screen (SC). 3 = Implicit Mode, Level 1. APS list disabled for application (AP) or program (PG) operations; ZMF automatically checks out & stages related components. NOTE: Default value is 1. |
| <auditLevel> | Optional | 0 - 1 | String (1) | Code for package audit level required prior to freeze. Values: 0 = Audit optional before freeze. 1 = Audit required before freeze, but any return code for audit accepted except ABEND. 2 = Audit required before freeze. Return code for audit is 12 or less; out-of synch conditions accepted in staging libraries. 3 = Audit required before freeze. Return code for audit is 8 or less. No out-of synch conditions accepted in stage libraries, but are accepted with respect to baseline libraries. 4 = Audit required before freeze. Return code for audit is 4 or less. No out-of synch conditions accepted relative to staging or baseline libraries; but staged module may duplicate its baseline counterpart. 5 = Audit required before freeze. Return code for audit is zero. No out-of synch conditions or baseline module duplicates accepted. |
| <auditLockPackage> | Optional | 0 - 1 | String (1) | Lock package during audit. Values: A = Always. N = Never. O = Optional |
| <autoScratchLoadMbr> | Optional | 0 - 1 | String (1) | Y = Yes, auto scratch load with source. N = No, do not auto scratch load with source. |
| <buildInstallJclAtApprove> | Optional | 0 - 1 | String (1) | Y = Yes, build JCL install job at approval. N = No, don’t build JCL install job at approval. |
| <businessFromTime> | Optional | 0 - 1 | Time (4), hhmm | Global start time for hours of business operation, 24-hour format, no seconds. |
| <businessToTime> | Optional | 0 - 1 | Time (4), hhmm | Global end time for hours of business operation, 24-hour format, no seconds. |
| <chkOutRule> | Optional | 0 - 1 | String (1) | Code for checkout enforcement rule applied to staging of components that already exist in baseline. Values: 1 = Allow any user to stage components without preserving baseline checkout integrity. 2 = Allow authorized users to stage components without preserving baseline checkout integrity. 3 = Enforce baseline checkout integrity for all users. |
| <cmnEnvironment> | Optional | 0 - 1 | String (1) | Code for ZMF environment type. Values: 1 = All (development & production on same LPAR, no remote production) 2 = Development only 3 = Both development & production on same LPAR; remote production sites also supported) 4 = Production only |
| <cmnSchedulerInterval> | Optional | 0 - 1 | String (4), variable | ZMF internal scheduler polling interval in minutes. |
| <cmnVersion> | Optional | 0 - 1 | String (4), vrmm | Version, release, and modification level of this ZMF instance. |
| <compBuildStartedProcName> | Optional | 0 - 1 | String (8), variable | Started procedure name for building component compile, recompile and relink JCL. |
| <componentAgingPeriod> | Optional | 0 - 1 | String (6), variable | Component aging period for deletion in days. Value range: 1 to 32,000. |
| <componentMasterLib> | Optional | 0 - 1 | String (44), variable | Fully qualified dataset name of library where component master resides. NOTE: Component master must be PDS library, not HFS directory. |
| <createCmpWorkRecs> | Optional | 0 - 1 | String (1) | Y = Yes, create component worklist records for a package. N = No, omit component worklist records from package. |
| <db2SubSystemId> | Optional, DB2 only | 0 - 1 | String (4), fixed | Global default for DB2 subsystem name. NOTE: Default value is ‘dsn ‘. |
| <defaultScheduler> | Optional | 0 - 1 | String (1) | Type of scheduler used. = ChangeMan ZMF. The installation jobs are submitted by the ChangeMan ZMF started task at the scheduled install date and time. = Manual. The installation jobs are submitted as soon as the package approvals are complete. = Other. The installation jobs are inserted into a third party scheduler via a batch job. |
| <defaultStartedProcName> | Optional | 0 - 1 | String (8), variable | Default started procedure name for building JCL. |
| <defaultUnitName> | Optional | 0 - 1 | String (8), variable | Global default for storage unit name. |
| <defaultVolume> | Optional | 0 - 1 | String (6), variable | Global default for storage volume ID. |
| <delayLib> | Optional | 0 - 1 | String (44), variable | Fully qualified dataset name of delay library for current ZMF instance. |
| <disableCalendar> | Optional | 0 - 1 | String (1) | Y = Yes, disable install calendar. N = No, don’t disable install calendar. |
| <disallowParallelChkOut> | Optional | 0 - 1 | String (1) | Y = Yes, prohibit checkout of active components. N = No, don’t prohibit checkout of active components. |
| <eliminatePersonalLib> | Optional | 0 - 1 | String (1) | Y = Yes, prohibit personal development library outside ZMF control. N = No, don’t prohibit personal development library outside ZMF. |
| <emailServerName> | Optional | 0 - 1 | String (32), variable | Email server name. |
| <emailServerPortid> | Optional | 0 - 1 | String (5), variable | Email server port number. |
| <enableApprovalOrderProcess> | Optional | 0 - 1 | String (1) | Y = Yes, turn on hierarchical approvals. N = No, don’t turn on hierarchical approvals. |
| <enableCompUserVars> | Optional | 0 - 1 | String (1) | Y = Yes, enable component user variables. N = No, don’t enable component user variables. |
| <enableDisplayOrder3dSkel> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for 3D skeletons. N = No, don’t enable display order for 3D skeletons. |
| <enableDisplayOrderApplication> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for applications. N = No, don’t enable display order for applications. |
| <enableDisplayOrderDb2Logical> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for DB2 logical. N = No, don’t enable display order for DB2 logical. |
| <enableDisplayOrderDb2Physical > | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for DB2 physical. N = No, don’t enable display order for DB2 physical. |
| <enableDisplayOrderDbdOverrid e> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for DBD overrides. N = No, don’t enable display order for DBD overrides. |
| <enableDisplayOrderImsControlR eg> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for IMS control regions. N = No, don’t enable display order for IMS control regions. |
| <enableDisplayOrderLanguage> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for language. N = No, don’t enable display order for language. |
| <enableDisplayOrderLibtype> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for library types. N = No, don’t enable display order for library types. |
| <enableDisplayOrderOnlineForm > | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for online forms. N = No, don’t enable display order for online forms. |
| <enableDisplayOrderProcedure> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for procedures . N = No, don’t enable display order for procedures. |
| <enableDisplayOrderPsbOverride > | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for PSB overrides. N = No, don’t enable display order for PSB overrides. |
| <enableDisplayOrderReason> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for reason codes. N = No, don’t enable display order for reason codes. |
| <enableDisplayOrderSite> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for sites. N = No, don’t enable display order for sites. |
| <enableDisplayOrderXmlReport> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for XML reports. N = No, don’t enable display order for XML reports. |
| <enableJes2Spool> | Optional | 0 - 1 | String (1) | Y = Yes, enable JES2 job entry system. N = No, don’t use JES2 job entry. |
| <enableLLamBaseLib> | Optional | 0 - 1 | String (1) | Y = Yes, generate Librarian LAM N = No, don’t enable CA Librarian LAM |
| <enableLibrBaseLib> | Optional | 0 - 1 | String (1) | Y = Yes, generate Librarian baseline lib N = Don’t enable CA Librarian baseline |
| <enableOtherBaseLib> | Optional | 0 - 1 | String (1) | Y = Yes, generate other (Roscoe) baseline library N = No, don’t enable other baseline library |
| <enablePanBaseLib> | Optional | 0 - 1 | String (1) | Y = Yes, generate Panvalet baseline lib N = No, don’t enable CA Panvalet |
| <enableStackedRevDelta> | Optional | 0 - 1 | String (1) | Y = Yes, stacked reverse delta baseline N = Don’t enable stacked reverse delta |
| <enableStageEditRecovery> | Optional | 0 - 1 | String (1) | Y = Yes, enable recovery of staging library edits. N = No, don’t recover staging edits. |
| <enableVsamRlsOption> | Optional | 0 - 1 | String (1) | Y = Yes, enable VSAM record-level security. N = No, don’t enableVSAM record-level security. |
| <eventNotifyCheckpoint> | Optional | 0 - 1 | String (18), FIXED | Event Notify Checkpoint number. |
| <forceChkOutToPackage> | Optional | 0 - 1 | String (1) | Y = Yes, force checkout to one package at a time. N = No, don’t restrict checkout to one package at a time. |
| <forceDept> | Optional | 0 - 1 | String (1) | Y = Yes, require department number at package create. N = No, department number optional. |
| <forcePackageAudit> | Optional | 0 - 1 | String (1) | Y = Yes, require audit of all packages prior to approval. N = No, don’t force package audit prior to approval. |
| <forceWorkChangeRequest> | Optional | 0 - 1 | String (1) | Y = Yes, required work order/change request at package create. N = No, work order/change request optional. |
| <globalNoticeModDate> | Optional | 0 - 1 | Date, yyyymmdd | Modification date for global notification dataset. |
| <globalNoticeModTime> | Optional | 0 - 1 | Time, hhmm | Modification time for global notification dataset, 24-hour format, no seconds. |
| <globalNoticeModTimeSeconds> | Optional | 0 - 1 | Integer (2) | Modification time seconds for global notification dataset. |
| <globalNotificationLib> | Optional | 0 - 1 | String (44), variable | Global notification dataset. |
| <hfsTempDirectory> | Optional | 0-1 | String (64), variable | Name of temporary HFS directory, prefixed by path from installation root, used for temporary changes to HFS components. |
| <inactiveTimeLimit> | Optional | 0 - 1 | String (6), variable | Time-out limit for inactive terminals in minutes. Value range: 1 to 999,999. |
| <includeIspllib> | Optional | 0 - 1 | String (1) | Y = Yes, include ISPLLIB libraries in validation & audit. N = No, omit ISPLLIB. |
| <includeIspmlib> | Optional | 0 - 1 | String (1) | Y = Yes, include ISPMLIB libraries in validation & audit. N = No, omit ISPMLIB. |
| <includeIspplib> | Optional | 0 - 1 | String (1) | Y = Yes, include ISPPLIB libraries in validation & audit. N = No, omit ISPPLIB. |
| <includeIspslib> | Optional | 0 - 1 | String (1) | Y = Yes, include ISPSLIB libraries in validation & audit. N = No, omit ISPSLIB. |
| <infoApproveRecord> | Optional | 0 - 1 | String (1) | Y = Yes, approve package automatically. N = No, do not approve package automatically. |
| <infoBypassAging> | Optional | 0 - 1 | String (1) | Y = Yes, INFO update bypassed during aging. N = No, INFO update not bypassed during aging. |
| <infoRule> | Optional | 0 - 1 | String (1) | Code for IBM INFO notification & approval rules. Values: = No ZMF-to-INFO communication. = INFO notified of package create. = INFO notified of pkg create/update.3 = Rule 2, plus: INFO subtask must be attached; enable INFO approval of packages. 4 = Rule 3, plus: planned packages must create INFO change record in advance & use its ID in ZMF work order/change request field. 5 = Rule 4, plus: unplanned packages also have INFO change record. |
| <infoSoapMember> | Optional | 0 - 1 | String (8) | INFO System Bus Soap member name. |
| <infoUsingBus> | Optional | 0 - 1 | String (1) | Y = Yes, INFO using system Bus. N = No, INFO not using system Bus. |
| <infoUsingVsam> | Optional | 0 - 1 | String (1) | Y = Yes, use VSAM file for INFO data mapping. N = No, don’t use VSAM file for INFO. |
| <infoVsamCreateTempPkg> | Optional | 0 - 1 | String (1) | Y = Yes, override ZMF temp package duration with setting in INFO VSAM file, or 1 day if INFO sets no value. N = No, don’t override ZMF temp pkg duration with INFO VSAM setting. |
| <infoVsamRejectPkg> | Optional | 0 - 1 | String (1) | Y = Yes, turn on selective INFO approval processing; ignore reject & other messages short of full approval. N = No, don’t turn on selective INF approval processing. |
| <infoVsamReuseRecord> | Optional | 0 - 1 | String (1) | Y = Yes, reuse VSAM file INFO record# from deleted packages for new packages. N = No, don’t reuse INFO record#. NOTE: If Y, deleted packages cannot be undeleted. |
| <installStartedProcName> | Optional | 0 - 1 | String (8), variable | Started procedure name for building package install JCL. |
| <isFullAssistanceCompleted> | Optional | 0 - 1 | String (1) | Y = Yes, impact analysis full assist tasks completed. N = No, full assist not completed. |
| <jobCard01> | Optional | 0 - 1 | String (72), variable | First of up to four global default JCL job cards. |
| <jobCard02> | Optional | 0 - 1 | String (72), variable | Second of up to four global default JCL job cards. |
| <jobCard03> | Optional | 0 - 1 | String (72), variable | Third of up to four global default JCL job cards. |
| <jobCard04> | Optional | 0 - 1 | String (72), variable | Fourth of up to four global default JCL job cards. |
| <keepBaselineBySite> | Optional | 0 - 1 | String (1) | Y = Yes, keep independent baseline libraries for each site. N = No, consolidate all sites under one baseline library. |
| <licensedLine1> | Optional | 0 - 1 | String (56), variable | Free-format text identification of ZMF licensee. First of up to two lines. |
| <licensedLine2> | Optional | 0 - 1 | String (56), variable | Free-format text identification of ZMF licensee. Second of up to two lines. |
| <logicalUnitName> | Optional | 0 - 1 | String (8), variable | Name of logical unit (LU) where this ZMF instance resides. |
| <maximumSiteCount> | Optional | 0 - 1 | Integer (3), variable | Deprecated; obsolete. |
| <modLevel> | Optional | 0 - 1 | String (2), fixed | ZMF modification level. Same as last two bytes of <cmnVersion>. |
| <nonVioUnitName> | Optional | 0 - 1 | String (8), variable | Default non-VIO UNIT name. |
| <notInfoChangeSystem> | Optional | 0 - 1 | String (1) | Y = Yes, INFO/MAN change management system. N = No, not an INFO/MAN change management system. |
| <numberOfDaysInCal> | Optional | 0 - 1 | String () | Calendar number of days. |
| <onlineFormsIsppLib> | Optional, OFM only | 0 - 1 | String (44), variable | Fully qualified dataset name of ISPF panel library (ISPPLIB) for online forms. |
| <onlyMemoDelEmptyPackages> | Optional | 0 - 1 | String (1) | Y = Yes, enforce memo-delete rules for empty packages. N = No, don’t enforce memo-delete for empty packages; allow physical deletion. |
| <packageAgingPeriod> | Optional | 0 - 1 | String (6), variable | Package aging period for deletion in days. Value range: 1 to 32,000. |
| <packageMasterLib> | Optional | 0 - 1 | String (44), variable | Fully qualified dataset name of library where package master resides. |
| <packageNumInPcver> | Optional | 0 - 1 | String (1) | Y = Yes, copy package number to PCVER variable. N = No, don’t copy package number. |
| <pcverOutputOnly> | Optional | 0 - 1 | String (1) | Y = Yes, set PCVER to output only. N = No, PCVER not output only. |
| <processPartPackageByInsDate> | Optional | 0 - 1 | String (1) | Y = Yes, process participating packages by install date. N = No, don’t process by install date. |
| <prohibitApprovalByCreator> | Optional | 0 - 1 | String (1) | Y = Yes, exclude package creator from package approval list. N = No, don’t exclude package creator from package approval list. |
| <prohibitApprovalByWorker> | Optional | 0 - 1 | String (1) | Y = Yes, exclude developers who worked on package from package approval list. N = No, don’t exclude package workers from package approval list. |
| <prohibitJobNameIncrement> | Optional | 0 - 1 | String (1) | Y = Yes, prohibit job name increment. N = No, don’t prohibit job name increment. |
| <promotionRule> | Optional | 0 - 1 | String (1) | Code for package promotion rule. Values: = Allow promote & demote even if package not frozen. = Require freeze before promote. Require selective component demote, unfreeze, edit, refreeze, & re-promote directly to promotion level of package as a whole. 2 = Require freeze before promote. Require selective component demote, unfreeze, edit, refreeze, & re-promote through all intermediate promotion levels to level of package as a whole. = Require freeze before promote. Require full package demote, then selective component unfreeze, edit, refreeze, & full package promotion through all intermediate promotion levels. = Require freeze before promote. Require full package demote, followed by revert to development status, before editing components. |
| <promotionStartedProcName> | Optional | 0 - 1 | String (8), variable | Started procedure name for building package promote and demote JCL. |
| <release> | Optional | 0 - 1 | String (1) | ZMF release. Same as second byte of <cmnVersion>. |
| <releaseManAuditLevel> | Optional | 0 - 1 | String (1) | Audit level. This numeric value dictates the Audit level that must be passed before a developing change package can be Frozen. 0 - Audit is recommended but entirely optional. 1 - Audit is required but any return code (except abend) is acceptable. 2 - Audit is required and the return code must not exceed 12, which implies that there are "out-of-synch" situations within the staging libraries. 3 - Audit is required and the return code must not exceed 8, which implies that there are no "out-ofsynch" situations within the staging libraries, but are "out-of-synch" situations with respect to the Baseline libraries. 4 - Audit is required and the return code must not exceed 4, which implies that there are no "out-of-synch" situations within the staging or Baseline libraries, but at least one module of a staging library is a "duplicate" of its Baseline counterpart. |
| 5 - Audit is required and the return code must not exceed 0, which implies that there are no "out-of-synch" situations with either implies that there are no "out-of-synch" situations with either the staging or Baseline libraries, and no "duplicates" exist. | ||||
| <releaseManDsPattern> | Optional, ERO only | 0 - 1 | String (5), variable | Pattern for release area dataset name. May be any combination of the following dataset qualifier symbols, with L as the final qualifier and P optional: H = High-level qualifier as defined in <rloHighLevelNode>. R = Release name defined to ERO. A = Release area name defined for R in ERO. P = Application or project defined for R in ERO. L = Library type defined for R in ERO. NOTE: If used, <rloHighLevelNode> also returned. |
| <resourceClassLength> | Optional | 0 - 1 | String (4), variable | Length of <resourceClassName> in bytes. NOTE: Returned only if <resourceClassName> used. |
| <resourceClassName> | Optional | 0 - 1 | String (8), variable | Resource class name for RACF or other security package. NOTE: If used, its length appears in <resourceClassLength>. |
| <resourceClassOwner> | Optional | 0 - 1 | String (8), variable | Owner of security resource in <resourceClassName> as defined in RACF or other security package. NOTE: Returned optionally if <resourceClassName> used. |
| <rloHighLevelNode> | Optional, ERO only | 0 - 1 | String (8), variable | Global default high-level node for ERO release area datasets. |
| <rloHighLevelPath> | Optional, ERO only | 0 - 1 | String (1024), variable | Global default high-level HFS path for ERO release area files. |
| <showUserPanels> | Optional | 0 - 1 | String (1) | Y = Yes, display package user panels. N = No, don’t show pkg user panels. |
| <siteName> | Optional | 0 - 1 | String (8), variable | ZMF name of site where this ZMF instance resides. |
| <stageDevHfsModel> | Optional | 0 - 1 | String (64), variable | HFS file name of model staging development library. |
| <stageDevLibModel> | Optional | 0 - 1 | String (32), variable | Dataset name of model staging development library. |
| <stageLibAgingPeriod> | Optional | 0 - 1 | String (6), variable | Staging library aging period for deletion in days. Value range: 1 to 32,000. |
| <stageLimitLevel> | Optional | 0 - 1 | String (1) | Code for staging restriction level. Values: 1 = Allow all users to stage or check-in to a package from a development library. 2 = Allow users that pass entity check to stage or check-in to a package from a development library. 3 = No users allowed to stage or check in to a package from a development library. |
| <stageProdHfsModel> | Optional | 0 - 1 | String (64), variable | HFS file name of model staging production library. |
| <stageProdLibModel> | Optional | 0 - 1 | String (32), variable | Dataset name of model staging production library. |
| <suppressMsgsForINSJobs> | Optional | 0 - 1 | String (1) | Y = Yes, suppress INS job messages. N = No, display INS job messages. |
| <useBatchNotifier> | Optional | 0 - 1 | String (1) | Y = Yes, use batch notification vehicle. N = No, don’t use batch notifier. |
| <useCmnScheduler> | Optional | 0 - 1 | String (1) | Y = Yes, use ZMF install scheduler. N = No, don’t use ZMF scheduler. |
| <useEmailNotifier> | Optional | 0 - 1 | String (1) | Y = Yes, use email notification vehicle. N = No, don’t use email notifier. |
| <useGlobalNotifier> | Optional | 0 - 1 | String (1) | Y = Yes, use global notification file. N = No, don’t use global notification file. |
| <useIebcopyDelivery> | Optional | 0 - 1 | String (1) | Y = Yes, use IEBCOPY file transfers. N = No, don’t use IEBCOPY file xfer. |
| <useLikeLODinSyslib> | Optional | 0 - 1 | String (1) | Y = Yes, use LIKE-LOD in syslib. N = No, don’t use LIKE-LOD in syslib |
| <useManualScheduler> | Optional | 0 - 1 | String (1) | Y = Yes, use manual install scheduler. N = No, don’t use manual scheduler. |
| <useMvsSendNotifier> | Optional | 0 - 1 | String (1) | Y = Yes, use MVS Send notification. N = No, don’t use MVS Send notifier. |
| <useOpcEcaScheduler> | Optional | 0 - 1 | String (1) | Y = Yes, use OPS/ECA scheduler. N = No, don’t use OPS/ECA scheduler. |
| <useOtherScheduler> | Optional | 0 - 1 | String (1) | Y = Yes, use other install scheduler. N = No, don’t use other scheduler. |
| <useSerCompress> | Optional | 0 - 1 | String (1) | Y = Yes, use SERNET compression on file transfers. N = No, don’t use SERNET data compression. |
| <useSernetNotifier> | Optional | 0 - 1 | String (1) | Y = Yes, use SERNET notification vehicle. N = No, don’t use SERNET notification vehicle. |
| <useZprefixForBatchJobs> | Optional | 0 - 1 | String (1) | Y = Yes, use ZPREFIX instead of ZUSER for batch job user ID. N = No, use ZUSER default for batch job user ID. |
| <validateStageVersion> | Optional | 0 - 1 | String (1) | Y = Yes, validate component staging version at check-in. N = No, don’t validate staging version. |
| <version> | Optional | 0 - 1 | String (1) | ZMF version. Same as first byte of <cmnVersion>. |
Parameters Application List - PARMS APL LIST
The application parameter list reports application-level overrides to global settings in ChangeMan ZMF that enforce the business rules for software change management at your installation. If you have not customized your application parameters, the default values are reported.
The Serena XML service/scope/message tags and attributes for messages to list application parameters are:
<service name="PARMS">
<scope name="APL">
<message name="LIST">
These tags appear in both requests and replies.
PARMS APL LIST — Request
The application parameter list service requires an application name in the request message. You can request two types of application parameter list:
-
Default Parameters Application List — Name the desired application in the <applName> tag and omit the <parms> tag in the request message or leave it blank. This option requests all application parameters for the named application. User must have access permissions for the application to retrieve a result.
-
Short Application Parameter List — Name the desired application in the <applName> tag and enter "S" (upper case) in the <parms> tag of the request message. This option requests only the application description. A result is returned if the application exists, even if the user does not have application access permissions.
Data structure details for the <request> data element appear in Exhibit 11-29.
Exhibit 11-29 PARMS APL LIST <request> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <applName> | Optional | 1 | String (4), variable | ZMF application name desired. NOTE: OK to omit trailing blanks. |
| <parms> | Optional | 0 - 1 | String (1) | Code for type of list requested. Values: S = Short list (description only), all users. Blank = Complete list, authorized application users only. NOTE: If used, upper case required. |
PARMS APL LIST — Reply
The reply message for this function exactly one <result> data element containing the requested parameter settings for the named application. If no parameter settings have been customized for this application, default (global) values are 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.
Data structure details for the <result> tag appear in Exhibit 11-30.
Exhibit 11-30 PARMS APL LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <allowChkOutToDevLib> | Optional | 0 - 1 | String (1) | Y = Yes, allow checkout to personal development library outside ZMF. N = Don’t allow checkout to personal development library outside ZMF |
| <allowLinkPackages> | Optional | 0 - 1 | String (1) | Y = Yes, allow external package linking. N = No, don’t allow package linking. |
| <allowOnlyOneApproval> | Optional | 0 - 1 | String (1) | Y = Yes, allow install after only one approval. N = No, don’t allow install if only one approval received. |
| <allowStageOverlay> | Optional | 0 - 1 | String (1) | Y = Yes, allow staged component to be overlaid by later check-in. N = No, don’t allow staging overlays. |
| <allowTempChange> | Optional | 0 - 1 | String (1) | Y = Yes, allow temp change packages. N = No temp change packages allowed. |
| <applDesc> | Optional | 0 - 1 | String (44), variable | Application description. |
| <applName> | Optional | 0 - 1 | String (4), variable | ZMF application name. |
| <apsRule> | Optional | 0 - 1 | String (1) | Code for APS processing rule. Values: 0 = No APS processing; standard ZMF. 1 = Explicit Mode. APS operates on physical dataset or component. |
| 2 = Implicit Mode, Level 2. APS operates t level of application (AP), scenario (CN), data structure (DS), program (PG), online express (OX), report mockup (RP), & screen (SC). 3 = Implicit Mode, Level 1. APS list disabled for application (AP) or program (PG) operations; ZMF automatically checks out & stages related components. NOTE: Default value is 1. |
||||
| <auditLevel> | Optional | 0 - 1 | String (1) | Code for package audit level required prior to freeze. Values: 0 = Audit optional before freeze. 1 = Audit required before freeze, but any return code for audit accepted except ABEND. 2 = Audit required before freeze. Return code for audit is 12 or less; out-of synch conditions accepted in staging libraries. |
| 3 = Audit required before freeze. Return code for audit is 8 or less. No out-of synch conditions accepted in stage libraries, but are accepted with respect to baseline libraries. 4 = Audit required before freeze. Return code for audit is 4 or less. No out-of synch conditions accepted relative to staging or baseline libraries; but staged module may duplicate its baseline counterpart. 5 = Audit required before freeze. Return code for audit is zero. No out-of synch conditions or baseline module duplicates accepted. |
||||
| <auditLockPackage> | Optional | 0 - 1 | String (1) | Lock package during audit. Values: A = Always. N = Never. O= Optional |
| <buildInstallJclAtApprove> | Optional | 0 - 1 | String (1) | Y = Yes, build JCL install job at approval. N = No, don’t build JCL install job at approval. |
| <businessFromTime> | Optional | 0 - 1 | Time (4), hhmm | Start time for business operations & package install for this application, 24-hour format, no seconds. |
| <businessToTime> | Optional | 0 - 1 | Time (4), hhmm | End time for business operations & package install for this application, 24-hour format, no seconds. |
| <chkOutEntity> | Optional | 0 - 1 | String (8), variable | Security entity in RACF or other security package to which user ID must belong to pass security entity check on staging. NOTE: Returned if value is 2 in <chkOutRule>. |
| <chkOutRule> | Optional | 0 - 1 | String (1) | Code for checkout enforcement rule applied to staging of components that already exist in baseline. Values: 1 = Allow any user to stage components without preserving baseline checkout integrity. 2 = Allow authorized users to stage components without preserving baseline checkout integrity. 3 = Enforce baseline checkout integrity for all users. |
| <cmnaudrcEntity> | Optional | 0 - 1 | String (8), variable | Entity for authority to run CMNAUDRC outside of ChangeMan |
| <componentAgingPeriod> | Optional | 0 - 1 | String (6), variable | Component aging period for deletion in days. Value range: 1 to 32,000. |
| <createCmpWorkRecs> | Optional | 0 - 1 | String (1) | Y = Yes, create component worklist records for a package. N = No, omit component worklist records from package. |
| <defaultScheduler> | Optional | 0 - 1 | String (8), variable | Type of scheduler used. 1 - ChangeMan ZMF. The installation jobs are submitted by the ChangeMan ZMF started task at the scheduled install date and time. 2 - Manual. The installation jobs are submitted as soon as the package approvals. are complete. 3 - Other. The installation jobs are inserted into a third party scheduler via a batch job. |
| <defaultUnitName> | Optional | 0 - 1 | String (8), variable | Application default for storage unit name. |
| <defaultVolume> | Optional | 0 - 1 | String (6), variable | Application default for storage volume ID. |
| <disallowParallelChkOut> | Optional | 0 - 1 | String (1) | Y = Yes, prohibit checkout of active components. N = No, don’t prohibit checkout of active components. |
| <eliminatePersonalLib> | Optional | 0 - 1 | String (1) | Y = Yes, prohibit personal development library outside ZMF control. N = No, don’t prohibit personal development library outside ZMF. |
| <enableApprovalOrderProcess> | Optional | 0 - 1 | String (1) | Y = Yes, turn on hierarchical approvals. N = No, don’t turn on hierarchical approvals. |
| <enableDisplayOrderDb2Logical> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for DB2 logical N = No, don’t enable. |
| <enableDisplayOrderDbdOverride> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for DBD overrides. N = No, don’t enable. |
| <enableDisplayOrderImsControlReg> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for IMS control regions. N = No, don’t enable. |
| <enableDisplayOrderLanguage> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for languages. N = No, don’t enable. |
| <enableDisplayOrderLibtype> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for library type. N = No, don’t enable. |
| <enableDisplayOrderProcedure> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for procedures. N = No, don’t enable. |
| <enableDisplayOrderPsbOverride> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for PSB overrides. N = No, don’t enable. |
| <enableDisplayOrderSite> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for sites. N = No, don’t enable. |
| <enableDisplayXmlReport> | Optional | 0 - 1 | String (1) | Y = Yes, enable display order for XML reports. N = No, don’t enable. |
| <enableStageEditRecovery> | Optional | 0 - 1 | String (1) | Y = Yes, enable recovery of staging library edits. N = No, don’t recover staging edits. |
| <forceChkOutToPackage> | Optional | 0 - 1 | String (1) | Y = Yes, force checkout to one package at a time. N = No, don’t restrict checkout to one package at a time. |
| <forceDept> | Optional | 0 - 1 | String (1) | Y = Yes, require department number at package create. N = No, department number optional. |
| <forcePackageAudit> | Optional | 0 - 1 | String (1) | Y = Yes, require audit of all packages prior to approval. N = No, don’t force package audit prior to approval. |
| <forceWorkChangeRequest> | Optional | 0 - 1 | String (1) | Y = Yes, required work order/change request at package create. N = No, work order/change request optional. |
| <inUseOwner> | Optional | 0 - 1 | String (6), variable | TSO user ID of current application (project) user. |
| <infoRule> | Optional | 0 - 1 | String (1) | Code for IBM INFO notification & approval rules. Values: 0 = No ZMF-to-INFO communication. 1 = INFO notified of package create. 2 = INFO notified of pkg create/update. 3 = Rule 2, plus: INFO subtask must be attached; enable INFO approval of packages. 4 = Rule 3, plus: planned packages must create INFO change record in advance & use its ID in ZMF work order/change request field. |
| 5 = Rule 4, plus: unplanned packages also have INFO change record. | ||||
| <infoUsingVsam> | Optional | 0 - 1 | String (1) | Y = Yes, use VSAM file for INFO data mapping. N = No, don’t use VSAM file for INFO. |
| <infoVsamCreateTempPkg> | Optional | 0 - 1 | String (1) | Y = Yes, override ZMF temp package duration with setting in INFO VSAM file, or 1 day if INFO sets no value. N = No, don’t override ZMF temp pkg duration with INFO VSAM setting. |
| <infoVsamRejectPkg> | Optional | 0 - 1 | String (1) | Y = Yes, turn on selective INFO approval processing; ignore reject & other messages short of full approval. N = No, don’t turn on selective INF approval processing. |
| <infoVsamReuseRecord> | Optional | 0 - 1 | String (1) | Y = Yes, reuse VSAM file INFO record# from deleted packages for new packages. N = No, don’t reuse INFO record#. NOTE: If Y, deleted packages cannot be undeleted. |
| <isApplBusy> | Optional | 0 - 1 | String (1) | Y = Yes, application (project) in use. N = No, application (project) not in use. |
| <isApplLocked> | Optional | 0 - 1 | String (1) | Y = Yes, application (project) locked. N = No, application (project) not locked. |
| <jobCard01> | Optional | 0 - 1 | String (72), variable | First of up to four global default JCL job cards. |
| <jobCard02> | Optional | 0 - 1 | String (72), variable | Second of up to four global default JCL job cards. |
| <jobCard03> | Optional | 0 - 1 | String (72), variable | Third of up to four global default JCL job cards. |
| <jobCard04> | Optional | 0 - 1 | String (72), variable | Fourth of up to four global default JCL job cards. |
| <keepBaselineBySite> | Optional | 0 - 1 | String (1) | Y = Yes, keep independent baseline libraries for each site. N = No, consolidate all sites under one baseline library. |
| <nextPackageNumber> | Optional | 0 - 1 | String (6), variable | Unique serial number to assign to next package created for this application. |
| <onlyMemoDelEmptyPackages> | Optional | 0 - 1 | String (1) | Y = Yes, enforce memo-delete rules for empty packages. N = No, don’t enforce memo-delete for empty packages; allow physical deletion. |
| <packageAgingPeriod> | Optional | 0 - 1 | String (6), variable | Package aging period for deletion in days. Value range: 1 to 32,000. |
| <packageBindLibType> | Optional | 0 - 1 | String (3), variable | Library type for package bind. |
| <packageNumInPcver> | Optional | 0 - 1 | String (1) | Y = Yes, copy package number to PCVER variable. N = No, don’t copy package number. |
| <pcverOutputOnly> | Optional | 0 - 1 | String (1) | Y = Yes, set PCVER to output only. N = No, PCVER not output only. |
| <processPartPackageByInsDate> | Optional | 0 - 1 | String (1) | Y = Yes, process participating packages by install date. N = No, don’t process by install date. |
| <prohibitApprovalByCreator> | Optional | 0 - 1 | String (1) | Y = Yes, exclude package creator from package approval list. N = No, don’t exclude package creator from package approval list. |
| <prohibitApprovalByWorker> | Optional | 0 - 1 | String (1) | Y = Yes, exclude developers who worked on package from package approval list. N = No, don’t exclude package workers from package approval list. |
| <prohibitJobNameIncrement> | Optional | 0 - 1 | String (1) | Y = Yes, prohibit job nameincrement. N = No, don’t prohibit job name increment. |
| <promotionRule> | Optional | 0 - 1 | String (1) | Code for package promotion rule. Values: 0 = Allow promote & demote even if package not frozen. 1 = Require freeze before promote. Require selective component demote, unfreeze, edit, refreeze, & re-promote directly to promotion level of package as a whole. |
| 2 = Require freeze before promote. Require selective component demote, unfreeze, edit, refreeze, & re-promote through all intermediate promotion levels to level of package as a whole. 3 = Require freeze before promote. Require full package demote, then selective component unfreeze, edit, refreeze, & full package promotion through all intermediate promotion levels. |
||||
| 4 = Require freeze before promote. Require full package demote, followed by revert to development status, before editing components. | ||||
| <skelsReleaseId> | Optional | 0 - 1 | String (4), variable | 3-D skeletons release ID. |
| <stageEntity> | Optional | 0 - 1 | String (8), variable | Security entity in RACF or other security package to which user ID must belong to pass security entity check on checkout. NOTE: Returned if value is 2 in <stageLimitLevel>. |
| <stageLibAgingPeriod> | Optional | 0 - 1 | String (6), variable | Staging library aging period for deletion in days. Value range: 1 to 32,000. |
| <stageLimitLevel> | Optional | 0 - 1 | String (1) | Code for staging restriction level. Values: 1 = Allow all users to stage or check-in to a package from a development library. 2 = Allow users that pass entity check to stage or check-in to a package from a development library. 3 = No users allowed to stage or check in to a package from a development library. |
| <suppressMsgsForINSJobs> | Optional | 0 - 1 | String (1) | Y = Yes, suppress messages for install jobs. N = No, do not suppress messages for install jobs. |
| Optional | 0 - 1 | String (1) | Y = Use APPL in current history process N = Do not use APPL in current history process | |
| Optional | 0 - 1 | String (1) | Y = Use CMN scheduler N = Do not use CMN scheduler | |
| Optional | 0 - 1 | String (1) | Y = Use Like LOD in SYSLIB N = Do not use Like LOD in SYSLIB | |
| Optional | 0 - 1 | String (1) | Y = Use Manual scheduler N = Do not use Manual scheduler | |
| Optional | 0 - 1 | String (1) | Y = Use Other scheduler N = Do not use Other scheduler | |
| Optional | 0 - 1 | String (1) | Y = Yes, use ZPREFIX not ZUSE for batch. N = No, use ZUSE not ZPREFIX for batch. |
|
| Optional | 0 - 1 | String (1) | Y = Yes, validate version during staging. N = No, do not validate version during staging. |
List Global Reason Codes - REASONS SERVICE LIST
This function lists all globally defined reason codes and their definitions for the creation of temporary change packages. If temporary change packages are not permitted at your installation, no results are returned by this function.
The Serena XML service/scope/message names for messages to list global reason codes for temporary packages are:
<service name="REASONS">
<scope name="SERVICE">
<message name="LIST">
These tags appear in both requests and replies.
REASONS SERVICE LIST — Requests
Global reason code list requests take no parameters and contain an empty <request> data element. The <request> tag is required to identify the message as a request rather than a reply.
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:
<request>
</request>
<request\>
...
REASONS SERVICE LIST — Replies
Zero to many <result> data elements are returned in response to a Serena XML request to list global reason codes. Each <result> tag defines a single reason code.
A standard <response> data structure follows the last <result> tag to indicate the success or failure of the request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. As the last tag in the reply message, the <response> tag also serves as an end-of-list marker.
Data structure details for the <result> tag appear in the following table.
Exhibit 11-31. REASONS SERVICE LIST <result> Data Structure
| Subtag | Use | Occurs | Data Type & Length | Values & Dependencies |
|---|---|---|---|---|
| <displayOrderNo> | Optional | 0 - 1 | Integer (undefined) | Display order number. This numeric value dictates the default order in which a list of items is displayed. |
| <reasonCode> | Required | 1 | String (3), variable | Code identifying a reason for creating a temporary package. |
| <reasonDesc> | Required | 1 | String (255), variable | Text description corresponding to code in <reasonCode> tag. |