ChangeManZMF XML Services User’s Guide © Copyright 2001 - 2018 Micro Focus or one of its affiliates. This document, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by such license, no part of this publication may be reproduced, photocopied, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Serena. Any reproduction of such software product user documentation, regardless of whether the documentation is reproduced in whole or in part, must be accompanied by this copyright statement in its entirety, without modification. The only warranties for products and services of Micro Focus and its affiliates and licensors ("Micro Focus") are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice. Contains Confidential Information. Except as specifically indicated otherwise, a valid license is required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. Third party programs included with the ChangeMan ZMF product are subject to a restricted use license and can only be used in conjunction with ChangeMan ZMF. Product version: 8.1 Publication date: September 2018 (rebranded only) CONTENTS About This Book 13 Software Versions 13 Audience 13 Scope 14 Related Topics 14 Related Documents 14 Typographical Conventions 15 Manual Organization 15 Chapter 1: XML Services Concepts and Architecture 19 Software Architecture 19 Message Processing Cycle 21 Submitting a Serena XML Request 21 XML Parsing and Data Mapping 22 Generating the Serena XML Reply 22 ChangeMan ZMF Interface Comparison 23 Chapter 2: XML Syntax Basics 25 XML Syntax Standards 26 XML Tag Names 26 XML Data Elements 26 XML Tag Attributes 27 Comments 27 Character Entities 27 XML Documents as Complex Data Elements 28 Well-Formed Documents 29 XML Document Declarations 30 Identifying XML Documents 30 <?XML?> Declaration Syntax 30 Serena XML Message Documents 32 Serena XML Syntax Example 32 Logical Document Structure 34 High-Level Tags in Serena XML 35 <service> Tag: The Root Data Element 35 <scope> Tag 36 3 Contents <message> Tag 36 <header> Tag 37 <request> Tag 38 <result> Tag 38 <response> Tag 39 Filtering XML Services Messages 40 <includeInResult> Tag 40 Service, Scope, and Message Summary 41 Core XML Services Summary 41 ERO XML Services Summary 47 Chapter 3: Package Management 51 Package Message Syntax 51 Identifying Package Messages 51 Package Naming Conventions 52 Special Tag Syntax for Package Management 52 Package Lifecycle Tasks 53 Create a Package - PACKAGE SERVICE CREATE 53 Delete a Package - PACKAGE SERVICE DELETE 63 Freeze a Package - PACKAGE SERVICE FREEZE 65 Submit a Package for JCL Build - PACKAGE SERVICE SUBMIT 67 Check a Package for Promotion Readiness - PACKAGE CHECK PROMOTE 70 Promote a Package - PACKAGE SERVICE PROMOTE 70 Lock Promotion Site for Package - PACKAGE PROMOTE LOCK 74 Demote a Package - PACKAGE SERVICE DEMOTE 75 Demote a Package with Cleanup - PACKAGE CLEANUP DEMOTE 76 Approve a Package - PACKAGE SERVICE APPROVE 79 List Package Installation Schedule - SCHEDULE SERVICE LIST 82 Hold Package Install Job - SCHEDULE SERVICE HOLD 85 Release Package Install Job - SCHEDULE SERVICE RELEASE 86 Back Out a Package - PACKAGE SERVICE BACKOUT 87 Revert a Package - PACKAGE SERVICE REVERT 90 Package-Level Component Change Management 93 Component Change Description List- CMPONENT CHG_DESC LIST 94 List Staged Components - CMPONENT PKG_COMP LIST 97 Component Description List- PACKAGE CMP_DESC LIST 109 List Components With Promotion Overlays - PACKAGE PRM_OVLY LIST 112 Unfreeze Source/Load Components - PACKAGE SRC_LOD UNFREEZE 118 Refreeze Source/Load Components - PACKAGE SRC_LOD REFREEZE 120 Unfreeze Non-Source Components - PACKAGE NON_SRC UNFREEZE 122 Refreeze Non-Source Components - PACKAGE NON_SRC REFREEZE 123 4 ChangeMan® ZMF XML Services User’s Guide List Scratch and Rename Utility Records - CMPONENT PKG_UTIL LIST 124 Unfreeze Scratch/Rename Records - PACKAGE SCR_REN UNFREEZE 129 Refreeze Scratch/Rename Records - PACKAGE SCR_REN REFREEZE 130 Package Validation Tasks 131 List Source-to-Load Dependencies - CMPONENT PKG_LOD LIST 131 Check Component Integrity - PACKAGE CMPONENT INTEGRTY 138 Audit a Package - PACKAGE SERVICE AUDIT 140 Package Information Management Tasks 146 List Package Description - PACKAGE GEN_DESC LIST 146 List General Package Parameters - PACKAGE GEN_PRMS LIST 148 Unfreeze Package Parameters - PACKAGE GEN_PRMS UNFREEZE 159 Refreeze Package Parameters - PACKAGE GEN_PRMS REFREEZE 160 List User-Defined Package Variables - PACKAGE USR_RECS LIST 160 List Package Install Sites - SITE PKG LIST 164 Unfreeze Package Install Sites - PACKAGE SITES UNFREEZE 168 Refreeze Package Install Sites - PACKAGE SITES REFREEZE 169 List Package Installation Dependencies - PACKAGE SCH_RECS LIST 169 List Package Implementation Instructions - PACKAGE IMP_INST LIST 173 List Package Approvers - APPROVER PKG LIST 174 List Affected Applications - PACKAGE AFF_APLS LIST 180 List Participating Packages - PACKAGE PRT_PKGS LIST 182 List Linked Packages - PACKAGE PKG_LINK LIST 183 List Package Library Types - LIBTYPE PKG LIST 187 List Package Promotion History - PACKAGE PRM_HIST LIST 193 Package Promoted Component List - PACKAGE PRM_CMP LIST 199 List Reasons for Backout or Revert - PACKAGE REASONS LIST 203 Chapter 4: Component Management 207 Component Management Message Syntax 207 Identifying Component Messages 207 Component Lifecycle Tasks 208 Check Out a Component - CMPONENT SERVICE CHECKOUT 209 Component Service Checkin - CMPONENT SERVICE CHECKIN 214 Check Designated Build Procedures - CMPONENT APL_DPRC CHECK 219 Find Designated Build Procedure - CMPONENT APL_DPRC FIND 223 List Designated Build Procedures - CMPONENT APL_DPRC LIST 224 List Global Designated Build Procedures - CMPONENT GBL_DPRC LIST 229 Component Service Build - CMPONENT SERVICE BUILD 229 Recompile a Component - CMPONENT SERVICE RECOMP 235 Relink a Component - CMPONENT SERVICE RELINK 240 Browse a Component - CMPONENT SERVICE BROWSE 246 5 Contents Compare Components - CMPONENT SERVICE COMPARE 249 Rename a Component - CMPONENT SERVICE RENAME 252 Scratch a Component - CMPONENT SERVICE SCRATCH 254 Lock or Unlock a Component - CMPONENT SERVICE LOCK/UNLOCK 255 List Load Module Subroutines - CMPONENT LOD_SUBR LIST 257 List Copybook Names in Source - CMPONENT SRC_INCL LIST 261 Component Staging Version Management 265 List Component Staging Versions - CMPONENT SSV_VER LIST 265 Retrieve Component Staging Version - CMPONENT SSV_VER RETRIEVE 270 Component Information Management Tasks 274 List Component Change Description - CMPONENT CHG_DESC LIST 274 Find Component Description - CMPONENT APL_CDSC FIND 277 List Component Description - CMPONENT APL_CDSC LIST 278 List Global Component Description - CMPONENT GBL_CDSC LIST 280 List Component Promotion History - CMPONENT PRM_HIST LIST 281 Component History List - CMPONENT HISTORY LIST 283 List Short Component History - CMPONENT HISTORY LISTSHRT 291 List Current Component History - CMPONENT HISTORY LISTCURR 292 List Concurrent Comp. History - CMPONENT HISTORY LISTCONC 293 List Baselined Component History - CMPONENT HISTORY LISTBASE 294 List Comp. User Worklist Records - CMPONENT PKG_WRKL LIST 294 Component Security Tasks 298 Check Component Security - CMPONENT APL_SECR CHECK 298 Find Component Authorized Users - CMPONENT APL_SECR FIND 300 List Component Authorized Users - CMPONENT APL_SECR LIST 302 List Global Component Authorized Users - CMPONENT GBL_SECR LIST 304 Chapter 5: Search, Summary, and Analysis Tasks 307 Syntax Conventions for Search, Summary, and Analysis 307 Semicolon-Delimited Lists 307 Yes/No Flag Tags 308 Package Search and Summary Tasks 309 General Package Search - PACKAGE GENERAL SEARCH 309 Search for Limbo Packages - PACKAGE LIMBO SEARCH 326 Search for Packages Pending Approval - PACKAGE APPROVE SEARCH 327 Search for Linked Packages - PACKAGE PKG_LINK SEARCH 328 Package Summary Statistics - PACKAGE SERVICE SUMMARY 336 Audit Trail Management 345 Create Log File Entry - LOG SERVICE CREATE 345 List Activity Log File Entries - LOG SERVICE LIST 349 Impact Analysis Functions 350 IMPACT BUN LIST 351 6 ChangeMan® ZMF XML Services User’s Guide IMPACT CMPONENT LIST 353 IMPACT TABLE LIST 355 Chapter 6: Dataset Management 361 Dataset Lifecycle Tasks 361 Allocate a Dataset - DSS SERVICE ALLOCATE 362 Delete a Dataset - DSS SERVICE DELETE 364 Delete a Dataset Member - DSS SERVICE MBRDEL 365 List Dataset Allocation Information - DSS SERVICE INFO 366 List Dataset Member Directory - DSS SERVICE LIST 369 List ISPF Dataset Allocation Information - DSS ISPFILE INFO 372 List Statistics for Baseline Members - DSS SERVICE BASESTAT 374 Expand Member in SRD Format - DSS SERVICE EXPAND 376 Chapter 7: Hierarchical File System Services 379 Overview 379 Hierarchical File System Functions 379 High-Level Syntax 379 Related Services 380 HFS Directory Services 380 Create a Directory — FILE SERVICE MKDIR 380 Delete