Configuring IBM Tivoli Candle Management Server on z/OS, V360publib.boulder.ibm.com/tividd/td/CanInstallDoc/GC32-9414-02/en_US/P… · This guide describes the features of CandleNet

IBMTivoli®

Version 360

Configuring IBM Tivoli Candle Management Server on z/OS

GC32-9414-02

Candle OMEGAMON Platform

12

1

2

IBMTivoli®

Version 360

Candle OMEGAMON Platform

Configuring IBM Tivoli Candle Management Server on z/OS

GC32-9414-02

34

3

Second Edition (June 2005)

This edition applies to version 360 of the IBM Tivoli Candle Management Server on z/OS (product number 5724-L50) and to all subsequent releases and modifications until otherwise indicated in new editions.

© Copyright Sun Microsystems, Inc. 1999

© Copyright International Business Machines Corporation 1996, 2005. All rights reserved.

Note to U.S. Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

4

Before using this information and the product it supports, read the information in Notices on page 201.

Note

5

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Documentation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Chapter 1. Configuration Tool Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 21About the Installation and Configuration Assistance Tool. . . . . . . . . . 22Configuration Tool Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Using the Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Chapter 2. Configuration Checklists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Using the Checklists and Topics in this Chapter . . . . . . . . . . . . . . . . . 30Checklist: Prerequisites for Configuring Products . . . . . . . . . . . . . . . . 31Checklist: Setting Up Your Configuration Environment . . . . . . . . . . . 32Checklist: Configuring your Product in a Runtime Environment . . . . 33Checklist: Configuring the Candle Management Server Using the Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Checklist: Configuring the Candle Management Server Outside of the Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Checklist: Customizing the Candle Management Server Outside of the Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Checklist: Registering Products on Distributed Platforms with the Candle Management Server. . . . . . . . . . . . . . . . . . . . . . . . . 44Checklist: Updating the Configuration . . . . . . . . . . . . . . . . . . . . . . . . 46Using Advanced Features in the Configuration Tool. . . . . . . . . . . . . . 47

Chapter 3. Planning Your Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . 49Determining the Topics to Use in this Chapter . . . . . . . . . . . . . . . . . . 50

Contents

6 Configuring IBM Tivoli Candle Management Server on z/OS, Version 360

Overview of the Products and Components . . . . . . . . . . . . . . . . . . . 51Candle Management Server to Agent Relationships . . . . . . . . . . . . . 54Determination of Components to Configure . . . . . . . . . . . . . . . . . . . 55Guidelines for Determining Which Candle Management Server to Use in Your Environment . . . . . . . . . . . . . . . . . . . . . . . . . . 59Requirements to Review Before Configuring the Candle Management Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Requirements and Recommendations for Candle Management Server Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Guidelines for Assigning and Locating Candle Management Server Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Implementation of Firewall Support with Sample Scenarios . . . . . . . 64

Chapter 4. Configuring Your Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Determining the Topics to Use in this Chapter . . . . . . . . . . . . . . . . . . 68Setting up Your Configuration Environment . . . . . . . . . . . . . . . . . . . 69Registering with the Candle Management Server. . . . . . . . . . . . . . . . 72Configuring the Persistent Data Store . . . . . . . . . . . . . . . . . . . . . . . . 73

Chapter 5. Configuring your Runtime Environment . . . . . . . . . . . . . . . . . . 75Determining Topics to Use in this Chapter . . . . . . . . . . . . . . . . . . . . . 76Runtime Environment Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . 77Background About the Types of Runtime Environments . . . . . . . . . . 78Reviewing Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Planning Your Runtime Environment . . . . . . . . . . . . . . . . . . . . . . . . 81Planning Your Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . 84Configuring Products. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Adding a Runtime Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Building Runtime Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Configuring Runtime Environments. . . . . . . . . . . . . . . . . . . . . . . . . . 93Loading Runtime Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Deleting a Runtime Environment (Optional) . . . . . . . . . . . . . . . . . . . 95Examples of Possible Configurations Using Runtime Environments . . 96

Chapter 6. Completing the Configuration. . . . . . . . . . . . . . . . . . . . . . . . . 103Determining the Topics to Use in this Chapter . . . . . . . . . . . . . . . . . 104Copying the Procedures for the Started Tasks . . . . . . . . . . . . . . . . . 105

7

Copying the VTAM Definition and Varying the VTAM Node Active . 106APF-Authorizing Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Copying the Procedures for the Persistent Data Store . . . . . . . . . . . 108Registering with and Seeding the Candle Management Server . . . . 109Verifying the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Using the Candle Management Server Error Log. . . . . . . . . . . . . . . 115

Chapter 7. Completing the Customization . . . . . . . . . . . . . . . . . . . . . . . . 117Determining the Topics to Use in this Chapter . . . . . . . . . . . . . . . . . 118Migration: Reviewing Migration Requirements. . . . . . . . . . . . . . . . . 119Migration: Grooming User-Customized Objects . . . . . . . . . . . . . . . . 120Migration: Migrating User-Customized Objects from Version 350 to Version 360. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Migration: Restoring User-Customized Objects . . . . . . . . . . . . . . . . 122Security: Reviewing Candle Management Server Security Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Security: Setting Up Candle Management Server Security . . . . . . . . 124Security: Defining for RACF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Security: Defining for CA-ACF2. . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Security: Defining for CA-TOP SECRET . . . . . . . . . . . . . . . . . . . . . 127Security: Defining for Network Access Method (NAM) . . . . . . . . . . . 128

Chapter 8. Starting and Stopping the Candle Management Server . . . . . 131Starting the Candle Management Server on z/OS . . . . . . . . . . . . . . 132Stopping the Candle Management Server on z/OS . . . . . . . . . . . . . 133

Chapter 9. Updating the Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . 135Updating and Changing the Configuration . . . . . . . . . . . . . . . . . . . 136

Chapter 10. Batch Mode Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Using Batch Mode Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Planning Your Runtime Environment Replication Process . . . . . . . . 139Creating Batch Mode Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 142Adding and Configuring Product Parameter Decks (Optional) . . . . . 143Transporting the Runtime Environment . . . . . . . . . . . . . . . . . . . . . . 145


Chapter 11. Enabling System Variable Support . . . . . . . . . . . . . . . . . . . . . 151Background on System Variable Support . . . . . . . . . . . . . . . . . . . . 152Sample Usage Scenario. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Enabling System Variable Support . . . . . . . . . . . . . . . . . . . . . . . . . 155Creating the System Variable Parameter Member . . . . . . . . . . . . . . 157Creating the VTAM Major Node Rename Job . . . . . . . . . . . . . . . . . 158Creating a VTAM Major Node (One Node for All Products) . . . . . . . 159

Chapter 12. Configuration Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Using the Configuration Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . 162Scenario 1: Rolling Out Products Across a 40 LPAR Enterprise (Standard Method) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Scenario 2: Rolling Out Products Across a 40 LPAR Enterprise (Common RKANPAR and Common RKANCMD Libraries) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Scenario 3: Replicating a Runtime Environment to Another LPAR Using Configuration Tool Batch . . . . . . . . . . . . . . . . 169Scenario 4: Replicating a Runtime Environment to Another LPAR Using Configuration Tool Batch Auto-submit . . . . . . 171Scenario 5: Replicating an Runtime Environment on Same LPAR Using Batch Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Scenario 6: Replicating a Runtime Environment Using Interactive Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Scenario 7: Copying Configuration Values fromOne Configuration Tool to Another Configuration Tool . . . . . . . . . . 177

Chapter 13. Configuration Services and Utilities . . . . . . . . . . . . . . . . . . . . 179Using Configuration Services and Utilities . . . . . . . . . . . . . . . . . . . . 180Services: Unlocking Runtime High-Level Qualifiers . . . . . . . . . . . . . 181Services: Creating the Configuration Tool Batch Mode Job . . . . . . . 182Utilities: Specifying DEBUG Options . . . . . . . . . . . . . . . . . . . . . . . . 183Utilities: Displaying an ISPF Table . . . . . . . . . . . . . . . . . . . . . . . . . . 184Utilities: Executing a CLIST in the TKANCUS Library . . . . . . . . . . . 185

Chapter 14. Configuration Tool Batch Utilities . . . . . . . . . . . . . . . . . . . . . . 187Using the Configuration Tool Batch Utilities. . . . . . . . . . . . . . . . . . . 188

9

KCISETUP: Setting Up the Environment . . . . . . . . . . . . . . . . . . . . . 189KCICFKEY: Managing PF Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190KCICPGHP: Displaying Batch Parm Deck Member Parameters Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192KCICPGEN: Generating the Batch Parameter Input Deck . . . . . . . . 194

Appendix A. Support Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Appendix B. Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205


11

Figure 1. Process for Verifying the Configuration . . . . . . . . . . . . . . . . . . . . . . 114Figure 2. Process for Updating and Changing Your Configuration . . . . . . . . . 136

Figures


13

Table 1. Symbols in Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Table 2. Additional Configuration Tool Features . . . . . . . . . . . . . . . . . . . . . . . 23Table 3. Configuration Tool Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Table 4. Commands and Functions That Apply to the Candle Management

Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Table 5. Terminology Used in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Table 6. Configuration Checklists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Table 7. Prerequisites for Configuring Products . . . . . . . . . . . . . . . . . . . . . . . . 31Table 8. Checklist for Setting up Your Configuration Environment . . . . . . . . . 32Table 9. Configuring your Product in a Runtime Environment . . . . . . . . . . . . 33

Table 10. Configuring your Product in a new runtime environment . . . . . . . . . 34Table 11. Configuring your Product in an Existing Runtime Environment . . . . . 35Table 12. Checklist for Configuring the Candle Management Server . . . . . . . . . 36Table 13. Configuring the Candle Management Server for Products

Installed on z/OS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Table 14. Configuring the Candle Management Server for Products

Installed on Distributed Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Table 15. Configuring the Candle Management Server Outside of the

Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Table 16. Checklist for Setting up Security for the Candle Management Server. 43Table 17. Checklist for Registering Your Product . . . . . . . . . . . . . . . . . . . . . . . . 44Table 18. Checklist for Updating the Configuration. . . . . . . . . . . . . . . . . . . . . . 46Table 19. Advanced Features Available in the Configuration tool . . . . . . . . . . . 47Table 20. Configuration Steps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Table 21. Overview of the Products and Components . . . . . . . . . . . . . . . . . . . 51Table 22. Details about the Relationships and Types of Candle Management

Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Table 23. Determining the Products and Components You Will Need . . . . . . . . 56Table 24. Determining the Products and Components to Configure . . . . . . . . . 57Table 25. Locating Information about Configuring the Product or Component . 58Table 26. Configuring your Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Tables


Table 27. Runtime Environment Term Definitions. . . . . . . . . . . . . . . . . . . . . . . 77Table 28. Actions Available from Runtime Environments (RTEs) Panel. . . . . . . 81Table 29. Additional Configuration Tool Features . . . . . . . . . . . . . . . . . . . . . . . 84Table 30. High-level Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Table 31. Runtime Environment Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Table 32. Add Runtime Environment Values. . . . . . . . . . . . . . . . . . . . . . . . . . . 89Table 33. Add Runtime Environment - FULL and SHARING RTE Values. . . . . 90Table 34. FULL RTE Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Table 35. Example of a BASE RTE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Table 36. Example of a SHARING BASE RTE . . . . . . . . . . . . . . . . . . . . . . . . . 99Table 37. Example of a SHARING FULL RTE . . . . . . . . . . . . . . . . . . . . . . . . 100Table 38. Example of a SHARING SMP/E TARGET RTE . . . . . . . . . . . . . . . . 101Table 39. Registering with and seeding the Candle Management Server . . . . . 109Table 40. Completing the Customization by Setting up Security . . . . . . . . . . . 118Table 41. Batch Mode Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Table 42. Runtime Environment Transport Methods . . . . . . . . . . . . . . . . . . . . 140Table 43. System Variable Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Table 44. Add Runtime Environment Values. . . . . . . . . . . . . . . . . . . . . . . . . . 156Table 45. Configuration Tool Batch Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . 188Table 46. Invoking the PF Key Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Table 47. PF Keys - Valid States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Table 48. PF Keys for Batch Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Table 49. Batch Parameter Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Table 50. KCICPGEN Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Preface 15

Preface

IntroductionConfiguring IBM Tivoli Candle Management Server on z/OS, Version 360 describes how to configure and customize the IBM Tivoli Candle Management Server® on z/OS.

The IBM Tivoli Candle Management Server

� is a component used by IBM products to collect, store, and process data in a central location

� communicates with the interfaces and agents, OMEGAMON XE products, and in some cases OMEGAMON II products

� is used along with one or more IBM products

This guide contains:

� a set of checklists you can use to complete the steps required to configure and customize the product

� an overview of the process for configuring products

� planning information you should review before you configure the product

� information about using the Installation and Configuration Assistance Tool to configure the product

� the instructions for completing the manual configuration and customization (if any) outside of the Configuration tool

P

About This Guide


About This Guide

Who should read this guideThis guide is for the z/OS Systems Programmer/Analyst who is responsible for the following tasks:

– Configuration of applications

– Automation of tasks on the system

– Monitoring new applications

– Troubleshooting and providing solutions for operators when they have problems

This guide is also useful for the Jr. Systems Analyst who is responsible for monitoring the health of production systems and resolving system problems or for forwarding problems to someone who can resolve them.

Document set informationThis section lists related publications. Refer to the configuration guide for your product for configuration instructions specific to your product. This section also describes how to access Tivoli publications online and how to order Tivoli publications.

Related publications

The following documents also provide useful information:

� Administering OMEGAMON Products: CandleNet Portal, GC32-9180

This document describes the support tasks and functions required for the OMEGAMON platform, including CandleNet Portal user administration.

� Using OMEGAMON Products: CandleNet Portal, GC32-9182

This guide describes the features of CandleNet Portal and how best to use them with your OMEGAMON products.

� Historical Data Collection Guide for IBM Tivoli OMEGAMON XE Products, GC32-9429

Describes the process of collecting historical data and either warehousing it or converting it to delimited flat files for reporting purposes.

The online glossary for CandleNet Portal includes definitions for many of the technical terms related to OMEGAMON XE software.

Accessing publications online

The documentation CD contains the publications that are in the product library. The format of the publications is PDF. Refer to the readme file on the CD for instructions on how to access the documentation.

Preface 17

About This Guide

IBM posts publications for this and all other Tivoli products, as they become available and whenever they are updated, to the Tivoli software information center Web site. Access the Tivoli software information center by first going to the Tivoli software library at the following Web address:

http://www.ibm.com/software/tivoli/library/

Scroll down and click the Product manuals link. In the Tivoli Technical Product Documents Alphabetical Listing window, click the OMEGAMON XE for Product_Name link to access the product library at the Tivoli software information center.

If you print PDF documents on other than letter-sized paper, set the option in the File -> Print window that allows Adobe Reader to print letter-sized pages on your local paper.

Ordering publications

You can order many Tivoli publications online at the following Web site:

http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi

You can also order by telephone by calling one of these numbers:

� In the United States: 800-879-2755

� In Canada: 800-426-4968

In other countries, contact your software account representative to order Tivoli publications.

Tivoli technical trainingFor Tivoli technical training information, refer to the following IBM Tivoli Education Web site:

http://www.ibm.com/software/tivoli/education

Support informationIf you have a problem with your IBM software, you want to resolve it quickly. IBM provides the following ways for you to obtain the support you need:

� Searching knowledge bases: You can search across a large collection of known problems and workarounds, Technotes, and other information.

� Obtaining fixes: You can locate the latest fixes that are already available for your product.

� Contacting IBM Software Support: If you still cannot solve your problem, and you need to work with someone from IBM, you can use a variety of ways to contact IBM Software Support.

For more information about these three ways of resolving problems, see “Support Information” on page 195.

http://www.ibm.com/software/tivoli/library/

http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi

http://www.ibm.com/software/tivoli/education

Documentation Conventions



OverviewThis guide uses several conventions for special terms and actions, and operating system-dependent commands and paths.

Panels and figuresThe panels and figures in this document are representations. Actual product panels may differ.

Required blanksThe slashed-b (!) character in examples represents a required blank. The following example illustrates the location of two required blanks.

!!!!eBA*ServiceMonitor!!!!0990221161551000

Revision barsRevision bars (|) may appear in the left margin to identify new or updated material.

Variables and literalsIn examples of z/OS® command syntax, uppercase letters are actual values (literals) that the user should type; lowercase letters are used for variables that represent data supplied by the user. Default values are underscored.

LOGON APPLID (cccccccc)

In the above example, you type LOGON APPLID followed by an application identifier (represented by cccccccc) within parentheses.

SymbolsThe following symbols may appear in command syntax:

Table 1. Symbols in Command Syntax

Symbol Usage

| The “or” symbol is used to denote a choice. Either the argument on the left or the argument on the right may be used. Example:

YES | NOIn this example, YES or NO may be specified.

[ ] Denotes optional arguments. Those arguments not enclosed in square brackets are required. Example:

APPLDEST DEST [ALTDEST]In this example, DEST is a required argument and ALTDEST is optional.

Preface 19


{ } Some documents use braces to denote required arguments, or to group arguments for clarity. Example:

COMPARE {workload} -REPORT={SUMMARY | HISTOGRAM}

The workload variable is required. The REPORT keyword must be specified with a value of SUMMARY or HISTOGRAM.

_ Default values are underscored. Example:

COPY infile outfile - [COMPRESS={YES | NO}]In this example, the COMPRESS keyword is optional. If specified, the only valid values are YES or NO. If omitted, the default is YES.

Table 1. Symbols in Command Syntax

Symbol Usage



21

Configuration Tool Overview

IntroductionThis chapter introduces the Installation and Configuration Assistance Tool that you use to configure the Candle Management Server on z/OS, as well as to configure your products.

The topics covered in this chapter are:

� the terminology used in this guide

� the commands and functions used in the Configuration tool

� the commands that apply specifically to the Candle Management Server

� the modes (Interactive and Batch) available for working in the Installation and Configuration Assistance Tool

Chapter contentsAbout the Installation and Configuration Assistance Tool . . . . . . . . . . . . . . . . . . . . . . 22Configuration Tool Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Using the Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

1

About the Installation and Configuration Assistance Tool


About the Installation and Configuration Assistance Tool

The Installation and Configuration Assistance Tool is used to:

� install the required and optional products and components for the earlier Candle products. This component is referred to as the Installation tool.

� configure products. This component is referred to as the Installation tool.

Some products are installed using the System Modification Program/Extended (SMP/E) tool. Both the earlier Candle products and those products that are installed using SMP/E are configured using the Configuration tool. Refer to your Program Directory for installation instructions pertaining to your product.

You perform most of your configuration using the Configuration tool. The Configuration tool creates and customizes all of the runtime datasets required to support the Candle Management Server software and the agent software. In addition to initializing datasets and data files, the Configuration tool also creates the VTAM major node member in SYS1.VTAMLST, and the startup procedure library JCL member in SYS1.PROCLIB. The members have the started task name and major node name that you specify during the configuration process.

In interactive mode, the Configuration tool uses ISPF dialogs to guide you through the configuration steps. Data entry panels assist you in understanding the configuration process and describe the input fields on the entry panels. In batch processing mode, the tool enables you to use a single batch job that you can use to build, configure, and load a runtime environment (RTE) on multiple images. You will use the Configuration tool to begin configuring the Candle Management Server software. However, you will also need to complete some configuration steps outside of the tool. The Configuration tool is restartable. If necessary, you can end the dialog, start it again, and continue from the point of interruption.

For instructions on installing the Configuration tool, see the Program Directory. For instructions on setting up your configuration environment, see “Setting up Your Configuration Environment” on page 69.

23

Configuration Tool Features


The Configuration tool contains numerous features. Some of the main features are described below.

Modes provided in the Configuration tool

The Configuration tool has two modes:

� Interactive Mode

� Batch Mode

Interactive

ISPF panel-driven facility that assists you in specifying parameters and tailoring jobs for

� configuring new products

� configuring new versions of products

ISPF V4.3 is required to use the Configuration tool.

Batch mode

Facility that creates a single batch job that you can use to build, configure, and load a runtime environment. This single job performs all of the same runtime environment processing as the interactive Configuration tool.

Batch Mode is a simple and useful way of replicating runtime environments to other z/OS systems. See “Batch Mode Processing” on page 137 for detailed information on batch mode processing.

System variable support

The Configuration tool supports z/OS system symbolics for some of the generated configuration values. For more information, see “Enabling System Variable Support” on page 151 or from any Configuration tool panel, enter README SYS.

Additional features and enhancements

Following are some additional features and enhancements.

Table 2. Additional Configuration Tool Features

SMS support SMS support has been added to the Configuration tool dataset allocation for the runtime datasets. For more information, from any Configuration tool panel enter README SMS.

PDSE support You can choose to allocate PDSE datasets instead of PDS datasets for runtime libraries that are not load libraries. For more information, from any Configuration tool panel enter README SMS.



Getting help with the Configuration toolThe online help for the Configuration tool contains detailed information about using the Configuration tool panels. To display help from any Configuration tool panel, press the Help key (F1) or type HELP on the command line.

You can also display help for the help. For example, you can display information about the command to use to return to the previous topic in the help system. To display the help for help from any help panel, press the Help key (F1) or type HELP on the command line.

RTE load optimization

You can define an runtime environment to load only changed members to runtime datasets after you apply maintenance or configure products.

JES3 support Configuration jobs are JES3 compatible.

Component upgrade alert

During configuration, the Configuration tool will compare the component products being configured to the component products in all runtime environments. If the runtime environment contains a component at a lower version, an upgrade panel will alert you that an upgrade of these runtime environments is required.

VTAM applid considerations

For information on VTAM applids, from any Configuration tool panel, enter README APP.

Table 2. Additional Configuration Tool Features (continued)

25

Using the Configuration Tool


This section describes the defaults provided, as well as the commands and functions available.

Defaults provided with the Configuration tool

Whenever possible, the Configuration tool provides defaults for fields and options. These defaults

� when provided, should be sufficient to complete the installation of products and maintenance

� can be changed to values specific to your site

Assistance provided in the Configuration tool

Whenever possible, the Configuration tool checks the values you specify and verifies that you have specified the required values. If the Configuration tool detects an error or omission, it displays a short message.

Display requirements in ISPF

If you are using a 3270 Model 2 (24 x 80) display, you must turn off the pre-defined function (PF) keys so that the the Configuration tool panels are not truncated.

To turn off the pre-defined function keys, type PFSHOW on any command line and press Enter until the function keys no longer appear.

Restrictions

The length of the high-level qualifier for the runtime libraries must be 26 characters or less.

You cannot use

� the ampersand character (&) as input data in the Configuration tool interactive or batch mode

� the ISPF feature for edit recovery

If the ISPF RECOVERY ON command is entered, edits will produce a recovery error message. Enter the RECOVERY OFF command to suppress the error messages.



Commands and functions The list that follows shows some of the commands and functions available in the Configuration tool. You can use these commands for navigation purposes and to display information.

Table 3. Configuration Tool Commands

F6 key (Applids) On some panels for configuring products, displays the VTAM APPLID panel where you can specify the full eight-character VTAM APPLID.

Advanced key On some panels for configuring products, displays panels where you can specify specialized values (such as values for the Persistent Data Store for a Candle Management Server).

End key Returns to the previous panel.

Enter key Accepts the values you have specified and displays the next panel in the process.

HELP command Displays information about a panel or the extended description for a message.

README command Displays the README for the current version of the Configuration tool.

README APP command Displays information about default applids for started tasks and VTAM, and how the Configuration tool processes VTAM applids.

README ERR command Displays a list of CLIST error codes and descriptions (for both interactive and batch mode).

README SYS command Displays a information about system variable support.

UTIL command Displays the Installation Services and Utilities menu.

27


Commands and functions specifically for the Candle Management ServerThe following table lists the commands and functions in the Configuration tool that apply specifically to the Candle Management Server. If the command or function is only available in a particular location in the Configuration tool, the table lists the location.

Table 4. Commands and Functions That Apply to the Candle Management Server

Command or Function Location (If Any) Task

F10 (CMS List) Specify Advanced CMS Configuration Values panel (accessed using F5 on the Specify CMS Configuration Values panel)

Navigates to the panel where a non-local Candle Management Server (z/OS-based, but in another CSI or non-z/OS Candle Management Server in a distributed platform) may be configured

Install product provided situations for distributed products option

RTE Utility Menu (accessed using the Z select on the Runtime Environment panel)

Register the IBM products you have installed on distributed platforms with the Candle Management Server so that you can use the predefined situations

Upgrade product provided situations option

RTE Utility Menu (accessed using the Z select on the Runtime Environment panel)

Update the Candle Management Server with information about an upgraded IBM product you have installed on distributed platforms so that you can use the predefined situations

View CMS list and registration status option

Configure the CMS panel Displays a list of all the Candle Management Server names that are configured and the products that are registered with each Candle Management Server

View CMW configuration values option

Configure the CMW panel Display and print the values for the Candle Management Workstation that you will need when you configure IBM products on a distributed platform (such as the network ID).

Terminology


Terminology

The following list contains some of the terms used in this guide and defines those terms.

Table 5. Terminology Used in This Guide

Installation and Configuration Assistance Tool

Tool used to: � install earlier Candle products. This component is

referred to as the Installation tool.� configure products. This component is referred to as

the Configuration tool.

Note: Some products are installed using the System Modification Program/Extended (SMP/E) tool instead of using the Installation tool. Both the earlier Candle products and those products installed using SMP/E are configured using the Configuration tool.

Component A separate function or feature of a product

Configuring Making a product operational by completing the configuration of the product using the Configuration tool and completing the manual steps required outside of the Configuration tool

Cumulative Maintenance

Maintenance through a given date that is customer approved

Customizing Modifying the defaults for options and settings and other changes that reflect the needs of your site

Installing Loading the contents of the IBM product and maintenance

Preventive Maintenance

Fixes that can be applied to avoid known problems

Runtime Environments (RTEs)

A group of runtime libraries that provide an operational environment on a z/OS system

Runtime libraries Libraries in the runtime environment that are used by the product when the product is started

Target libraries SMP/E controlled libraries that contain the data from the distribution media

29

Configuration Checklists

IntroductionThis chapter contains a checklist or topic for each of the steps in the process for configuring the Candle Management Server.

You use the checklists and topics in this chapter to:

� guide you through the steps in the process for configuring and customizing the Candle Management Server

� verify that you have used all of the options in the Configuration tool required for your specific situation

� verify that you have completed all the required steps outside of the Configuration tool to configure and customize the Candle Management Server

� locate detailed information when you need background information or step-by-step instructions for a specific task

Chapter contentsUsing the Checklists and Topics in this Chapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Checklist: Prerequisites for Configuring Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Checklist: Setting Up Your Configuration Environment . . . . . . . . . . . . . . . . . . . . . . . . 32Checklist: Configuring your Product in a Runtime Environment . . . . . . . . . . . . . . . . . 33Checklist: Configuring the Candle Management Server Using the Configuration Tool . 36Checklist: Configuring the Candle Management Server Outside of the Configuration Tool 41Checklist: Customizing the Candle Management Server Outside of the Configuration Tool 43Checklist: Registering Products on Distributed Platforms with the Candle Management Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Checklist: Updating the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Using Advanced Features in the Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . 47

2

Using the Checklists and Topics in this Chapter


Using the Checklists and Topics in this Chapter

The tasks in the checklists are listed in the order they are performed. You use:

� the first column(s) to determine the task

� the second column with the box to track the tasks you complete

� the last column to locate background information or step-by-step instructions in the resources provided with the product (such as the online help and this guide)

If you are not familiar with the terminology or with the Configuration toolIf you are not familiar with the terminology being used or the Configuration tool, see Chapter 2 in this guide.

Determine the checklists and topics to useThe following table shows the checklist or topic you should use for your tasks.

Table 6. Configuration Checklists

Task Checklists and Topics to Use in this Chapter Page #

Complete the configuration of the

Candle Management Server

! Checklist: Prerequisites for Configuring Products page31

! Checklist: Setting Up Your Configuration Environment page32

! Checklist: Configuring your Product in a Runtime Environment

page33

! Checklist: Configuring the Candle Management Server Using the Configuration Tool

page36

! Checklist: Configuring the Candle Management Server Outside of the Configuration Tool

page41

! Checklist: Customizing the Candle Management Server Outside of the Configuration Tool

page43

! Checklist: Registering Products on Distributed Platforms with the Candle Management Server

page44

! Using Advanced Features in the Configuration Tool page47

Update or change the configuration for the Candle Management Server

! Setting up Your Configuration Environment page32

! Checklist: Updating the Configuration page46

! Using Advanced Features in the Configuration Tool page47

31

Checklist: Prerequisites for Configuring Products

Checklist: Prerequisites for Configuring Products

The checklist contains the prerequisite actions you must have completed before you can begin to configure the product. The checklist also:

� indicates the order in which the steps should be performed

� shows where you would find the information you need if you have not completed the prerequisite

Table 7. Prerequisites for Configuring Products

✓ Prerequisite Location of Information

! If you have not already done so, verify for the product you want to configure that:

! you have the required software

! you have the required DASD storage space

! the product versions can exist in the same Consolidated Software Inventory (CSI)

Program Directory

! You must have installed the product and components.

Program Directory

! You must have created a runtime environment (RTE) using the Configuration tool.

� Chapter 5 in this guide� online help in the

Configuration tool

! If this is the first time you are using IBM products or you are not familiar with the terminology or with the Configuration tool, review an overview.

Chapter 2 in this guide

! If this is the first time you are using IBM products or you do not know the configuration you want, review the background, planning information, and migration information (if any).


Checklist: Setting Up Your Configuration Environment


Checklist: Setting Up Your Configuration Environment

This checklist contains the steps you perform to set up your configuration environment.

Table 8. Checklist for Setting up Your Configuration Environment

✓ TaskLocation of Information

! After installing the product tape that contains the Installation and Configuration Assistance Tool FMID (HKCI310), you must copy the contents from one of the target libraries into the appropriate Configuration tool work library. This applies to products installed into either an existing Consolidated Software Inventory (CSI) or into a new CSI.


! For products being installed into an existing CSI, follow the procedure for copying the contents of the target library (&thilev.TKCIINST) to the existing Configuration tool work library (&shilev.INSTLIBW).


! For products being installed into a new CSI, follow the procedure for copying the contents of the target library (&thilev.TKCIINST) to the newly created Configuration tool work library (&shilev.INSTLIB).


! If you:

! use an existing CSI, follow the procedure for configuring your product

! use a new CSI, follow the procedure for setting up your work environment and your configuration environment


! On the Runtime Environments (RTEs) panel in the Main Menu of the Configuration tool, select either of these options:

– if you want to configure an existing runtime environment, type C (Configure) in the Action field for the runtime environment (if you use an existing CSI)

– if you want to create a new runtime environment, type A (Add) in the Action field and specify the values for the new runtime environment (if you use a new CSI)


33

Checklist: Configuring your Product in a Runtime Environment


Review the tables that follow to determine the checklist or topic appropriate for your needs.

Checklist: Configuring your product in a runtime environment

Table 9. Configuring your Product in a Runtime Environment

Task Resources to Use in this TopicPage #s

You want to configure a product in a new runtime environment

! Checklist: Configuring your product in a new runtime environment

page 34

You want to configure a product in an existing runtime environment

! Checklist: Configuring your product in an existing runtime environment

page 35



Checklist: Configuring your product in a new runtime environment

Table 10. Configuring your Product in a new runtime environment

✓ TaskLocation of Information

! Select Configure products on the Configuration tool Main Menu and complete the following options on the menu.

! Select Set up configuration environment to specify values that the Configuration tool uses to build the JCL for the product that you are configuring.

! Select Select product to configure to display a list of the products available and to specify the product you want to configure using the S (Select product) select.

“Configuring Products” on page 86

! Add a runtime environment.

! On the Runtime Environments panel, specify A (Add RTE) in the select field of the first row in the list.

! Use the remaining panels the Configuration tool displays to specify the values for the runtime environment (such as the name and type).

“Adding a Runtime Environment” on page 88

! Build the runtime libraries.

! On the Runtime Environments panel, select B (Build libraries).

! Review and submit the JCL that allocates the runtime libraries for the products in the runtime environment.

“Building Runtime Libraries” on page 92

! Configure the runtime environment.

! On the Runtime Environments panel, select C (Configure).

! Use the remaining panels the Configuration tool displays to specify the values for the configuration.

“Configuring Runtime Environments” on page 93

and

Online help in the Configuration tool

! Load the runtime libraries.

! On the Runtime Environments panel, select L (Load all product libraries after SMP/E).

! Review and submit the JCL that loads the libraries from the SMP/E target libraries.

“Loading Runtime Libraries” on page 94

! If you want to replicate or use IBM products on other z/OS images, see Using Advanced Features in the Configuration Tool.

page 47

35


Checklist: Configuring your product in an existing runtime environment

Table 11. Configuring your Product in an Existing Runtime Environment

✓Task

Location of Information

! Select Configure products on the Main Menu and complete the following options on the menu.

! Select Set up configuration environment to specify values that the Configuration tool will use to build the JCL for the product you are configuring.

! Select Select product to configure to display a list of the products available and to specify the product you want to configure using the S (Select product) select.

“Configuring Products” on page 86

! Configure the runtime environment.

! On the Runtime Environments panel, select C (Configure).

! Use the remaining panels Configuration tool displays to specify the values for the configuration.

“Configuring Runtime Environments” on page 93

and


! Load the runtime libraries.

! On the Runtime Environments panel, select L (Load all product libraries after SMP/E).

! Review and submit the JCL that loads the libraries from the SMP/E target libraries.

“Loading Runtime Libraries” on page 94

! If you want to replicate or use IBM products on other z/OS images, see Using Advanced Features in the Configuration Tool.

page 47

Checklist: Configuring the Candle Management Server Using the Configuration Tool



For detailed information about the specific values you specify in the Configuration tool, see the online help.

Determine the checklist to use for configuring the Candle Management ServerReview this table to determine the checklist to use to configure your Candle Management Server using the Configuration tool. The checklist you use depends on the platform where those products communicating with the Candle Management Server are installed and configured.

Table 12. Checklist for Configuring the Candle Management Server

Platform for the Products Communicating with the Candle

Management Server

Checklist to Use

z/OS “Configuration tool: Candle Management Server for products installed on z/OS” on page 37

Distributed platform (such as UNIX, Windows, or AS/400)

“Configuration tool: Candle Management Server for products installed on distributed platforms” on page 39

37


Configuration tool: Candle Management Server for products installed on z/OSThe following checklist contains the steps you perform in the Configuration tool to begin to configure the Candle Management Server for a z/OS-based product.

Table 13. Configuring the Candle Management Server for Products Installed on z/OS

✓ Location in the

Configuration Tool

Configuration Step to Perform in the Configuration Tool


! Configure the CMS Menu

Use Create LU6.2 logmode to create the LU6.2 logmode and logmode table required by the Candle Management Server.

Note: Running this job requires update access to your site’s VTAMLIB load library.



Use Specify CMS configuration values to:

! Specify the configuration values for a hub or remote Candle Management Server.

! If you want to specify additional Candle Management Server configuration values, use the F5 (Advanced key) and specify:

� advanced CMS configuration options� persistent data store parameters! If you are configuring a remote Candle

Management Server, you must define the hub connection for the remote Candle Management Server. The Configuration tool displays a panel where you can either:

� select the hub Candle Management Server from a list

� manually specify values for the hub Candle Management Server using the Advanced key (F5)


and

“Requirements to Review Before Configuring the Candle Management Server” on page 60


Use Specify CMS communication protocols to:

! Specify the communication protocols (SNA, IP, IP.PIPE) you want the Candle Management Server to support. One of the protocols must be SNA.

! If the Candle Management Server will support the IP protocol, and you are running multiple TCP/IP interfaces or network adapters on the same z/OS image, specify the network interface card (NIC).

! If the Candle Management Server will support the IP.PIPE protocol, specify values for address translation and partition name.


and





Use Create runtime members to generate the job that creates the runtime members required by the Candle Management Server.



Use Complete the Configuration to display a set of instructions for completing the configuration outside of the Configuration tool. (The instructions are also covered in this guide.)


! Runtime Environments (RTEs) panel

Use L (Load all product libraries after SMP/E) to load the target libraries to the runtime libraries for the runtime environment.


Table 13. Configuring the Candle Management Server for Products Installed on z/OS

✓ Location in the

Configuration Tool



39


Configuration tool: Candle Management Server for products installed on distributed platforms

The following checklist contains the steps you perform in the Configuration tool to begin to configure the Candle Management Server for a distributed product.

Table 14. Configuring the Candle Management Server for Products Installed on Distributed Platforms

✓ Location in the

Configuration tool




Use Create LU6.2 logmode to create the LU6.2 logmode and logmode table required by the Candle Management Server.

Note: Running this job requires update access to your site’s VTAMLIB load library.



Use Specify CMS configuration values to:

! Specify the configuration values for a hub or remote Candle Management Server.

! If you want to specify additional Candle Management Server configuration values, use the F5 (Advanced key) and specify:

� advanced CMS configuration options� Persistent Data Store parameters! If you are configuring a remote Candle

Management Server, you must define the hub connection for the remote Candle Management Server. The Configuration tool displays a panel where you can either:

� select the hub Candle Management Server from a list

� manually specify values for the hub Candle Management Server using the Advanced key (F5)


and





Use Specify CMS communication protocols to:

! Specify the communication protocols (SNA, IP, IP.PIPE) you want the Candle Management Server to support. One of the protocols must be SNA.

! If the Candle Management Server will support the IP protocol, and you are running multiple TCP/IP interfaces or network adapters on the same z/OS image, specify the network interface card (NIC).

! If the Candle Management Server will support the IP.PIPE protocol, specify values for address translation and partition name.


and



Use Create runtime members to generate the job that creates runtime members required by the Candle Management Server.



Use Complete the Configuration to display a set of instructions for completing the configuration outside of the Configuration tool. (Instructions are also covered in this guide.)


! Configure the CMS Menu (Optional)

If you are configuring a distributed product that reports historical data to a z/OS-based Candle Management Server, use Configure persistent datastore for distributed system products to configure a persistent data store.


! Runtime Environments (RTEs) panel

Use L (Load all product libraries after SMP/E) to load the target libraries to the runtime libraries for the runtime environment.


! RTE Utility Menu

If you are configuring a z/OS-based Candle Management Server to which distributed products will report data, use Install product provided situations for distributed products to register and add situations.


Table 14. Configuring the Candle Management Server for Products Installed on Distributed Platforms (continued)

✓ Location in the

Configuration tool



41

Checklist: Configuring the Candle Management Server Outside of the Configuration Tool


In addition to the detailed information provided in the online help in the Configuration tool, the tool contains a summary of the information contained in this guide.

The Complete the configuration option on the Configure the CMS menu also displays some of the manual steps you perform outside of the Configuration tool to complete the configuration.

Checklist: Configure the product outside of the Configuration toolThe following checklist contains the manual steps you perform outside of the Configuration tool to complete the configuration of the Candle Management Server.

Table 15. Configuring the Candle Management Server Outside of the Configuration Tool

✓ Configuration Steps to Perform Outside the Configuration Tool

Location of Information You Will Need

! Copy the Candle Management Server started task procedure from rhilev.midlev.RKANSAM to your procedure library (PROCLIB).

“Copying the Procedures for the Started Tasks” on page 105

! Copy VTAM definitions and vary the major node active:

! copy VTAM definitions from rhilev.midlev.RKANSAM to your VTAM list library (VTAMLST)

! vary the VTAM major node in VTAMLST active

“Copying the VTAM Definition and Varying the VTAM Node Active” on page 106

! APF-authorize the RKANMODn runtime load libraries. “APF-Authorizing Libraries” on page 107

! If you configured the Persistent Data Store , copy the Persistent Data Store maintenance procedures from rhilev.midlev.RKANSAM to your procedure library (PROCLIB).

“Copying the Procedures for the Persistent Data Store” on page 108

! Seed the Candle Management Server, if required. “Registering with and Seeding the Candle Management Server” on page 109

! Verify the configuration by:

! if you selected SNA as the communication protocol, varying the VTAM major node active

! starting the Candle Management Server started task

“Verifying the Configuration” on page 114



Determine what to do nextReview the following table to determine what to do next.

Task You Want to Perform Checklist or Topic to Use

Set up security for the Candle Management Server.

“Checklist: Customizing the Candle Management Server Outside of the Configuration Tool” on page 43


“Checklist: Registering Products on Distributed Platforms with the Candle Management Server” on page 44

Use advanced features in the Configuration tool to replicate the product or use the product on other z/OS images

“Using Advanced Features in the Configuration Tool” on page 47

43

Checklist: Customizing the Candle Management Server Outside of the Configuration Tool

Checklist: Customizing the Candle Management Server Outside of the Configuration Tool

The online help in the Configuration tool provides detailed information on customizing the Candle Management Server. It also contains a summary of the information in this guide.

Checklist: Setting up Security for the Candle Management ServerThe following checklist contains the manual steps you perform outside of the Configuration tool to set up the security for the Candle Management Server.

Determine what to do nextReview the following table to determine what to do next.

Table 16. Checklist for Setting up Security for the Candle Management Server

✓ Customization Steps to Perform Outside of the Configuration Tool

Location of the Information You Will

Need

! Migrate user-customized objects, if you are creating a new Candle Management Server Version 360-based runtime environment and want to migrate the Candle Management Server objects from a previous version of the Candle Management Server-based runtime environment

All topics beginning with Migration in the chapter

“Completing the Customization” on page 117

! Specify security for the Candle Management Server. All topics beginning with Security in the chapter

“Completing the Customization” on page 117

Task You Want to Perform Checklist or Topic to Use


“Checklist: Registering Products on Distributed Platforms with the Candle Management Server” on page 44

Use advanced features in the Configuration tool to replicate the product or use the product on other z/OS images


Checklist: Registering Products on Distributed Platforms with the Candle Management Server



When you install and configure products on distributed platforms, you must return to the Configuration tool and register the product by installing the seed data that the product needs for situations.

If the Candle Management Server is a

� hub Candle Management Server, you must perform the tasks in this checklist for the hub Candle Management Server

� remote Candle Management Server, you must perform the tasks in this checklist for the remote Candle Management Server, as well as the hub Candle Management Server to which the remote Candle Management Server is reporting

Prerequisites for using the checklist Before using the checklist in this section, be sure you have:

� installed, configured and verified the product you want to use on the distributed platform. For installation instructions, refer to the Program Directory or to the installation guide for your product.

� installed, configured, and verified the Candle Management Server

� stopped the started task for the Candle Management Server

Checklist: Register products The following checklist contains the steps you perform inside the Configuration tool to register your product.

Table 17. Checklist for Registering Your Product

✓ Location of the Information You

Will Need

! On the Runtime Environments (RTEs) panel, use the Z (Utilities) to select the runtime environment that contains the Candle Management Server.


! On the RTE Utility Menu, use the Install product provided situations for distributed products option to specify the two character product code for the distributed product. (A list of the products and their corresponding product code is available in the online help.)


! Review and submit the JCL for the job that installs the seed data and product-specific information required to use the situations for the distributed product with the Candle Management Server.


45


! Use L (Load all product libraries after SMP/E) on the Runtime Environments (RTEs) panel in the Configuration tool to load the target libraries to the runtime libraries for the runtime environment.


! If you want to replicate the product or use the product on another z/OS image.


Table 17. Checklist for Registering Your Product (continued)


Will Need

Checklist: Updating the Configuration


Checklist: Updating the Configuration

In some cases, you will need to update the configuration for a product.

The following checklist contains the steps you perform inside and outside of the Configuration tool to update the configuration.

Table 18. Checklist for Updating the Configuration


Will Need

! Make the changes you want to the configuration in the Configuration tool and

! use L (Load all product libraries after SMP/E) on the Runtime Environments (RTEs) panel in the Configuration tool to load all the libraries used by the runtime environment

! perform the manual steps required to complete the configuration outside of the Configuration tool (if any)

“Updating and Changing the Configuration” on page 136

! If you want to replicate the product or use the product on another z/OS image.


47

Using Advanced Features in the Configuration Tool


Use the following advanced features if you

� have completed the appropriate checklist for configuring products

� have completed the appropriate checklist for verifying that the configuration is complete

Table 19. Advanced Features Available in the Configuration tool

TaskAdvanced

FeatureLocation of Information

Port an existing runtime environment to one or more z/OS images, without reconfiguring the runtime environment for those z/OS images

System Variable Support

Configuration guide for your product

Replicate and transport an runtime environment to one or more z/OS images

Batch Mode Processing

Configuration guide for your product



49

Planning Your Configuration

IntroductionThis chapter contains information that you should review before configuring products and maintenance. This chapter:

� contains background about products and components

� helps you determine the components to configure

� contains requirements you must review before you begin to configure the product

� contains information about Candle Management Server names

Chapter contentsDetermining the Topics to Use in this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Overview of the Products and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Candle Management Server to Agent Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . 54Determination of Components to Configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Guidelines for Determining Which Candle Management Server to Use in Your Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Requirements to Review Before Configuring the Candle Management Server. . . . . . . 60Requirements and Recommendations for Candle Management Server Names . . . . . . 62Guidelines for Assigning and Locating Candle Management Server Names . . . . . . . . 63Implementation of Firewall Support with Sample Scenarios . . . . . . . . . . . . . . . . . . . . 64

3

Determining the Topics to Use in this Chapter



This chapter contains topics that correspond to the tasks in Checklist: Prerequisites for Configuring Products in Chapter 1.

Determining the topics to use in this chapterIf you are not sure of the topics you will need in this chapter or you are not using a checklist, review the matrix to determine the pages to use in this chapter. R indicates that topic is required; O indicates the topic is optional.

Table 20. Configuration Steps

Page Numbers for Topics

55 54 55 60 62 63 64

Determine the products and components to configure and whether or not the products and components have manual steps performed outside of the Configuration tool

O

Review the Candle Management Server to agent relationships

O

Review information about IBM products and components

O

Review information about how Candle Management Server names are assigned and where you can locate them on z/OS and distributed platforms

O

Review information about implementing firewall support and review some sample scenarios

O

Review requirements before you begin the configuration

R

Review requirements and recommendations for Candle Management Server names

R

51

Overview of the Products and Components


The Installation and Configuration Assistance Tool automatically installs the required and optional products and components for the earlier Candle products. Other products, however, are installed using SMP/E. Both the earlier Candle products and the products installed using SMP/E are configured using the Configuration tool. Refer to the Program Directory for installation instructions pertaining to your product.

In most cases, you must configure the components to make them available. For installation instructions, refer to the Program Directory or to the Installation Guide for your product.

Background about the products and components The following table shows all the product and components available with some IBM products. The products and components are listed in the order they should be installed and configured (if configuration is required).

Table 21. Overview of the Products and Components

Component Name or Category Purpose

Operating Systemfor Product or Component


Component that: � consolidates the data collected by the agent and

distributes the data either to the CandleNet Portal interface or to the Candle Management Workstation interface

� in some cases, receives commands from the interface and distributes them to the appropriate agent or OMEGAMON XE product

� stores historical data and prototypes for configuration in the form of seed data

Note: If you have a distributed environment, you can use a Candle Management Server on the different platforms in that environment.

� Windows � z/OS � UNIX

Persistent Data Store

Component that records and stores historical data that you can access using either the CandleNet Portal interface or the Candle Management Workstation interface.

In some cases you can configure the Persistent Data Store with the agent or OMEGAMON XE product. If you decide not to configure the Persistent Data Store with the Candle Management Server, configure the Persistent Data Store when you configure the agent.

z/OS



IBM Tivoli OMEGAMON II

Component that collects and displays data in the IBM Tivoli OMEGAMON II user interface(s). These include: � the menu driven CUA interface that is IBM SAA

CUA compliant � the facility that allows multiple OMEGAMON IIs to

execute in the same address space and that communicates with all of them; the Common Interface (CI)

� for some IBM Tivoli OMEGAMON IIs, the command driven Classic interface

z/OS

Candle Subsystem

Component that is a z/OS subsystem running in its own address space, that provides dynamic I/O activity to IBM Tivoli OMEGAMON II

z/OS

Agents and OMEGAMON XE products

Component that monitors systems, subsystems, and applications on the system where they are installed. Agents: � collect data and monitor performance � provide data and performance information to the

Candle Management Server� receive instructions from the Candle Management

Server � issue commands to the system or application you

are monitoring Agents can be: � OMEGAMON XE, which collect performance and

analysis data.� Alert Managers, which monitor alerts and relay

the information from console or message logs, network management products, and system management products.

� Alert Emitters, which monitor events or exceptions in products running under the control of the Candle Management Server and relay them back for corrective action (if applicable).

� Gateways, which communicate events to a management application running on a supported platform using a network service.

Platform appropriate for the system or software being monitored

Table 21. Overview of the Products and Components (continued)



53


OMEGAVIEW® If available, the product that can be used to: � display data from all the IBM Tivoli OMEGAMON

IIs in a single location � display an IBM Tivoli OMEGAMON II session in

an OMEGAMON XE, so that the condition that caused an alert can be researched in IBM Tivoli OMEGAMON II

z/OS

OMEGAMON XE platform

Consists of these two graphical user interfaces (GUIs):� the Java based GUI CandleNet Portal™ (CNP)

that you use to display and work with data. The CandleNet Portal communicates with the Candle Management Server and the CandleNet Portal server. (This interface can be run either in desktop mode or in browser mode.)

� the Windows based GUI Candle Management Workstation® that communicates with the Candle Management Server.

� Windows

� Windows XP� Windows 2000

Table 21. Overview of the Products and Components (continued)



Candle Management Server to Agent Relationships


Candle Management Server to Agent Relationships

The following table shows the Candle Management Server types, the relationship for the type, and a description of the relationship.

Table 22. Details about the Relationships and Types of Candle Management Servers

Relationship IBM Term Description

Candle Management Server to Candle Management Server relationship

Hub Candle Management Server that:� receives data from agents and one or more remote

Candle Management Server in the environment � communicates data to and receives commands from an

interface

Remote Candle Management Server that: � receives data from agents � communicates data to the hub Candle Management

Server only (It does not communicate directly with an interface.)

Candle Management Server to agent relationship

Local Candle Management Server that is installed in the same runtime environment as the agent

Non-local Candle Management Server that is installed on: � z/OS, but is not installed and configured in the same

runtime environment as the agent. � z/OS, but is not installed and configured in the same CSI

as the agent. (For example, the Candle Management Server is installed using a different INSTLIB.)

� a platform other than z/OS (such as UNIX or Windows)

55

Determination of Components to Configure


In some cases, a product or component can be shared by more than one product. If you have already installed and configured these types of components, you can use the existing component.

For example, you can use the Candle Management Server with more than one IBM product.

If you are going to use an existing component, the component must be current. You must have installed and configured the component for another IBM product at the same level. For installation instructions, see the Program Directory for your product.

Determining the products and components you will needThe following table shows the products and components available for some IBM products. The table shows:

� a typical product and its components, and whether or not the components are required (R) or optional (O)

� (A blank indicates that the product does not use the component.)

� whether or not the component can be shared

� additional information that might help you decide whether or not you want to configure the component (if any)

The products and components are listed in the order they should be installed and configured (if configuration is required).



Table 23. Determining the Products and Components You Will Need

Component Name or Category IB

M P

rod

uct

Can

be

Sh

ared

?

Additional Information (If Any)


R Y

Persistent Data Store O N You can configure the Persistent Data Store with the Candle Management Server, with the agent (depending on how you choose to configure the agent), or with IBM Tivoli OMEGAMON II for SMS.

IBM Tivoli OMEGAMON II

O N

Candle Subsystem O Y Required only if you configure an IBM Tivoli OMEGAMON II product.

Note: IBM Tivoli OMEGAMON XE for OS/390 does not require IBM Tivoli OMEGAMON II for MVS to be configured, so this is required for IBM Tivoli OMEGAMON XE for OS/390.

We recommend using one Candle Subsystem for all the OMEGAMON products and components you install and configure.

Agents and OMEGAMON XE products

R Y

OMEGAVIEW® O Y Configure this component only if you want to access an IBM Tivoli OMEGAMON II session using the zoom feature (if available).

Candle Management Workstation interface or CandleNet Portal interface

R Y If the interface you are using is the Candle Management Workstation, you can also use:� the 327x-family color terminals with extended

attributes with some mainframe products� all 329x-family terminals with mainframe products

57


Determining whether or not you have to configure the products and componentsThe table shows the components and indicates whether or not you must:

� configure the component using the Configuration tool to make the component available to the product

� perform manual steps outside of the Configuration tool to configure the component to make it available to the product.


Table 24. Determining the Products and Components to Configure

Component Name or Category Configure Using the Configuration tool?

Requires Manual Steps Outside of the Configuration

tool?

Candle Management Server Y Y

Persistent Datastore Y Y

IBM Tivoli OMEGAMON II Y Y

Candle Subsystem Y Y

Agents and OMEGAMON XE products Y Y

OMEGAVIEW® (if available) Y Y

CandleNet Portal interface or Candle Management Workstation interface

N/A N/A



Locating information about configuring the product or componentThe table shows where you can locate information about configuring the product or component if it is not included in this guide.


Table 25. Locating Information about Configuring the Product or Component

Component Name or Category Location of Information for Configuring

the Product or Component

Candle Management Server This guide

Persistent Data Store Historical Data Collection Guide for IBM Tivoli OMEGAMON XE Products

IBM Tivoli OMEGAMON II Configuration Guide for the product

Candle Subsystem Configuration Guide for IBM Tivoli OMEGAMON II

Agents and OMEGAMON XE products Configuration Guide for the product

OMEGAVIEW® Configuration Guide for the product

CandleNet Portal interface or Candle Management Workstation interface

Administrator’s Guide for the product.

59

Guidelines for Determining Which Candle Management Server to Use in Your Environment

Guidelines for Determining Which Candle Management Server to Use in Your Environment

You can use any combination of hub and remote Candle Management Servers for your environment. Follow these guidelines when determining the type and location of the Candle Management Servers.

� A remote Candle Management Server must report to a hub Candle Management Server.

� You can configure an runtime environment with or without a Candle Management Server.

� Products must report to a Candle Management Server. (Products in a runtime environment without a Candle Management Server must report to a Candle Management Server in another runtime environment or on another platform.)

� Products can report to a remote Candle Management Server or a hub Candle Management Server.

In some cases, a product must be installed in the same address space as the Candle Management Server. If the product must be installed in the same address space, you will need to configure a Candle Management Server in the runtime environment for the product.

Review your product-specific Configuration Guide to determine whether or not your product must be installed in the same address space. Refer to the Program Directory for your product for installation instructions.

Requirements to Review Before Configuring the Candle Management Server



In defining the hub connection for each remote Candle Management Server, the hub port number and the remote Candle Management Server port number must match.

If you make a change to a hub Candle Management Server configuration, you must reconnect the hub connection for each remote Candle Management Server that reports to that hub. For example, if you change the port number or revise the communication protocols on the hub Candle Management Server, you must reconnect the hub connection from each remote Candle Management Server to pick up the change.

For applications that connect to the hub Candle Management Server (remote Candle Management Server, agents), you must use the F10=CMSLIST key to reconnect the application and refresh the hub Candle Management Server values.

Enabling security validationDuring Candle Management Server configuration, do not enable security validation until after your security is set.

Using TCP/IP or IP.PIPE

TCP/IP

If your site is using TCP/IP, be aware that network services such as NIS, DNS, and the /etc/hosts file should be configured to return the fully qualified hostname of the Candle Management Server and the product. For example:

#HostName.candle.com

This minimizes the risk of inconsistent values being returned for the hostname.

Note: When the installers reference the TCP/IP protocol suite, this means the component will use UDP (User Datagram Protocol) for connection.

Important: The same TCP/IP port number must be used on every Candle Management Server in the enterprise. Additionally, the Candle Management Server well-known port should not be on the TCP/IP reserved port list.

IP.PIPE

If your site is using IP.PIPE, be aware of the following limitations.

� There can be at most 16 IP.PIPE processes per host.

� IP.PIPE uses one, and only one, physical port per process. Port numbers are allocated using a well-known port allocation algorithm. The first process for a host is assigned port 1918, which is the default.

� KDC_PORTS is not supported for IP.PIPE.

Note: When the installers reference IP.PIPE, this means the component will use IP (Internet Protocol).

61


Specifying multiple network interface cards (NIC)If you are running multiple TCP/IP interfaces or network adapters on the same z/OS image, you must specify the network interface card that you want the Candle Management Server to use. This allows you to direct the Candle Management Server to connect to a specific TCP/IP local interface.

You will set the network interface card parameter while specifying the IP and IP.PIPE communication values for the Candle Management Server. During configuration, the Configuration tool will then add the KDCB0_HOSTNAME= parameter in the KDSENV member of the runtime environment’s RKANPAR library.

Note: If you are using Interlink’s TCPACCESS, you cannot use this variable.

Using the Inter-user Communication Vehicle (IUCV)If you are using the Inter-user Communication Vehicle (IUCV) interface, you will indicate this while specifying your TCP (IP and IP.PIPE) communication values for the Candle Management Server. During configuration, the Configuration tool adds the IUCV keyword in the KLXINTCP member of the runtime environment’s RKANPAR library.

KLXINTCP is the CT/Engine initialization member for:

� IBM’s High Performance Native Sockets (HPNS) TCP/IP protocol support

� IUCV interface support

� Interlink V5.2 HPNS TCP/IP protocol support

Note: When using IBM’s HPNS TCP/IP protocol support, do not specify Y.

Requirements and Recommendations for Candle Management Server Names


Requirements and Recommendations for Candle Management Server Names

For the best performance, use the following guidelines.

� Each name should be unique. For example, candle and candle_remote are unique and permitted; server_1 and server_1 are not unique and are not permitted.

� The Candle Management Server name should be alphanumeric and must begin with an alpha character.

� Each name must be between 2—32 characters in length.

� No blanks or special characters ($#@) should be used. An underscore (_) is permitted and conforms to ISO 9660 standards. A period (.) is also valid.

� The Candle Management Server name is case-sensitive (mixed case is allowed) on all platforms. If you use a mixed case Candle Management Server name, you should use the same mixed case Candle Management Server name for all applications that will connect to this Candle Management Server.

In general the names you use for any Candle Management Server should be short, but meaningful within your environment.

63

Guidelines for Assigning and Locating Candle Management Server Names

Guidelines for Assigning and Locating Candle Management Server Names

On z/OS, the Candle Management Server name is assigned and located using the following guidelines.

� The Candle Management Server name is specified during runtime environment configuration.

� The default for the Candle Management Server name is RTENAME.

� The Candle Management Server name is assigned to CMS_NODEID.

� CMS_NODEID is defined in the KDSENV member of RKANPAR.

Candle Management Server names on distributed platformsOn distributed platforms, the Candle Management Server name is assigned and located using the following guidelines.

� The hub and remote Candle Management Server name is assigned to CMS_NODEID.

� If the hub or remote Candle Management Server executes on Windows, you can view this value using Manage Candle Services > right-click on the Candle Management Server > Browse Settings. It is also visible in the KBBENV file in the Candle Management Server directory.

� If the hub or remote Candle Management Server executes on UNIX, this value is visible in the KBBENV file located in the $CANDLEHOME/tables/<Candle Management Server_Name> subdirectory.

Implementation of Firewall Support with Sample Scenarios



This discussion does not include specific steps for configuring the OMEGAMON XE across a firewall; those steps can be found either in the Program Directory for your product or in the product-specific installation guide, depending on which product you are configuring.

Basic implementationAt this release, the OMEGAMON XE supports most common firewall configurations, including those that use address translation (application proxy firewall is a notable exception).

To enable this support, we use the IP.PIPE socket address family, a TCP-based protocol that opens a single port on the firewall for communication by IBM products. If your target OMEGAMON XE environment includes a firewall between any IBM products, you must specify IP.PIPE as your communication protocol during configuration. No other special configuration is needed, unless your firewall also uses address translation.

Implementation with address translationAddress translation is an enhanced security feature of some firewall configurations. With this feature, components that must be reached across the firewall have two unique, but corresponding addresses:

� the external address (valid for components outside the firewall)

� the internal address (valid for components inside the firewall)

With regard to the OMEGAMON XE, the component that typically must be reached for connection is the Candle Management Server. However, the Warehouse Proxy, which runs on Windows as a server-type application, must also be accessible to clients and would also require an external and internal address. A component on either side of the firewall only knows about the address that is valid for its side (its “partition”.)

To accommodate sites with address translation, we use a partition-naming strategy. This strategy requires two steps:

� The creation of a text file called a “partition file” as part of the configuration of a hub or remote Candle Management Server (or Warehouse Proxy). The partition file contains an entry that defines that component’s address in the other partition.

– For a z/OS Candle Management Server, this partition file is called KDCPART.

It is created by the Configuration tool and resides in the rhilev.midlev.RKANPAR library. When address translation is enabled during Candle Management Server configuration, the KDSENV member is created to add the KDC_PARTITION=&partition_name and KDC_PARTITIONFILE=KDCPART parameters.

– For a Candle Management Server on a distributed platform, this partition file is called kdcpartition.txt.

65


� The specification of a partition name (any alphanumeric string up to 32 characters), as part of the configuration of any agent, a hub or remote Candle Management Server, a Candle Management Workstation, or the Warehouse Proxy. A partition name must be specified for each component regardless of whether it resides inside or outside the firewall.

Sample scenariosAssuming that your site has one firewall, there would be two partitions: one outside the firewall and one inside the firewall. In the sample scenarios that follow, the names OUTSIDE and INSIDE, respectively, are used for these partitions. (If your site’s configuration includes more than one firewall, we recommend that you contact IBM Software Support for assistance in configuring the OMEGAMON XE.)

Scenario 1: hub Candle Management Server inside firewall, agents, and Candle Management Workstation outside firewall

In this scenario, as part of the configuration of the hub Candle Management Server, we specify the name of the partition that it resides in (INSIDE). We also create a partition member in the hub library rhilev.midlev.RKANPAR(KDCPART), containing the following entry:

OUTSIDE ip.pipe:hub’s_external_address

The partition name outside the firewall is OUTSIDE. The address of the hub Candle Management Server that is valid for the agents and Candle Management Workstation is hub’s_external_address. As part of the configuration of each agent and the Candle Management Workstation, we specify the name of the partition that each resides in (OUTSIDE).

When an agent or the Candle Management Workstation starts, the partition file is searched for an entry that matches the partition name OUTSIDE and “sees” the Candle Management Server address that is valid for the agents and the Candle Management Workstation (the external address).

Scenario 2: hub and remote Candle Management Server inside firewall, agents outside firewall

In this scenario, we assume that all agents report to the remote Candle Management Server. As part of the configuration of the hub Candle Management Server, we specify the name of the partition that it resides in (INSIDE). No partition file is needed because the only component that reports to it (the remote Candle Management Server) is also inside the firewall.

As part of the configuration of the remote Candle Management Server, we specify the name of the partition that it resides in (INSIDE). A partition member in the remote library rhilev.midlev.RKANPAR(KDCPART) must also be created at the remote Candle Management Server. It contains the following entries:

OUTSIDE ip.pipe:remote’s_external_address



When configuring the agents (all of which are outside the firewall, reporting to the remote Candle Management Server), we specify the name of the partition that they reside in (OUTSIDE). When the agents start, KDCPART is searched for an entry that matches the partition name OUTSIDE and “sees” the remote Candle Management Server address that is valid for them (the external address).

Scenario 3: hub Candle Management Server inside firewall, remote Candle Management Server and agents outside firewall

In this scenario, we assume that all agents report to the remote Candle Management Server. As part of the configuration of the hub Candle Management Server, we specify the name of the partition that it resides in (INSIDE). We also create a partition member in the hub library rhilev.midlev.RKANPAR(KDCPART), containing the following entry:

OUTSIDE ip.pipe:hub’s_external_address

The partition name outside the firewall is OUTSIDE. The address of the hub Candle Management Server that is valid for the remote Candle Management Server is hub’s_external_address.

As part of the configuration of both the agents and the remote Candle Management Server, we specify the name of the partition they reside in (OUTSIDE). A partition member in the remote library rhilev.midlev.RKANPAR(KDCPART) also must be created at the remote Candle Management Server. It contains the following entry:

INSIDE ip.pipe:remote’s_internal_address

If the hub Candle Management Server needs to communicate with the remote (for example, to issue a report request from an agent that is connected to the remote), partremote.txt is searched for an entry that matches the partition name INSIDE and sees the remote Candle Management Server address that is valid for it (the internal address).

67

Configuring Your Product

IntroductionThis chapter provides information about

� setting up your configuration environment

� registering with the Candle Management Server

� configuring your product

This chapter assumes that you have already installed your product, and you are ready to proceed with configuration. See your program directory or your installation guide for installation instructions. For detailed information on configuring your product, see your product-specific configuration guide.

Important: After configuring your product using the Configuration tool, be sure to load all product libraries from the Runtime Environments (RTE) panel. You may then proceed to completing the configuration outside of the Configuration tool.

Chapter ContentsDetermining the Topics to Use in this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Setting up Your Configuration Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Registering with the Candle Management Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Configuring the Persistent Data Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

4




This chapter contains topics that correspond to the tasks in Checklist: Setting Up Your Configuration Environment in Chapter 1.

Determining the topics to use in this chapterIf you are not sure of the topics you will need in this chapter or you are not using a checklist, review the matrix to determine the pages to use in this chapter. The R indicates the topic is required. The O indicates the topic is optional.

Table 26. Configuring your Product


69 72 73

Setting up your configuration environment

R

Registering with the Candle Management Server and adding seed data

R

Configuring persistent data stores R

69

Setting up Your Configuration Environment


After installing the product tape that contains the Installation and Configuration Assistance Tool FMID (HKCI310), as instructed in the Program Directory, you need to set up your configuration environment.

Setting up your environment consists of copying the contents from one of the target libraries into the appropriate Configuration tool work library. This applies to products installed into either an existing Consolidated Software Inventory (CSI) or into a new CSI. The CSI is a VSAM dataset in which SMP/E maintains information about the system.

If you use an existing CSI, you copy the contents of the target library (&thilev.TKCIINST) into your existing Configuration tool work library (&shilev.INSTLIBW). If you use a new CSI, you copy the contents of the target library (&thilev.TKCIINST) to the newly created Configuration tool library (&shilev.INSTLIB).

If you use an existing CSIIf you use an existing CSI, perform these steps to copy the contents of the target library into your existing Configuration tool work library and to configure your environment:

1. Copy the contents of the &thilev.TKCIINST library to the &shilev.INSTLIBW library as follows:

//COPY EXEC PGM=IEBCOPY //SYSPRINT DD SYSOUT=* //IN DD DSN=&thilev.TKCIINST,DISP=SHR //OUT DD DSN=&shilev.INSTLIBW,DISP=SHR //SYSIN DD *

C O=OUT,I=((IN,R))

where:

&thilev = the SMP/E target high-level qualifier&shilev = the installation high-level qualifier

Important: If you copy and paste the JCL from this guide, the spacing before the COPY statement will be dropped. Otherwise, you will get errors.

2. Start the Configuration tool. The Configuration tool will automatically perform any required updates. To start the Configuration tool:

1. Log onto a TSO session.2. Invoke ISPF.3. Go to a TSO command line. (In most cases, this is option 6 on the ISPF Primary

Option Menu.)4. Enter the following command:

EX ‘&shilev.INSTLIB’

where &shilev is the high-level qualifier you specified for the Configuration tool.

Result: The Configuration tool first displays the copyright panel and then the Main Menu. (Both the copyright panel and the Main Menu display the version and release of the Configuration tool.)



3. From the Main Menu, select Configure products and complete the following options on the menu. Only those packages that are eligible to be configured are listed on this panel.

1. Select Select product to configure to display a list of the products available. 2. On the Product Selection Menu, select S to select a product to be configured. You can

only select one product at a time for configuration.Result: The Configuration tool displays the Runtime Environments (RTEs) panel.

4. On the Runtime Environments (RTEs) panel, specify:

� to use an existing runtime environment, select C (Configure) and L (Load)

� to create a new runtime environment, select A (Add), B (Build libraries), C (Configure), and L (Load)

Result: The Configuration tool displays the Configure the CMS Menu. See Chapter 5 for complete details on configuring the runtime environment.

If you use a new CSIFor a new CSI, perform these steps to copy the contents of the target library to the newly created Configuration tool library, and to set up and configure your environment:

1. Allocate the &shilev.INSTLIB library using the sample JCL below://JOBCARD //ALLOCDS EXEC PGM=IEFBR14 //* //INSTLIB DD DSN=&shilev.INSTLIB, // DISP=(NEW,CATLG,DELETE), // UNIT=&tunit, // VOL=SER=&tvol, // DCB=(RECFM=FB,LRECL=80,BLKSIZE=8880), // SPACE=(TRK,(90,15,132))

Replace the following parameters with the values specific to your site,

where:

JOBCARD = your job card &shilev = the high-level qualifier for the installation environment &tunit = the disk unit type for the target library&tvol = the disk volser for the target library

2. Copy the contents of the &thilev.TKCIINST library into the &shilev.INSTLIB library:

//COPY EXEC PGM=IEBCOPY //SYSPRINT DD SYSOUT=* //IN DD DSN=&thilev.TKCIINST,DISP=SHR //OUT DD DSN=&shilev.INSTLIB,DISP=SHR //SYSIN DD *

C O=OUT,I=((IN,R))

Important: If you copy and paste the JCL from this guide, the spacing before the COPY statement will be dropped. Otherwise, you will get errors.

71


3. Start the Configuration tool:

1. Log onto a TSO session.2. Invoke ISPF.3. Go to a TSO command line. (In most cases, this is option 6 on the ISPF Primary

Option Menu.)4. Enter the following command:

EX ‘&shilev.INSTLIB’

where &shilev is the high-level qualifier you specified for the Configuration tool.

4. From the Main Menu, select Set up work environment and complete the following options on the menu.

1. Select Specify options to specify allocation and processing values that will be used to create the work datasets that are needed by the Configuration tool.

2. Select Allocate work libraries to allocate the Configuration tool work libraries.Important: Once you create and submit the Allocate work libraries job, you must exit the Configuration tool and allow the job to run before starting the Configuration tool once more.

5. From the Main Menu, select Configure products and complete the following options on the menu. Only those packages that are eligible to be configured are listed on this panel.

1. Select Set up configuration environment to specify the remaining values that the Configuration tool uses for all of the products you are configuring.

2. Select Select product to configure to display a list of the products available. 3. On the Product Selection Menu, select S to select a product to be configured. You can

only select one product at a time for configuration.Result: The Configuration tool displays the Runtime Environments (RTEs) panel.

6. On the Runtime Environments (RTEs) panel, specify:

� to create a new runtime environment, select A (Add), B (Build libraries), C (Configure), and L (Load)

Result: The Configuration tool displays the Configure the CMS Menu. See your product-specific configuration guide for complete details on runtime environments.

Registering with the Candle Management Server


Registering with the Candle Management Server

This procedure updates the Candle Management Server to recognize newly installed products (that is, registers the product with the Candle Management Server and seeds the Candle Management Server (that is, initializes it with application data). Seeding adds product-provided situations, templates, and other sample data to the Enterprise Information Base (EIB) tables of the Candle Management Server.

Your product must be registered with the Candle Management Server to which it reports. If that Candle Management Server is remote, you must also register the product with the remote server’s corresponding hub Candle Management Server.

Note: When you select the Complete the Configuration step from the Main Menu, the Configuration tool dynamically displays the Candle Management Server seeding requirements. The requirements that display depend upon how a particular product seeds its Candle Management Server. It is possible that your product seeds the Candle Management Server using CandleNet Portal. If so, see “Registering with and Seeding the Candle Management Server” on page 109.

Registering with and seeding a local Candle Management Server on z/OSIf the Candle Management Server and your agent are installed on the same z/OS system, you can register the agent with the Candle Management Server and seed the Candle Management Server in one operation executed by the Configuration tool.

1. If you have not already configured the Candle Management Server, do so now.

2. Verify that the Candle Management Server is not running.

3. From the Main Menu, select Configure products > Select product to configure... and select the product you are configuring.

Result: The Configuration tool displays the Runtime Environments (RTEs) panel.

4. Enter C to select the runtime environment where the Candle Management Server resides.

5. On the Product Selection Menu, select the product you want to configure. (That is, the component you will register with the Candle Management Server.)

6. On the Configure panel for the product you selected, select Register with local CMS. Result: If the agent has already been registered, a panel prompts you to confirm a product refresh.

7. Review the JCL and submit the job.

8. Press F3 until you return to the Main Menu.

9. Select Complete the Configuration.

10. Make a note of the additional configuration steps described on the panel that appears. Those steps must be performed outside of the Configuration tool. See “Completing the Configuration” on page 103.

73

Configuring the Persistent Data Store


The Persistent Data Store is used to store the data for historical collection. You can retrieve this data at a later date. This option is required when using the data warehouse function.

For applications configured to run in the z/OS Candle Management Server address space, the Configure persistent datastore step within the Candle Management Server product configuration is required. This step applies to both z/OS-based and to non-z/OS-based products that enable historical data collection in the specified z/OS Candle Management Server.

Additionally, any started task associated with a product (including the Candle Management Server address space itself), that is running prior to configuring the Persistent Data Store, must be stopped.



75

Configuring yourRuntime Environment

IntroductionThis chapter provides detailed instructions for

� planning the configuration sequence for your runtime environment

� configuring runtime environments for your IBM products, after you have installed your product and maintenance packages

� adding a new runtime environment

� building and loading your runtime environments

A runtime environment includes the libraries required to execute products on a z/OS image. One runtime environment is typically configured per z/OS image.

Chapter contentsDetermining Topics to Use in this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Reviewing Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Planning Your Runtime Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Planning Your Product Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Configuring Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Adding a Runtime Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Building Runtime Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Configuring Runtime Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Loading Runtime Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Deleting a Runtime Environment (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

5

Determining Topics to Use in this Chapter


Determining Topics to Use in this Chapter

This chapter contains topics that correspond to the tasks in the checklist called Checklist: Configuring the Candle Management Server Using the Configuration Tool.

There are also topics that cover planning and managing your runtime environments (such as the order products are configured in the runtime environment and how they are deleted when they are no longer needed).

For instructions on installing products, refer to the Program Directory for your product.

Determine the topics to use in this chapterIf you are not sure of the topics you will need in this chapter or you are not using a checklist, review the matrix to determine the pages to use in this chapter. An R indicates the topic is required; O indicates the topic is optional.


79 81 84 86 88 92 93 94 95

You are installing products and creating a new runtime environment.

R R R R R R R R

You are installing products and using an existing runtime environment.

R R R R R

You are installing maintenance and changes need to be made to the configuration values for the product. To obtain current “PSP Bucket” information, access the Software Support Web site at http://www-3.ibm.com/software/support.

R R

You are installing maintenance and no changes need to made to the configuration values for the product. To obtain current “PSP Bucket” information, access the Software Support Web site at http://www-3.ibm.com/software/support.

R

You are deleting an existing runtime environment.

O

77

Runtime Environment Terminology

Runtime Environment Terminology

The following list provides definitions for some of the runtime environment terms used in this guide.

Table 27. Runtime Environment Term Definitions

Base libraries

Runtime libraries that the configuration process does not alter, and that are shareable between systems.

These libraries physically exist in a FULL RTE or BASE RTE, or as SMP/E target libraries (if a runtime environment shares with SMP/E).

BASE RTE Configuration containing only shareable runtime libraries, that are a subset of the libraries needed to run products (therefore, they must be shared by another runtime environment).

FULL RTE Configuration containing a full set of dedicated libraries, that consists of BASE libraries and LPAR- specific libraries.

LPAR-specific libraries

Runtime libraries that are built during the configuration process to run on a specific LPAR.

These libraries contain the unique elements required for a particular LPAR and cannot be shared between z/OS images.

Runtime Environment (RTE)

Configuration containing a logical grouping of product libraries.

There are five types of runtime environments: Full, Base, Sharing Base, Sharing Full, and Sharing SMP/E Target.

Runtime libraries

Libraries that tasks reference during execution.

SHARING BASE

Configuration containing LPAR-specific libraries, that references libraries configured in a BASE RTE.

SHARING FULL

Configuration containing LPAR-specific libraries, that references libraries configured in a FULL RTE.

SHARING SMP/E TARGET

Configuration containing LPAR-specific libraries, that references libraries managed by SMP/E.

SMP/E target libraries

SMP/E maintained target libraries.

Background About the Types of Runtime Environments


Background About the Types of Runtime Environments

A runtime environment comprises a grouping of runtime libraries that are referenced by tasks as they execute upon an z/OS image. These runtime libraries include base libraries and LPAR-specific libraries.

Background about the types of runtime environments and configuration The distinction between library types allows you to optimize your product environment. For example, by allocating common base libraries to a single runtime environment that can be shared by other runtime environments, you can substantially reduce the amount of disk space required, as well as simplify the application of maintenance across remote z/OS images.

To take advantage of runtime environment sharing relationships, you will need to make a decision on the type and number of runtime environments you will be configuring.

Examples of different types of runtime environment configurationsFor examples of different types of runtime environment configurations, see “Examples of different types of runtime environment configurations” on page 78. The way you choose to set up your runtime environments depend on your site requirements, maintenance procedures, and DASD sharing capabilities.

79

Reviewing Product Configuration


For each product, the Configuration tool displays the components in the order they should be configured.

For products that use the Candle Management Server, to ensure maximum efficiency, install and configure the various products and components in the following order:

1. Hub Candle Management Server2. Remote Candle Management Server3. CandleNet Portal or Candle Management Workstation interface 4. Agents5. OMEGAMON II component, if applicable

Note: For existing customers, following this order prevents communication problems between the agents, the Candle Management Server, and the interface being used.

When installing and configuring an interface, the Candle Management Server, or agents, be aware that:

� If you are using a shared CSI, you must first configure the hub Candle Management Server, then the remote Candle Management Server, and then the agents.

� If a remote Candle Management Server and agents will connect to a Candle Management Server in another CSI for z/OS, or to a distributed Candle Management Server, the installation order does not matter. You can configure a remote Candle Management Server and agents without configuring a hub Candle Management Server.

� You will not be able to use the interface and all its functions until you have configured and started the Candle Management Server.

Naming convention for VTAM applidsUse the default names provided, which use the format ccccppxx, where:

� ccc = 1–4 character global VTAM applid prefix (The default is CTD.)

� pp = 2-character product code

� xx = 2-character specific applid suffix

Enter README APP on the Configuration tool command line, to display an extended explanation of how the tool processes applids and lists of default applid names, product codes, and applid suffix values.

Following are some VTAM applid considerations you should be aware of when configuring your products.

� Applids are standardized across products and used to communicate between applications.

� VTAM applid prefix and virtual terminal prefix can be specified separately.



� You can use the F6=Applids key on the Configuration tool product configuration panels to access the list of VTAM major node and applid values for products.

Naming conventions for started tasks Use the product-provided default names, which use the format ccccpp, where:

� cccc = 1–4 character global started task prefix (The default is CANS.)

� pp = 2-character product code

Started task names are standardized across products.

Enter README APP on a Configuration tool command line, to display the list of product codes.

Recommended configuration for applications with network interface cardsIf you are running multiple TCP/IP interfaces or network adapters on the same z/OS image, you must specify the network interface card that you want your application to use. This allows you to direct the application to connect to a specific TCP/IP local interface.

Note: Applications that can have network interface cards include the Candle Management Server and all stand-alone agents.

You will set the network interface card parameter while specifying the IP and IP.PIPE communication values for the application. During configuration, the Configuration tool will then add the KDCB0_HOSTNAME= parameter in the KDSENV member of the runtime environment’s RKANPAR library.


81

Planning Your Runtime Environment


After installing product and maintenance packages, you will need to perform one or more actions to configure your products in the runtime environments.

The following table shows the actions available on the Runtime Environments (RTEs) panel.

� The table shows the actions to use for specific installation and maintenance tasks.

� The actions are listed in the order they are used, from left to right.

Table 28. Actions Available from Runtime Environments (RTEs) Panel

Installation and Maintenance Tasks

Ad

d R

TE

(A

)

Bu

ild li

bra

ries

(B

)

Co

nfi

gu

re (

C)

Lo

ad a

ll p

rod

uct

libra

ries

aft

erS

MP

/E (

L)

You installed new products or new versions of existing products and you want to create a new runtime environment.

✓ ✓ ✓ ✓

You installed new products or new versions of existing products and you want to use an existing runtime environment.

✓ ✓ ✓

You installed maintenance for existing products and changes need to be made to the configuration values for the product. To obtain current “PSP Bucket” information, access the Software Support Web site at http://www-3.ibm.com/software/support.

✓ ✓

You installed maintenance for existing products and no changes need to be made to the configuration values for the product. To obtain current “PSP Bucket” information, access the Software Support Web site at http://www-3.ibm.com/software/support.

✓



Special considerations when sharing a BASE RTEFor runtime environments that share a common BASE RTE, the sample VTPOOL definition statements provided in the RKANSAM(KOBVTPL) member of each SHARING RTE will be shared across all runtime environments that share the BASE RTE.

Runtime environment configuration sequenceTo fully define a runtime environment for your products, follow the runtime environment configuration sequence below that is appropriate for your situation. Detailed instructions for each action in the configuration sequence are provided in this chapter.

Creating a new runtime environment

Follow this configuration sequence to create a new runtime environment.

1. Add (A) an RTE. This action defines the runtime environment to the Configuration tool. You are prompted to enter parameters that will be used later to allocate libraries and establish defaults for product configuration within the runtime environment.

2. Build (B) RTE libraries.

This action generates a batch job that allocates the runtime libraries.

3. (FULL and SHARING RTEs only) Configure (C) products in the RTE.

This action collects the parameters required to fully configure a product within an runtime environment. You cannot configure BASE RTEs.

4. Load (L) RTE libraries.

This action generates a batch job that loads the runtime environment libraries from the SMP/E target libraries.

Note: The Load action must be performed any time that a product has been configured within a runtime environment, or if maintenance has been applied.

Adding new products to an existing runtime environment

Follow this configuration sequence to add new products to an existing runtime environment.

1. Build (B) RTE libraries again.This action allocates any additional runtime libraries needed by the new product. Pre-existing libraries will not be reallocated.


You cannot configure BASE RTEs.



83


Runtime environment configuration sequence for agent address spaces

To create a runtime environment in which one or more agents will reside (without a Candle Management Server), follow the runtime environment configuration sequence above that is appropriate for your situation. There is nothing different or special about configuring a runtime environment for this purpose.

Creating a new runtime environment for National Language Support (NLS) products

Follow this configuration sequence to create a new runtime environment for NLS products.

4. Add (A) an RTE.

Make sure that you enable the “Install National Language components” option on the Add Runtime Environment panel.

5. Build (B) RTE libraries.


7. You cannot configure BASE RTEs.



Adding National Language Support products to an existing runtime environment

Follow this configuration sequence to add NLS products to an existing runtime environment.

1. (FULL and SHARING RTEs only)Update (U) an RTE to display its configuration information.

Ensure that you enable the “Install National Language components” option from the Update Runtime Environment panel.

2. Build (B) RTE libraries again.

3. (FULL and SHARING RTEs only)

Configure (C) products in the RTE to select Japanese VTAM APPLIDs and recreate CT/Engine address spaces.

4. Load (L) RTE libraries again.


Planning Your Product Configuration



Review the Configuration tool features and enhancementsThe following features are available when configuring your products.

Configuration tool batch mode processing

You can use batch mode processing to quickly create an runtime environment for another z/OS image. For more detailed information, see “Batch Mode Processing” on page 137.

System variable support

The Configuration tool now supports z/OS system symbolics for some of the generated configuration values. For more information, see “Enabling System Variable Support” on page 151 or from any Configuration tool panel, enter README SYS.

Additional features and enhancements

Following are some additional features and enhancements.

Table 29. Additional Configuration Tool Features

SMS support SMS support has been added to the Configuration tool dataset allocation for the runtime datasets. For more information, from any Configuration tool panel enter README SMS.

PDSE support You can choose to allocate PDSE datasets instead of PDS datasets for runtime libraries that are not load libraries. For more information, from any Configuration tool panel enter README SMS.

RTE load optimization

You can define an runtime environment to load only changed members to runtime datasets after you apply maintenance or configure products.

JES3 support Configuration jobs are JES3 compatible.

Component upgrade alert

During configuration, the Configuration tool will compare the component products being configured to the component products in all runtime environments. If the runtime environment contains a component at a lower version, an upgrade panel will alert you that an upgrade of these runtime environments is required.

VTAM applid considerations

For information on VTAM applids, from any Configuration tool panel, enter README APP.

85


Review TCP-related configuration features and requirementsReview the following TCP-related features and requirements before you configure your products.

Started task authorization for TCP/IP privileges

If you are using TCP/IP 3.4 and above, to enable your application to connect to TCP/IP you must create an OMVS segment for RACF, or equivalent security system, identifying your CANSpp started task as a Superuser:

ALU CANSpp OMVS(UID(0) HOME(/) PROGRAM(/BIN/SH))

where pp is the product code.

Multiple network interface cards (NIC)

If you are running multiple TCP/IP interfaces or network adapters on the same z/OS image, you must specify the network interface card that you want your application to use. This allows you to direct the application to connect to a specific TCP/IP local interface.

Note: Applications that can have network interface cards include the Candle Management Server and all stand-alone agents.

You will set the network interface card parameter while specifying the IP and IP.PIPE communication values for the application. During configuration, the Configuration tool will then add the KDCB0_HOSTNAME= parameter in the KppENV member (pp is the product code) of the runtime environment’s RKANPAR library. For example, the Candle Management Server member name is KDSENV.


Inter-user Communication Vehicle (IUCV) interface

If you are using the Inter-user Communication Vehicle (IUCV) interface, you will indicate this while specifying your TCP (IP and IP.PIPE) communication values for the application. During configuration, the Configuration tool adds the IUCV keyword in the KLXINTCP member of the runtime environment’s RKANPAR library.

KLXINTCP is the CT/Engine initialization member for:

� IBM’s High Performance Native Sockets (HPNS) TCP/IP protocol support

� IUCV interface support

� Interlink V5.2 HPNS TCP/IP protocol support

Note: When using IBM’s HPNS TCP/IP protocol support, do not specify Y.

Configuring Products



You access the options to configure your products by selecting Configure products from the Main Menu.

Set up the configuration environmentBefore you configure your products and components, you may need to specify or update your site-specific configuration environment, such as global DASD information that will be used in any JCL that the Configuration tool generates.

Follow these steps to specify or update your site’s configuration information.

1. From the Main Menu, select Configure products > Set up configuration environment.

2. On the Set Up Configuration Environment panel, specify the high-level qualifiers that identify the attributes used for library allocation for the following library types:

3. To modify the high-level qualifiers after setting them, you must first unlock them by selecting Unlock runtime high-level qualifiers from the Configuration Services and Utilities panel.

4. If the runtime libraries are not to be SMS-managed, specify the unit name (Unit) and volume serial number (Volser) to be used for runtime library allocation.

If the runtime libraries are to be SMS-managed:

� Specify the SMS storage (Storclas) and management class (Mgmtclas) to be used for library allocation.

� Indicate if you want to use PDSE libraries. PDSEs do not require compression and are not limited by a pre-defined number of directory entries.

The default of N indicates that PDS libraries are to be used.

Note: SMS values must be supplied for PDSE libraries.

5. Indicate the technique (RTE allocation routine) you want the Configuration tool to use when generating the runtime environments.

Note: Use the Batch TMP method.

6. After specifying all required site-specific parameters, press Enter.

Table 30. High-level Qualifiers

VSAM CSI VSAM Cluster library used by each runtime

Non-VSAM Non-VSAM library used by each runtime

SMP/E Target Datasets

If not provided during product or maintenance processing, the high-level qualifiers of the SMP/E target libraries must be specified here. Runtime environment creation and maintenance requires access to these libraries. All SMP/E targets must have the same high-level qualifiers if they are to be part of this configuration.

87


7. If you have finished setting up your configuration environment, press F3 to return to the Main Menu.

View configuration informationTo view information about the current release of the Configuration tool, select Configuration information from the Configure Products panel.

Note: The word Revised, when present to the right of this option, indicates that there are updates to this information that you should review.

Manage your environment - configuration services and utilitiesTo access miscellaneous services and utilities that will help you manage your environment, select Services and utilities from the Configure Products panel.

Note: Do not modify any values unless you are specifically told to do so in the documentation or by Software Support personnel. Modifying the Configuration tool values incorrectly may produce unpredictable results or cause the configuration tool to stop functioning.

See the appendix “Configuration Services and Utilities” on page 179 for details on each of these services and utilities.

Select a product to configureYou select a product for configuration from the Product Selection Menu. Only those packages that are eligible to be configured are listed on this panel.

Follow these steps to select the product you want to configure.

1. From the Main Menu, select Configure products > Select product to configure.

2. On the Product Selection Menu, select S to select a product to be configured. You can only select one product at a time for configuration.

Result: The Configuration tool displays the Runtime Environments (RTEs) panel.

3. If you installed new products or new versions of existing products, to

� create a new runtime environment, see “Adding a Runtime Environment” on page 88

� use an existing runtime environment, see “Configuring Runtime Environments” on page 93

If you installed maintenance for existing products and there are

� configuration changes required, see “Configuring Runtime Environments” on page 93

� no configuration changes, see “Loading Runtime Libraries” on page 94

Adding a Runtime Environment



Follow these steps to add a new runtime environment.

1. From the Main Menu, select Configure products > Select product to configure... and select the product you are configuring.Result: The Configuration tool displays the Runtime Environments (RTEs) panel.

2. Type A in the Action field and type a name for your new runtime environment.

The name is a unique identifier (up to 8 characters), automatically used as the mid-level qualifier for FULL and SHARING RTEs. You can optionally specify a mid-level qualifier for BASE RTEs.

3. Enter the type of runtime environment being created. Valid types are:

4. (For SHARING RTEs only) Type the name of the BASE or FULL RTE from which this runtime environment will obtain its base library information. If SMP/E target libraries are to be shared, type SMP.

5. Type a description for this runtime environment, which may be any information that is useful for you and others at your site.

6. After specifying all required values on the Runtime Environments (RTEs) panel, press Enter and continue with ““Specify values on the Add Runtime Environment panels” on page 89.

Table 31. Runtime Environment Types

FULL Allocates both private and base libraries. Use this if only one runtime environment will be defined for your environment, or if you add a runtime environment for a unique set of products.

BASE Allocates base libraries only, and does not execute alone. Use this only in conjunction with SHARING RTEs populated with the same products.

SHARING Allocates private libraries only. This type can share base libraries with a BASE or FULL RTE populated with the same products, or use SMP/E target libraries for its base libraries. Define one SHARING RTE for each z/OS image if you have multiple images.

89


Specify values on the Add Runtime Environment panelsFollow these steps to specify values to define your runtime environment.

1. On the first Add Runtime Environment panel, specify the following values to define the runtime environment:

Table 32. Add Runtime Environment Values

Non-VSAM libraries � Type the high-level qualifier.� Type your site’s values for either the Volser/Unit

parameters or the Storclas/Mgmtclas parameters.� Indicate whether PDSE libraries are to be used. � PDSEs do not require compression, and are not

limited by a pre-defined number of directory entries. The default of N signifies that PDS libraries are to be used.Note: Supply SMS values for libraries specified as PDSEs.

VSAM libraries � Type the high-level qualifier.� Type your site’s values for the Volser or the

Storclas/Mgmtclas parameters.

Mid-level qualifier � For FULL and SHARING RTEs, accept the mid-level qualifier default value (which is the runtime environment name you previously specified) or specify a unique mid-level qualifier.

� For BASE RTEs, specify a unique mid-level qualifier or optionally leave this field blank.

JCL suffix Type a suffix for the JCL.

The suffix (up to four characters) is appended to all JCL that is generated in INSTJOBS. The JCL suffix uniquely identifies the batch job members created by the Configuration tool for this runtime environment.

STC prefix (FULL and SHARING RTEs only)

Type a global STC Prefix (of from 1–4 characters) to be used in building started tasks names for products in this runtime environment. The default is CANS.

SYSOUT class / Diagnostic SYSOUT class

Specify values for the non-diagnostic and diagnostic output DDNAMES.

Note: These values were previously hardcoded.

Load optimization Indicate whether you want to optimize loading of this runtime environment. The default is N.



2. After specifying all required values on the first Add Runtime Environment panel, press Enter.

Result: The second Add Runtime Environment panel displays.

3. On the second Add Runtime Environment panel, for FULL and SHARING RTEs only, specify these values:

Will the RTE have a CMS?

(FULL and SHARING RTEs only)

Specify whether a Candle Management Server will be configured within this runtime environment.

Select N if no Candle Management Server will be configured for this runtime environment. This saves disk space. The default of Y will allocate Candle Management Server libraries.

You must type the name of the Candle Management Server to be configured; it will be used by other objects that need to communicate with this Candle Management Server. The name of the defined runtime environment is used as the default.

Copy configuration values from RTE

(FULL and SHARING RTEs only - Optional)

Type the name of an existing runtime environment, from which configuration values will be copied and used for this runtime environment.

Note: This procedure makes an exact copy of the existing runtime environment. If you will not be using the same products in the new runtime environment, do not use this procedure.

Install National Language components?

(FULL and SHARING RTEs only - NLS products only)

Specify Y to install National Language Components in this runtime environment for all eligible products.

Table 33. Add Runtime Environment - FULL and SHARING RTE Values

Use OS/390 system variables?

Specify Y if this runtime environment will use OS/390 system variables.

See “Enabling System Variable Support” on page 155 for more information on enabling system variable support.

Security type Specify what, if any, security system is to be used for this runtime environment. The default is NONE.

If ACF2 is specified, you must also type the name of the ACF2 macro library.

Table 32. Add Runtime Environment Values (continued)

91


4. When you have finished defining your runtime environment, continue with “Building Runtime Libraries” on page 92.

Note: Select “View Values” (V) to verify the runtime environment information and “Update” (U) to make the necessary changes.

VTAM communication values

� Type a global VTAM applid prefix (of from 1–4 characters) to be used in building the VTAM applids for products in this runtime environment. The default is CTD.

� Identify your VTAM network. � Type the Logmode table name for LU6.2 logmode

entries. The default is KDSMTAB1.� Type the LU6.2 logmode for this runtime

environment. The default is CANCTDCS.

TCP/IP communication values

� Type the TCP/IP host name of the z/OS system in which this runtime environment resides and the TCP/IP address of the host.

� Select TSO HOMETEST to get these values.� Type the started task name of the TCP/IP server.� Type the address of the IP port. The default is 1918.� Type the Interlink TCP/IP subsystem name (if

applicable).

Table 33. Add Runtime Environment - FULL and SHARING RTE Values

Building Runtime Libraries


Building Runtime Libraries

Follow these steps to build the runtime libraries.


2. Build the runtime libraries:

A. Type B next to the runtime environment you are creating and press Enter. B. Review the JCL and submit the job.C. Verify that the job completes successfully. All return codes should be zero.

3. When you are finished building the runtime libraries, continue with “Configuring Runtime Environments” on page 93.

93

Configuring Runtime Environments

Configuring Runtime Environments

Once you have defined at least one runtime environment, you are ready to configure a product within it.

Candle Management Server configuration (optional)If you have installed a Candle Management Server, you must first configure the Candle Management Server before configuring the products that communicate with the Candle Management Server.

See the chapters on configuration in this guide for detailed information on configuring a Candle Management Server.

Product-specific configurationTo configure the products you have installed, follow the instructions on each Configuration tool panel. Help is available for each panel by pressing F1.

Once you finish configuring one product, press F3 to return to the Product Selection Menu. Repeat the process beginning with “Select a product to configure” on page 87, to configure all of your products.

Persistent Data Store configuration and maintenanceIf you will be configuring and maintaining the Persistent Data Store, see the Historical Data Collection Guide for IBM Tivoli OMEGAMON XE Products for information about the Persistent Data Store facility.

Loading Runtime Libraries


Loading Runtime Libraries

You must load the runtime libraries after you

� install and configure the products you want in a new runtime environment

� install and configure an additional product in an existing runtime environment

� install maintenance, whether or not you reconfigure a product

Note: The load job requires exclusive access to the runtime libraries.

Load the runtime librariesFollow these steps to load the runtime libraries from the SMP/E target libraries.


2. Load the runtime libraries:

A. Type L next to the runtime environment for which you want to load the runtime libraries and press Enter.

Note: If you are sharing runtime environments, both the master runtime environment and the sharing runtime environment must be loaded.

B. Review the JCL and submit the job. C. Verify that the job completes successfully and that the return code is 04 or less.

3. When you are finished loading the runtime libraries, press F3 to return to the Main Menu.

95

Deleting a Runtime Environment (Optional)

Deleting a Runtime Environment (Optional)

If you no longer need a particular runtime environment, including the runtime libraries and the configuration values set for the runtime environment, you can delete it. Make sure you really do not need the runtime environment before proceeding. If you delete a runtime environment, any other runtime environment that shares libraries with it will become inoperable.

Be aware that the delete job will delete all libraries that match the pattern:

rhilev.midlev.*

If you have allocated libraries for this runtime environment with a different high-level prefix, then you will have to manually delete those libraries. Also make sure that any libraries that match the pattern rhilev.midlev.* (that may not be part of the runtime environment) are renamed if you do not want to delete those libraries.

As a precaution, back up the entire SMP/E and runtime environment environment, including the INSTLIB, INSTDATA, and INSTJOBS libraries. This allows the runtime environment and INSTLIB to be restored as needed. Restoring only the runtime environment is not sufficient since the runtime environment information is deleted from the INSTLIB.

Delete a runtime environmentFollow these steps to delete a runtime environment.


2. Delete the RTE:

A. Type D next to the runtime environment you want to delete and press Enter. B. On the Delete Runtime Environment panel, specify Y for “Are you sure you want

to delete this RTE” and press Enter.C. Review the JCL and submit the job.

3. Press F3 to return to the Main Menu.

Examples of Possible Configurations Using Runtime Environments



The following five examples show different types of runtime environment configurations. The way you choose to set up your runtime environments will depend on your site requirements, maintenance procedures, and DASD sharing capabilities.

Note: In each example, the field settings and library names are for illustrative purposes only.

Example 1: FULL RTE (self-contained)The FULL RTE contains all libraries that are required to execute some IBM products and is the easiest runtime environment to create.

This type of runtime environment can be defined in any situation, but must be defined if

� your installation comprises only a single z/OS image

� you want each of the z/OS images within your installation to be independent

� there is no DASD sharing between z/OS images

� you are creating an runtime environment for a specific combination of products that does not exist in any other runtime environment

The following example represents a FULL RTE called RTE1, that is completely self-contained. As you can see, all base libraries and LPAR-specific libraries have been allocated within RTE1.

Table 34. FULL RTE Example

RTE Name: RTE1

Type: FULL

Hilev: PROD.CAN

Midlev: RTE1

Shares with: (none)

97


LPAR-specific library DD DSNAME resolution:

//RKANPAR DD DSN=PROD.CAN.RTE1.RKANPAR

Base library DD DSNAME resolution:

//RKANMODL DD DSN=PROD.CAN.RTE1.RKANMODL

BaseLibraries

RTE1

LPAR-specific Libraries



Example 2: BASE RTEThe BASE RTE allocates shareable base libraries only. A BASE RTE must be used in conjunction with a SHARING BASE in order to obtain the LPAR-specific libraries that are required to run some IBM products. Further, both the BASE RTE and the SHARING BASE must have been defined for the same combination of products.

A BASE RTE is typically used in DASD sharing environments, or when maintenance synchronization across multiple systems is desired. In either case, the BASE RTE should be defined on the master z/OS image within your installation. Sharing base libraries avoids unnecessary duplication, saves disk space, and simplifies the application of maintenance to a common point.

The following example represents a BASE RTE called RTE2.


*There are no LPAR-specific libraries in a BASE RTE.


//RKANMODL DD DSN=COMMON.BASE.RKANMODL

Table 35. Example of a BASE RTE

RTE Name: RTE2

Type: BASE

Hilev: COMMON.BASE

Midlev: (none)

Shares with: (none)

RTE2

BaseLibraries

99


Example 3: RTE SHARING with BASE RTE2 (recommended for sharing)This configuration is recommended for DASD sharing environments.

Utilizing the BASE RTE for common datasets, this runtime environment only contains LPAR-specific libraries. The Configuration tool resolves product configuration elements to correctly point at the LPAR-specific libraries and the BASE RTE libraries as necessary.

The following example represents a SHARING BASE RTE called RTE3, which obtains its base library information from the BASE RTE (RTE2).


//RKANPAR DD DSN=SYS.V2000.RTE3.RKANPAR


//RKANMODL DD DSN=COMMON.BASE.RKANMODL

Table 36. Example of a SHARING BASE RTE

RTE Name: RTE3

Type: SHARING

Hilev: SYS.V2000

Midlev: RTE3

Shares with: BASE RTE2

RTE2 BaseLibraries

RTE3

LPAR-specificLibraries



Example 4: RTE SHARING with FULL RTE1The SHARING RTE allocates LPAR-specific libraries only, and in this example, obtains its base library information from a FULL RTE that contains the same combination of products.

This configuration can also be used for DASD sharing environments, although the BASE/SHARING pair is the favored approach. The FULL RTE should be defined on the master z/OS image in your installation, with sharing runtime environments being defined on the remaining remote images.

The following example represents a SHARING FULL RTE called RTE4, which obtains its base library information from the FULL RTE (RTE1).


//RKANPAR DD DSN=X.Y.Z.RTE4.RKANPAR


//RKANMODL DD DSN=PROD.CAN.RTE1.RKANMODL

Table 37. Example of a SHARING FULL RTE

RTE Name: RTE4

Type: SHARING

Hilev: X.Y.Z

Midlev: RTE4

Shares with: FULL RTE1

BaseLibraries

RTE4


RTE1


101


Example 5: RTE SHARING with SMP/E target librariesThe SHARING RTE allocates LPAR-specific libraries only, and in this example, obtains its base library information from target libraries managed by SMP/E.

This configuration is useful for sites that

� have limited DASD space, as this configuration method will not allocate base libraries in the runtime environment, thereby reducing storage requirements.

� want to immediately activate any SMP/E applied maintenance.

The following example represents a SHARING SMP/E TARGET RTE called RTE5, which obtains its base library information from SMP/E target libraries.


//RKANPAR DD DSN=SYS2.OS26.RTE5.RKANPAR


//RKANMODL DD DSN=INSTALL.SMPE.TKANMODL

Table 38. Example of a SHARING SMP/E TARGET RTE

RTE Name: RTE5

Type: SHARING

Hilev: SYS2.OS26

Midlev: RTE5

Shares with: SMP/E Target Libraries

Hilev (SMP): INSTALL.SMPE

SMP/ETargetLibraries

RTE5


BaseLibraries



103

Completing the Configuration

IntroductionThis chapter contains:

� the manual steps you must perform outside of the Configuration tool to complete the configuration of the Candle Management Server

� the procedure to follow to verify the configuration of the Candle Management Server

See “Completing the Customization” on page 117 for instructions on completing the customization for the Candle Management Server.

Chapter contentsDetermining the Topics to Use in this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Copying the Procedures for the Started Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Copying the VTAM Definition and Varying the VTAM Node Active. . . . . . . . . . . . . . 106APF-Authorizing Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Copying the Procedures for the Persistent Data Store . . . . . . . . . . . . . . . . . . . . . . . . 108Registering with and Seeding the Candle Management Server . . . . . . . . . . . . . . . . . 109Verifying the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Using the Candle Management Server Error Log . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

6




This chapter contains topics that correspond to the tasks in Checklist: Configuring the Candle Management Server Outside of the Configuration Tool in Chapter 1.

Determine the topics to use in this chapterYou must complete all of the procedures in this chapter to configure the Candle Management Server outside of the Configuration tool.

105

Copying the Procedures for the Started Tasks

Copying the Procedures for the Started Tasks

When you use the Configuration tool to configure a product or component, the Configuration tool creates the started task procedures.

You must copy the started task procedures to your procedure library (PROCLIB) to complete the configuration.

Copy the procedures for the started tasks to your procedure library You must copy the started task procedures for the product from rhilev.midlev.RKANSAM to your procedure library (PROCLIB).

Copying the VTAM Definition and Varying the VTAM Node Active


Copying the VTAM Definition and Varying the VTAM Node Active

If you configured the Candle Management Server to use SNA as the communication protocol, the Configuration tool created VTAM definitions.

To complete the configuration, you must:

� copy the VTAM definition to VTAMLST

� vary the VTAM major node active

Copy the VTAM definition and vary the VTAM major node activeFollow this procedure to complete the configuration for the SNA communication protocol.

1. Copy the VTAM definition from rhilev.midlev.RKANSAM to VTAMLST. The VTAM definition in rhilev.midlev.RKANSAM has the same name you specified using the Configuration tool for either:

� the VTAM major node

� the global VTAM major node (The default is KCANDLE1.)

2. Vary the VTAM major node active using the following command.

V NET,ACT,ID=ccccccccc

The ccccccccc indicates the name for the VTAM major node you specified using the Configuration tool for either:

� the VTAM major node

� the global VTAM major node

107

APF-Authorizing Libraries

APF-Authorizing Libraries

The load libraries must be APF-authorized or some of the functions in the product may not be available.

You APF-authorize the load libraries by adding them to your list of APF-authorized libraries.

APF-authorize the libraries If the RTE is sharing with SMP/E, APF-authorize the target load libraries:

� thilev.midlev.TKANMOD

� thilev.midlev.TKANMODL

For all other RTEs, APF-authorize the runtime load libraries:

� rhilev.midlev.RKANMOD

� rhilev.midlev.RKANMODL

If one library in a steplib or joblib concatenation requires APF-authorization, all the libraries in the concatenation require APF-authorization.

Note: Any runtime libraries concatenated in the STEPLIB DDNAME and in the RKANMODL DDNAME of the started task must be APF-authorized.

Copying the Procedures for the Persistent Data Store


Copying the Procedures for the Persistent Data Store

The Persistent Data Store is used to store the data for historical collection. This option is required in order to use the data warehousing feature. Additionally, agents that are configured to run in the z/OS Candle Management Server address space must configure the Persistent Data Store. This step applies to both z/OS-based and to non z/OS-based products that enable historical data collection in the specified z/OS Candle Management Server.

When you configure the Persistent Data Store using the Configuration tool, the Configuration tool creates the procedures for the Persistent Data Store. You must copy these procedures to your procedure library (PROCLIB) to complete the configuration.

For more information about the Persistent Data Store facility, see the Historical Data Collection Guide for IBM Tivoli OMEGAMON XE Products.

Copy the procedures to your procedure library If you configured the Persistent Data Store, you must copy the following procedures from rhilev.midlev.RKANSAM to your procedure library (PROCLIB).

� pdsmprefix1

� pdsmprefix2

The value for pdsmprefix is the unique prefix you specified for the maintenance procedure using the Configuration tool. The default is KPDPROC.

109

Registering with and Seeding the Candle Management Server


This procedure updates the Candle Management Server to recognize newly installed products (that is, registers the product with the Candle Management Server and seeds the Candle Management Server (that is, initializes it with application data). Seeding adds product-provided situations, templates, and other sample data to the Enterprise Information Base (EIB) tables of the Candle Management Server.

Your product must be registered with the Candle Management Server to which it reports. If that Candle Management Server is remote, you must also register the product with the remote server’s corresponding hub Candle Management Server.

Note: When you select the Complete the Configuration step from the Main Menu, the Configuration tool dynamically displays the Candle Management Server seeding requirements. The requirements that display depend upon how a particular product seeds its Candle Management Server for products on z/OS.

Before seeding the Candle Management Server, verify that:

� the z/OS products are installed and available with CandleNet Portal

� the same versions of the z/OS products are installed and available with CandleNet Portal

Also verify that the image you used to install CandleNet Portal is compatible with the products you installed and configured. For example, if you received a product package containing tapes and a CD image, verify that an older or a newer CD image of CandleNet Portal has not been installed on the workstation you will be using to seed the Candle Management Server. If you have any question about whether or not they are compatible, contact IBM Software Support.

Additionally, you will need the IBM Tivoli OMEGAMON Data Files for z/OS CD. This CD contains the seed data files that you use for seeding the Candle Management Server.

Table 39. Registering with and seeding the Candle Management Server

If the Candle Management Server is installed on... See these instructions...

the same z/OS system as the agent “Registering with and seeding a local Candle Management Server on z/OS” on page 72

a different z/OS system from the agent “Registering with and seeding a remote Candle Management Server on z/OS” on page 110

a Windows system “Registering with and seeding a Candle Management Server on Windows” on page 111

a UNIX system One of these:� “Registering with and seeding a remote

Candle Management Server on UNIX (GUI)” on page 112

� “Registering with and seeding a remote Candle Management Server on UNIX (command line)” on page 113



Registering with and seeding a remote Candle Management Server on z/OSIf the Candle Management Server and the agent are installed on different z/OS systems, you will seed the Candle Management Server and register the agent with it in two separate operations:

1. You will seed the Candle Management Server from the Windows workstation that hosts the CandleNet Portal Server.

2. You will register the agent with the Candle Management Server from the Configuration tool on the z/OS system that hosts the Candle Management Server.

1. If you have not already configured and started the remote Candle Management Server, do so now.

2. If you have not already done so, install the seed data from the IBM Tivoli OMEGAMON Data Files for z/OS CD on the Windows workstation that hosts the CandleNet Portal Server.

1. Log onto the Windows workstation under a user ID with Administrator authority.2. Insert the IBM Tivoli OMEGAMON Data Files for z/OS CD into the CD-ROM drive.Installation begins automatically. If the InstallShield Wizard does not start, go to CD directory WINDOWS and run setup.exe. If setup.exe initialization fails, you do not have enough disk space to decompress the setup files.

3. Follow the prompts to install the seed data files.

3. On the same Windows workstation, select Start > Programs > Candle OMEGAMON XE > Manage Candle Services.

4. From the Actions menu in the Manage Candle Services window, select Advanced > Seed CMS....

5. On the Seed CMS window, select On a different computer and click OK.

6. When you are prompted to ensure that the Candle Management Server is configured and running, click OK.

7. On the Non-Resident CMS Connection dialog, provide the CMS Node ID, which you can find as the value of the CMS_NODEID variable in this location:

&RHILEV..&SYS..RKANPAR(KDSENV)

8. Select the appropriate communications protocol and click OK.

9. In the next dialog, provide any values required by your communications protocol. (For example, if your protocol is TCP/IP, the dialog prompts you for the TCP/IP host name and port number of the Candle Management Server to be seeded.)

10. On the Select Product to Seed CMS dialog, select the products whose seed data you want to add to the Candle Management Server configuration, and click OK.

11. When the seeding is complete (this might take several minutes), the Seed Data Operation Complete dialog gives you information about seeding status and seed data location. If desired, click Save As to save the information in a text file. Click Close to close the dialog.

111


Registering the agent with a remote Candle Management Server on z/OS

1. Start the Configuration tool in the CSI where the Candle Management Server is installed, and navigate to the Runtime Environments (RTEs) panel. For instructions, see “Setting up Your Configuration Environment” on page 69.

2. Enter C (Configure) to select the runtime environment where the Candle Management Server resides.

3. On the Product Selection Menu, select the product you want to configure. (That is, the component you will register with the Candle Management Server.)

4. On the Configure panel for the product you selected, select Register with local CMS.

5. Review the JCL and submit the job.

6. Press F3 until you return to the Runtime Environments (RTEs) panel.

7. Enter L to load the target libraries to the runtime libraries for the runtime environment.

8. To exit the Configuration tool, press the END key repeatedly until you return to the TSO Command Processor.

Registering with and seeding a Candle Management Server on WindowsIf the Candle Management Server is installed on Windows, you will install the seed data on the Windows workstation that hosts the Candle Management Server. Then you will use Manage Candle Services to seed the Candle Management Server and register the agent with it in a single operation.

1. Under a user ID with Administrator authority, log onto the Windows workstation that hosts the Candle Management Server.

2. If you have not already configured and started the Candle Management Server, do so now. For instructions, see Installing and Setting up OMEGAMON Platform and CandleNet Portal on Windows and UNIX.

3. Insert the IBM Tivoli OMEGAMON Data Files for z/OS CD into the CD-ROM drive.

Installation begins automatically. If the InstallShield Wizard does not start, go to CD directory WINDOWS and run setup.exe. If setup.exe initialization failes, you do not have enough disk space to decompress the setup files.

4. Follow the prompts to install the seed data files.

5. On the same Windows workstation, select the Start > Programs > Candle OMEGAMON XE > Manage Candle Services..

6. From the Actions menu in the Manage Candle Services window, select Advanced > Seed CMS...

7. On the Seed CMS window, select On this computer and click OK.

8. On the Select Product to Seed CMS dialog, select the products whose seed data you want to add to the Candle Management Server and click OK.



9. When the seeding is complete, the Seed Data Operation Complete dialog gives you information about seeding status and seed data location. If desired, click Save As to save the information in a text file. Click Close to close the dialog.

Registering with and seeding a remote Candle Management Server on UNIX (GUI)If the Candle Management Server is installed on UNIX, you will install the seed data on the UNIX system that hosts the Candle Management Server. Then you will use Manage Candle Services to seed the Candle Management Server and register the agent with it in a single operation.

1. If you have not already configured and started the Candle Management Server on the UNIX system, do so now. For instructions, see Installing and Setting up OMEGAMON Platform and CandleNet Portal on Windows and UNIX.

2. Mount the IBM Tivoli OMEGAMON Data Files for z/OS CD into the CD-ROM drive.

3. From the root directory of the CD-ROM on the system that hosts the Candle Management Server, execute install.sh:

./install.sh -h $candlehome

where $candlehome is the home directory for the OMEGAMON Platform and Tivoli OMEGAMON XE products on the system.

4. Enter y in response to the prompt asking whether you want to use the existing $candlehome directory.

5. Enter 1 to select the GUI installation.

6. Click Install in the left column of the Welcome dialog, then click Install in the menu bar at the bottom of the dialog.

7. On the Select Products to Install dialog, use the drop-down list to select _CMS data for products running on UNIX.

8. Use the checkboxes to select all the products you have installed, and click Install.

The Manage Candle Services dialog opens and displays messages like these:

Installing CMS data for < agent>, please wait...Changed access permissions on <$ candlehome> to < pattern>.Executing permissions script.Permission script finished.

9. In Manage Candle Services, right-click Candle Management Serverand select Seed >Advanced Seed.

10. On the Seed Products dialog, select all the products you want to seed, and click Seed.

The Candle Management Server is started, if it is not already running. Messages like these will appear:

Copying CAT and ATTR files.Starting CMS, please wait...Executing Candle Management Server startup script.CMS started.Seeding for < agent>.

113


Seeding complete.Stopping CMS.

Registering with and seeding a remote Candle Management Server on UNIX (command line)

If the Candle Management Server is installed on UNIX, you will install the seed data on the UNIX system that hosts the Candle Management Server. Then you will seed the Candle Management Server and register the agent with it in a single operation.

To complete this process successfully, the Candle Management Server must be in the same $candlehome structure as defined by the $candlehome environment variable or the command-line -h option. Scripts are located in $candlehome/bin.

1. If you have not already configured and started the Candle Management Server on the UNIX system, do so now. For instructions, see Installing and Setting up OMEGAMON Platform and CandleNet Portal on Windows and UNIX.

2. Mount the IBM Tivoli OMEGAMON Data Files for z/OS CD into the CD-ROM drive.

3. From the root directory of the CD-ROM on the system that hosts the Candle Management Server, execute install.sh:

./install.sh -h $candlehome

where $candlehome is the home directory for the OMEGAMON Platform and Tivoli OMEGAMON XE products on the system.

4. Enter y in response to the prompt asking whether you want to use the existing $candlehome directory.

5. Enter 2 to select the command-line installation.

6. When you are prompted to select an operating system, enter the line number for the Candle Management Server running on UNIX.

7. Enter y to accept the selection.

8. Enter the numbers that correspond to the products for which you want to install seed data.

9. Enter y to accept the selection.

10. When you are prompted to select another operating system, enter n.

11. To seed the Candle Management Server with the data you just installed, execute the CandleSeed command:

./CandleSeed -t cms_name pc pc pc pc pc ...

where pc is the two-character product code for your product.

12. Stop the Candle Management Server by entering this command:

./CandleServer stop cms_name

13. Restart the Candle Management Server by entering this command:

./CandleServer start cms_name

Verifying the Configuration


Verifying the Configuration

Prerequisites for verifying the configurationIn addition to completing the configuration for the product, you must also have:

� completed the configuration of the interface you want to use

� completed the configuration of the Candle Management Server on the appropriate platform (including seeding the Candle Management Server using the interface)

Process to follow to verify the configuration Follow this process to verify the configuration by starting the product. Follow this process only if the Candle Management Server is installed on z/OS.

Figure 1. Process for Verifying the Configuration

For step-by-step instructions on how to start the Candle Management Server, see “Starting and Stopping the Candle Management Server” on page 131.

If the Candle Management Server is not already running, vary the CandleManagement Server VTAM major node active.

.

If the Candle Management Server is not already running, start the started task for the Candle Management Server.

Using the CandleNet Portal interface, connect to the Hub Candle Management

Server and verify that the data for the product is being displayed.

115

Using the Candle Management Server Error Log


On z/OS, the RKLVLOG sysout dataset contains all the information and error messages that you will need when reporting problems to IBM Software Support.

Optionally, the RKPDLOG sysout dataset contains the information and error messages related to the handling of persistent data stores.

Candle Management Server error log on WindowsOn Windows, the Candle Management Server log is in $CandleHome$\CMS\Logs\kmsras1.log.

Additional messages can be found in $CandleHome$\CMS\cms.msg and $CandleHome$\CMS\kdsmain.msg.



117

Completing the Customization

IntroductionThis chapter contains information about the manual steps you must perform outside of the Configuration tool to complete the customization for the Candle Management Server.

Chapter contentsDetermining the Topics to Use in this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Migration: Reviewing Migration Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Migration: Grooming User-Customized Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Migration: Migrating User-Customized Objects from Version 350 to Version 360 . . . 121Migration: Restoring User-Customized Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Security: Reviewing Candle Management Server Security Requirements . . . . . . . . . 123Security: Setting Up Candle Management Server Security . . . . . . . . . . . . . . . . . . . . 124Security: Defining for RACF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Security: Defining for CA-ACF2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Security: Defining for CA-TOP SECRET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Security: Defining for Network Access Method (NAM) . . . . . . . . . . . . . . . . . . . . . . . 128

7




This chapter contains topics that correspond to the tasks in Checklist: Customizing the Candle Management Server Outside of the Configuration Tool in Chapter 1.

Determine the topics to use in this chapterIf you are not sure of the topics you will need in this chapter or you are not using a checklist, review the matrix to determine the pages to use in this chapter.

The table contains only steps you perform to customize the product for your site and are not required to make the product operational. All of the topics in this chapter are optional (O).

Table 40. Completing the Customization by Setting up Security


119 120 121 122 123 124

125—

128

Defining your security system for the Candle Management Server

O

Reviewing migration requirements O

Grooming user-customized objects O

Migrating user-customized objects O

Restoring user-customized objects O

Reviewing the Candle Management Server security requirements

O

Setting up your Candle Management Server security

O

119

Migration: Reviewing Migration Requirements

Migration: Reviewing Migration Requirements

If you are creating a new Candle Management Server Version 360-based runtime environment and you want to copy customized objects from a previously-defined Candle Management Server Version 350-based runtime environment, see “Follow these steps to migrate objects from Version 350 to Version 360. This step is required if you create a new runtime environment and you would like to use the Version 350 user-customized objects.” on page 121.

You do not need to migrate if you are using the runtime environment you used for Candle Management Server Version 350.

Object migration jobThe object migration job copies modified product-provided situations, templates, and managed objects (referred to as objects) created in Version 350 architecture, to the Version 360 architecture.

Migration processAt a high-level, the migration process includes:

� grooming the Candle Management Server objects from the previous version of the Candle Management Server

� installing the new version of the Candle Management Server and registering products, as required

� stopping both the previous and the new versions of the Candle Management Server

� archiving the Candle Management Server objects for the new version of the Candle Management Server

� executing the migration job

Migration: Grooming User-Customized Objects


Migration: Grooming User-Customized Objects

Grooming is defined as:

� copying modified product-provided objects from a previous Candle Management Server version to similar objects with customer-unique names

� removing all unused or unwanted objects

� identifying all installed products

In general, the grooming process lets you copy customer-unique objects from a previous Candle Management Server version, and remove unwanted objects prior to migration to the new Version 360 runtime environment.

Grooming processIf you have modified the product-provided objects, you will have to copy them (using “Create Another”) to objects with different names, to preserve the information they contain when you migrate. During the migration process, Version 360 names take precedence over Version 350 names to make migration a success.

We recommend you groom your customer-unique objects from your previous Candle Management Server version prior to executing the migration job.

Note: Important: If you use the product-provided object migration utility to migrate product-provided situations for distributed products, you must seed the Version 360 Candle Management Server with seed data for each IBM distributed product on the Candle Management Server. You must perform this task even if you do not intend to install the distributed products on the Version 360 Candle Management Server at this time.

121

Migration: Migrating User-Customized Objects from Version 350 to Version 360

Migration: Migrating User-Customized Objects from Version 350 to Version 360

Follow these steps to migrate objects from Version 350 to Version 360. This step is required if you create a new runtime environment and you would like to use the Version 350 user-customized objects.

1. Log onto a CandleNet Portal that connects to your Version 350 Candle Management Server.

2. Groom your Version 350 objects as required. If no grooming is needed or has already been performed, continue to the next step.

3. From a z/OS operator console, stop the Candle Management Server started task using the MVS STOP or MODIFY command as follows:

� P proc for MVS STOP

� F proc, SHUTDOWNfor MODIFY

4. To back up your Version 350 user-defined objects prior to migration, log onto ISPF and edit thilev.TKANSAM (KDSDMG2A).

Follow the instructions provided with the job content to edit the JCL with site values. Submit the job.

5. To migrate your Version 350 user-defined objects to Version 360, edit thilev.TKANSAM (KDSDMG2B).

Follow the instructions provided in the job to edit the JCL with site values. Submit the job.

6. Continue with “Follow these steps to restore your Version 350 objects.” on page 122.

Migration: Restoring User-Customized Objects


Migration: Restoring User-Customized Objects

Follow these steps to restore your Version 350 objects.

1. From a z/OS operator console, stop the Candle Management Server started task using the MVS STOP or MODIFY command as follows:� P proc

for MVS STOP

� F proc, SHUTDOWNfor MODIFY

2. Log onto ISPF. For Version 350, edit thilev.TKANSAM (KDSDMG2C).

3. Follow the instructions provided in the job to edit the JCL with site values. Submit the job.

123

Security: Reviewing Candle Management Server Security Requirements

Security: Reviewing Candle Management Server Security Requirements

The first time you configure the Candle Management Server, configure it with security turned off.

Before adding security to your Candle Management Server,

� configure all products and verify that they are operating properly. See your product-specific Configuration Guide for details.

� if you choose a third-party security package, verify that it is installed and configured properly for your site

� if you are an IBM Tivoli OMEGAMON II for MVS user and you choose a third-party security package to secure your Candle Management Server, you must use the same package to secure IBM Tivoli OMEGAMON II for MVS.

Supported security packagesCandle Management Server security is based on password validation using either the security feature called NAM (Network Access Method) or one of the following third-party security packages:

� RACF

� CA-ACF2

� CA-TOP SECRET

Changing the security system specificationWhen you create the runtime members for the Candle Management Server, appropriate parameters are generated for the security system that you selected.

If you must convert to another security system, change the security system specification using the Update Runtime Environment panel. For the change to take effect, you must recreate the runtime members for the Candle Management Server before you recycle the Candle Management Server started task.

Security: Setting Up Candle Management Server Security


Security: Setting Up Candle Management Server Security

This section provides the generalized steps that are valid for all supported security systems. Depending on the security system you are using, additional steps must be performed outside of the Configuration tool as described in the following sections.

Note: You must first decide which of the security systems you will use. If you choose a third-party security package, verify that it is installed and configured properly for your site.

General procedureFollow these steps to set up Candle Management Server security.

1. Your security administrator must define, to your security system, each logon ID that will be allowed to access the Candle Management Server. Logon IDs are passed from CandleNet Portal or from CMW to the Candle Management Server when you log on. To log on successfully with security enabled, logon IDs passed from the CMW or from CandleNet Portal must be pre-defined to the security system used by the Candle Management Server.

You may want to define a generic logon ID; for example sysadmin.

2. Define the security system to be used by the Candle Management Server.

You specify the security system on the the Configuration tool Runtime Environments panel when you add or update an runtime environment. This example uses RACF:

Security system ==> RACF (RACF, ACF2, TSS, NAM, NONE)

3. Enable security validation.

On the the Configuration tool Specify CMS Configuration Values panel, change the default of N on this field:

Security validation? ==> N (Y, N)

Warning: Do not enable security validation until your security is set.

4. Locate the section in this chapter for the security system you are using and follow the specified instructions.

125

Security: Defining for RACF

Security: Defining for RACF

Follow these steps to implement RACF security.

1. If your Candle Management Server is running, stop it by typing: P cccccccc

where cccccccc is the name of your Candle Management Server started task.

2. If your site has a large numbers of users, you may need to increase the value assigned to the RESERVE parameter of member KDSSYSIN in the hilev.midlev.RKANPAR library. This is an unlikely event.

Contact IBM Sofware Support, if necessary.

3. Restart your Candle Management Server by typing:

S cccccccc


Security: Defining for CA-ACF2


Security: Defining for CA-ACF2

Follow these steps to install an exit for CA-AF2 security validation.



2. Follow the instructions in KLVA2NEV to assemble and link KLVA2NEV. Change the -RHILEV- and -THILEV- variables as directed. Member KLVA2NEV in hilev.midlev.TKANSAM is the product-supplied interface to CA-ACF2. The product-supplied member KLV@ASM, in hilev.midlev.RKANSAM, contains sample assembly JCL.

Note: The -RHILEV- variable that the SYSLMOD DD should point to, depends on the runtime environment type that you defined for your Candle Management Server.

� For SMP-sharing runtime environments, assemble the exit into RKANMOD. SMP-sharing runtime environments allocate their own private RKANMOD, but do not allocate an RKANMODL.

� For FULL, BASE, or BASE-SHARING RTEs, assemble the exit in RKANMODL.

� For runtime environments that share with a FULL RTE, this job does not apply, as the master runtime environment (the FULL) customizes the module.

3. Define the Candle Management Server started task as a MUSASS to CA-ACF2:

A. Log onto TSO. At the READY prompt, type ACF and press Enter.B. At the ACF prompt, type SET LID and press Enter.C. At the LID prompt, type CH cccccccc MUSASS,

where cccccccc is the name of the Candle Management Server started task. Press Enter.

D. At the LID prompt, type END and press Enter.E. If your site has large numbers of users, you may need to increase the value

assigned to the RESERVE parameter of member KDSSYSIN in the hilev.midlev.RKANPAR library. This is an unlikely event. IBM Software Support, if necessary.


S cccccccc


127

Security: Defining for CA-TOP SECRET

Security: Defining for CA-TOP SECRET

Follow these steps to implement CA-TOP SECRET security.



2. Define the Candle Management Server as a started task in the STC record and relate it to a master facility accessor identifier. For example:

TSS ADD(STC) PROC(cccccccc) ACID(master_facility_acid)

where cccccccc is the name of your Candle Management Server started task. The value for master_facility_acid may be the same as cccccccc.

3. Define the name of your Candle Management Server started task as a FACILITY in the CA-TOP SECRET Facility Matrix Table. Set the SIGN parameter as SIGN(M) and set MODE to MODE=FAIL. Make sure the name of your Candle Management Server started task and the FACILITY name match.

Example: This example shows FACILITY statements for a site that uses CA-TOP SECRET. Some statements may not be relevant to your site or might need to be modified to fit the standards and configuration of your site.

FACILITY(USER3=NAME=task)

FACILITY(task=MODE=FAIL,ACTIVE,SHRPRF)

FACILITY(task=PGM=KLV,NOASUBM,NOABEND,NOXDEF)

FACILITY(task=ID=3,MULTIUSER,RES,WARNPW,SIGN(M))

FACILITY(task=NOINSTDATA,NORNDPW,AUTHINIT,NOPROMPT,NOAUDIT,NOMRO)

FACILITY(task=NOTSOC,LOG(INIT,SMF,MSG,SEC9))


S cccccccc


Security: Defining for Network Access Method (NAM)



You can use the product-provided security feature NAM (Network Access Method) to secure your Candle Management Server.

You enable NAM, an alternative to third-party security packages, from either the CT/Engine operator facility or from the system console using the MVS MODIFY command. Instructions are given below for both methods.

Adding users to NAM from CT/EngineFollow these steps to add users to NAM from the CT/Engine.

1. Log on to a CT/Engine session using the CT/Engine operator logon applid.

2. Define a password for a user who will access the Candle Management Server:

NAM SET userid PASSWORD=password

where userid is the user ID and password is the NAM password you want to define for that user.

Repeat the above command for every user who will access the Candle Management Server.

Adding users to NAM from the z/OS system consoleFollow these steps to add users to NAM from the z/OS system console.

1. Access the z/OS system console.

2. Define a password for each user who will access the Candle Management Server:

F cccccccc,NAM SET userid PASSWORD=password

where cccccccc is the name of your Candle Management Server started task, userid is the user ID, and password is the NAM password you want to define for that user

Adding a userid password file to NAMIf you are defining passwords for a large number of users, you may want to use the procedure below. It enables you to set up a file containing all your NAM SET statements and execute the file once to define all passwords.

1. Access rhilev.midlev.RKANCMD and create member userids.

2. Edit userids, and populate it with a NAM SET command for each user who will access your Candle Management Server.

Example:

NAM SET userid1 PASSWORD=password1



129


Note: Make sure there is sufficient security on the RKANCMD library, as it now contains sensitive information.

3. Execute member userids as follows:

� From the CT/Engine operator facility enter this command:

userids

� From the z/OS system console, enter this command:

F cccccccc,userids




131

Starting and Stopping theCandle Management Server

IntroductionThis chapter contains information about the steps you must perform outside of the Configuration tool to start and stop the Candle Management Server on the z/OS platform.

Chapter contentsStarting the Candle Management Server on z/OS . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Stopping the Candle Management Server on z/OS . . . . . . . . . . . . . . . . . . . . . . . . . . 133

8

Starting the Candle Management Server on z/OS


Starting the Candle Management Server on z/OS

If you installed and configured the Candle Management Server on z/OS, follow these steps to start the Candle Management Server.

1. From a z/OS operator console, vary the Candle Management Server VTAM major node active using the following command:

VARY NET,ACT,ID=ccccccccc

where ccccccccc is the name in the VTAM system definition library (VTAMLST) for the Candle Management Server VTAM major node.

Note: During configuration of the Candle Management Server, the VTAM definition is copied from rhilev.midlev.RKANSAM to the VTAM system definition library called VTAMLST.

2. Start the started task for the Candle Management Server, using the following z/OS command:

START jobname

where jobname is the started task name you specified for the Candle Management Server during the configuration.

133

Stopping the Candle Management Server on z/OS


To stop the Candle Management Server on z/OS, issue the command

P jobname

where jobname is the started task name you specified for the Candle Management Server during configuration.



135

Updating the Configuration

IntroductionThis chapter contains information about updating and changing your configuration.

Chapter contentsUpdating and Changing the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

9

Updating and Changing the Configuration


Updating and Changing the Configuration

If the changes you make using the Configuration tool are to configuration values that also require manual steps outside of the Configuration tool, then you must also perform the steps outside of the Configuration tool.

For example, if you are using the persistent data store and you change the prefix for the procedure using the Configuration tool, you must also copy the renamed procedure to your PROCLIB.

For step-by-step instructions for these tasks, see Chapter 6 in this guide.

Overview of the process for updating or changing your configurationThe illustration shows the process for updating or changing your configuration.

Figure 2. Process for Updating and Changing Your Configuration

.Using the Configuration tool, make the changes you want to the configuration.

.

On the Runtime Environments (RTEs) panel, use the L (Load all product libraries after SMP/E) to load the target libraries to the runtime libraries.

If the changes are to values that require manual steps outside of the

Configuration tool to complete the configuration, perform the appropriate steps.

137

Batch Mode Processing

IntroductionThis chapter provides detailed instructions on using the Configuration tool batch mode processing to

� create a new runtime environment by running a single batch job

� replicate an existing runtime environment

� transport a replicated runtime environment to other z/OS images

Chapter contentsUsing Batch Mode Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Planning Your Runtime Environment Replication Process. . . . . . . . . . . . . . . . . . . . . 139Creating Batch Mode Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Adding and Configuring Product Parameter Decks (Optional) . . . . . . . . . . . . . . . . . 143Transporting the Runtime Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

10

Using Batch Mode Processing


Using Batch Mode Processing

Batch mode processing using the Configuration tool is an alternate way of building and configuring an runtime environment. Instead of using the interactive Configuration tool to build and configure an runtime environment, you can submit a single batch job that performs all of the same processing.

Configuration tool batch mode componentsThe components of batch mode processing in the Configuration tool include:

Considerations when creating the Configuration tool batch jobYou create the Configuration tool batch job only once on an image. It can then be used for all subsequent batch mode processing on that image.

Notes:� You must recreate the Configuration tool batch job if your ISPF environment has

changed.

� When the SUBMIT parameter is set to YES, the generated runtime environment configuration jobs are submitted for execution automatically if the job names do not currently exist in the INSTJOBS library. If the generated jobs already exist, then the jobs are regenerated but not automatically submitted for execution.

� The JCL suffix must be unique for each runtime environment, because when the Configuration tool batch job runs, it is used in every member name that is generated in INSTJOBS. If the suffix is not unique, the jobs that are generated will conflict with other runtime environment jobs that may already exist in INSTJOBS.

Table 41. Batch Mode Components

Configuration tool batch job (CICATB)

CICATB is a new job that is generated into the INSTJOBS library. You submit this job to build and configure an runtime environment.

Configuration tool batch parameter member

This is a single member in INSTJOBS, that contains all of the configuration values for all products to be configured in the runtime environment.

RTE Utility to create Configuration tool batch parameter member

This utility creates the batch parameter member for an existing runtime environment, which can then be used for subsequent CICATB job executions. The name of the parameter member is the runtime environment name.

139

Planning Your Runtime Environment Replication Process


Batch mode processing in the Configuration tool is tailored for installations that want to replicate an existing runtime environment onto any number of z/OS images.

Once you have interactively created and configured an runtime environment for your products, the Configuration tool batch mode processing option allows you to collect those parameters and replicate the runtime environment onto any local or remote z/OS image.

The Configuration tool batch mode process involves the following three broad steps:

� creating batch mode parameters

� adding and configuring parameter input decks

� creating the new runtime environment on the appropriate z/OS image, using the appropriate runtime environment transportation method

Note: Once an runtime environment has been created in batch mode, it can later be accessed and further configured using the interactive Configuration tool.

Create batch mode parametersIn this step, you invoke the Create batch mode parameters processing option to export an existing runtime environment’s parameters into a library member.

You then copy the member and change the image-specific parameters, as necessary, to configure the runtime environment for its new environment.

Add and configure parameter input decks (optional)In this step, you edit the newly created member and invoke Configuration tool edit macros to add additional product parameter decks to it.

Once you have finished adding products to the member, configure the product by changing the default parameter values as required.



Create a new runtime environment on the appropriate z/OS image using the appropriate runtime environment transportation method

In this step, you create the new runtime environment on the appropriate z/OS image using one of the following transport methods.

Table 42. Runtime Environment Transport Methods

Transport Method

This method uses... Advantages & Disadvantages

Define RTE on local z/OS image using shared DASD

interactive and batch mode Configuration tool on the local z/OS image, to create an runtime environment accessible to the target image.

Advantages of this method:� The interactive Configuration

tool, located on the local image, contains the configuration information for all images.

� Only one copy of the runtime libraries is created.

� Only one batch job is submitted.

The disadvantage of using this method is that this is only applicable for z/OS images with shared DASD.

Transport RTE from local image to remote image

interactive and batch mode Configuration tool on the local image to create an runtime environment.

Once the runtime environment has been defined, you use sample transport jobs to ship the runtime libraries and parameters to the remote image.



� Only one batch job is submitted.� This is applicable for remote

z/OS images that do not share DASD.

The disadvantage of using this method is that two copies of the runtime libraries are created.

141


Transport RTE batch jobs from local z/OS image to remote image

interactive and batch mode Configuration tool on the local image to create a set of batch jobs that can build an runtime environment.

Once created, you use sample transport jobs to ship the batch jobs to the remote image. The jobs are manually submitted on the remote image to create the runtime libraries and parameters.



� This is applicable for remote z/OS images that do not share DASD.


The disadvantage of using this method is that you must manually submit a series of batch jobs, or use the Auto Submit CLIST to submit the jobs that will create the runtime environment.

Transport RTE batch mode parameters from local z/OS image to remote image equipped with the Configuration tool

interactive Configuration tool on the local image to export an existing runtime environment.

Once the runtime environment parameters have been collected, you use the sample transport jobs to ship the batch mode parameters to the remote image.

The batch mode Configuration tool is run on the remote image to create the runtime libraries and parameters.

Advantages of this method:� This is applicable for remote

z/OS images that do not share DASD.


� Only one batch job is submitted.

The disadvantage of using this method is that the interactive Configuration tool located on the local image does not contain the configuration information for all images.

Table 42. Runtime Environment Transport Methods (continued)

Transport Method

This method uses... Advantages & Disadvantages

Creating Batch Mode Parameters


Creating Batch Mode Parameters

You can generate parameter decks for all products within an existing runtime environment, and then copy the information into a new library member to be used during batch mode processing.

Follow these steps to generate the runtime environment parameters and copy the information into a new library member.


2. Create the new library member:

A. Type Z next to the runtime environment you want to replicate and press Enter.B. From the RTE Utility Menu, select Create batch mode parameters and press

Enter.C. Specify the library that will receive the batch parameter member generated by the

Configuration tool. D. The INSTJOBS library is specified by default, and the member name will be the

same as that of the current runtime environment.E. Press Enter.

3. Exit the Configuration tool.

4. Edit the INSTJOBS library and copy the exported library member to a new member name. This new member name will also be used as the name of the new runtime environment.

5. Using ISPF Option 2, edit the new library member to reflect the settings specific to the z/OS image where the new runtime environment will exist.

143

Adding and Configuring Product Parameter Decks (Optional)


You can add parameter decks for additional products to the newly created library member.

Follow these steps to add and configure parameter decks for additional products.

1. Start the Configuration tool on your local image.

2. Generate KCISETUP in your INSTLIB:

A. Starting from the Main Menu, select Configure Products > Services and utilities > Create batch mode job.

B. Press Enter.Note: KCISETUP needs to be created once on an image and can be used for all

subsequent parameter deck processing on that image. KCISETUP must be recreated if your ISPF environment has changed, or you subsequently split your INSTLIB.


4. Set the environmental variables required to run the the Configuration tool edit macros:

A. Log onto a TSO session, invoke ISPF, and then go to TSO command mode (Option 6 in ISPF).

B. Enter the following command:EX ‘shilev.INSTLIB(KCISETUP)’

where shilev is the high-level qualifier.

5. Using ISPF Option 2, edit the library member that was created using “Creating Batch Mode Parameters” on page 142, entering the following on the command line:

� For SMP/E installs, enter:

KCICPGEN Kppvvv

where pp is the two-letter component code for the product you are configuring, and vvv represents the version of that product.

Note: Only supply the component code and version that identifies the package you purchased. Underlying components that make up the package will be included.

Repeat the above command until a parameter deck is generated for all the products you want to add.

� For a Quick Install, enter:

KCICPGEN QI

The KCICPGEN command invokes the Configuration tool edit macro, which uses the Kppvvv or QI parameter within the command string to locate the correct product information (PI) member within INSTDATA. Once it finds the PI member, the edit macro scans the file and builds a list of all components and parameters required for the specified product. A product that already exists within the library member is not replaced.



6. Change the product parameter values within the library member as required. The values displayed represent default settings.

7. Once you have finished editing the library member, save your changes. The library member is now ready for batch processing.

145

Transporting the Runtime Environment


Use any of the following the transport methods to create the new runtime environment on the appropriate z/OS image.

� Define an runtime environment on a local z/OS image using shared DASD

� Transport an runtime environment from a local z/OS image to a remote image

� Transport runtime environment batch jobs from a local z/OS image to a remote image

� Transport runtime environment batch mode parameters from a local z/OS image to a remote image

Before using the transport methods within this section, make sure that sufficient space and library security authorizations exist.

For a list of the advantages and disadvantages for each transport method see “Create a new runtime environment on the appropriate z/OS image using the appropriate runtime environment transportation method” on page 140.

Define a runtime environment on a local z/OS image using shared DASDFollow these steps to define an runtime environment on a local z/OS image using shared DASD.


2. Create the Configuration tool batch mode job:

A. Starting from the Main Menu, select Configure products > Services and utilities > Create batch mode job.

B. Press Enter.


4. Perform a scan on your runtime environment parameters:

A. Edit CICATB, updating the BATCHLIB and BATCHMEM parameters as necessary, and setting the SUBMIT parameter to SCAN.

B. Submit the CICATB job to scan your runtime environment parameters. C. Verify that the job completes successfully; review the parameter report; correct

any errors in the parameter member; repeat the scan until a clean report is generated.

5. Create a new runtime environment that is accessible to the target image:

A. Edit CICATB again, setting the SUBMIT parameter to YES. This submits the runtime environment configuration jobs that allocate and populate runtime libraries.

B. Submit the CICATB job to create the runtime environment. C. Verify that the job completes successfully.



6. Perform any manual configuration steps on the target image, such as

� copying procedures to PROCLIB

� copying VTAM definitions to VTAMLST

� APF-authorizing libraries

Transport RTE from a local z/OS image to a remote imageFollow these steps to transport an runtime environment from a local z/OS image to a remote image:


2. Create the Configuration tool batch mode job:


B. Press Enter.






5. Create a new runtime environment that is accessible to the target image runtime environment:



6. Start the Configuration tool again.

7. Select the runtime environment you want to transport:

A. Access the Runtime Environments (RTEs) panel. (From the Main Menu, select Configure products > Select product to configure, and then select a product.)

B. Type Z next to the runtime environment you want to transport and press Enter.

8. On the RTE Utility Menu, select Generate sample transport JCL and press Enter. This action will cause several sample transport jobs to be generated within the RKANSAM library. Member $XPRTNDX provides a description of all generated members.

147


For example, to use DFDSS to transport the runtime libraries to the target image, use sample job

� XDFDMP01 on the master image to dump the runtime libraries

� XDFRST01 on the target image to restore the runtime libraries

Result: You have now successfully transported a new runtime environment to the target image.





Transport RTE batch jobs from a local z/OS image to a remote image equipped with the Configuration tool

Follow these steps to transport runtime environment batch jobs from a local z/OS image to a remote image that is equipped with the Configuration tool.


2. Create the the Configuration tool batch mode job:


B. Press Enter.






5. Create the runtime environment generation jobs:

A. Edit CICATB again, setting the SUBMIT parameter to NO. This creates the runtime environment configuration jobs that allocate and populate runtime libraries.

B. Submit the CICATB job to create the runtime environment generation jobs. C. Verify that the job completes successfully.

Result: You have now successfully created a set of runtime environment configuration batch jobs that must be transported to the target image.

6. Start the Configuration tool again.






8. On the RTE Utility Menu, select Generate sample transport JCL and press Enter. This will cause several sample transport jobs to be generated within the RKANSAM library. Member $XPRTNDX provides a description of all generated members.

For example, to use DFDSS to transport the targets, INSTLIB, INSTDATA, and INSTJOBS to the remote image, use sample job

� XDFDMP03 on the master image to dump the batch jobs

� XDFRST03 on the target image to restore the batch jobs

9. Submit the batch jobs on the target image in the order listed in the Jobs Sorted By Generation Sequence section of the the Configuration tool Batch Mode job report.

You can submit each job manually or use the Auto Submit CLIST to automatically submit the the Configuration tool jobs on the target image. To use the Auto Submit CLIST:

A. Verify that the SMP/E target libraries are available on this image upon which the CLIST will be executed.

B. Edit the member named SUB#jclsuffix in INSTJOBS, where jclsuffix identifies the JCL suffix for the new runtime environment.

C. Execute the CLIST to submit the the Configuration tool jobs that will create the runtime environment.

Result: You have successfully created a new runtime environment on the target image.





Transport RTE batch mode parameters from a local z/OS image to a remote imageFollow these steps to transport runtime environment batch mode parameters from a local z/OS image to a remote image.





149


3. On the RTE Utility Menu, select Generate sample transport JCL and press Enter. This will cause several sample transport jobs to be generated within the RKANSAM library. Member $XPRTNDX provides a description of all generated members.

For example, to use DFDSS to transport the targets, INSTLIB, INSTDATA, and INSTJOBS to the remote image, use sample job

� XDFDMP03 on the master image to dump the batch jobs

� XDFRST03 on the target image to restore the batch jobs

Result: You have successfully transported the batch mode parameters to the target image.

4. Create the Configuration toolbatch mode job:


B. Press Enter.






7. Create the runtime environment on the target image:









151

Enabling System Variable Support

IntroductionThis chapter provides detailed instructions for

� enabling system variable support

� using system variable support to run your products on any z/OS system

Chapter contentsBackground on System Variable Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Sample Usage Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Enabling System Variable Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Creating the System Variable Parameter Member . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Creating the VTAM Major Node Rename Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Creating a VTAM Major Node (One Node for All Products) . . . . . . . . . . . . . . . . . . . 159

11

Background on System Variable Support


Background on System Variable Support

System variable support provides you with an easy method of running software on any of your z/OS systems. The software is configured so that it becomes z/OS system-independent. It can then be ported and started on any z/OS system without extensive Configuration tool reconfiguration.

Note: For additional information, you can access the README file for system variable support by issuing the README SYS command.

By utilizing system variable support, the components inherit the system values for the system on which they are started (the host z/OS system). These system-specific values are then automatically loaded into dynamic in-memory parameter members that exist only for the duration of the component execution. The result is that the software runs correctly using the system-specific parameter values for the host z/OS system.

Benefits of using system variable support Following are some of the benefits of using system variable support:

� You can deploy the same software unit, consisting of any or all products, on any system without modification. LPAR-specific values are automatically resolved and substituted at product startup.

� The number of unique runtime environments required is less, which can translate into savings on DASD, CPU, and human time.

� The same started task JCL and the same VTAM node can be used on any system without modification.

� You can choose to use a single VTAM major node in place of the individual product major nodes. When generated, it will contain all VTAM applids for all products you have configured in the runtime environment.

Considerations when using system variable supportWhen using system variable support, you should consider the following:

� product started tasks (STCs) contain a new preprocessing step (STEP1 in the STC JCL). This new step resolves all system variable specifications in the product parameter members.

� product parameter members contain many variables, instead of values, that are resolved when the STC starts. For example, the members contain &SVXDSNV instead of the VSAM high-level qualifier value.

153

Sample Usage Scenario


The following steps describe the process for enabling and using system variable support.

1. Define and configure a runtime environment. During runtime environment configuration, specify the values to enable system variable support. See Chapter 5 for details on configuring a runtime environment.Note: Multiple runtime environments may be required depending on the runtime

environment structure (FULL, SHARING, BASE, or SMP/E), the Candle Management Server type (hub or remote), and variations in product mixtures.

2. Create the system variable parameter member.

After configuring an runtime environment, you can create the system variable parameter member. Each runtime environment contains one user system variable parameter member named RKANPAR(rtename), which contains all system-specific values.

See “Creating the System Variable Parameter Member” on page 157 for information on creating the rtename system variable parameter member in the RKANPAR library.

3. Create the VTAM major node rename job.

After configuring an runtime environment, you can create the VTAM major node rename job. This job creates VTAM major nodes on remote systems with names that are resolved from your system variable specification.

See “Creating the VTAM Major Node Rename Job” on page 158 for information on creating a VTAM major node rename job.

4. Create the runtime environment transport job.

The sample transport jobs are created using the RTE Utility option, “Generate sample transport JCL”. For more information on this option, see “Transporting the Runtime Environment” on page 145.

5. Copy the runtime environment to a remote system using the runtime environment transport job (or any other copy utility).

6. After the copy completes, edit the system variable parameter member RKANPAR (rtename). If necessary, set values for components running on other systems. For example, set values for a hub Candle Management Server running on a different LPAR.

7. Perform other remote system set-up tasks as required.

� Copy the new started tasks to your system procedure library. These started tasks have been enabled for system variables.

� If you are not using an existing system variable for runtime environment name on the LPAR, set the &SYSNAME system variable to the name of the runtime environment. This is set in SYS1.PARMLIB(IEASYMxx).



� If you are using VTAM system variable support, you must run the VTAM major node rename job. This job creates new major nodes that are named according to your system variable specifications. Once the new nodes are created, copy them to SYS1.VTAMLST.

� VSAM file allocation and seeding will most likely be required on every system.

8. Start the components.

155



You enable system variable support from the Add Runtime Environment panel. In an existing runtime environment, use the Update (U) command to enable system variable support.

Some older versions of products may not support the system variable feature. These products can exist in the same runtime environment and you will not need to reconfigure these products in the runtime environment.

Turn on system variable supportFollow these steps to enable system variable support.


2. Add a new runtime environment or update an existing runtime environment:

A. If you are adding a new runtime environment, type A in the Action field and specify all other required information. If you are updating an runtime environment, type U in the Action field.

B. Press Enter.C. On the first Add Runtime Environment panel, enter all of the required

information.D. Press Enter to access the second Runtime Environment panel.

3. Specify the following values to enable system variable support:

Important: If you change the status of system variable support in an existing runtime environment (on to off or vice versa), you must reconfigure all products in that runtime environment. This includes respecifying VTAM values and recreating runtime members.

Table 43. System Variable Values

Use z/OS system variables?

Specify Y to enable support. The default is N.

RTE name specification

Specify the system variable name by which the runtime environment is identified in the SYS1.PARMLIB LPAR system definition member. The default is &SYSNAME. This value becomes the value of the SYS parameter in all started tasks (for example, SYS=’&SYSNAME’).

Note: Resolved system variable values cannot exceed the length of the variable name (maximum length of 8 characters).



4. (Optional) Specify the following values on the second Add Runtime Environment panel to enable other functions:

5. When you have finished specifying the values to enable system variable support, press F3 until you return to the Main Menu.

Table 44. Add Runtime Environment Values

RTE base alias specification

If this runtime environment is sharing with a base runtime environment, specify an optional system variable specification for the base runtime environment.

This value will be inserted into the base runtime environment library references in all started tasks. The resolved name must be a valid library name qualifier. This field is commonly used to switch between base runtime environments at different maintenance levels.

You can use the runtime environment base alias as:� an easy way to switch runtime environment bases� an alternate way to refer to an existing baseNote: A label of n/a will be next to this field if the current runtime environment is not sharing with a base runtime environment.

Applid prefix specification

Specify the VTAM applid prefix that contains system variables. Be sure to place a period after the last symbolic in the specification. The resolved prefix can be a maximum of four characters. The default is K&SYSCLONE.

Use VTAM model applids?

If you want to use model applids (wildcards), specify Y.

Using model applids will generate VTAM nodes that contain applids with wildcard suffixes wherever possible. These wildcards allow usage of any applids that match the pattern within the VTAM node. The default is N.

157

Creating the System Variable Parameter Member

Creating the System Variable Parameter Member

After configuring a runtime environment, you can create the system variable parameter member.

Each runtime environment contains one user system variable parameter member named RKANPAR(rtename). All system-specific values are contained in this member.

Follow these steps to create the system variable parameter member, rtename, in the RKANPAR library.


2. Create the system variable parameter member:

A. Type Z next to the name of the runtime environment you have configured and press Enter.

B. On the RTE Utility Menu, select Create System Variable parameter member and press Enter. Result: The JCL that creates the system variable parameter member, CB#Vxxxx job, displays.

C. Review the JCL and submit the job. Verify that the job completed successfully. All return codes should be 0.

D. Edit the RKANPAR(PLEX220H) parameter member. Follow the directions to ensure proper resolution of cross-system variables.

3. When you have finished creating the system variable parameter member, press F3 until you return to the Main Menu.

Creating the VTAM Major Node Rename Job


Creating the VTAM Major Node Rename Job

After configuring a runtime environment, you can create the VTAM major node rename job. This job creates VTAM major nodes on remote systems with names that are resolved from your system variable specification.

Follow these steps to create a VTAM major node rename job in the INSTJOBS library.


2. Create the VTAM major node rename job:


B. On the RTE Utility Menu, select Create System Variable VTAM major node rename job, then press Enter. Result: The JCL that renames the VTAM major node, CB#7xxxx job, displays.

C. Review the JCL. Do not submit the job yet.

Note: You will submit this job on each remote system where the software is to run. The job is in the RKANSAM library.

3. When you have finished creating the VTAM major node rename job, press F3 until you return to the Main Menu.

159

Creating a VTAM Major Node (One Node for All Products)


A single VTAM major node can contain all the VTAM applids for all of the products you have configured in the runtime environment. This single major node is then used in place of the individual product major nodes.

If you choose to use a single VTAM major node, you must create it after all products have been configured in the runtime environment. Once the node is created and copied to your system VTAM system library (SYS1.VTAMLST), you vary it active and then start all of the components (started tasks).

Create a VTAM major nodeFollow these steps to create a single VTAM major node in the RKANSAM library.


2. Create the VTAM major node:


B. On the RTE Utility Menu, select Create VTAM major node (one node for all products) and press Enter.

C. On the Create VTAM Major Node panel, enter the name you want to use for the single node and press Enter. Result: The JCL that creates the single node displays.

D. Review the JCL and submit the job.Verify that the job completed successfully. All return codes should be 0.

3. When you have finished creating a single VTAM major node, press F3 until you return to the Configuration tool Main Menu.



161

ConfigurationScenarios

IntroductionThis chapter provides a series of scenarios for configuring products.

Chapter contentsUsing the Configuration Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Scenario 1: Rolling Out Products Across a 40 LPAR Enterprise (Standard Method) . 163Scenario 2: Rolling Out Products Across a 40 LPAR Enterprise (Common RKANPAR and Common RKANCMD Libraries) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Scenario 3: Replicating a Runtime Environment to Another LPAR Using Configuration Tool Batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Scenario 4: Replicating a Runtime Environment to Another LPAR Using Configuration Tool Batch Auto-submit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Scenario 5: Replicating an Runtime Environment on Same LPAR Using Batch Processing 174Scenario 6: Replicating a Runtime Environment Using Interactive Copy. . . . . . . . . . 176Scenario 7: Copying Configuration Values from One Configuration Tool to Another Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

12

Using the Configuration Scenarios


Using the Configuration Scenarios

The following table lists the supporting topics with detailed procedures in this manual and indicates which topic applies to each scenario.

Supporting Topics with Detailed Procedures

Scenarios

1 2 3 4 5 6 7

Installing Products

Note: For instructions on installing products, refer to the installation documentation for your product.

✓ ✓ ✓ ✓ ✓

Configure Products in Runtime Environments ✓ ✓ ✓ ✓ ✓ ✓ ✓

Creating the System Variable Parameter MemberCreating VTAM Major Node (One Node All Products)

✓ ✓

KCICPGEN: Generating the Batch Parameter Input Deck ✓ ✓ ✓

Create, Replicate, & Transport RTEs (Batch Mode Processing) ✓ ✓ ✓ ✓

Transport runtime environment batch mode parameters from a local z/OS image to a remote image

✓

Transport runtime environment batch jobs from a local z/OS image to a remote image equipped with the Configuration tool

✓

163

Scenario 1: Rolling Out Products Across a 40 LPAR Enterprise (Standard Method)


This scenario describes a standard Configuration tool method for rolling out products across your z/OS enterprise. You install and configure all products on your main LPAR, and then copy items from the main LPAR to other systems and LPARs throughout your enterprise.

Note: This particular scenario shows 40 LPARs. You can use this scenario for any number of LPARs at your site.

This scenario assumes that you are using:

� IBM symbolics on all your LPARs

� consistent naming conventions across all of your LPARs (dataset names, started tasks, and VTAM applids)

Pros and Cons of using this scenario

Procedure

1. Install all your products on Central Processor Complex (CPC) A, LPAR A1 (Main). Refer to the Program Directory for detailed installation instructions.This sets up one Configuration tool and one SMP/E environment that will be used to support all LPARs.

2. Create the RTE BASE on LPAR A1 (Main).

3. Create the SHARING RTE template on LPAR A1 (Main).

This runtime environment shares the RTE BASE, has system variables enabled, and is a superset configuration of what will run on other LPARs.

Note: If you are using a hub and remote Candle Management Server, create a hub SHARING RTE template and a remote SHARING RTE template.

Pros � Only 3 unique runtime environments need to be configured� Runtime environments are copied to other LPARs� 1 Configuration tool� Products use symbolic values defined on LPAR they run on� Fast rollout across enterprise� Consistency� Potential DASD savings

Cons � Cannot update runtime environments on other LPARs with the Configuration tool



4. After configuring your SHARING RTE template:

A. Create the system variable member. A. (Optional) Create the single VTAM major node. This will simplify VTAM set up.

5. Copy the RTE BASE datasets to LPAR B1 (Target), using any copy/rename method or the supplied Configuration tool transport runtime environment batch jobs. Keep the same dataset names, if possible.

6. Copy and rename the SHARING RTE template datasets to each execution LPAR, using any copy/rename method or the supplied Configuration tool transport runtime environment batch jobs. As the files are copied, rename them to match the execution LPAR name.

7. In each RKANPAR library, manually create a new system variable member that matches the name of the execution LPAR by copying the contents of the system variable member you created in step 4A. If necessary, in this new member change LPAR-specific values and update cross-system values for components running on different LPARs.

8. Set up your products on all other systems and LPARs in your enterprise. Repeat steps 5-7 for each system that exists in your enterprise.

Note: The following diagram shows two systems that contain 6 LPARs.

9. Complete your configuration. At a minimum you must:

� Copy the started tasks and VTAM major nodes to the system libraries.

� APF-authorize the datasets on the appropriate LPARs.

10. Start each of your products.

165


Legend: <item> = Copied from main LPAR A1

CPC A

Shared DASD within CPC A1 Configuration Tool and 1 SMP/E environment1 RTE BASE1 SHARING RTE A1 template2 copies SHARING RTE A1 template

LPAR A1 (Main)

Configuration Tool, SMP/E, Target libraries

RTE BASE

SHARING RTE A1 template

RKANPAR member A1

LPAR A3

<copy of SHARING RTE A1 renamed to A3>

RKANPAR member A3

LPAR A4


RKANPAR member A4

CPC B

Shared DASD within CPC B1 copy of RTE BASE3 copies SHARING RTE A1 template

LPAR B1 (Target)

<RTE BASE>

<copy of SHARING RTE A1 renamed to B1>

RKANPAR member B1

LPAR B4


RKANPAR member B4

LPAR B7


RKANPAR member B7

Scenario 2: Rolling Out Products Across a 40 LPAR Enterprise (Common RKANPAR and Common RKANCMD


Scenario 2: Rolling Out Products Across a 40 LPAR Enterprise (Common RKANPAR and Common RKANCMD Libraries)

This scenario describes another method for rolling out products across your z/OS enterprise. In the scenario you create a new common RKANPAR library and a new common RKANCMD library, that will contain all of the unique configuration values required by all of your LPARs. You install and configure all products on your main LPAR, and then copy items from the main LPAR to other LPARs throughout your enterprise.

Note: This particular scenario shows 40 LPARs. You can use this scenario for any number of LPARs at your site.

This scenario assumes that you are using:

� IBM symbolics on all your LPARs

� consistent naming conventions across all of your LPARs (dataset names, started tasks, and VTAM applids)


Procedure



3. Create the SHARING RTE template on LPAR A1 (Main).

This runtime environment shares the RTE BASE, has system variables enabled, and is a superset configuration of what will run on other LPARs.

Note: If you are using a hub and remote Candle Management Server, create a hub SHARING RTE template and a remote SHARING RTE template.

4. After configuring your SHARING RTE template:

Pros � 1 common RKANPAR and RKANCMD library for all LPARs� Only 3 unique runtime environments need to be configured� Runtime environments are copied to other LPARs� 1 Configuration tool� Products use symbolic values defined on LPAR they run on� Fast rollout across enterprise� Consistency� Potential DASD savings

Cons � Cannot update runtime environments on other LPARs with the Configuration tool

� Manual updates are required

167


A. Create the system variable member (RTE Utility Menu > Create System Variable parameter member).

B. Create common RKANPAR and RKANCMD datasets and then copy the runtime environment template datasets into these common datasets.

C. In the common RKANPAR, create additional system variable members as necessary. The names of these members match the other LPAR names. For each member, change LPAR-specific values as necessary. Review cross-system values for components on different LPARs.

D. Edit RKANSAM started tasks and change all occurrences of the RKANPAR/RKANCMD dataset names to the common dataset names. For example:

C ‘&RHILEV..&SYS..RKANPAR’ ‘common.RKANPAR’ all

C ‘&RHILEV..&SYS..RKANCMD’ ‘common.RKANCMD’ all

E. (Optional) Create the single VTAM major node. This will simplify VTAM set up.

5. Copy the following to LPAR B1 (Target), using any copy/rename method or the supplied Configuration tool transport runtime environment batch jobs:

� RTE BASE datasets

� common RKANPAR and RKANCMD datasets

Keep the same dataset names, if possible.

6. Copy and rename the SHARING RTE template datasets to each execution LPAR, using any copy/rename method or the supplied Configuration tool transport runtime environment batch jobs. As the files are copied, rename them to match the execution LPAR name.

7. Set up your products on all other systems and LPARs in your enterprise. Repeat steps 5-6 for each system that exists in your enterprise.

The following diagram shows 2 systems that contain 6 LPARs.




9. Start each of your products.



Legend: <item> = Copied from main LPAR A1

CPC A

Shared DASD within CPC A1 Configuration tool and 1 SMP/E environment1 RTE BASE1 SHARING RTE A1 template2 copies of SHARING RTE A1 template1 Common RKANPAR and RKANCMD

LPAR A1 (Main)

Configuration Tool, SMP/E, Target libraries

RTE BASE

SHARING RTE A1 template

Common RKANPAR RKANCMD with members A1, A3, A4, B1, B4, B7

LPAR A3


LPAR A4


CPC B

Shared DASD within CPC B1 copy of RTE BASE3 copies of SHARING RTE A1 template1 Common RKANPAR and RKANCMD

LPAR B1 (Target)

<RTE BASE>


<Common RKANPAR RKANCMD with members A1, A3, A4, B1, B4, B7>

LPAR B4


LPAR B7


169

Scenario 3: Replicating a Runtime Environment to Another LPAR Using Configuration Tool Batch


This scenario describes a method for creating an runtime environment on another LPAR using batch mode processing in the Configuration tool.


Procedure


2. Copy the Configuration tool and the SMP/E target libraries to CPC B, using any copy/rename method or the supplied Configuration tool transport runtime environment batch jobs.


4. Create SHARING RTE A1 on LPAR A1 (Main). This runtime environment shares the RTE BASE.

5. Create the Configuration tool batch parm deck for SHARING RTE A1.

6. Create a new batch parm deck for each of the other LPARs (A3, A4, B1, B4, and B7, as shown in the following diagram), by copying the contents of the SHARING RTE A1 batch parm deck.

7. In each new batch parm deck, review and modify the values accordingly.

8. Submit the Configuration tool batch job on CPC A for each LPAR in CPC A (A3 and A4). This creates the required runtime environments for CPC A.

9. Copy the batch parm decks for each LPAR in CPC B (B1, B4, B7) to the Configuration tool on CPC B.

10. Submit the Configuration tool batch job on CPC B for each LPAR in CPC B (B1, B4, B7). This creates the required runtime environments for CPC B.

11. Copy the RTE BASE datasets to the LPAR B1 (Target). Keep the same dataset names, if possible.

Pros � Less interactive Configuration tool work � Runtime environment creation with a single batch job� Runtime environment detail report

Cons � None






13. Start each of the products.

Legend: <item> = Copied from main LPAR A1{item} = Created with Configuration tool Batch

CPC A

Shared DASD within CPC A1 Configuration tool and 1 SMP/E environment (includes Target libraries)

1 RTE BASE3 Unique runtime environments

LPAR A1 (Main)

Configuration tool, SMP/E, Target libraries

RTE BASE

SHARING RTE A1

LPAR A3

{RTE A3}

LPAR A4

{RTE A4}

CPC B

Shared DASD within CPC B1 Configuration tool1 Copy of Target libraries

1 Copy of RTE BASE3 Unique runtime environments

LPAR B1 (Target)

Configuration tool, <Target libraries>

<RTE BASE>

{RTE B1}

LPAR B4

{RTE B4}

LPAR B7

{RTE B7}

171

Scenario 4: Replicating a Runtime Environment to Another LPAR Using Configuration Tool Batch Auto-submit


This scenario describes a method for creating an runtime environment on a another LPAR using the Auto-submit feature of batch mode processing in the Configuration tool.

This is similar to Scenario 4, except that the runtime environments are created by canned JCL built on the main LPAR using Configuration tool batch mode processing. The JCL is copied to the execution LPAR and submitted by the Auto Submit CLIST.


Procedure


2. Copy the SMP/E target libraries to CPC B, using any copy/rename method or the supplied Configuration tool transport runtime environment batch jobs.




6. Create a new batch parm deck for each of the other LPARs (A3, A4, B1, B4, and B7, as shown in the following diagram), by copying the contents of the SHARING RTE A1 batch parm deck.

In each new batch parm deck, review and modify the values accordingly.

Pros � 1 Configuration tool contains all runtime environment configuration values

� Runtime environment creation with a single batch job� Runtime environment detail report� All JCL built on the main LPAR� Less interactive Configuration tool work

Cons � None



7. On CPC A:

A. Submit the Configuration tool batch job for each LPAR in CPC A (A3 and A4), and set the SUBMIT parameter to YES in the batch job options.This creates the required runtime environments for CPC A.

B. Submit the Configuration tool batch job for each LPAR in CPC B (B1, B4, B7) and set the SUBMIT parameter to NO in the batch job options.This creates the JCL necessary for creating the runtime environment on each execution LPAR in CPC B.

8. Copy the JCL members from INSTJOBS to CPC B.

Note: These members all end in the same 4-character suffix that you specified in the Configuration tool batch parm deck.

9. On CPC B, execute the Auto Submit CLIST for each LPAR in CPC B. This submits the jobs required to create the runtime environments for CPC B (B1, B4, B7).

10. Copy the RTE BASE datasets to the LPAR B1 (Target). Keep the same dataset names, if possible.





173



CPC A

Shared DASD within CPC A1 Configuration tool and 1 SMP/E environment (includes Target libraries)1 RTE BASE3 Unique runtime environments

LPAR A1 (Main)


RTE BASE

SHARING RTE A1

{JCL to create RTEs A3, A4, B1, B4, B7}

LPAR A3

{RTE A3}

<JCL to create RTE A3>

LPAR A4

{RTE A4}

<JCL to create RTE A4>

CPC B

Shared DASD within CPC B

1 Copy of Target libraries1 Copy of RTE BASE3 Unique runtime environments

LPAR B1 (Target)

<Target libraries>

<RTE BASE>

{RTE B1}

<JCL to create RTE B1>

LPAR B4

{RTE B4}


LPAR B7

{RTE B7}


Scenario 5: Replicating an Runtime Environment on Same LPAR Using Batch Processing



This scenario describes a method for replicating an runtime environment on the same LPAR using batch mode processing in the Configuration tool. You install and configure all products on your main LPAR, and then copy the runtime environments to the appropriate LPARs.


Procedure





5. Create a new batch parm deck for each of the other LPARs (A3, A4, B1, B4, B7 as shown in the diagram below), by copying the contents of the SHARING RTE A1 batch parm deck.

6. In each new batch parm deck, review and modify the values accordingly.

7. Submit the Configuration tool batch job for each of the other LPARs. This creates the required runtime environments for the other LPARs.

8. Copy the RTE BASE datasets to the LPAR B1 (Target), using any copy/rename method or the supplied Configuration tool transport runtime environment batch jobs. Keep the same dataset names, if possible.

9. Copy and rename the appropriate runtime environment to each execution LPAR, using any copy/rename method or the supplied Configuration tool transport runtime environment batch jobs. As the files are copied, rename them to match the execution LPAR name.

Pros � 1 Configuration tool� 1 set of Target libraries� Configuration tool Batch� More copies

Cons � Duplicated runtime environments temporarily use more DASD

175







CPC A

Shared DASD within CPC A1 Configuration tool and 1 SMP/E environment (includes Target libraries)1 RTE BASE6 Unique runtime environments

LPAR A1 (Main)


RTE BASE

SHARING RTE A1 {RTE A3}{RTE A4}{RTE B1}{RTE B4}{RTE B7}

LPAR A3 LPAR A4

CPC B

Shared DASD within CPC B

1 Copy of RTE BASE3 Copies of runtime environments

LPAR B1

<RTE BASE>

<RTE B1>

LPAR B4

<RTE B4>

LPAR B7

<RTE B7>

Scenario 6: Replicating a Runtime Environment Using Interactive Copy


Scenario 6: Replicating a Runtime Environment Using Interactive Copy

This scenario describes a method for creating a second runtime environment that is based on values specified in another runtime environment.


Procedure

1. Create and configure RTE A.

2. Create RTE B, by jump-starting it with all the configuration values you specified for RTE A:

A. On the Add Runtime Environment panel, specify “A” (name of RTE A) for Copy configuration values from RTE.

B. Continue with the RTE Add function.

3. After copying all the configuration values from RTE A to RTE B, continue with configuring RTE B.

Note: You must complete all configuration steps and jobs for RTE B.

Pros � Saves time by jump starting a new runtime environment with configuration values already specified in an existing runtime environment

Cons � Still need to navigate through all panels to review values and submit all configuration jobs

177

Scenario 7: Copying Configuration Values from One Configuration Tool to Another Configuration Tool


This scenario describes a method for copying configuration values (one runtime environment at a time), from one Configuration tool to another. This can also be thought of as Export and Import.


Procedure

1. In Configuration tool #1:A. Create RTE A.B. Generate the Configuration tool batch parm deck for RTE A.

2. In Configuration tool #2, create the Configuration tool batch mode job CICATB.

3. Submit CICATB for Configuration tool #2, using the parm deck for RTE A.

Note: To only populate the Configuration tool ISPF tables and create the runtime environment construction JCL in INSTJOBS, you can specify SUBMIT(NO). The jobs will not be submitted to construct the runtime environment.

Pros � Saves time because you do not need to enter configuration values into the new Configuration tool

Cons � None

Configuration Tool #1

RTE ACreate batch parm deck for RTE A

Configuration Tool #2

Run CICATB using batch parm deck from Configuration Tool #1 RTE A.

All RTE values will be stored into ISPF tables of Configuration Tool #2



179

Configuration Servicesand Utilities

IntroductionThis chapter describes the Configuration tool configuration services and utilities.

Chapter contentsUsing Configuration Services and Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Services: Unlocking Runtime High-Level Qualifiers. . . . . . . . . . . . . . . . . . . . . . . . . . 181Services: Creating the Configuration Tool Batch Mode Job. . . . . . . . . . . . . . . . . . . . 182Utilities: Specifying DEBUG Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Utilities: Displaying an ISPF Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Utilities: Executing a CLIST in the TKANCUS Library . . . . . . . . . . . . . . . . . . . . . . . 185

13

Using Configuration Services and Utilities


Using Configuration Services and Utilities

You can use the configuration services and utilities to perform various services on the runtime environment and specify diagnostic information. Some of the services may modify the Configuration tool values stored in ISPF tables.

Note: You should not modify any values unless you are told to do so in the documentation or by Software Support personnel. If the Configuration tool values are modified incorrectly, the Configuration tool could stop functioning or produce unpredictable results.

Access the configuration services and utilitiesTo access the configuration services and utilities, select Configure products from the Main Menu and then select Services and utilities from the Configure Products menu.

181

Services: Unlocking Runtime High-Level Qualifiers

Services: Unlocking Runtime High-Level Qualifiers

You can use this option to unlock the high-level qualifier values that you specified when you were setting up your configuration environment. If you need to modify these values, you must first unlock them.

Warning: If you unlock and change the high-level qualifiers, the Configuration tool does not automatically delete and reallocate the existing libraries. The jobs generated by the Configuration tool will fail if they are pointing at incorrect libraries.

Unlock and modify runtime high-level qualifier valuesFollow these steps to unlock and modify runtime high-level qualifiers.

1. From the Main Menu, select Configure products > Services and utilities > Unlock runtime high-level qualifiers.

2. Unlock and modify the high-level qualifiers:

A. On the Unlock Runtime High-Level Qualifiers panel, specify Y. B. On the Set Up Configuration Environment panel, make your modifications to the

high-level qualifiers and press Enter


See “Configuring Products” on page 86 for more information on setting up your configuration environment and specifying high-level qualifiers.

Services: Creating the Configuration Tool Batch Mode Job


Services: Creating the Configuration Tool Batch Mode Job

You can use this option to generate the JCL that runs the Configuration tool steps under batch.

This option also creates the KCISETUP REXX exec. Invoking KCISETUP enables your ISPF environment to use the ISPF macros provided with the Configuration tool. You can use these macros to compose and manage the parameter members used for the Configuration tool batch mode process.

Follow these steps to create the the Configuration tool batch mode job.

1. From the Main Menu, select Configure products > Services and utilities >Create batch mode job.Result: The Configuration tool displays a message at the top of the panel indicating the job has been created.

To view additional information about this job press F1.


183

Utilities: Specifying DEBUG Options

Utilities: Specifying DEBUG Options

Follow these steps to specify or modify DEBUG parameter values.

1. From the Main Menu, select Configure products > Services and utilities > DEBUG options.Result: The Configuration tool displays the DEBUG Options panel with all of the existing DEBUG values that you entered when invoking the Configuration tool.

2. Contact IBM Software Support.

Note: IBM Software Support personnel will direct you in specifying or modifying the DEBUG parameter values.


Utilities: Displaying an ISPF Table


Utilities: Displaying an ISPF Table

You can use this option to specify the contents of an ISPF table located in the data library.

Follow these steps to display an ISPF table.

1. From the Main Menu, select Configure products > Services and utilities > Display an ISPF table.

2. Specify and view an ISPF table:

A. Specify the name of the ISPF table you want to display. You can limit the information displayed for an ISPF table by specifying one to three sets of display criteria under Optional section parameters. For each set you must specify the variable name and matching value.

B. Press Enter to view the ISPF table you specified.The actions you can use on the table are:


END (PF3) Go to previous record

ENTER Go to next record

CANCEL Go back to prior panel

UP/DOWN Use scroll variables

185

Utilities: Executing a CLIST in the TKANCUS Library


You can use this option to execute a specific CLIST/REXX exec that is in the TKANCUS library.

Follow these steps to select and execute a specific CLIST in TKANCUS.

1. From the Main Menu, select Configure products > Services and utilities > Execute a CLIST in the TKANCUS library.

2. Contact IBM Software Support.

Note: Software Support personnel will direct you in selecting and executing a CLIST in the TKANCUS library.




187

Configuration ToolBatch Utilities

IntroductionThis chapter describes the the Configuration tool batch utilities.

Chapter contentsUsing the Configuration Tool Batch Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188KCISETUP: Setting Up the Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189KCICFKEY: Managing PF Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190KCICPGHP: Displaying Batch Parm Deck Member Parameters Help . . . . . . . . . . . . 192KCICPGEN: Generating the Batch Parameter Input Deck. . . . . . . . . . . . . . . . . . . . . 194

14

Using the Configuration Tool Batch Utilities


Using the Configuration Tool Batch Utilities

There are four Configuration tool utilities that are available if you are using Batch Mode processing.

These utilities are designed to run outside the Configuration tool, but can also be used while in the Configuration tool.

Table 45. Configuration Tool Batch Utilities

KCISETUP Sets up the environment that is needed to use the Configuration tool batch utilities.

KCICFKEY Manages the PF keys that are used for the Configuration tool batch utilities.

KCICPGHP Displays help information for parameters in a batch parameter deck member.

KCICPGEN Adds products to a batch parameter deck member.

189

KCISETUP: Setting Up the Environment

KCISETUP: Setting Up the Environment

You use the KCISETUP utility to set up the environment that is necessary for using the other Configuration tool batch utilities. This utility must be run once after starting your TSO ISPF session and can only be run from an ISPF session.

Before using the KCISETUP utility, you must generate the KCISETUP member in your INSTLIB. KCISETUP can only be run once per session. There is no confirmation message issued to indicate successful completion of KCISETUP.

Generate KCISETUP in your INSTLIBFollow these steps to generate KCISETUP.

1. Start the Configuration tool on your master image.

2. From the Main Menu, select Configure products > Services and utilities > Create batch mode job.

Result: The Configuration tool generates member KCISETUP in your INSTLIB.


Note: KCISETUP must be created once on an image and can be used for all subsequent parameter deck processing on that image. If your ISPF environment changes or you split your INSTLIB, you must recreate KCISETUP.

Invoke the environment setupYou can invoke the environment setup utility, using either of the following methods.

From the ... enter ...

ISPF command line, TSO EXEC ‘shilev.INSTLIB(KCISETUP)’

ISPF Primary Option Menu, select Enter TSO or Workstation commands, and then

EXEC ‘shilev.INSTLIB(KCISETUP)’where shilev is the high-level qualifier of the INSTLIB.

KCICFKEY: Managing PF Keys



You use the KCICFKEY utility to manage ISPF session PF keys that are used for batch utilities. This includes turning the PF keys on and off, and toggling which set of keys display. This utility can only be run under an ISPF session.

Note: If you will be using KCICFKEY to manage the ISPF session PF keys for the batch utilities, you must turn on the pre-defined function keys. To do this, issue the PFSHOW command from either the ISPF command line or any of the Configuration tool panel command lines.

Before using KCICFKEYBefore using this Configuration tool batch utility, you must use the KCISETUP utility to set up the environment.

Set up the ISPF session to support 24 PF keysTo use the KCICFKEY utility, the ISPF session must support 24 PF keys. Follow these steps to set up the ISPF session to support 24 PF keys.

1. From the ISPF Primary Option Menu, select Terminal and user parameters > Function keys > Non-Keylist PF Key settings.

2. Type 24 for Number of PF Keys.

3. Press F3 to return to the ISPF Primary Option Menu.

If the ISPF session is not setup to support 24 PF keys, the KCICFKEY utility will run but will issue the following ISPF dialogue warning message:

“PFKEYS COUNT ERROR”, “Number of PF Keys must be 24. See ISPF Settings.”

Features of the Configuration tool PF Key ManagerWhen setting PF keys, the Configuration tool PF Key Manager will own PF keys 13–24. On keyboards that do not support 24 PF keys, PF keys 13–24 are obtained by holding the Shift key and pressing a function key. While the shift key is pressed, function keys 1–12 become 13–24.

When the Configuration tool PF keys are active, any change in the PF Key Show State is preserved. If you have set the PF Key Show State to “Show All” and then turned the PF keys off, when you turn the PF keys back on, the PF Key Show State is restored to “Show All”.

While using the Configuration tool PF Key Manager, all of your original PF key and Show State settings are preserved. After exiting the PF Key Manager, all of your original PF key and Show State settings are restored.

191


Invoke the PF Key ManagerYou invoke the PF Key Manager utility using one of the following methods.

The state is the desired state of the Configuration tool PF keys. Valid states are:

If state is not specified, the the Configuration tool PF keys will toggle between ON and OFF.

PF keys for batch utilitiesThe Configuration tool PF Key Manager sets the following keys for the batch utilities.

Table 46. Invoking the PF Key Manager

As ... from the ...

an ISPF edit command,

Edit command line, enter

KCICFKEY state

Note: To use this method you must be running under an ISPF session, editing a member or dataset.

a TSO command,

ISPF command line, enter

TSO KCICFKEY state

where shilev is the high-level qualifier of the INSTLIB.

Table 47. PF Keys - Valid States

ON Turn on the PF keys.

OFF Turn off the PF keys.

SHOW If the PF keys are active, then toggle the PF keys between All (1–24), Alternate (13–24), and Primary (1–12).

HELP Display the PF Key Manager help information.

Table 48. PF Keys for Batch Utilities

PF13 Displays the PF Key Manager Help information.

PF14 Provides detail help information for the Batch Parameter, on the line where the cursor is positioned.

PF15 Turns the PF keys off.

PF21 Toggles the PF keys shown at the bottom of the display between All (1–24), Alternate (13–24), and Primary (1–12).

KCICPGHP: Displaying Batch Parm Deck Member Parameters Help



You use the KCICPGHP utility to display help information for parameters in a batch parameter deck member. The detailed help information for each of the batch parameters is provided to help you modify or construct a batch parameter deck.

This utility must be run from an ISPF Edit session.

Before using KCICPGHPBefore using this batch utility, you must use the KCISETUP utility to set up the environment.

Invoke the Batch Parameter Deck Help utilityYou invoke the Batch Parameter Deck Help utility using either of the following methods:

� From an ISPF Edit command line, enter the command KCICPGHP, position the cursor on the row that contains a batch parameter, and then press Enter.

� Position your cursor on the row that contains a batch parameter and then select the PF key assigned by the Configuration tool PF Key Manager.

Note: This is the preferred method for invoking Batch Parameter Deck Help. The PF Key Manager will assign a PF key to invoke this function.

With either method, you must position the cursor on the row that contains the batch parameter. The utility will then isolate the parameter, perform a look-up, and display a pop-up dialogue with the detailed help information.

Format of the batch parameter helpsThe batch parameter helps contain the following four sections:

Table 49. Batch Parameter Format

Title Information The parameter name, followed by a short description of the parameter.

Description Area The detailed help information for the parameter. This area is scrollable, as indicated by the (+) indicator on the bottom right.

PF7 and PF8 are assigned to scroll this area.

Attribute Area The attributes of the parameter. This information can help you determine what type of data is expected for this parameter.

PF Key Area The PF key assignments that only apply to the pop-up dialogue.

Note: PF5, “Show All”, displays the help information for all parameters that make up this product.

193


Sample batch parameter helpFollowing is an example of a batch parameter help:

KMV_CMS_NAME - CMS Name

Description: This is the nodeid of the CMS to which you are connecting the agent. This name must match the domain name of a non-z/OS CMS, or the nodeid parameter in the KDSCNFG member of the RKANPAR library for a z/OS CMS. If the NODEID parameter contains the literal “*SMFID”, the CMS Name definition must use the actual z/OS SMFID in place of this literal value. The value of this field is case sensitive for both z/OS and (+)

Attributes:Required: YesMaximum Length: 32Type of Data: Character (Mixed Case)Default value:

F1=Help F3=End F5=Show All **=Backward F8=Forward

KCICPGEN: Generating the Batch Parameter Input Deck


KCICPGEN: Generating the Batch Parameter Input Deck

You use the KCICPGEN utility to add products to a batch parameter deck member or to construct a batch parameter deck from scratch.

Note: For a product that has already been installed, KCICPGEN does not support the addition of a new product release.

Before using KCICPGENBefore using this Configuration tool batch utility, you must use the KCISETUP utility to set up the environment.

Invoke KCICPGENYou invoke the Batch Parameter Input Deck Generator as an ISPF Edit command. From the Edit command line, enter:

KCICPGEN product

where product is the product on which you will perform the operation.

Note: To use this utility you must be running under an ISPF session, editing a member or dataset.

The format of this parameter can be either:

Note: When adding a product, only supply the component code and version that identifies the package that you purchased. For example, if you are adding a Plex product such as OMEGAMON XE for Sysplex V220, specify KOS220. The underlying components that make up the package, such as OMEGAMON II for MVS, will be included.

The KCICPGEN utility invokes the Configuration tool edit macro. The edit macro uses the Kppvvv or QI parameter to locate the correct product information (PI) member within INSTDATA. Once the PI member has been found, the edit macro scans the file and builds a list of all the components and parameters required for the specified product. If a product already exists within the library member, it will not be replaced.

Table 50. KCICPGEN Format

Kppvvv For a specific product, where:

K must be the letter K.pp is an alpha-numeric product code of length two.vvv is a numeric version number of length three.

BASERTE For a base RTE build.

195

Support Information

IntroductionIf you have a problem with your IBM software, you want to resolve it quickly. This section describes the following options for obtaining support for IBM software products:

� “Searching knowledge bases” on page 195

� “Obtaining fixes” on page 196

� “Receiving weekly support updates” on page 196

� “Contacting IBM Software Support” on page 197

Searching knowledge basesYou can search the available knowledge bases to determine whether your problem was already encountered and is already documented.

Searching the information center

IBM provides extensive documentation that can be installed on your local computer or on an intranet server. You can use the search function of this information center to query conceptual information, instructions for completing tasks, and reference information.

Searching the Internet

If you cannot find an answer to your question in the information center, search the Internet for the latest, most complete information that might help you resolve your problem.

To search multiple Internet resources for your product, use the Web search topic in your information center. In the navigation frame, click Troubleshooting and support > Searching knowledge bases and select Web search. From this topic, you can search a variety of resources, including the following:

� IBM technotes

� IBM downloads

� IBM Redbooks®

� IBM developerWorks®

� Forums and newsgroups

A


� Google

Obtaining fixesA product fix might be available to resolve your problem. To determine what fixes are available for your IBM software product, follow these steps:

1. Go to the IBM Software Support Web site at (http://www.ibm.com/software/support).

2. Click Downloads and drivers in the Support topics section.

3. Select the Software category.

4. Select a product in the Sub-category list.

5. In the Find downloads and drivers by product section, select one software category from the Category list.

6. Select one product from the Sub-category list.

7. Type more search terms in the Search within results if you want to refine your search.

8. Click Search.

9. From the list of downloads returned by your search, click the name of a fix to read the description of the fix and to optionally download the fix.For more information about the types of fixes that are available, IBM Software Support Handbook at http://techsupport.services.ibm.com/guides/handbook.html.

Receiving weekly support updatesTo receive weekly e-mail notifications about fixes and other software support news, follow these steps:

1. Go to the IBM Software Support Web site at http:/www.ibm.com/software/support.

2. Click My Support in the upper right corner of the page.

3. If you have already registered for My Support, sign in and skip to the next step. If you have not registered, click register now. Complete the registration form using your e-mail address as your IBM ID and click Submit.

4. Click Edit Profile.

5. In the Products list, select Software. A second list is displayed.

6. In the second list, select a product segment, for example, Application servers. A third list is displayed.

7. In the third list, select a product sub-segment, for example, Distributed Application & Web Servers. A list of applicable products is displayed.

8. Select the products for which you want to receive updates, for example, IBM HTTP Server and WebSphere Application Server.

9. Click Add products.

10. After selecting all products that are of interest to you, click Subscribe to email on the Edit profile tab.

http://www.ibm.com/software/support

http://techsupport.services.ibm.com/guides/handbook.html

http://techsupport.services.ibm.com/guides/handbook.html

197

11. Select Please send these documents by weekly email.

12. Update your e-mail address as needed.

13. In the Documents list, select Software.

14. Select the types of documents that you want to receive information about.

15. Click Update. If you experience problems with the My support feature, you can obtain help in one of the following ways:

Online: Send an e-mail message to [email protected], describing your problem.

By phone: Call 1-800-IBM-4You (1-800-426-4968).

Contacting IBM Software SupportIBM Software Support provides assistance with product defects.

Before contacting IBM Software Support, your company must have an active IBM software maintenance contract, and you must be authorized to submit problems to IBM. The type of software maintenance contract that you need depends on the type of product you have:

� For IBM distributed software products (including, but not limited to, Tivoli, Lotus®, and Rational® products, as well as DB2® and WebSphere® products that run on Windows or UNIX operating systems), enroll in Passport Advantage® in one of the following ways:

– Online: Go to the Passport Advantage Web page (http://www.lotus.com/services/passport.nsf/WebDocs/ Passport_Advantage_Home) and click How to Enroll

– By phone: For the phone number to call in your country, go to the IBM Software Support Web site at http://techsupport.services.ibm.com/guides/contacts.html and click the name of your geographic region.

� For customers with Subscription and Support (S & S) contracts, go to the Software Service Request Web site at https://techsupport.services.ibm.com/ssr/login.

� For customers with IBMLink™, CATIA, Linux™, S/390®, iSeries™, pSeries®, zSeries®, and other support agreements, go to the Support Line Web site at http://www.ibm.com/services/us/index.wss/so/its/a1000030/dt006.

� For IBM eServer™ software products (including, but not limited to, DB2 and WebSphere products that run in zSeries, pSeries, and iSeries environments), you can purchase a software maintenance agreement by working directly with an IBM sales representative or an IBM Business Partner. For more information about support for eServer software products, go to the IBM Technical Support Advantage Web site at http://www.ibm.com/servers/eserver/techsupport.html.

If you are not sure what type of software maintenance contract you need, call 1-800-IBMSERV (1-800-426-7378) in the United States. From other countries, go to the contacts page of the IBM Software Support Handbook on the Web at

http://www.lotus.com/services/passport.nsf/WebDocs/ Passport_Advantage_Home

http://www.lotus.com/services/passport.nsf/WebDocs/ Passport_Advantage_Home

http://techsupport.services.ibm.com/guides/contacts.html


http://www.ibm.com/servers/eserver/techsupport.html

http://www.ibm.com/servers/eserver/techsupport.html


http://techsupport.services.ibm.com/guides/contacts.html and click the name of your geographic region for phone numbers of people who provide support for your location.

To contact IBM Software Support, follow these steps:

1. “Determining the business impact” on page 1982. “Describing problems and gathering information” on page 1983. “Submitting problems” on page 199

Determining the business impactWhen you report a problem to IBM, you are asked to supply a severity level. Therefore, you need to understand and assess the business impact of the problem that you are reporting. Use the following criteria:

Describing problems and gathering informationWhen explaining a problem to IBM, be as specific as possible. Include all relevant background information so that IBM Software Support specialists can help you solve the problem efficiently. To save time, know the answers to these questions:

� What software versions were you running when the problem occurred?

� Do you have logs, traces, and messages that are related to the problem symptoms? IBM Software Support is likely to ask for this information.

� Can you re-create the problem? If so, what steps were performed to re-create the problem?

� Did you make any changes to the system? For example, did you make changes to the hardware, operating system, networking software, and so on.

� Are you currently using a workaround for the problem? If so, be prepared to explain the workaround when you report the problem.

� What software versions were you running when the problem occurred?

Severity 1 The problem has a critical business impact. You are unable to use the program, resulting in a critical impact on operations. This condition requires an immediate solution.

Severity 2 The problem has a significant business impact. The program is usable, but it is severely limited.

Severity 3 The problem has some business impact. The program is usable, but less significant features (not critical to operations) are unavailable.

Severity 4 The problem has minimal business impact. The problem causes little impact on operations, or a reasonable circumvention to the problem was implemented.


199

Submitting problemsYou can submit your problem to IBM Software Support in one of two ways:

� Online: Click Submit and track problems on the IBM Software Support site at http://www.ibm.com/software/support/probsub.html. Type your information into the appropriate problem submission form.

� By phone: For the phone number to call in your country, go to the contacts page of the IBM Software Support Handbook (http://techsupport.services.ibm.com/guides/contacts.html) and click the name of your geographic region.

If the problem you submit is for a software defect or for missing or inaccurate documentation, IBM Software Support creates an Authorized Program Analysis Report (APAR). The APAR describes the problem in detail. Whenever possible, IBM Software Support provides a workaround that you can implement until the APAR is resolved and a fix is delivered. IBM publishes resolved APARs on the Software Support Web site daily, so that other users who experience the same problem can benefit from the same resolution.




201

Notices

IntroductionThis information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785 U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 106, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement might not apply to you.

B


This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation2Z4A/10111400 Burnet RoadAustin, TX 78758 U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some cases payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurement may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject to change before the products described become available.

203

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. You may copy, modify, and distribute these sample programs in any form without payment to IBM for the purposes of developing, using, marketing, or distributing application programs conforming to IBM‘s application programming interfaces.

Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows:

© (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp. _enter the year or years_. All rights reserved.

If you are viewing this information in softcopy form, the photographs and color illustrations might not display.

TrademarksIBM, the IBM logo, AIX, Candle, Candle Management Server, Candle Management Workstation, CandleNet, CandleNet Portal, CT/Engine, DB2, developerWorks, eServer, IBMLink, Informix, iSeries, Lotus, MVS, OMEGAMON, OMEGAMON II, OMEGAMON Monitoring Agent, OMEGAVIEW, OpenEdition, pSeries, Passport Advantage, RACF, Rational, Redbooks, S/390, SAA, SMP/E, Tivoli, the Tivoli logo, Tivoli Enterprise Console, TME, VTAM, WebSphere, and zSeries are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both.

CA-ACF2 and CA-Top Secret are registered trademarks of Computer Associates International, Inc. (CA)

Intel, Intel Inside (logos), MMX, Celeron, Intel Centrino, Intel Xeon, Itanium, Pentium and Pentium III Xeon are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States, other countries, or both.


Linux is a trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Other company, product, and service names may be trademarks or service marks of others.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

205

Index

AACF2 90adding

a new runtime environment 88an RTE 82new products to an existing RTE 82NLS products to an existing RTE 83

address translation 37, 40advanced Candle Management Server

configuration 37, 39Advanced key 26Agents 52

registering with local Candle Management Server 73

allocatingruntime libraries 92

allocating PDSE datasets 23, 84APF-authorizing runtime load libraries 41applid prefix, global 91

Bbase libraries 77, 78BASE RTE 77, 98Batch Mode

overview 139parameter decks 139, 143RTE parameter export 139, 142RTE transportation 140, 145

batch mode processing 23, 47, 84, 138Batch Parameter Deck Help utility 192batch utilities 187

KCICFKEY 190KCICPGEN 194KCICPGHP 192KCISETUP 189

bookssee publications 16

buildingRTE libraries 82runtime libraries 92

CCA-ACF2 123Candle Management Server

assigning names on distributed platforms 63

assigning names on z/OS 63guidelines for assigning names 63name 90name requirements 62order of component configuration 79overview 51port number requirements 60registering products 43registering z/OS-based agents 73security 43seeding using Manage Candle

Services 111Candle Subsystem 52CA-TOP SECRET 123changing the configuration 136checklists 29, 30communication protocols 60completing configuration outside of the

Configuration tool 38completing the customization 117component products 28component upgrade alert 24, 84components

definition of shared 51configuration

considerations 79for DASD sharing environments 99, 100for limited DASD space 101registering with the Candle Management


Server 67select a product 87services and utilities 87

configuration scenarioscopying configuration values from one

Configuration tool to another Configuration tool 177

location of supporting topics 162replicating an RTE on same LPAR using

batch processing 174replicating an RTE to another LPAR using

batch Auto-submit 171replicating an RTE to another LPAR using

batch processing 169replicating an RTE using Interactive

Copy 176rolling out products across a 40 LPAR

Enterprise (Common RKANPAR and Common RKANCMD Libraries) 166

rolling out products across a 40 LPAR Enterprise (Standard Method) 163

Configuration toolbatch components 138batch mode 139batch mode processing 137commands and functions 25, 26defaults 25displaying information in 26modes 23restrictions 25

configuration toolbatch mode processing 138

configure products in a new RTE 33configuring

checklist for updating or changing 46definition 28distributed products 40outside of the Configuration tool 41persistent datastore 40prerequisites 31products 86products in an RTE 82remote Candle Management Server 37,

39runtime environments 93the Candle Management Server 93updating or changing 136

configuring productsin a new RTE 34in a new runtime environment 33in an existing RTE 33, 35VTAM applid considerations 79

copying Candle Management Server started task procedure 41

copying customized Candle Management Server objects 119

copying VTAM definitions 41creating

a new RTE 81, 82a new RTE for NLS products 83LU6.2 logmode 37, 39runtime members 38, 40single Candle VTAM major node 159system variable parameter member 157VTAM major node rename job 158

creating an RTE for another z/OS image 84cumulative maintenance 28customer support

see Software Support 197customer-unique objects 120customized Candle Management Server

objects 119customizing

definition 28migration procedures and setting up

security 43

Ddefaults provided with Configuration

tool 25defining hub connection for remote Candle

Management Server 37, 39deleting

an existing RTE 76an RTE 95

207

displaying information in the Configuration tool 26

documentation conventions 18

Eeasiest RTE to create 96edit recovery 25enabling system variable support 153, 155End key 26Enter key 26existing CSI

copying the installation library 69

Ffirewalls

address translation 64and Warehouse Proxy 64application proxy firewall 64partition-naming strategy 64sample scenarios 65use of IP.PIPE 64

FULL RTE 77, 96

Ggenerating a batch parameter deck 194global

VTAM major node 106global applid prefix 91global DASD information 86global started task prefix 89grooming user-customized objects 120

HHELP command 25, 26high-level qualifiers

non-VSAM datasets 86non-VSAM libraries 89VSAM datasets 86VSAM libraries 89

historical data 40HPNS TCP/IP protocol support 61, 85

hub Candle Management Server 54, 59hub Candle Management Server

requirements 60

Iinformation centers, searching to find

software problem resolution 195Installation and Configuration Assistance

Tool 28installing

definition 28maintenance and changing configuration

values 76maintenance and no changes to

configuration values 76product provided situations 40product provided situations for distributed

products 27products and creating a new RTE 76products and using an existing RTE 76

INSTJOBS 158interactive mode 23Interlink TCPACCESS 61Inter-user Communication Vehicle 61IP protocol 37, 40IP.PIPE protocol 37, 40IP.PIPE socket address family 64ISPF display requirements 25

JJES3 support 24, 84

KKCICFKEY 188, 190KCICPGEN 188, 194KCICPGHP 188, 192KCISETUP 188, 189knowledge bases, searching to find software

problem resolution 195


Lload libraries 107loading

RTE libraries 82runtime libraries 94

LPAR-specific libraries 77, 78

Mmanaging ISPF session PF keys 190managing your environment 87manuals

see publications 16mid-level qualifier 88migrating

product-provided situations 120user-customized objects 43, 121

migrationprocess 119, 120requirements 119

NNAM (Network Access Method) 123National Language Support (NLS)

installing NLS components 90RTE configuration sequence 83

network interface card 37, 40new CSI

creating the installation library 70NIC 37, 40non-local Candle Management Server 54

Oobject migration job 119object migration utility 120OMEGAMON XE 52OMEGAMON XE platform 53online publications

accessing 16order of component configuration 79ordering publications 17

Ppartition name 37, 40PDSE support 23, 84Persistent Data Store

copy procedures 41overview 51parameters 37

persistent data store parameters 39PF Key Manager 190PFSHOW command 25planning

your runtime environment 81possible configurations using RTEs 96prefix

applid 91started task 89

preventive maintenancedefinition 28

procedurescopying for the Persistent Data Store 108copying for the started tasks 105

processingof applids by the Configuration tool 79

PROCLIBPersistent Data Store 108started tasks 105

product-specific configuration 93publications 16

accessing online 16ordering 17

RRACF 123README APP 24, 84README APP command 26README command 26README ERR command 26README SMS 23, 84README SYS command 26RECOVERY OFF command 25RECOVERY ON command 25reducing amount of disk space 78

209

registering Candle products with the Candle Management Server 44

registering products on distributed platforms 44

remote Candle Management Server 54, 59, 60

replicating an RTE 139restoring user-customized objects 122restrictions 25RKANPAR library 157RKANSAM library 159RTE 28

configuration sequence 82, 83replication process 139security 90sharing

with SMP/E 107terms 77transportation methods 140

RTE load optimization 24, 84running multiple network adapters 37, 40running multiple TCP/IP interfaces 37, 40running software on any z/OS system 152Runtime Environment (RTE)

adding 82adding new products to 82base libraries 77building libraries 82, 92configuring products 82copying values 90definition 77exporting parameters 139loading libraries 82private libraries 78sharing RTE 99, 100, 101

runtime libraries 77runtime load libraries 107

Sscenarios

configuration 161security 90

security requirements 60, 123seeding the Candle Management Server 41

background 109selecting

a product to configure 87services and utilities

configuration 87setting network interface card parameter 61setting up

the configuration environment 86setting up your configuration

environment 32, 67, 69shareable base libraries 98SHARING BASE 77SHARING FULL 77SHARING SMP/E TARGET 77SMP/E

target libraries 77SMS support 23, 84SNA protocol 37, 40Software Support

contacting 197specifying

configuration values 37network interface card 61RTE values 89security 43

specifying Candle Management Server communication protocols 37, 40

started task considerations 80started task names 80started task prefix 89started tasks

copying procedures 105, 107synchronizing maintenance across multiple

systems 98system variable support 23, 47, 84, 152

existing RTEs 155new RTEs 155

system-specific parameter values 152


Ttarget load libraries 107TCP/IP requirements 60terminology 28Tivoli software information center 16turning on system variable support 155types of RTE configurations 78, 96types of RTEs 78

Uupdating

Candle Management Server configuration 46

detailed procedures 135site-specific information 86the configuration 136

upgrading product provided situations option 27

usinga single VTAM major node 159an existing RTE 81checklists in this guide 30IP.PIPE 60IUCV interface 61, 85

UTIL command 26utilizing system variable support 152

Vvarying VTAM major node active 41verifying the configuration 41viewing

Candle Management Workstation configuration values option 27

configuration information 87list of Candle Management Server names

and registration status option 27VTAM

applid considerations 79major nodes on remote systems 158

VTAM applid considerations 24, 84VTAM definitions 41VTAMLIB load library 37, 39

VTAMLSTcopying the VTAM definition 106

Zz/OS system symbolics 23, 84z/OS-based Candle Management Server 40

IBM@

Part Number: GC32-9414-02

Printed in USA

GC32-9414-02

GC32-9414-02