Service, Scope, and Message Summary
Only certain combinations of service, scope, and message name attributes are valid in Serena XML. The combination chosen must make sense for the low-level service object invoked and for the task or information desired. Valid service/scope/message combinations are listed in the following tables:
-
Core XML Services Summary
-
ERO XML Services Summary
Core XML Services Summary
Valid combinations of service, scope, and message names for the core XML Services functions are listed in Exhibit 3-10. Names of the corresponding COBOL copybooks are also listed for each function.
Exhibit 3-10. Core XML Service, Scope, and Message Names with COBOL Copybooks
| Service Name | Scope Name | Message Name | Description of Function | COBOL Copybook |
|---|---|---|---|---|
| approver | apl | list | List default approver list for application | XMLCAAPR |
| pkg | list | List package approvers | XMLCPAPR | |
| baselib | service | list | List baseline library records | XMLCBASL |
| calendar | service | list | List calendar records by site | XMLCCLDR |
| cmponent | apl_cdsc | find list |
Find application-level component description List application-level component description |
XMLCACGD XLMCACGD |
| apl_dprc | check find list |
Check designated build procedure for component Find components with designated build procedures List designated build procedures for component |
XMLCADCP XMLCADCP XMLCADCP |
|
| apl_secr | check find list |
Check security authorization for component Find security entity for component List security entities for component |
XMLCACSC XMLCACSC XMLCACSC |
|
| chg_desc | list | List active component change description | XMLCPSVD | |
| gbl_cdsc | list | List global component description | XMLCGCGD | |
| gbl_dprc | list | List global component build procedure | XMLCGDCP | |
| gbl_secr | list | List global component member-level security setting | XMLCGCSC | |
| history | list listbase listconc listcurr listshrt |
List comprehensive component history List baselined component history List concurrent development history of component List current component history List active component history (short list) |
XMLCCHIS XMLCCHIS XMLCCHIS XMLCCHIS XMLCCHIS |
|
| lod_subr | list | List component subroutines | XMLCPINC | |
| pkg_comp | list | List source/copybook relationship (ISAL/ICPY) records for components in package | XMLCPSCC | |
| pkg_lod | list | List load-to-source relationship (ILOD) records for components in package | XMLCPILC | |
| pkg_util | list | List scratch/rename (IUTL) records for components in package | XMLCPUTL | |
| pkg_wrkl | list | List users working on component (ICWK) | XMLCPCUW | |
| prm_hist | list | List component promotion history | XMLCPPCH | |
| service | browse build checkin checkout compare lock recomp relink rename scratch unlock |
Browse (or download) component Build component (with stage & compile options) Check in component Check out component Compare component in package vs baseline Lock component Recompile component from baseline Relink component from baseline Rename a component/member Scratch a component/member Unlock component |
XMLCCBRW XMLCBULD XMLCCKIN XMLCCKOT XMLCCMPR XMLCCLCK XMLCRCMP XMLCRLNK XMLCSCRN XMLCSCRN XMLCCLCK |
|
| src_incl | list • count • nolocate • locate |
List source-to-included-copies relationship records for components in package count of included copybooks for a source componentin package list of included copybook names (baseline I/A or package records) list of included copybook names along with their physical location in lifecycle |
XMLCPISC XMLCPISC XMLCPISC XMLCPISC |
|
| ssv_ver | list retrieve |
List component staging version change description Retrieve staging version of component |
XMLCPSSV XMLCPSSV |
|
| db2admin | apl_actv | list | List active DB2 records for application | XMLCAAD2 |
| apl_logl | list | List logical DB2 records for application | XMLCALD2 | |
| gbl_logl | list | List global DB2 logical records | XMLCGLD2 | |
| gbl_phys | list | List global DB2 physical records | XMLCGPD2 | |
| dss | ispfile | list | List ISPF file | XMLCDSIN |
| service | allocate basestat delete expand info list mbrdel stclist |
Allocate dataset List statistics for baseline library member Delete dataset Expand baseline member in SRD format Get dataset allocation information List dataset member, directory entries, & hash token Delete dataset member List datasets allocated to requested DDNAME by the ZMF started task |
XMLCDSAL XMLCDSBS XMLCDSDE XMLCDSEX XMLCDSIN XMLCDSLI XMLCDSMD XMLCDSST |
|
| environ | service | list | List ChangeMan ZMF environment parameters | XMLCENVR |
| file | dirs | list | List HFS directories | XMLCFILL |
| files | list | List HFS files in a directory | XMLCFILL | |
| service | access change copy create delete download export import link list mkdir rename rmdir scan upload |
List HFS (Hierarchical File System) file access Change HFS file attributes Copy HFS file Create HFS file Delete HFS file Download HFS file Export HFS file Import HFS file Link HFS file List HFS file contents Make an HFS file directory Rename an HFS file or directory Remove an HFS file directory Scan HFS files for requested strings Upload HFS files |
XMLCFILA XMLCFILC XMLCFILC XMLCFILC XMLCFILD XMLCFILE XMLCFILE XMLCFILL XMLCFILC XMLCFILC XMLCFILC XMLCFILU XMLCFILM XMLCFILS XMLCFILU |
|
| forms | gbl | list | List global online forms | XMLCGOFM |
| pkg | approve comment detail list reject submit |
Approve online form for package Add comment or reject reason to form for package List online form details for package List online form for package Reject online form for package Submit online form for package |
XMLCPOFM XMLCPOFM XMLCPOFM XMLCPOFM XMLCPOFM XMLCPOFM |
|
| impact | bun | list | List BUN library type information | XMLCIABN |
| cmponent | list | List impact analysis information for component | XMLCIACM | |
| table | list | List impact analysis table | XMLCIATB | |
| imscrgn | apl | list | List IMS control region defaults for application | XMLCAICR |
| gbl | list | List global IMS control region defaults | XMLCGICR | |
| imsovrd | apl | apl_dbd apl_psb |
List IMS DBD overrides for application List IMS PSB overrides for application |
XMLCAIOR XMLCAIOR |
| gbl | gbl_dbd gbl_psb |
List global IMS DBD overrides List global IMS PSB overrides |
XMLCGIOR XMLCGIOR |
|
| pkg | pkg_dbd pkg_psb |
List IMS DBD overrides for package List IMS PSB overrides for package |
XMLCPIOR XMLCPIOR |
|
| language | apl | list | List default programming language for application | XMLCALNG |
| gbl | list | List global default programming language | XMLCGLNG | |
| libtype | apl | list | List library types defined for application | XMLCALTP |
| gbl | list | List globally defined library types | XMLCGLTP | |
| pkg | list | List library types defined for package | XMLCPLTP | |
| log | service | create list |
Create activity log entry List activity log entries |
XMLCALOG XMLCALOG |
| notyfile | service | download | Download the global notification file | XMLCNTFI XMLCNTFI |
| package | aff_apls | list | List affected applications | XMLCPAAP |
| approve | search | Search for packages pending approval | XMLCPSCH | |
| check | promote | Check promotion readiness of package | XMLCPPRM | |
| cleanup | demote | Demote package & clean up promotion libraries | XMLCPPRM | |
| cmponent | integrty | Check component integrity of package | XMLCPINT | |
| cmp_desc | list | List component description records for package | XMLCPCDS | |
| forms | refreeze unfreeze |
Refreeze online forms for package Unfreeze online forms for package |
XMLCPFRZ XMLCPFRZ |
|
| gen_desc | list | List general description of package | XMLCPDSC | |
| gen_prms | list refreeze unfreeze |
List general parameters for package Refreeze general parameters for package Unfreeze general parameters for package |
XMLCPGPM XMLCPFRZ XMLCPFRZ |
|
| general | search | General package search | XMLCPSCH | |
| imp_inst | list | List implementation instructions | XMLCPIMI | |
| ims_acb | list | List IMS ACB control blocks | XMLCPIAS | |
| ims_crgn | list | List IMS control regions for package | XMLCPICR | |
| limbo | search | Search for limbo packages | XMLCPSCH | |
| non_src | refreeze unfreeze |
Refreeze non-source modules in package Unfreeze non-source modules in package |
XMLCPFRZ XMLCPFRZ |
|
| pkg_link | list search |
List linked packages Search for linked packages |
XMLCPLNK XMLCPSCH |
|
| prm_cmp | list | List component promotion history for package | XMLCPPRC | |
| prm_hist | list | List promotion history for package | XMLCPPRH | |
| prm_ovly | list | List overlaid components for package promotion | XMLCPPRO | |
| promote | lock | Lock promotion site for a package | XMLCPPLU | |
| prt_pkgs | list | List participating packages | XMLCPPPK | |
| reasons | list | List reasons for backout or revert | XMLCPRBR | |
| sch_recs | list | List installation schedule for package | XMLCPSCD | |
| scr_ren | refreeze unfreeze |
Refreeze scratched/renamed member Unfreeze scratched/renamed member |
XMLCPFRZ •XMLCPFRZ |
|
| service | approve audit backout create delete demote freeze promote revert submit summary |
Package approval action Audit a frozen package Back out installed package from production Create change package Memo-delete change package Demote a promoted change package (no cleanup) Freeze package Promote package to next promotion library Revert package to development status Submit package for file tailoring and JCL build List package summary statistics |
XMLCPAPV XMLCPAUD XMLCPBKO XMLCPCRT XMLCPMDL XMLCPPRM XMLCPFRZ XMLCPPRM XMLCPRVT XMLCPFTC XMLCPSUM |
|
| sites | refreeze unfreeze |
Refreeze site records for package Unfreeze site records for package |
XMLCPFRZ XMLCPFRZ |
|
| src_lod | refreeze unfreeze |
Refreeze source & load modules in package Unfreeze source & load modules in package |
XMLCPFRZ XMLCPFRZ |
|
| usr_recs | list | List user records for package | XMLCPURC | |
| parms | apl | list | List general parameters for application | XMLCAPRM |
| gbl | list | List global default general parameters | XMLCGPRM | |
| procs | apl | list | List application procedures | XMLCAPRC |
| gbl | list | List global procedures | XMLCGPRC | |
| prodlib | service | list | List production libraries | XMLCPRDL |
| promlib | library | list | List promotion library records | XMLCPRLN |
| site | list | List promotion site records | XMLCPRSN | |
| reasons | service | list | List global reason codes for unplanned changes | XMLCGRSN |
| schedule | service | hold list release |
Hold scheduled package installation List installation schedule records Release held package installation |
XMLCSCHD XMLCSCHD XMLCSCHD |
| site | apl | list | List site records for application | XMLCASIT |
| gbl | list | List global site records | XMLCGSIT | |
| pkg | list | List site records for package | XMLCPSIT | |
| system | environ | list | List SERNET environment parameters | SERVSYSO |
| service | list | List system setup & install parameters | SERVSYSO | |
| user | service | notify | Sends notification message to user | XMLCNTFY |
| util | line | SERNET print service | XMLCUTIL |
ERO XML Services Summary
Valid combinations of service, scope, and message names for the Enterprise Release Option (ERO) functions supported by XML Services are listed in the following table Exhibit 3-11. COBOL copybook names are also listed for each function. These services are shown here for completeness; they are documented in the ChangeMan ZMF ERO XML Services User’s Guide.
Exhibit 3-11. ERO XML Service, Scope, and Message Names with COBOL Copybooks
| Service Name | Scope Name | Message Name | Description of Function | COBOL Copybook |
|---|---|---|---|---|
| package | service | attach detach |
Attaches a package to a release Detaches a package from a release |
XMLCPGPM XMLCPGPM |
| rlsmappl | promote | list | Lists release management promotion data | XMLCRPRM |
| service | list release |
Lists application release status Lists release data for each release to which an application is joined |
XMLCRAPL XMLCRARL | |
| syslib | list | Lists SYSLIB data for release applications | XMLCRASY | |
| rlsmappr | area | list | Lists release area approver data | XMLCRAAP |
| ascapprv | list | Lists the items that are associated with an approval entity | XMLCRASC | |
| global | list | Lists global release approval entity data | XMLCRGAP | |
| release | list | Lists data for install approval entities | XMLCRAAP | |
| rlsmarea | all_chk | syslib | Lists the COPYLIB, LOADLIB, and source concatenation lists for libraries that are allocated | XMLCRSYL |
| all_noc | syslib | Lists all of the COPYLIB, LOADLIB, and source concatenation lists, including libraries that are not yet allocated | XMLCRSYL | |
| cim | list | Lists release area component in motion (CIM) information from the ERO DB2 CIM table | XMLCRCIM | |
| cmp_lock | list | Lists the holder of a release component lock | XMLCRCLK | |
| cpy | syslib | Lists the COPYLIB concatenation for a release application | XMLCRSYL | |
| detail | cmp_rlse integrty test |
Lists all components in a release concatenation and shows all locations where each component resides Checks the integrity of the component-in-motion (CIM) table against physical members in area libraries. Checks all versions of all components in the release concatenation. Tests the contents of a release area against all of the packages that may place a component in that area. Lists information for failing components and packages. |
XMLCRCML XMLCRCHK XMLCRTST |
|
| hst | list | Lists history from the ERO component history table | XMLCRHST | |
| imp | list | Lists impact data from the ERO DB2 impact table | XMLCRIMP | |
| load | syslib | Lists the LOADLIB concatenation for a release application | XMLCRSYL | |
| scan | cmp_rlse | Scans the latest version of components in a release concatenation to find those with content matching a search string | XMLCRCML | |
| scanall | cmp_rlse | Scans all components in a release concatenation to find those with content matching a search string | XMLCRCML | |
| service | list test |
Lists release area definitions Tests the contents of a release against all of the packages that may place a component in that release. Displays a message describing the status of packages and components in the release. |
XMLCRARE XMLCRTST |
|
| source | syslib | Lists the source SYSLIB information for a library type | XMLCRSYL | |
| start | list | Lists the release area definitions for a starting area | XMLCRARE | |
| summary | cmp_rlse integrty |
Lists information for the latest version of each component in a release concatenation Checks integrity of the component-in-motion (CIM) table against physical members in area libraries. |
XMLCRCML XMLCRCHK |
|
| syslib | list | Lists SYSLIB data for an application | XMLCRASL | |
| ver_regr | list | Performs a version regression check on components. If a version regression situation exists between the current release and a prior release, lists information for the current and prior versions. | XMLCRVER | |
| rlsmltyp | bun | list | Lists information from the release BUN library-type table | XMLCRBUN |
| service | list | Lists library security and format information | XMLCRLTP | |
| rlsmrlse | cim | list | Lists release area component in motion (CIM) information from the ERO DB2 CIM table | XMLCRLCM |
| detail | test | Tests the contents of a release against all of the packages that may place a component in that release | XMLCRTSC | |
| hst | list | Lists release component history from the ERO component history table | XMLCRLHT | |
| imp | list | Lists impact data from the ERO DB2 impact table | XMLCRLMP | |
| library | list | Lists release area libraries | XMLCRLLT | |
| prior | list | Lists prior release information | XMLCRLPR | |
| reasons | list | List Backout and Revert reasons for a release | XMLCRRBR | |
| rls_link | list | Lists release management data across a TCP/IP link | XMLCRLLK | |
| service | list search test |
Lists scheduler dates, times, and status for a release Searches for releases and lists information Tests the contents of a release against all of the packages that may place a component in that release. Displays a status message. |
XMLCRLSM XMLCRSRC XMLCRTSC |
|
| sites | list | Lists release/site dates and contacts | XMLCRSTE |