Support for IMS Tools Knowledge Base

If your installation currently uses IMS Tools Knowledge Base, which is a component of IBM® IMS Tools Base for z/OS® (5655-V93), IMS Buffer Pool Analyzer can take advantage of the product’s ability to archive and retrieve reports. The use of IMS Tools Knowledge Base is optional.

About this task

If you choose to use IMS Tools Knowledge Base, you must prepare the IMS Tools Knowledge Base repository for IMS Buffer Pool Analyzer reports.

To retain a history of IMS Buffer Pool Analyzer reports in IMS Tools Knowledge Base, use the product administration utility to define the report retention period. After IMS Buffer Pool Analyzer is registered, you can edit the report retention period. By default, the reports are retained for 30 days. A sample job is provided in the SBPLSAMP library. The following figure shows the sample job that is provided in the BPLITKB member of the SBPLSAMP library.

Important: Do not use the PRODUCTID=IB option when you register IMS Buffer Pool Analyzer with IMS Tools Knowledge Base. IMS Buffer Pool Analyzer is not defined in the default definition table, so only the most recent reports will be stored in the repository if you specify PRODUCTID=IB.

Figure 1. Sample BPLITKB JCL

//BPLITKB  JOB (ACCT#),BPL140,NOTIFY=&SYSUID,                          
// class="K",MSGCLASS=A,TIME=10                                          
//*--------------------------------------------------------------------
//*                                                                    
//*  LICENSED MATERIALS - PROPERTY OF IBM                              
//*                                                                    
//*  5697-H77                                                          
//*                                                                    
//*  Copyright IBM Corp. 2002, 2013                                    
//*  ALL RIGHTS RESERVED.                                              
//*                                                                    
//*  Copyright Rocket Software, Inc. 2014                              
//*  ALL RIGHTS RESERVED.                                              
//*                                                                    
//*--------------------------------------------------------------------
//*                                                                    
//* THIS OPTIONAL JOB DEFINES IMS BUFFER POOL ANALYZER TO THE          
//* IMS TOOLS KNOWLEDGE BASE.  IF YOU DO NOT HAVE THE IMS TOOLS        
//* KNOWLEDGE BASE YOU SHOULD SKIP THIS PROCESS.                       
//*                                                                    
//*****************************************************************    
//* TOOL:     IMS BUFFER POOL ANALYZER                            *    
//* DESC:     SAMPLE JCL TO DEFINE PRODUCTS TO IMS TOOLS KB       *    
//* SOURCE:   SBPLSAMP(BPLITKB)                                   *    
//*****************************************************************    
//*                                                                    
//* THIS JOB WILL DEFINE THE ITKB SERVER TO THE ABOVE TOOL.            
//*                                                                    
//* INSTRUCTIONS:                                                      
//*  1) MODIFY THE JOBCARD TO MEET YOUR STANDARDS.                     
//*  2) CHANGE 'ITKBSRVR=itkbsrvr'                                     
//*     TO YOUR ITKB SERVER NAME.                                      
//*  3) CHANGE 'your.SHKTLOAD' ALL                                     
//*     TO YOUR DATA SET NAME FOR THE ITKB LOAD LIBRARY.               
//*  4) CHANGE SBPLLINK=sbpllink                                       
//*     TO YOUR DATA SET NAME FOR THE BPA LOAD LIBRARY.                
//*  5) IF YOU USE IMS TOOLS KNOWLEDGE BASE V1.6 OR LATER, REMOVE THE  
//*     ATTERISK AT THE BEGINNING OF THE LISTX COMMAND.                
//*                                                                    
//  SET  SBPLLINK=sbpllink                                             
//  SET  SHKTLOAD=shktload                                             
//  SET  ITKBSRVR=itkbsrvr                                             
//*                                                                    
//* THE DATA SET NAME SPECIFIED FOR THE SHKTLOAD KEYWORD IS THE DATA   
//* SET THAT CONTAINS THE IMS TOOLS KNOWLEDGE BASE SOFTWARE.           
//*                                                                    
//* ------------------------------------------------------------------
//* DEFINE IMS BUFFER POOL ANALYZER TO ITKB                           
//* ------------------------------------------------------------------
//ADDPROD EXEC PGM=HKTAPRA0,PARM='ITKBSRVR=&ITKBSRVR'                 
//STEPLIB  DD DISP=SHR,DSN=&SBPLLINK                                  
//         DD DISP=SHR,DSN=&SHKTLOAD                                  
//SBPLLINK DD DISP=SHR,DSN=&SBPLLINK                                  
//TEMPLATE DD DUMMY                                                   
//SYSPRINT DD SYSOUT=*                                                
//OUTRPT   DD SYSOUT=*                                                
//OUTRPTX  DD SYSOUT=*                                                
//SYSIN    DD *                                                       
  ADDPROD TABLE=BPL$RIB0,REPLACE=YES                                  
  LIST    PRODUCTID=IB,REPORTID=*                                     
* LISTX   PRODUCTID=IB                                                
/*

Note that in addition to updating the JOB card to meet your installation’s standards, you must supply appropriate values for the three symbolic variables.

SBPLLINK symbolic parameter: This symbolic parameter must be set to the data set name of the IMS Buffer Pool Analyzer SBPLLINK library.
SHKTLOAD symbolic parameter: This symbolic parameter must be set to the data set name of the IMS Tools Knowledge Base SHKTLOAD load library.
ITKBSRVR symbolic parameter: This symbolic parameter must be set to the XCF group name for the IMS Tools Knowledge Base servers.

You should expect to receive the following messages from execution of the first step in the above job:

HKT2178I Attempting to add an IBM product

HKT2158I Request completed successfully

These messages are expected and normal. The second step in the sample job lists the IMS Buffer Pool Analyzer definitions in the IMS Tools Knowledge Base repository. The output from this step will show the definitions as follows.

PRODUCT  ID: IB RELEASE  010300 LONG NAME:  IMS BUFFER POOL ANALYZER
  REPORT ID     LONG TITLE                                                    
   DB           DATABASE INFORMATION                                          
   DS           DATA SET INFORMATION                                          
   GT           GTF TRACE STATISTICS                                          
   MD           MODEL SUBPOOL REPORTS                                         
   SP           SUBPOOL REPORTS

Any other messages that occur when defining IMS Buffer Pool Analyzer to the IMS Tools Knowledge Base should be reviewed using the IMS Tools Base IMS Tools Knowledge Base User’s Guide and Reference.

In order to use IMS Tools Knowledge Base when creating reports, you must supply a PARM field in the report job step EXEC statement. The PARM field must specify the name of the IMS Tools Knowledge Base server. Further information can be found in Generating buffer pool reports. If the ITKBSRVR specification is not included in the PARM of the report JCL, IMS Buffer Pool Analyzer will not archive report output in the knowledge base repository.