Micro Focus. Enterprise View. MVS Custom Agent - API

Micro Focus Enterprise View MVS Custom Agent - API

Copyright 2008 Micro Focus (IP) Ltd. All rights reserved. Micro Focus (IP) Ltd. has made every effort to ensure that this book is correct and accurate, but reserves the right to make changes without notice at its sole discretion at any time. The software described in this document is supplied under a license and may be used or copied only in accordance with the terms of such license, and in particular any warranty of fitness of Micro Focus software products for any particular purpose is expressly excluded and in no event will Micro Focus be liable for any consequential loss. Animator, COBOL Workbench, EnterpriseLink, Mainframe Express, Micro Focus, Net Express, REQL and Revolve are registered trademarks, and AAI, Analyzer, Application Server, Application to Application Interface, AddPack, AppTrack, AssetMiner, CCI, DataConnect, Dialog System, Enterprise Server, Enterprise Server with MTO, EuroSmart, FixPack, LEVEL II COBOL, License Server, Mainframe Access, Mainframe Manager, Micro Focus COBOL, Micro Focus Studio, Micro Focus Server, Object COBOL, OpenESQL, Personal COBOL, Professional COBOL, Server Express, SmartFind, SmartFind Plus, SmartFix, SourceConnect, SupportLine, Toolbox, VS COBOL, WebSync, and Xilerator are trademarks of Micro Focus (IP) Ltd. IBM and CICS are registered trademarks, and IMS, DB2, DB2/390, DB2 Connect Enterprise Edition, DB2 Connect Personal Edition, COBOL for OS/390, Enterprise Systems Architecture/390, ESA/390, MVS, MVS/ESA, OS/390, S/390, System/390, VSE/ESA and MFS are trademarks, of International Business Machines Corporation. Netscape Enterprise Server is a trademark of Netscape Communications Corporation. Internet Information Server, Windows 95, Windows 98, Windows NT 4.0, Windows ME and Windows 2000 are registered trademarks of Microsoft Corporation. Pentium is a registered trademark of INTEL Corporation. Borland Database Engine and Midas are trademarks of Inprise Corporation. Oracle is a trademark of Oracle Corporation Inc. UNIX is a registered trademark of The Open Group. Solaris, Ultra Sparc and Java are trademarks of Sun Microsystems, Inc. Linux, GCC compiler, GNU CTAGS, GNU DIFF, Samba and KDE/GNOME refer to Open Source tools. This product includes modified versions of software developed by the Apache Software Foundation (as described on the Apache web site). The YGrep Search Engine is Copyright (c) 1992-2004 Yves Roumazeilles. All other trademarks are the property of their respective owners. No part of this publication, with the exception of the software product user documentation contained on a CD-ROM, may be copied, photocopied, reproduced, transmitted, transcribed, or reduced to any electronic medium or machine-readable form without prior written consent of Micro Focus (IP) Ltd. Contact your Micro Focus

representative if you require access to the modified Apache Software Foundation source files. Licensees may duplicate the software product user documentation contained on a CD- ROM, but only to the extent necessary to support the users authorized access to the software under the license agreement. Any reproduction of the 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. U.S. GOVERNMENT RESTRICTED RIGHTS. It is acknowledged that the Software and the Documentation were developed at private expense, that no part is in the public domain, and that the Software and Documentation are Commercial Computer Software provided with RESTRICTED RIGHTS under Federal Acquisition Regulations and agency supplements to them. Use, duplication or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause at DFAR 252.227-7013 et. seq. or subparagraphs (c)(1) and (2) of the Commercial Computer Software Restricted Rights at FAR 52.227-19, as applicable. Contractor is Micro Focus (IP) Ltd, 9420 Key West Avenue, Rockville, Maryland 20850. Rights are reserved under copyright laws of the United States with respect to unpublished portions of the Software.

4

5 Table of Contents 1. INTRODUCTION... 7 1.1. ABOUT THIS DOCUMENT... 7 1.2. WHO SHOULD USE THIS DOCUMENT... 7 1.3. HOW TO READ THE SYNTAX DIAGRAM... 7 2. APIS FOR INITIAL LOADING... 9 2.1. KPCCMI STANDARD INTERFACE... 10 2.1.1. Hierarchy... 11 2.1.2. Syntax diagram... 11 2.1.3. Parameter list... 11 2.1.4. Returned value... 11 2.1.5. Examples... 11 2.1.5.1. Command... 11 2.1.5.2. JCL... 12 2.2. KPCMANI - CHANGEMAN INTERFACE... 12 2.2.1. Hierarchy... 12 2.2.2. Syntax diagram... 13 2.2.3. Parameter list... 13 2.2.4. Returned value... 13 2.2.5. Examples... 13 2.2.5.1. Command... 13 2.2.5.2. JCL... 14 2.3. KPEDVRI - CA-ENDEVOR INTERFACE... 14 2.3.1. Hierarchy... 14 2.3.2. Syntax diagram... 14 2.3.3. Parameter list... 15 2.3.4. Returned value... 15 2.3.5. Examples... 15 2.3.5.1. Command... 15 2.3.5.2. JCL... 16 3. APIS FOR SYNCHRONIZATION PROCESS... 17 3.1. KPCCMS STANDARD INTERFACE... 18 3.1.1. Hierarchy... 19 3.1.2. Syntax diagram... 19 3.1.3. Parameter list... 19 3.1.4. Returned value... 19 3.1.5. Examples... 19 3.1.5.1. Command... 19 3.1.5.2. JCL... 20 3.2. KPCMANS CHANGEMAN INTERFACE... 20 3.2.1. Hierarchy... 20 3.2.2. Syntax diagram... 20 3.2.3. Parameter list... 21

6 3.2.4. Returned value... 21 3.2.5. Examples... 21 3.2.5.1. Command... 21 3.2.5.2. JCL... 22 3.3. KPEDVRS CA-ENDEVOR INTERFACE... 22 3.3.1. Hierarchy... 22 3.3.2. Syntax diagram... 23 3.3.3. Parameter list... 23 3.3.4. Returned value... 23 3.3.5. Examples... 23 3.3.5.1. Command... 23 3.3.5.2. JCL... 24 4. APIS FOR SOFTWARE LIFE CYCLE... 25 4.1. KPCCMU STANDARD INTERFACE... 26 4.1.1. Hierarchy... 27 4.1.2. Syntax diagram... 27 4.1.3. Parameter list... 27 4.1.4. Returned value... 27 4.1.5. Examples... 28 4.1.5.1. Command... 28 4.1.5.2. JCL... 28 4.2. KPCMANU - CHANGEMAN INTERFACE... 29 4.2.1. Hierarchy... 29 4.2.2. Syntax diagram... 29 4.2.3. Parameter list... 29 4.2.4. Returned value... 30 4.2.5. Examples... 30 4.2.5.1. Command... 30 4.2.5.2. JCL... 31 4.3. KPEDVRU - CA-ENDEVOR INTERFACE... 31 4.3.1. Hierarchy... 31 4.3.2. Syntax diagram... 32 4.3.3. Parameter list... 32 4.3.4. Returned value... 32 4.3.5. Examples... 33 4.3.5.1. Command... 33 4.3.5.2. JCL... 33 5. GLOSSARY... 36

7 1. Introduction This document contains information about the MVS Custom Agent API. You will learn what it does and how to work with it. 1.1. About this document This document provides syntax diagrams and describes the commands and subcommands included in MVS Custom Agents. It provides only reference material and assumes you are experienced in the use of the MVS environment and Enterprise View. 1.2. Who should use this document Anyone who has to create interfaces with MVS Custom Agents should read this document. 1.3. How to read the syntax diagram Syntax is described using the structure defined below. Read the syntax diagrams from left to right, from top to bottom. An italicized lower-case word indicates a variable No characters must be added between the parameter name and the following parenthesis Required items appear in bold text (Text) Optional items appear in normal text (Text) Repeatable items must be separated by a comma (xxx, yyy) The end of the command is indicated by the sequence of characters ( ;\ ) Example P01(<value>); P02(<value>); P03(<value01>,, <value20>,); P04(<value01>,,);\ P01. Is a mandatory parameter P02. Is an optional parameter P03. Is an optional parameter that lets you indicate up to 20 values P04. Is an optional parameter that lets you indicate multiple values ;\. Indicates the end of the command line

8

9 2. APIs for initial loading The process performs the first load into the AKP. Starting from the CCM component list, the process loads source information in order to inventory the customer software components. If necessary, you should provide a partial list to limit the loading. The output of the process is a list driving the inventory load.

10 2.1. KPCCMI Standard interface The standard interface lets you perform the initial load of the customer software. You must invoke the API for each software component in the component list.

11 2.1.1. Hierarchy KPCCMI 2.1.2. Syntax diagram NAME(<Value>); LIBRARY(<Value>); EXTENSION(<Value>); DESTINATIONPATH(<Value01>,.., <Value10>,); ALIAS(<Value>); DESCRIPTION(<Value>); OBJECTCODES(<Value01>,.., <Value20>,);\ 2.1.3. Parameter list NAME Source name LIBRARY PDS name containing the source EXTENSION Enterprise View extension used to identify the object type DESTINATIONPATH Set of codes used to compose the destination path ALIAS Object name. Only if it is different from the source name DESCRIPTION Description of the sources OBJECTCODES Set of codes related to changes 2.1.4. Returned value At the end, the API sets the returned value in RETURN-CODE variable. The returned value could be: 0 Elaboration ended normally 4 Elaboration ended normally. Informative messages issued. 8 Elaboration ended abnormally. Error messages issued. 2.1.5. Examples 2.1.5.1. Command NAME(KPPGM); LIBRARY(KBB.R53.CBL); EXTENSION(.CBLBAT); DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ In this example, the custom interface invokes the API KPCCMI passing the command above. The command line indicates that KPPGM is a batch COBOL program and it is stored into the PDS called KBB.R53.CBL. The default reason for changes is 001 (inventory).

12 2.1.5.2. JCL //KPCCMI JOB (00001),EVZAG,MSGCLASS=A,CLASS=L,NOTIFY=USER, // TIME=NOLIMIT,REGION=0M //JOBLIB DD DISP=SHR,DSN=KBB.RxxPTF.LOAD // DD DISP=SHR,DSN=KBB.Rxx.LOAD // DD DISP=SHR,DSN=DSNxxx.SDSNLOAD // DD DISP=SHR,DSN=CEE.SCEERUN //LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) 1 2 //RUNPGM EXEC KREXCPGP,PROGRAM=KPCCMI,KENVNAME=KBB.KBTxxA, // KPARM='*CARD' //IMPSRC DD DISP=SHR,DSN=KBB.KBTxxA.IMPSRC //CARDIN DD * NAME(KPPGM); LIBRARY(KBB.R53.CBL); EXTENSION(.CBL); 4 DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ 3 (//LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) - Library list of catalogued procedures in order to invoke MVS Custom Agents programs (//RUNPGM EXEC KREXCPGP,PROGRAM=KPCCMI, KENVNAME=KBB.KBTxxA,) - KREXCPGP is the procedure to invoke a MVS Custom Agents program with PARM (//RUNPGM EXEC KREXCPGP,PROGRAM=KPCCMI,KENVNAME=KBB.KBTxxA) Environment name (LIBRARY(KBB.R53.CBL);) API command must be indicated in DD called CARDIN. 2.2. KPCMANI - CHANGEMAN interface The CHANGEMAN interface performs the initial load of the customer software. You must invoke the API for each software component in the component list. 2.2.1. Hierarchy KPCCMI Standard interface KPCMANI

13 2.2.2. Syntax diagram NAME(<Value>); LIBRARY(<Value>); CMANLIB(<Value>); CMANLNG(<Value>); DESTINATIONPATH(<Value01>,.., <Value10>,); ALIAS(<Value>); DESCRIPTION(<Value>); OBJECTCODES(<Value01>,.., <Value20>,);\ 2.2.3. Parameter list NAME Source name LIBRARY PDS name containing the source CMANLIB CHANGEMAN library type. In this case, the KTQCM file must be already loaded, to retrieve the correct extension to apply to the object CMANLNG CHANGEMAN language type. In this case, the KTQCM file must be already loaded, to retrieve the correct extension to apply to the object DESTINATIONPATH Set of codes used to compose the destination path ALIAS Object name. Only if it is different from the source name DESCRIPTION Description of the sources OBJECTCODES Set of codes related to changes 2.2.4. Returned value At the end, the API sets the returned value in RETURN-CODE variable. The returned value could be: 0 Elaboration ended normally 4 Elaboration ended normally. Informative messages issued. 8 Elaboration ended abnormally. Error messages issued. 2.2.5. Examples 2.2.5.1. Command NAME(KPPGM); LIBRARY(KBB.R53.CBL); CMANLIB(PGM); CMANLNG(CBL); DESTINATIONPATH(KBB,R50,CBL,);\ In this example, the custom interface invokes the API KPCMANI passing the command above. The type will be managed by the interface in order to identify the extension based on information stored in KTQCM file. You must load the file to create a link between CHANGEMAN and MVS Custom Agents. The default reason for changes is 001 (inventory).

14 2.2.5.2. JCL //KPCMANI JOB (00001),EVZAG,MSGCLASS=A,CLASS=L,NOTIFY=USER, // TIME=NOLIMIT,REGION=0M //JOBLIB DD DISP=SHR,DSN=KBB.RxxPTF.LOAD // DD DISP=SHR,DSN=KBB.Rxx.LOAD // DD DISP=SHR,DSN=DSNxxx.SDSNLOAD // DD DISP=SHR,DSN=CEE.SCEERUN //LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) 1 2 //RUNPGM EXEC KREXCPGP,PROGRAM=KPCMANI,KENVNAME=KBB.KBTxxA, // KPARM='*CARD' //IMPSRC DD DISP=SHR,DSN=KBB.KBTxxA.IMPSRC //CARDIN DD * NAME(KPPGM); LIBRARY(KBB.R53.CBL); EXTENSION(.CBL); 4 DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ 3 (1) Library list of catalogued procedures in order to invoke MVS Custom Agents programs (2) KREXCPGP is the procedure to invoke a MVS Custom Agents program with PARM (3) Environment name (4) API command must be indicated in DD called CARDIN. 2.3. KPEDVRI - CA-ENDEVOR interface The CA-ENDEVOR interface performs the initial load of customer software. You must invoke the API for each software component in the component list. 2.3.1. Hierarchy KPCCMI Standard interface KPEDVRI 2.3.2. Syntax diagram NAME(<Value>); LIBRARY(<Value>); EDVRTYPE(<Value>); DESTINATIONPATH(<Value01>,.., <Value10>,); ALIAS(<Value>); DESCRIPTION(<Value>); OBJECTCODES(<Value01>,.., <Value20>,);\

15 2.3.3. Parameter list NAME Source name LIBRARY PDS name containing the source EDVRTYPE CA-ENDEVOR object type. In this case, the KTQCM file must be already loaded, to retrieve the correct extension to apply to the object DESTINATIONPATH Set of codes used to compose the destination path ALIAS Object name. Only if it is different from the source name DESCRIPTION Description of the sources OBJECTCODES Set of codes related to changes 2.3.4. Returned value At the end, the API sets the returned value in RETURN-CODE variable. The returned value could be: 0 Elaboration ended normally 4 Elaboration ended normally. Informative messages issued. 8 Elaboration ended abnormally. Error messages issued. 2.3.5. Examples 2.3.5.1. Command NAME(KPPGM); LIBRARY(KBB.R53.CBL); EDVRTYPE(CBLBCH); DESTINATIONPATH(KBB,R50,CBL,);\ In this example, the custom interface invokes the API KPEDVRI passing the command above. The type will be managed by the interface in order to identify the extension based on information stored in KTQCM file. You must load the file to create a link between CA-ENDEVOR and MVS Custom Agents. The default reason for changes is 001 (inventory).

16 2.3.5.2. JCL //KPEDVRI JOB (00001),EVZAG,MSGCLASS=A,CLASS=L,NOTIFY=USER, // TIME=NOLIMIT,REGION=0M //JOBLIB DD DISP=SHR,DSN=KBB.RxxPTF.LOAD // DD DISP=SHR,DSN=KBB.Rxx.LOAD // DD DISP=SHR,DSN=DSNxxx.SDSNLOAD // DD DISP=SHR,DSN=CEE.SCEERUN //LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) 1 2 //RUNPGM EXEC KREXCPGP,PROGRAM=KPEDVRI,KENVNAME=KBB.KBTxxA, // KPARM='*CARD' //IMPSRC DD DISP=SHR,DSN=KBB.KBTxxA.IMPSRC //CARDIN DD * NAME(KPPGM); LIBRARY(KBB.R53.CBL); EXTENSION(.CBL); 4 DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ 3 (1) Library list of catalogued procedures in order to invoke MVS Custom Agents programs (2) KREXCPGP is the procedure to invoke a MVS Custom Agents program with PARM (3) Environment name (4) API command must be indicated in DD named CARDIN

17 3. APIs for synchronization process The main process performs the environment update, capturing the source and promoting to the production environment. In some cases, this is not sufficient to find all real changes in the production environment. For example, compilations and changes performed in production environment directly might not be found. The synchronization process provides a report containing all non-aligned information and, in some specific cases, creates the proper actions to manage the situation itself. It uses the list extracted from the CCM to retrieve information about software components. These are transferred to a UNIX or Linux box to compare them with information stored in AKP.

18 3.1. KPCCMS Standard interface The standard interface stores information related to software components managed by CCM. You must invoke the API for each software component in the component list.

19 3.1.1. Hierarchy KPCCMS 3.1.2. Syntax diagram NAME(<Value>); LIBRARY(<Value>); EXTENSION(<Value>); DESTINATIONPATH(<Value01>,.., <Value10>,); ALIAS(<Value>); USER(<Value>); LSTCHGDT(<Value>); VERSION(<Value>); DESCRIPTION(<Value>); OBJECTCODES(<Value01>,.., <Value20>,);\ 3.1.3. Parameter list NAME Source name LIBRARY PDS name containing the source EXTENSION Enterprise View object type DESTINATIONPATH Set of codes used to compose the destination path ALIAS Object name. Only if it is different from the source name USER User identifier. User who made the last changes LSTCGHDT Last date of changes (like DB2 Timestamp format) VERSION Source version DESCRIPTION Description of the sources OBJECTCODES Set of codes related to changes 3.1.4. Returned value At the end, the API sets the returned value in RETURN-CODE variable. The returned value could be: 0 Elaboration ended normally 4 Elaboration ended normally. Informative messages issued. 8 Elaboration ended abnormally. Error messages issued. 3.1.5. Examples 3.1.5.1. Command NAME(KPPGM); LIBRARY(KBB.R53.CBL); EXTENSION(.CBLBAT); DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ In the example, the custom interface invokes the API KPCCMS passing the command above. The command line indicates that KPPGM is a batch COBOL program; it is stored in the PDS called KBB.R53.CBL.

20 3.1.5.2. JCL //KPCCMS JOB (00001),EVZAG,MSGCLASS=A,CLASS=L,NOTIFY=USER, // TIME=NOLIMIT,REGION=0M //JOBLIB DD DISP=SHR,DSN=KBB.RxxPTF.LOAD // DD DISP=SHR,DSN=KBB.Rxx.LOAD // DD DISP=SHR,DSN=DSNxxx.SDSNLOAD // DD DISP=SHR,DSN=CEE.SCEERUN //LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) 1 2 //RUNPGM EXEC KREXCPGP,PROGRAM=KPCCMS,KENVNAME=KBB.KBTxxA, // KPARM='*CARD' //IMPSRC DD DISP=SHR,DSN=KBB.KBTxxA.IMPSRC //CARDIN DD * NAME(KPPGM); LIBRARY(KBB.R53.CBL); EXTENSION(.CBL); 4 DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ 3 (1) Library list of catalogued procedures in order to invoke MVS Custom Agents programs (2) KREXCPGP is the procedure to invoke a MVS Custom Agents program with PARM (3) Environment name (4) API command must be indicated in DD called CARDIN 3.2. KPCMANS CHANGEMAN interface The CHANGEMAN interface stores information related to software components managed by CCM. You must invoke the API for each software component in the component list. 3.2.1. Hierarchy KPCMANS 3.2.2. Syntax diagram NAME(<Value>); LIBRARY(<Value>); CMANLIB(<Value>); CMANLNG(<Value>); DESTINATIONPATH(<Value01>,.., <Value10>,); ALIAS(<Value>); USER(<Value>); LSTCHGDT(<Value>); VERSION(<Value>); DESCRIPTION(<Value>); OBJECTCODES(<Value01>,.., <Value20>,);\

21 3.2.3. Parameter list NAME Source name LIBRARY PDS name containing the source CMANLIB CHANGEMAN library type. In this case, the KTQCM file must be already loaded, to retrieve the correct extension to apply to the object CMANLNG CHANGEMAN language type. In this case, the KTQCM file must be already loaded, to retrieve the correct extension to apply to the object DESTINATIONPATH Set of codes will be used to compose the destination path ALIAS Object name. Only if it is different from the source name USER User identifier. User who made the last changes LSTCGHDT Last date of changes (like DB2 Timestamp format) VERSION Source version DESCRIPTION Description of the sources OBJECTCODES Set of codes related to changes 3.2.4. Returned value At the end, the API sets the returned value in RETURN-CODE variable. The returned value could be: 0 Elaboration ended normally 4 Elaboration ended normally. Informative messages issued. 8 Elaboration ended abnormally. Error messages issued. 3.2.5. Examples 3.2.5.1. Command NAME(KPPGM); LIBRARY(KBB.R53.CBL); CMANLIB(PGM); CMANLNG(CBL); DESTINATIONPATH(KBB,R50,CBL,);\ In this example, the custom interface invokes the API KPCMANS passing the command above. The type will be managed by the interface in order to identify the extension based on information stored in KTQCM file. You must load the file to create a link between CHANGEMAN and MVS Custom Agents.

22 3.2.5.2. JCL //KPCMANS JOB (00001),EVZAG,MSGCLASS=A,CLASS=L,NOTIFY=USER, // TIME=NOLIMIT,REGION=0M //JOBLIB DD DISP=SHR,DSN=KBB.RxxPTF.LOAD // DD DISP=SHR,DSN=KBB.Rxx.LOAD // DD DISP=SHR,DSN=DSNxxx.SDSNLOAD // DD DISP=SHR,DSN=CEE.SCEERUN //LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) 1 2 //RUNPGM EXEC KREXCPGP,PROGRAM=KPCMANS,KENVNAME=KBB.KBTxxA, // KPARM='*CARD' //IMPSRC DD DISP=SHR,DSN=KBB.KBTxxA.IMPSRC //CARDIN DD * NAME(KPPGM); LIBRARY(KBB.R53.CBL); EXTENSION(.CBL); 4 DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ 3 (1) Library list of catalogued procedures in order to invoke MVS Custom Agents programs (2) KREXCPGP is the procedure to invoke a MVS Custom Agents program with PARM (3) Environment name (4) API command must be indicated in DD called CARDIN 3.3. KPEDVRS CA-ENDEVOR interface The CA-ENDEVOR interface stores information related to software components managed by CCM. You must invoke the API for each software component in the component list. 3.3.1. Hierarchy KPEDVRS

23 3.3.2. Syntax diagram NAME(<Value>); LIBRARY(<Value>); EDVRTYPE(<Value>); DESTINATIONPATH(<Value01>,.., <Value10>,); ALIAS(<Value>); USER(<Value>); LSTCHGDT(<Value>); VERSION(<Value>); DESCRIPTION(<Value>); OBJECTCODES(<Value01>,.., <Value20>,);\ 3.3.3. Parameter list NAME Source nam LIBRARY PDS name containing the source EDVRTYPE CA-ENDEVOR object type. In this case, the KTQCM file must be already loaded, to retrieve the correct extension to apply to the object DESTINATIONPATH Set of codes used to compose the destination path ALIAS Object name. Only if it is different from the source name USER User identifier. User who made the last changes LSTCGHDT Last date of changes (like DB2 Timestamp format) VERSION Source version DESCRIPTION Description of the sources OBJECTCODES Set of codes related to changess 3.3.4. Returned value At the end, the API sets the returned value in RETURN-CODE variable. The returned value could be: 0 Elaboration ended normally 4 Elaboration ended normally. Informative messages issued. 8 Elaboration ended abnormally. Error messages issued. 3.3.5. Examples 3.3.5.1. Command NAME(KPPGM); LIBRARY(KBB.R53.CBL); EDVRTYPE(PGM); DESTINATIONPATH(KBB,R50,CBL,);\ In this example, the custom interface invokes the API KPEDVRS passing the command above. The type will be managed by the interface in order to identify the extension based on information stored in KTQCM file. You must load the file to create a link between CA-ENDEVOR and MVS Custom Agents.

24 3.3.5.2. JCL //KPEDVRS JOB (00001),EVZAG,MSGCLASS=A,CLASS=L,NOTIFY=USER, // TIME=NOLIMIT,REGION=0M //JOBLIB DD DISP=SHR,DSN=KBB.RxxPTF.LOAD // DD DISP=SHR,DSN=KBB.Rxx.LOAD // DD DISP=SHR,DSN=DSNxxx.SDSNLOAD // DD DISP=SHR,DSN=CEE.SCEERUN //LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) 1 2 //RUNPGM EXEC KREXCPGP,PROGRAM=KPEDVRS,KENVNAME=KBB.KBTxxA, // KPARM='*CARD' //IMPSRC DD DISP=SHR,DSN=KBB.KBTxxA.IMPSRC //CARDIN DD * NAME(KPPGM); LIBRARY(KBB.R53.CBL); EXTENSION(.CBL); 4 DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ 3 (1) Library list of catalogued procedures in order to invoke MVS Custom Agents programs (2) KREXCPGP is the procedure to invoke a MVS Custom Agents program with PARM (3) Environment name (4) API command must be indicates into DD named CARDIN

25 4. APIs for software life cycle One of the main features that the product provides is up-to-date technical documentation. A process called Software Life Cycle performs the update. The product provides a synchronous process, invoked during the promote phase, and an asynchronous process, which should be scheduled daily. This lets you minimize the impact on customer procedures, and optimize resource usage.

26 4.1. KPCCMU Standard interface The standard interface performs the update of the AKP. You must invoke the API for each software component in the component list.

27 4.1.1. Hierarchy KPCCMU 4.1.2. Syntax diagram NAME(<Value>); LIBRARY(<Value>); EXTENSION(<Value>); DESTINATIONPATH(<Value01>,.., <Value10>,);ALIAS(<Value>); ISTODELETE(<Value>); REASON(<Value>); DESCRIPTION(<Value>); CHANGECODES(<Value01>,.., <Value20>,); OBJECTCODES(<Value01>,.., <Value20>,);\ 4.1.3. Parameter list NAME Source name LIBRARY PDS name containing the source EXTENSION Enterprise View object type DESTINATIONPATH Set of codes will be used to compose the destination path ALIAS Object name. Only if it is different from the source name ISTODELETE Indicates when the object must be removed from the knowledge base. Allowed values are: Y To delete N To process REASON Indicates the reason for changes. Allowed values are: 001 Inventory loading 101 Bug fixing 111 Enhancements project 121 Maintenance activities DESCRIPTION Description of the sources CHANGECODES Set of codes related to changes OBJECTCODES Set of codes related to object 4.1.4. Returned value At the end, the API sets the returned value in RETURN-CODE variable. The returned value could be: 0 Elaboration ended normally 4 Elaboration ended normally. Informative messages issued. 8 Elaboration ended abnormally. Error messages issued.

28 4.1.5. Examples 4.1.5.1. Command NAME(KPPGM); LIBRARY(KBB.R53.CBL); EXTENSION(.CBLBAT); DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ In this example, the CCM invokes the application program interface KPCCMU passing the command above. It stores the change event in IMPSRC. The default reason for changes is 121 (maintenance). 4.1.5.2. JCL //KPCCMU JOB (00001),EVZAG,MSGCLASS=A,CLASS=L,NOTIFY=USER, // TIME=NOLIMIT,REGION=0M //JOBLIB DD DISP=SHR,DSN=KBB.RxxPTF.LOAD // DD DISP=SHR,DSN=KBB.Rxx.LOAD // DD DISP=SHR,DSN=DSNxxx.SDSNLOAD // DD DISP=SHR,DSN=CEE.SCEERUN //LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) 1 2 //RUNPGM EXEC KREXCPGP,PROGRAM=KPCCMU,KENVNAME=KBB.KBTxxA, // KPARM='*CARD' //IMPSRC DD DISP=SHR,DSN=KBB.KBTxxA.IMPSRC //CARDIN DD * NAME(KPPGM); LIBRARY(KBB.R53.CBL); 4 EXTENSION(.CBL); REASON(101); DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ 3 (1) Library list of catalogued procedures in order to invoke MVS Custom Agents programs (2) KREXCPGP is the procedure to invoke a MVS Custom Agents program with PARM (3) Environment name (4) API command must be indicates into DD named CARDIN

29 4.2. KPCMANU - CHANGEMAN interface The CHANGEMAN interface performs the update of the AKP. You must invoke the API for each software component in the component list. 4.2.1. Hierarchy KPCMANU 4.2.2. Syntax diagram NAME(<Value>); LIBRARY(<Value>); CMANLIB(<Value>); CMANLNG(<Value>); DESTINATIONPATH(<Value01>,.., <Value10>,); ALIAS(<Value>); ISTODELETE(<Value>); REASON(<Value>); DESCRIPTION(<Value>); CHANGECODES(<Value01>,.., <Value20>,); OBJECTCODES(<Value01>,.., <Value20>,);\ 4.2.3. Parameter list NAME Source name LIBRARY PDS name containing the source CMANLIB CHANGEMAN library type. In this case, the KTQCM file must be already loaded, to retrieve the correct extension to apply to the object CMANLNG CHANGEMAN language type. In this case, the KTQCM file must be already loaded, to retrieve the correct extension to apply to the object DESTINATIONPATH Set of codes used to compose the destination path ALIAS Object name. Only if it is different from the source name ISTODELETE Indicates when the object must be removed from the knowledge base. Allowed values are: Y To delete N To process REASON Indicates the reason for changes. Allowed values are: 001 Inventory loading 101 Bug fixing 111 Enhancements project 121 Maintenance activities DESCRIPTION Description of the sources CHANGECODES Set of codes related to changes OBJECTCODES Set of codes related to object

30 4.2.4. Returned value At the end, the API sets the returned value in RETURN-CODE variable. The returned value could be: 0 Elaboration ended normally 4 Elaboration ended normally. Informative messages issued. 8 Elaboration ended abnormally. Error messages issued. 4.2.5. Examples 4.2.5.1. Command NAME(KPPGM); LIBRARY(KBB.R53.CBL); CMANLIB(PGM); CMANLNG(CBL); DESTINATIONPATH(KBB,R50,CBL,);\ In this example, the CCM invokes the application program interface KPCMANU passing the command above. It stores the change event in IMPSRC. The object type will be managed by the interface in order to identify the extension based on information stored in KTQCM file. You must load the configuration file to create a link between CHANGEMAN and MVS Custom Agents. The default reason for changes is 121 (maintenance).

31 4.2.5.2. JCL //KPCMANU JOB (00001),EVZAG,MSGCLASS=A,CLASS=L,NOTIFY=USER, // TIME=NOLIMIT,REGION=0M //JOBLIB DD DISP=SHR,DSN=KBB.RxxPTF.LOAD // DD DISP=SHR,DSN=KBB.Rxx.LOAD // DD DISP=SHR,DSN=DSNxxx.SDSNLOAD // DD DISP=SHR,DSN=CEE.SCEERUN //LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) 1 2 //RUNPGM EXEC KREXCPGP,PROGRAM=KPCMANU,KENVNAME=KBB.KBTxxA, // KPARM='*CARD' //IMPSRC DD DISP=SHR,DSN=KBB.KBTxxA.IMPSRC //CARDIN DD * NAME(KPPGM); LIBRARY(KBB.R53.CBL); 4 EXTENSION(.CBL); REASON(101); DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ 3 (1) Library list of catalogued procedures in order to invoke MVS Custom Agents programs (2) KREXCPGP is the procedure to invoke a MVS Custom Agents program with PARM (3) Environment name (4) API command must be indicated in DD called CARDIN 4.3. KPEDVRU - CA-ENDEVOR interface The CA-ENDEVOR interface performs the update of the AKP. You must invoke the API for each software component in the component list. 4.3.1. Hierarchy KPEDVRU

32 4.3.2. Syntax diagram NAME(<Value>); LIBRARY(<Value>); EDVRTYPE(<Value>); DESTINATIONPATH(<Value01>,.., <Value10>,); ALIAS(<Value>); ISTODELETE(<Value>); REASON(<Value>); DESCRIPTION(<Value>); CHANGECODES(<Value01>,.., <Value20>,); OBJECTCODES(<Value01>,.., <Value20>,);\ 4.3.3. Parameter list NAME Source name LIBRARY PDS name containing the source EDVRTYPE CA-ENDEVOR object type. In this case, the KTQCM file must be already loaded, to retrieve the correct extension to apply to the object DESTINATIONPATH Set of codes used to compose the destination path ALIAS Object name. Only if it is different from the source name ISTODELETE Indicates when the object must be removed from the knowledge base. Allowed values are: Y To delete N To process REASON Indicates the reason for changes. Allowed values are: 001 Inventory loading 101 Bug fixing 111 Enhancements project 121 Maintenance activities DESCRIPTION Description of the sources CHANGECODES Set of codes related to changes OBJECTCODES Set of codes related to objects 4.3.4. Returned value At the end, the API sets the returned value in RETURN-CODE variable. The returned value could be: 0 Elaboration ended normally 4 Elaboration ended normally. Informative messages issued. 8 Elaboration ended abnormally. Error messages issued.

33 4.3.5. Examples 4.3.5.1. Command NAME(KPPGM); LIBRARY(KBB.R53.CBL); EDVRTYPE(CBLBAT); DESTINATIONPATH(KBB,R50,CBL,);\ In this example, the CCM invokes the application program interface KPEDVRU passing the command above. It stores the change event in IMPSRC. The object type will be managed by the interface in order to identify the extension based on information stored in KTQCM file. You must load the configuration file to create a link between CA-ENDEVOR and MVS Custom Agents. The default reason for changes is 121 (maintenance). 4.3.5.2. JCL //KPEDVRU JOB (00001),EVZAG,MSGCLASS=A,CLASS=L,NOTIFY=USER, // TIME=NOLIMIT,REGION=0M //JOBLIB DD DISP=SHR,DSN=KBB.RxxPTF.LOAD // DD DISP=SHR,DSN=KBB.Rxx.LOAD // DD DISP=SHR,DSN=DSNxxx.SDSNLOAD // DD DISP=SHR,DSN=CEE.SCEERUN //LIST JCLLIB ORDER=(KBB.RxxPTF.PROC, KBB.Rxx.PROC) 1 2 //RUNPGM EXEC KREXCPGP,PROGRAM=KPEDVRU,KENVNAME=KBB.KBTxxA, // KPARM='*CARD' //IMPSRC DD DISP=SHR,DSN=KBB.KBTxxA.IMPSRC //KTQCM DD DISP=SHR,DSN=KBB.KBTxxA.KTQCM //CARDIN DD * NAME(KPPGM); LIBRARY(KBB.R53.CBL); 4 EXTENSION(.CBL); REASON(101); DESCRIPTION(Standard interface for software life cycle); DESTINATIONPATH(KBB,R50,CBL,);\ 3 (1) Library list of catalogued procedures in order to invoke MVS Custom Agents programs (2) KREXCPGP is the procedure to invoke a MVS Custom Agents program with PARM (3) Environment name (4) API command must be indicates into DD named CARDIN

34

35

36 5. Glossary Change codes are a set of customer codes linked to the changes performed on the sources. For example the enhancement projects, the ticket, the outsourcer and so on. These codes could be used to arrange for specific analysis. Destination path MVS Custom Agent transfers all information about customer software to a UNIX or Linux box where the engine that will perform the analysis is installed. Environment name is the name indicated during the creation environment and is the same one you indicate to connect to the environment. Normally, it corresponds to the library prefix of the environment. Extension Each source is recognized based on its class, type and language provided by the change management tool. During the transfer, the product renames the source adding an extension to identify its classification. Object codes are a set of customer codes linked to the sources. For example the application, subapplication, development team and so on. These codes could be used to maintain specific views called organization views.

37