IBM Rational Synergy - Castalia Camp · 2020. 2. 26. · IBM® Rational® Synergy Administration...

IBM Rational Synergy

Administration Guide for Windows

Release 7.1

ii IBM® Rational® Synergy Administration Guide for Windows

Before using this information, be sure to read the general information under Appendix: “Notices” on page 171.

This edition applies to 7.1, IBM Rational Synergy (product number 5724V66) and to all subsequent releases and modifications until otherwise indicated in new editions. © Copyright IBM Corporation 1992, 2009US Government Users Restricted Rights—Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Table of Contents

Chapter 1: Introduction 1Using this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Changes in version 7.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Rational Synergy administrator road map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2About Rational Synergy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Running Rational Synergy administrative commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Opening command windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Command line interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Default text editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Rational Synergy Web mode and traditional mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Rational Synergy Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Obtaining additional information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Contacting IBM Rational Software Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Submitting problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 2: General System Administration 13Installing the Rational License Server TL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Adding users to a Rational Synergy database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Customizing user environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Setting and changing default settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Changing personal settings for Synergy Classic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Changing personal settings for Rational Synergy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Changing system settings for Synergy Classic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Changing system settings for Rational Synergy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Configuring for trusted users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Configuring for remote execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Customizing remote execution tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Managing audit files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Monitoring product usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

IBM® Rational® Synergy Administration Guide for Windows iii

Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Process status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Database server usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Broadcast system messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Monitoring the services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26ccm_ess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26ccm_router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27ccm_objreg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27ccm_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Other services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Informix services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Monitoring output to log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Customer feedback module logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Setting up databases for read security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 3: Administering the CCM Server 33About the CCM server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Starting and stopping the CCM server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Monitoring the CCM server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Refreshing databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Managing log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Using the Web Administrator User interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Databases tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Archive Conversion tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Debug Server tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Tuning the CCM server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Changing the number of back-end sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Changing the maximum heap size of the CCM server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Changing the session timeout period for the Web Administrator User interface . . . . . . . . . . . . . 42Changing the frequency of user credential checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

iv IBM® Rational® Synergy Administration Guide for Windows

Chapter 4: Administering the Database Server 45Informix database server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

rootdbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46tempdbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46ccm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Dbspace chunk files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Database server states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Creating the database server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Creating the Informix Dynamic Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Running the ccmsrv create command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Using a file to specify parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Using the database server commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Bringing a database server online. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Displaying the database server status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Modifying parameter values for a database server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Putting a database server in quiescent state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Taking a database server offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Deleting a database server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Increasing the dbspace of the database server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Archiving and restoring database servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Reasons to archive database servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Knowing when to archive database servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Archiving the database server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Restoring a database server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Restoring database servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Logical log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Backing up logical log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Preparing for backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Backup procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Using logical log backup to restore database servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Obtaining detailed Informix messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Informix tuning guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

IBM® Rational® Synergy Administration Guide for Windows v

Chunk file distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Dedicated Informix server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Chapter 5: Administering Databases 77Rational Synergy database overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Supplied Rational Synergy databases (pack files) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Database directory structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Performing database integrity checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Rational Synergy database naming restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Backing up and recovering the Rational Synergy database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Database backup methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Packing databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Dumping databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Archiving database servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Repairing a database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Creating, modifying, and deleting a Rational Synergy database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Creating through unpack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Renaming (or moving) a database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Deleting a database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Moving a database between UNIX and Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Managing Rational Synergy database space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Deleting product files from Rational Synergy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Deleting cache files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Monitoring database space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Deleting unused databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Using the Save Offline and Delete tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Performing other housekeeping activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Performing database maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Nightly. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Weekly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Monthly or less often . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

vi IBM® Rational® Synergy Administration Guide for Windows

Chapter 6: Administrative Commands 101Command summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101ccm admin_user_name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104ccm fs_check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105ccm message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109ccm monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111ccm ps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114ccm version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116ccmadm admin_user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117ccmadm config_admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119ccmadm password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120ccmdb backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123ccmdb check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126ccmdb copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128ccmdb create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130ccmdb delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132ccmdb drop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133ccmdb dump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134ccmdb info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135ccmdb load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138ccmdb pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140ccmdb prepare_admin_user_change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142ccmdb protect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145ccmdb refresh. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146ccmdb repair. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147ccmdb shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149ccmdb unpack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151ccmdb unprotect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154ccmdb update_statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155ccmdb upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156ccmsrv archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157ccmsrv create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159ccmsrv delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

IBM® Rational® Synergy Administration Guide for Windows vii

ccmsrv expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162ccmsrv modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164ccmsrv offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165ccmsrv online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166ccmsrv quiescent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167ccmsrv restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168ccmsrv status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Appendix: Notices 171Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

viii IBM® Rational® Synergy Administration Guide for Windows

1 IntroductionThe IBM® Rational® Synergy Administration Guide for Windows® contains complete administrative command descriptions and step-by-step instructions for administering Rational Synergy. If you are installing Rational Synergy for the first time, see the Rational Synergy Installation Guide for Windows. For installation and upgrade instructions, please see the following documents:

• IBM Rational Synergy Installation Guide for Windows

• IBM Rational Synergy Installation Guide for UNIX®

• IBM Rational Synergy Upgrade Instructions for Windows

• IBM Rational Synergy Upgrade Instructions for UNIX

You can obtain this guide in PDF format on the Documentation section of the DVD, the Rational Software Information Center (at http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp), or the FTP site.Information in this guide may be superseded by information in the Rational Synergy Readme, which is shipped with the product. The latest updates to the Readme are available in the Information Center.For administration information specific to installing the product for the first time, including hardware configuration requirements, see the IBM Rational Synergy Installation Guide for Windows.

Using this guideThis guide is intended for the change management (CM) administrator.The CM administrator is responsible for the smooth, day-to-day operation of the Rational Synergy tools. This document describes the Rational Synergy services and databases, including how to run the Rational Synergy database backup programs, how to use space effectively, and so forth.

Changes in version 7.1Telelogic Synergy is now called IBM Rational Synergy. Also, if you are upgrading from Telelogic Synergy 7.0, the feature called Telelogic Synergy Distributed is now referred to as Rational Synergy Distributed and is included in the Rational Synergy product.

IBM® Rational® Synergy Administration Guide for Windows 1

http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsphttp://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsphttp://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp

Chapter 1: Introduction

Rational Synergy administrator road mapThe following items briefly describe the tasks you need to complete to prepare the Rational Synergy environment for the use of your team. This road map assumes that you have installed Rational Synergy already.

• See the Readme for any last-minute information.

• Install the IBM® Rational® License Server TL and the license.

This procedure is described in the IBM Rational License Server TL Guide.

• Unpack a database.

This procedure is described in “Creating through unpack” on page 87.

• Add users to the database.

This procedure is described in “Adding users to a Rational Synergy database” on page 14.

• Coordinate the customization of local types with your site type developer.

• Devise a database backup plan.

For guidelines, see “Performing database integrity checks” on page 79 and “Knowing when to archive database servers” on page 60.

• Monitor space to plan for growth.

This procedure is described in “Monitoring product usage” on page 25.

About Rational SynergyThis release supports Windows clients, engines, and database servers on a variety of Windows operating systems. Windows clients can be used with Windows or UNIX servers. For the most current list of supported platforms, see the Readme.When you run Rational Synergy, the client, engine, and database all must be at the same release level. Do not mix components from different Rational Synergy releases. This means that you must install this release of Rational Synergy clients on all Windows client machines that will access a Windows or UNIX server. See the IBM Rational Synergy Installation Guide for Windows and the IBM Rational Synergy Administration Guide for Windows for information about installing and administering Windows clients. See the IBM Rational Synergy Installation Guide for UNIX and the IBM Rational Synergy Administration Guide for UNIX for information about installing and administering UNIX servers. All documents are located on the Rational Software Information Center.

2 IBM® Rational® Synergy Administration Guide for Windows

http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsphttp://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsphttp://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp

Running Rational Synergy administrative commands

Running Rational Synergy administrative commandsDepending on which administrative commands you use, you need to have the following access:

• Rational Synergy administrator

In previous releases, the ccm_root user was a fixed name. You can now set the name for that user to whatever you would like. This document uses the term Rational Synergy administrator for that user.

For example, to run the Rational Synergy database commands and to perform a model install, you need to log on as the Rational Synergy administrator.

• Local administrator

The Local administrator is a member of the Administrators group on the local machine.

For example, to run the database server administrative commands, you need to have Local administrator privilege.

• Informix-Admin group member

The Informix-Admin group member is a user who has membership in the Informix-Admin group on the domain.

For example, to use the database server administration commands, you need to be an Informix-Admin group member.

Opening command windows

When you run administrative commands, you can use the Rational Synergy command prompt instead of typing the full path to your Rational Synergy installation area (CCM_HOME). This starts a command prompt window with the environment properly set for Rational Synergy command use. To open a command prompt window, from the Windows task bar, select Start > All Programs > IBM Rational > IBM Rational Tools > IBM Rational Synergy 7.1 > CM Command Prompt.



ConventionsThe following conventions are used in this document.The table below describes the typeface and symbol conventions used in this guide.

This document also uses the following conventions:

Note Contains information that should not be overlooked.

Caution Contains critical information that must be observed or damage to the database or system could result.

Command line interfaceThe command line interface (CLI) is supported on all Windows platforms. You can execute any Rational Synergy command from the command prompt.

Prompt

This document uses the greater than ( > ) character as the prompt.

Option delimiter

Rational Synergy supports the slash ( / ) option delimiter.

Typeface Description

Italic Used for book titles and terminology. Also designates names of roles (developer), states (working), groups (ccm_root), and users (sue).

Bold Used for dialog box names and options, items that you can select and menu paths, also used for emphasis.

Courier Used for commands, filenames, and directory paths. Represents command syntax to be typed verbatim. Signifies computer output that displays on-screen. Also used for the names of attributes (modify_time), functions (remote_type), and types (csrc).

Courier Italic Represents values in a command string that you supply. For example, (drive:\username\commands).


Conventions

Universal naming convention

You can use the universal naming convention (UNC) any time you enter a path to an administrative command. UNC makes network access to files, machines, and other devices easier, enabling you to reference remote machines and files.The UNC format is as follows:

\\computer_name\share_name\path.

In the following example, “c:\users\ccmdb\base” is a regular database path. A UNC-style path is “\\loon\ccmdb\tstgonzo”:

> ccmdb copy c:\users\ccmdb\base \\loon\ccmdb\tstgonzo

Most Rational Synergy commands accept both UNC paths and paths with drive letters. However, three commands, ccmdb create, ccmdb copy, and ccmdb unpack, require UNC paths to create databases.

CCM_HOME location

CCM_HOME is the Rational Synergy product installation directory. Many procedures shown in this document require that you change a file somewhere in the CCM_HOME directory hierarchy. For example, if you want to edit the remexec.cfg file, which resides in the etc directory in the Rational Synergy installation area, you would need to change the directory to CCM_HOME\etc.

Default text editor

Instructions for editing text files are given using Notepad™, which is the Rational Synergy default text editor. If you change text editors, substitute the appropriate command. See Rational Synergy Help for instructions on changing your text editor.



Rational Synergy Web mode and traditional modeBeginning with the Rational Synergy 7.0 release, Rational Synergy performance was improved with the introduction of an architecture that allowed Rational Synergy clients to communicate to a Web-based Rational Synergy server using the HTTP protocol. This architecture reduces the dependency on network latency by using parallel, asynchronous network communication between the client and server.Rather than replacing the original network communication with this new technique, Rational Synergy 7.0 introduced the new technique as Web mode. The previous RFC architecture, which is referred to as traditional mode, is still available for use by some users.Most developers and build managers will be able to use Web mode. Users who need administration capabilities or other advanced features can use traditional mode instead. Traditional mode behaves as it did in Synergy 6.5.Users need to use one of the Classic clients (CLI or GUI) for the following reasons:

• Administrative operations

• Data migration

• Save offline and delete


Rational Synergy Web mode and traditional mode

Rational Synergy ArchitectureThe following picture shows the Rational Synergy architecture for Web mode and traditional mode.

Web mode clients connect to a Rational Synergy Web server using HTTP. The Rational Synergy server manages a pool of back-end sessions, which all run on the server system. The Web mode and traditional mode differ in some ways that are important for the CM administrator to understand.

• CCM server—The Web mode Web server. This process manages back-end Rational Synergy sessions on the server system. This document provides information about configuring and administering the CCM server.

For more information on administering the CCM server, see “Administering the CCM Server” on page 33.



• Authentication—Web mode users are authenticated using IBM® Rational® Directory Server (RDS). Rational Synergy can share a single RDS LDAP installation with IBM® Rational® Change and other software tools. RDS is installed and administered separately from Rational Synergy. For more information, see the IBM Rational Directory Server Administration Guide and the IBM Rational Directory Server Install Guide. All documents are located on the Rational Software Information Center at http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp.

In addition to defining users in RDS, the CM administrator must add user IDs and their associated roles to each Rational Synergy databases in which they will work, to identify which databases they can access and the privileges they have in each databases.

Traditional mode users are authenticated using OS authentication, as in previous releases. On UNIX operating systems, it is possible to configure PAM to authenticate users using RDS. RDS can also be configured to authenticate users against the operating system.

For more information on authentication, see the IBM Rational Directory Server Administration Guide.

Also, users can change their RDS password on the CCM server Web site at http://server:port/user.

• Session start —To start a Web mode session, users must specify a URL rather than a host name for the server. The CM administrator can provide the appropriate startup information for different sets of users.

Note You can only start a Rational Synergy client or Rational Synergy CLI in Web mode. Neither the Classic GUI nor the Classic CLI can be started in Web mode.

• To start a Rational Synergy GUI session in Web mode, in the Start Rational Synergy dialog box, in Server, type the CCM server URL.

• To start a Rational Synergy CLI session in Web mode, type the CCM server URL with the /s argument. For example:

% ccm start /d \\vod\ccmdb\mydb /s http://vod:8400


http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp

Obtaining additional information

• Scripting—Rational Synergy 7.0 introduced a new command line interface (CLI). This CLI is referred to as the Rational Synergy CLI, and the original CLI is referred Classic CLI.

• The Rational Synergy CLI runs only in Web mode.• The Classic CLI runs only in traditional mode.

The Rational Synergy CLI is not as complete compared to the Classic CLI, but provides equivalent commands for most functions available in the Rational Synergy GUI. Most administration commands are not supported in the new Rational Synergy CLI yet, including those described in this book.

You may choose to continue running your existing scripts in the Classic CLI, or port them to the Rational Synergy CLI if it includes all of the functionality needed by your scripts. Because the Rational Synergy CLI runs in Web mode, it is faster than the Classic CLI, but the Classic CLI continues to run as it has in previous releases.

Obtaining additional informationThe Readme describes the new features in Rational Synergy, provides updates to the documentation, and contains sections on troubleshooting, contacting support, and known errors. Look in the Readme for the latest updates to the installation documentation.The Readme is in an HTML document available on the product DVD and on the Rational Software Information Center. The Readme is also available to Rational Synergy GUI users from the Welcome page. To display the Welcome page, from the main menu, select Help > Welcome.Information in the Readme takes precedence over information in the documentation or in the Help.




Contacting IBM Rational Software SupportIf the self-help resources have not provided a resolution to your problem, you can contact IBM® Rational® Software Support for assistance in resolving product issues.

Note If you are a heritage Telelogic customer, a single reference site for all support resources is located at http://www.ibm.com/software/rational/support/telelogic.

Prerequisites

To submit your problem to IBM Rational Software Support, you must have an active Passport Advantage® software maintenance agreement. Passport Advantage is the IBM comprehensive software licensing and software maintenance (product upgrades and technical support) offering. You can enroll online in Passport Advantage from http://www.ibm.com/software/lotus/passportadvantage/howtoenroll.html.

• To learn more about Passport Advantage, visit the Passport Advantage FAQs at http://www.ibm.com/software/lotus/passportadvantage/brochures_faqs_quickguides.html.

• For further assistance, contact your IBM representative.

To submit your problem online (from the IBM Web site) to IBM Rational Software Support, you must additionally:

• Be a registered user on the IBM Rational Software Support Web site. For details about registering, go to http://www.ibm.com/software/support/.

• Be listed as an authorized caller in the service request tool.


http://www.ibm.com/software/rational/support/telelogichttp://www.ibm.com/software/rational/support/telelogichttp://www.ibm.com/software/lotus/passportadvantage/howtoenroll.htmlhttp://www.ibm.com/software/lotus/passportadvantage/howtoenroll.htmlhttp://www.ibm.com/software/lotus/passportadvantage/howtoenroll.htmlhttp://www.ibm.com/software/lotus/passportadvantage/brochures_faqs_quickguides.htmlhttp://www.ibm.com/software/lotus/passportadvantage/brochures_faqs_quickguides.htmlhttp://www-01.ibm.com/software/support/http://www-01.ibm.com/software/support/

Contacting IBM Rational Software Support

Submitting problemsTo submit your problem to IBM Rational Software Support:

1. Determine the business impact of your problem. When 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 table to determine the severity level.

2. Describe your problem and gather background information, When describing a problem to IBM, be as specific as possible. Include all relevant background information so that IBM Rational 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?

To determine the exact product name and version, use the option applicable to you: • Start the IBM Installation Manager and select File > View Installed

Packages. Expand a package group and select a package to see the package name and version number.

• Start your product, and click Help > About to see the offering name and version number.

Severity Description

1The 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.

2 This problem has a significant business impact: The program is usable, but it is severely limited.

3The problem has some business impact: The program is usable, but less significant features (not critical to operations) are unavailable.

4The problem has minimal business impact: The problem causes little impact on operations or a reasonable circumvention to the problem was implemented.



• What is your operating system and version number (including any service packs or patches)?

• Do you have logs, traces, and messages that are related to the problem symptoms?

• Can you recreate the problem? If so, what steps do you perform to recreate the problem?

• Did you make any changes to the system? For example, did you make changes to the hardware, operating system, networking software, or other system components?

• Are you currently using a workaround for the problem? If so, be prepared to describe the workaround when you report the problem.

3. Submit your problem to IBM Rational Software Support. You can submit your problem to IBM Rational Software Support in the following ways:

• Online: Go to the IBM Rational Software Support Web site at https://www.ibm.com/software/rational/support/ and in the Rational support task navigator, click Open Service Request. Select the electronic problem reporting tool, and open a Problem Management Record (PMR), describing the problem accurately in your own words.

For more information about opening a service request, go to http://www.ibm.com/software/support/help.html

You can also open an online service request using the IBM Support Assistant. For more information, go to http://www.ibm.com/software/support/isa/faq.html.

• By phone: For the phone number to call in your country or region, go to the IBM directory of worldwide contacts at http://www.ibm.com/planetwide/ and click the name of your country or geographic region.

• Through your IBM Representative: If you cannot access IBM Rational Software Support online or by phone, contact your IBM Representative. If necessary, your IBM Representative can open a service request for you. You can find complete contact information for each country at http://www.ibm.com/planetwide/.


https://www.ibm.com/software/rational/support/http://www.ibm.com/software/support/help.htmlhttp://www-01.ibm.com/software/support/isa/faq.htmlhttp://www-01.ibm.com/software/support/isa/faq.htmlhttp://www.ibm.com/planetwide/http://www.ibm.com/planetwide/http://www.ibm.com/planetwide/http://www.ibm.com/planetwide/http://www.ibm.com/planetwide/

2 General System AdministrationThe General System Administrator is responsible for maintaining non-specific areas of the Rational Synergy installation area. General administrative tasks include the following:

• “Installing the Rational License Server TL” on page 14

• “Adding users to a Rational Synergy database” on page 14

• “Customizing user environments” on page 16

• “Setting and changing default settings” on page 16

• “Configuring for trusted users” on page 20

• “Configuring for remote execution” on page 21

• “Managing audit files” on page 24

• “Monitoring product usage” on page 25

• “Monitoring the services” on page 26

• “Other services” on page 28

• “Monitoring output to log files” on page 28

• “Setting up databases for read security” on page 30

• “Troubleshooting” on page 31


Chapter 2: General System Administration

Installing the Rational License Server TLThe Rational License Server TL installation is described in the IBM Rational License Server TL Guide. See this document for step-by-step instructions.

Adding users to a Rational Synergy databaseEach Rational Synergy database has a list of users. After you unpack a database from base.cpk, the list contains suggestions of user roles that you might want to give to users of a database. Each user list needs to contain the team members who can use the database. You need to add user names to the list of users for each Rational Synergy database, and give each user at least one role to define his capabilities within a Rational Synergy database. Before you assign user names, consider whether you are going to use automatic email notification. If this is the case, make sure your email tool can recognize the OS user name and deliver mail to the appropriate address. A user can have multiple roles within a single database. For example, user sue could have the role of writer and developer.Roles identify which privileges a user has within a database. For example, if user sue is only given the developer role, she can perform all developer operations, but she cannot perform any build_mgr operations. The ccm_admin role is only used in Synergy Classic and CLI.

Caution Users with the ccm_admin role can perform administrative actions on a database, and have the right to modify any and every object in a database. You should limit access to this role, and also to the Rational Synergy administrator, to those who specifically need this level of access.

You must be working as the Rational Synergy administrator to perform this procedure.

Note The first time you add users to a database, you need to do so as the Rational Synergy administrator. Once you establish the administrative user (the user with ccm_admin role), then he can add users to the user list while logged in as himself.


http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsphttp://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp

Adding users to a Rational Synergy database

The following steps describe how to add user names to your database.

1. Log on as the Rational Synergy administrator.2. Start Rational Synergy on the database where you need to add user names.

> ccm start /nogui /r ccm_admin /d database_path

3. Open the list of users.> ccm users

You can add or remove users from this file, or change a user’s role. To add a user, read through the user list, and then give users the appropriate role(s).

Additionally, you can add comments and blank lines.

The list of users looks similar to the following:user john = build_mgr developer;user sue = ccm_admin developer;user mary = writer developer;user joe = developer;

#testing groupuser bill = tester; user tom = tester; user linda= tester; user ann = tester; user bob = tester;

user user1= developer;user user2= developer;

In the example above, john, sue, mary, and joe are the users’ logon names. sue has the roles of ccm_admin and developer, john has build_mgr and developer roles, mary has writer and developer roles, while joe has developer role only. Below the first group of users, a second group, including only testers, is defined.

Note Create only one line, with all the user’s roles, for each user. Also, end each line with a semicolon.

Additionally, user names in databases on UNIX servers must not be longer than eight characters, must not contain spaces, and must start with an alphabetical character.

4. Stop the Rational Synergy session.> ccm stop



5. Log off as the Rational Synergy administrator.Note Users who run Web mode sessions must be added to

RDS as well as the Rational Synergy databases. See the IBM Rational Directory Server Administration Guide.

Customizing user environmentsThe following sections describe how to customize user environments to run Rational Synergy efficiently.

Setting and changing default settingsYou can customize settings for Rational Synergy options and for database options. Some of the settings can be modified by users and some can be modified by the CM administrator only. In general, if there is a conflict between a user's personal settings and system settings, the personal settings override the system settings.



Setting and changing default settings

Changing personal settings for Synergy ClassicSynergy Classic users can set their own defaults for engine host, database, browser, and other options.

ccm.ini

Initialization files (for example, the users' ccm.ini files) are usually the files used to customize defaults. The personal ccm.ini file is located in the %USERPROFILE% directory.If you start Synergy Classic by adding /f filename to the ccm start command, Rational Synergy checks the file specified by the /f switch instead of the ccm.ini file in the %USERPROFILE% directory.Note The ccm set command overrides any settings in the

ccm.ini file.

Additionally, you can use /f to set up multiple shortcuts to start Rational Synergy sessions with different settings on different databases, or to start different releases of Rational Synergy.You can change GUI settings in the ccm.ini file or in the Object Color Options dialog box. Refer to Synergy Classic Help for instructions on setting GUI options in either place.See Rational Synergy CLI Help for information about default Rational Synergy options and settings.

ccminit

The ccminit file lists Synergy Classic commands that are executed at startup.

Changing personal settings for Rational SynergyRational Synergy users can use the settings in the ccm.user.properties file to set their own defaults.

ccm.user.properties

This file provides local workstation settings, such as startup options for Rational Synergy. Most user settings can also be configured using the Options dialog box. This file is located in the %USERPROFILE% directory.



Changing system settings for Synergy Classic

ccm.ini

Synergy Classic checks the ccm.ini file located in the installation area for system-wide settings. This file is located in the CCM_HOME\etc directory.

Changing system settings for Rational SynergyRational Synergy has options that can be configured for the interface and server.

ccm.ini

Rational Synergy checks the ccm.ini file located in the installation area for system-wide settings. This file is located in the CCM_HOME\etc directory.

ccm.properties

This file provides system-wide settings for Rational Synergy, such as default tools. Settings in this file can be overwritten by the settings in the ccm.user.properties file. This file is located in the %USERPROFILE% directory.

ccm.server.properties

This file provides settings for tuning the server for Rational Synergy This file is located in the CCM_HOME\etc directory.Restart the server so that the changed values have an effect.

system_info.txt

This file provides settings for configuring the Rational Synergy installation system information. The file is located in the $CCM_HOME/etc. directory and includes the following settings:

• PROBLEM_SUBMIT_EMAIL—Email address to which problem information will be sent from the Submit Request dialog box in the Rational Synergy GUI. Set this option to an internal email address so that Rational Synergy experts at your company can review end-user requests to ensure they are valid and do not contain company-confidential information before passing them on to IBM Rational Software Support.

For the IBM Support email, uncomment the line that corresponds to your geographic location.

See “Contacting IBM Rational Software Support” on page 10 for more information.


Setting and changing default settings

• PROBLEM_SUBMIT_ICN—Your IBM Customer Number (ICN), which is required when you send email to IBM. Your ICN is included in the email that is sent from the Submit Request dialog box.

• LICENSE_SERVER—Host and port where the license server is running. For possible formats of the license server address, see the IBM Rational License Server TL Licensing Guide documentation.

• HELP_SERVER—Host and port where the CCM server is running.

• RATIONAL_DIRECTORY_SERVER—Host and port where RDS is running.

For possible formats of the license server address, see the IBM Rational License Server TL Licensing Guide documentation.

• VIDEO_RECORDING_DISALLOWED—Uncomment this line to disable the video recording and snapshot features in the Synergy GUI.


http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsphttp://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsphttp://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsphttp://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp


Configuring for trusted usersThis section does not apply to Web mode users.This option allows users to start a client without providing a password. When using this option, sessions on UNIX databases must be started using ESD.To enable this feature, the administrator needs to create a file named trusted_clients on the router machine $CCM_HOME\etc directory. The file must have the following format:

hostname1 [user_name1]

hostname2 [user_name2]

Where the hostname is the client’s hostname and the user_name is the client’s logon user name.

Both hostname and user_name fields accept + (plus sign) for ANY hosts or ANY user.If the user_name field is missing, it has the same meaning as user_name set to +.If the client is trusted, Rational Synergy displays the following behavior.Synergy Classic:On the startup dialog, User name and Password are disabled.The User name displays the OS user name.If the user name is specified from the command line (/n option), the client is no longer considered trusted and behaves like non-trusted clients.

Rational Synergy Command Line Interface (CLI):If the client is trusted, the CLI does not prompt for the password.

If the user name is specified from the command line (/n option), the client is no longer consider trusted and behaves like non-trusted clients.

Rational Synergy:The logon pane does not display UserID or Password (like Rational Synergy on UNIX). The User name displays the OS user name.

If the user name is specified from the command line (/u option), the client is no longer considered trusted and behaves like non-trusted clients.


Configuring for remote execution

Configuring for remote executionIf you want Rational Synergy to run remote operations, such as running the remote DCM receive operation, you must specify the remote execution method to use. Because a different machine might use a different protocol, you must configure Rational Synergy for proper remote execution on your system. Rational Synergy uses a configuration file, remexec.cfg, to determine the method it will use for remote execution on a specific host.You must be working as local administrator, and your PATH variable must contain CCM_HOME\bin to perform this procedure.

1. Log on as local administrator.2. Change to the directory where the remexec.cfg file resides.3. Launch your editor, and then edit the remexec.cfg file.

Add the method for each host.

Specify the source host, destination host, purpose, environment variables, and command using the following syntax:source_host dest_host [%purpose envvar] command

where source_host is the name of the source host machine.

dest_host is the name of the destination host machine.

purpose is an optional remote execution purpose, normally either DCM or DEFAULT. If specified, the purpose must include a leading percent symbol ( % ) so that ccm_remexec can determine that a purpose was specified.

If the purpose is not specified, it is treated as a DEFAULT purpose. If both DEFAULT purpose and matching purpose exist between two machines, the entry with the matching purpose is used.

envvar is a list of environment variables that starts with an optional leading dash ( - ), and is separated by commas and no extra spaces. This defines the environment variables that ccm_rem will pass to the process executing the remote command. A list that starts with a dash means that all environment variables except the specified ones will be passed by ccm_rem. A list that does not start with a dash means that only the specified environment variables will be passed by ccm_rem. The keyword value ALL means pass all environment variables.



An environment variable can be in one of the following formats:

• NONE—None of the environment variables are passed to the remote machine.

• ALL—All environments variables are passed to the remote machine. • Only the listed environment variable is passed to the remote machine

(for example, env1, env2, ..., envn).• All the environment variables except the listed ones (-env1, env2,

... envn) are passed to the remote machine.

Note ccm_rsh only performs this environment processing when the remote execution host has a different IP address than the local host. In other words, if you use a ccm_remexec command that ultimately calls ccm_rsh to execute a command on the local host, all environment variables are propagated, regardless of the settings defined in remexec.cfg.

Both purpose and envvar are optional. However, if envvar is specified, then purpose must also be specified. If the purpose field is not specified, then all environment variables are passed when ccm_rem is used as the remote execution method.

The remexec.cfg file is shipped with the following default:DEFAULT DEFAULT ccm_rem %hostname [%shell /C] %cmd_line

Note If you are using Rational Synergy Distributed, it only uses ccm_remexec for auto-receives on remote UNIX systems. A Windows to Windows auto-receive is not affected by entries in remexec.cfg.

The following are the search rules for remexec.cfg:source_host dest_host matching_purpose Highest PriorityALL dest_host matching_purposesource_host ALL matching_purposeDEFAULT DEFAULT matching_purposesource_host dest_host DEFAULT ALL dest_host DEFAULTsource_host ALL DEFAULTDEFAULT DEFAULT DEFAULT Lowest Priority

See “remexec_method” on page 23 for an example of a shipped remexec.cfg file.


Configuring for remote execution

4. Save, and then exit from this file.5. Log off from local administrator.

remexec_method

The remexec.cfg file is used for defining remote execution tools on particular machines. The following are predefined keywords in this module:

%hostname Remote hostname on which to run the command.

%cmdline Command to be executed (as one line).

%cmdargv Command to be executed (parsed as argv).

%shell Shell that is used to run this command, if required.

%command Overall parsed argv of shell + command.

The remexec_method string must contain the keywords %hostname and %command_line, which Rational Synergy expands automatically to the name of the remote host and the command to be executed remotely. This enables you to specify a remote execution command containing options in any position.

Sample methods

The following is a possible remexec.cfg file:DEFAULT DEFAULT %DEFAULT -COMSPEC ccm_rem %hostname [ %shell /C ] %cmdline

In Windows environments, not all machines have their operating system installed at the same location. The COMSPEC environment variable points to the command prompt of the local system. Therefore, do not pass the COMSPEC environment variable if the executed command is a batch file.



Customizing remote execution toolsRational Synergy uses ccm_rem as the default tool to execute remote commands between two Windows machines. If you decide to use your own tool, or if you need to run remote execution to a UNIX machine, you need to change the remexec.cfg file.

1. Develop your own tool to have similar functionality as ccm_rem, keeping the following in mind:

• Preserve the return status of the remote commands.This is required.

• Add the ability to replicate local environment variables to remote machines.This is optional.

• Preserve the current directory for remote commands.This is optional.

2. Modify the corresponding fields in the remexec.cfg file to use your own tool.

For example, change it to use your tool by changing the following line in the remexec.cfg file.

Change this line:DEFAULT DEFAULT ccm_rem %hostname [ %shell /C ] %cmdline

Make the following changes:DEFAULT DEFAULT my_rexec_tool %hostname %cmdline

Managing audit filesThe audit log contains security-related messages from all Rational Synergy processes accessing each database. One audit log is maintained per database. The default location for the audit_log file is database_path\audit_log.


Monitoring product usage

Monitoring product usageThe following subsections describe ways to monitor product usage. The commands that actually do the monitoring are described later, starting in “Administrative Commands” on page 101, but each of the following subsections contain references to the pages where the command information is located.

Users

You can monitor a variety of Rational Synergy processes by using the ccm monitor command.The ccm monitor command provides a network-wide view of Rational Synergy users and processes. It provides a list of the user, process type, host name, process ID, port number, and the associated database path.For a complete description of all command parameters, including usage examples, refer to “ccm monitor” on page 111.

Process statusThe ccm ps command provides network-wide process status information of the various Rational Synergy users and processes. It is a maximum verbosity version of the ccm monitor command.For a complete description of all command parameters, including usage examples, see “ccm ps” on page 114.

Database server usage

The ccmsrv status command shows the status of the database server. This information complements the data provided by the ccm monitor and ccm ps commands.For a complete description of all command parameters, see “ccmsrv status” on page 169. For a usage example, see “Displaying the database server status” on page 54.

Broadcast system messagesThe ccm message command enables you to communicate with specific users or sets of users for administration purposes. You can send a message to an individual Rational Synergy user on a specific Rational Synergy database, or even on a specific Rational Synergy host. For a complete description of all command parameters, including usage examples, see “ccm message” on page 109.



Monitoring the servicesRational Synergy uses the following services that are started automatically:

• Engine startup service is called ccm_ess.

• Router service is called ccm_router.

• Object registrar service is called ccm_objreg.

• Help service is ccm_server.

All of the services display with a version number. For example, for Release 7.1, you will see the following service names: ccm7.1_ess, ccm7.1_router, ccm7.1_objreg, and ccm7.1_server.Rational Synergy supports all services running on machines with more than one IP address.If the interface process will not start and the router is running on a machine that has multiple IP addresses, you may need to modify the _router.adr file, located in the CCM_HOME\etc directory. The additional IP addresses need to be appended to the end of the _router.adr file. The format for machines with a host name is:

hostname:port[:IP]*

The format for machines with no known host name is:ip:port[:IP]*

where [:IP]* represents zero or more IP addresses separated by colons.

ccm_ess

To use an engine process, you must have local logon permission. You must run one ccm_ess service process per engine machine. The ccm_ess service starts automatically upon installation and reboot. It registers with the router. When you start a Rational Synergy session, the interface process requests that ccm_ess start the engine. This service runs as the Rational Synergy administrator.


Monitoring the services

ccm_routerYou must run one router process per network installation. The router starts automatically upon installation and reboot. Note that you must specify the same router host and port for each Rational Synergy installation that is located on the same local network. You will do this when you install Rational Synergy. If you need to refer to this information, look in CCM_HOME\log\setup.log.The router is a central point for registering and requesting information about Rational Synergy processes. It does not explicitly route messages between processes. Rather, it supplies a process with the addresses of other processes, and allows the individual processes to independently communicate among themselves.The log file for the router service is CCM_HOME\log\ccm_router.log. This service runs as system user.

Note You may be running the router on a UNIX server.

ccm_objregYou must run one object registrar process per database host. The object registrar process forwards notifications from one session to another as modifications are made to Rational Synergy databases. This allows each user interface to update its views as other programs modify the data it displays. An object registrar must execute at all times on each host with an active Rational Synergy database, as determined by the object registrar host name property of each database. The object registrar starts automatically upon installation and reboot.The object registrar host name of a database defaults to the host on which the database server resides, but you can change the name by using the ccmdb info command, which is described in “ccmdb info” on page 135. The default log file for the object registrar is CCM_HOME\log\ccm_objreg.log.This service runs as system user.



ccm_serverRational Synergy uses a Web server to serve Rational Synergy Web mode sessions and help requests from users' sessions. The CCM server runs on the same system as the router.Additionally, Rational Synergy uses this Web server to provide client downloads and to distribute patches for Windows clients.

Other servicesIn addition to services that are started automatically, two other services are required. These are Informix® services.

Informix servicesTwo Informix services are required per database server installation:

• Informix Dynamic Server

• Informix Message

You should start and stop the Informix services by using the Rational Synergy administrative commands, ccmsrv online and ccmsrv offline, rather than using the service manager.This service runs as user informix.For more information, see “ccmsrv offline” on page 165 and “ccmsrv online” on page 166.

Monitoring output to log filesThe Rational Synergy services write their output to log files stored in the following locations:

• The router, object registrar, and CCM server write output to log files in CCM_HOME\log

• The engine startup writes output to the Event Log.

• The Rational License Server TL log file is typically located in c:\Program Files\Rational.

The log files for each service reside on the machine where the service is running. Therefore, if one of the services did not start or it stopped running, the appropriate log file holds the information that usually explains the reason for the failure.


Monitoring output to log files

Customer feedback module logsRational Synergy produces a series of log files in one of the following locations:

• UNIX Server—$CCM_HOME/log/synergy_host_port.log• UNIX client—$HOME/ccmlog/synergy.log• Windows Server—$CCM_HOME\log\synergy_host_port.log• Windows client—\IBM

Rational\Synergy\synergy.log

As each log file grows past a configurable limit, the files are rotated, producing log files such as synergy1.log, synergy2.log, and so forth, for the older versions. The size of each generation and the number of generations kept may be configured in the $CCM_HOME\etc\logging.properties file, with the properties com.rational.cm.logging.TLogFileHandler.limit and com.rational.cm.logging.TLogFileHandler.count. The default file size limit is 4MB, and the default number of files kept is 4. On the server side, logs for the back-end sessions supporting Web mode clients are produced in the $CCM_HOME\log directory, using names in the format username_ui.log and username_eng.log, for each client user name.



Setting up databases for read securityGroup security allows restriction of check out and modify permissions to a specified group of users. In addition, read security, which limits visibility of source to designated groups, can be specified. Read security is implemented by providing access control to an object source attribute. Users can query for objects and see other attributes regardless of any read restrictions. Read security applies to source objects which can be versioned, and does not apply to directories and projects.Read security does not have any affect on link-based work areas.Your database should be set up to deny read access to the database path to all regular users. You can do this by mounting the database on a machine that no one can access, or by changing permissions at the system level so no one has access to the database path. This requires that users run remote clients. The remote clients will only be able to use copy-based work areas.Three different levels of read access security can be defined:

• An object that has no read access restrictions to its source can be accessed by any user.

• An object that has one or more groups defined for read access only allows access to the source if the user is a member of at least one of those groups. All other users are denied access to the source contents of that object.

• An object with the highest level of security (no access to the source) cannot be viewed, checked out, or modified, but other attributes can be viewed. However, users working in the ccm_admin role can always view the source contents of files.

Any object that is checked out inherits the same group security restrictions as its predecessor, including read security restrictions. Use the ccm groups command to implement and define security for objects. Group settings on individual objects may be viewed or modified in the Rational Synergy GUI.


Troubleshooting

TroubleshootingThe following sections describe some problems you might encounter while using Rational Synergy and how to solve the problems. To read technical support technical bulletins, go to the Rational Software Information Center.

• Services TerminatedProblem: The engine startup service, router or object registrar terminated abnormally.

Solution: Any Rational Synergy interfaces that are still running will issue a pop-up warning message(s) and suspend operation until the service(s) are restarted. Restart the service, using the Services dialog box on the appropriate machine. After you restart the service(s), the user processes resumes operation.

• ccm monitor Command FailsCannot locate daemon_name messageProblem: After you issue the ccm monitor command, you receive a message similar to the following:Cannot locate router.Please notify your administrator that router must be run.

Solution: The router is not running. Start the router from the Services dialog box, on the router host.

• Error Received When Trying to Start a Session.Problem: When trying to start a session, you receive the Database type not licensed error message.

Solution: Check the following:1. Ensure that ccm_home\etc\license_data.txt contains

port@host.

2. Use the LMTOOLS program on the license host to verify that it is running.

See the IBM Rational License Server TL Guide for details on the Rational License Server TL commands.

3. Check the license manager log file, license.log, located in the installation directory of the Rational License Server TL.




The following are some other messages that you might see in log files. If you need help understanding these messages, see the IBM Rational License Server TL Guide.• TCP_NODELAY NOT enabled • 14:16:17 (IBM) Multiple dup-groupings in effect for

DOORS: 14:16:17 (IBM) NONE vs. USER HOST DISPLAY 14:16:17 (IBM) No further warnings about this.

• 14:46:39 (IBM) DENIED: ‘DOORS’ ann@annpc [IBM] (Licensed number of users already reached. (-4,342:10054 "")) 14:46:39 (IBM) DENIED: ‘DOORS’ ann@annpc [IBM] (Licensed number of users already reached. (-4,342:10054 "")) 14:46:39 (IBM) OUT: ‘TLOG-token’ ann@annpc[DOORS] (3 licenses)



3 Administering the CCM ServerThis chapter discusses the following:

• “About the CCM server” on page 34

• “Starting and stopping the CCM server” on page 34

• “Monitoring the CCM server” on page 35

• “Refreshing databases” on page 36

• “Managing log files” on page 37

• “Using the Web Administrator User interface” on page 38

• “Tuning the CCM server” on page 40


Chapter 3: Administering the CCM Server

About the CCM serverThe CCM server is a Web server that is responsible for the following tasks:

• Serves requests from Rational Synergy sessions running in Web mode.

• Serves online help pages for all Rational Synergy GUI sessions, both Web mode and traditional mode.

• Hosts patches for automatic deployment to Rational Synergy client installations.

Every Rational Synergy server installation needs at least one CCM server. For better scalability, you can start additional CCM servers, for example, if you have multiple Rational Synergy databases with many users. One CCM server can manage multiple databases, but one database cannot be managed by more than a single CCM server. One CCM server must be designated to serve help. For more information, see system_info.txt in “Changing personal settings for Rational Synergy” on page 17.A CCM server can run on any system on your network that is running a server platform supported by Rational Synergy 7.1.The CCM server starts back-end command interface sessions to process user requests from Rational Synergy Web mode clients. It manages the back-end sessions, starting new ones as needed and shutting down old ones when they are no longer needed.

Starting and stopping the CCM serverThe CCM server is started automatically by the installation program and runs as a service.Start or stop the CCM server manually using the Windows Services dialog box.The CCM server runs the port number you specified at the time of installation. The port number is located in the HELP_SERVER setting in the system_info.txt file. See “system_info.txt” on page 18.


Monitoring the CCM server

Monitoring the CCM serverThe following commands can be used to monitor CCM server processes:

• ccm monitor shows a dynamic display of all Rational Synergy processes on the network for a given Rational Synergy installation. CCM servers are shown with the process name server, and the server URL is shown in the Database column. To start a session, Rational Synergy Web mode users need to specify the server URL.

• ccm ps lists all Rational Synergy processes on the network for a given Rational Synergy installation. CCM servers are shown with the process name server, and the server URL is shown in the Database column.

See “Monitoring the services” on page 26.



Refreshing databasesThe ccmdb refresh command refreshes all Web mode back-end sessions for the specified database. Use this command after you create or change a model object attribute that affects the behavior of Rational Synergy clients, so your changes will take effect for all users.After you run this command, the Rational Synergy server starts new back-end sessions to process all new incoming user requests for that database, and shuts down existing sessions on that database as they finish processing requests. Because back-end sessions are reused by different Web mode users, restarting a Rational Synergy GUI Web mode session will not cause model changes to take effect. Therefore, it is necessary to refresh the database using this command.Examples of model changes for which you may want to refresh the database include:

• Changing the conflict_parameters or conflict_exclude_rules that control which conflicts are shown.

• Changing the parallel_exclude_rules that control which parallel conflicts are shown.

• Setting the default work area template for all users.

• Changing the range for keyword expansion in source files.

It is not necessary to use this command after adding, removing, or editing users. Modifying the users attribute causes back-end sessions to be refreshed automatically.Group changes that require a database refresh so that you do not need to refresh databases more than necessary. Although the refresh should be transparent to end users, their session response time may be somewhat slower during a refresh.For more information about this command, see “ccmdb refresh” on page 146.


Managing log files

Managing log filesThe CCM server log is contained in the synergy_host_port.log file, located in the log directory of the Rational Synergy server installation, for example, boon.8400.54123. For more information, see “Other services” on page 28.The Rational Synergy back-end sessions managed by the CCM server all run on the server host. Their log files (both ui and engine) are saved in the log directory of the Rational Synergy server installation. There will be one pair of log files for each user who runs Rational Synergy Web mode sessions. The names of the log files are _ui.log and _eng.log.Because these back-end session log files tend to grow and end users do not have direct access to them, the administrator should monitor the sizes of the files in the log directory and move those approaching a limit such as 1GB to a different name. When a log file is moved, the Rational Synergy logger continues logging to the original file name. Older log files that were moved can be deleted after a period of time. It is good practice to keep them for some time period after moving them in case you need to investigate an issue for the user.The CM administrator may want to automate the process of monitoring the directory for large log files, moving large log files, and deleting very old moved log files.



Using the Web Administrator User interfaceThe Web Administrator User interface is located at /admin. For example:

http://myhost:8400/admin

To use this interface, log on as cm_admin.This interface contains the following sections:

• “Databases tab” on page 38

• “Archive Conversion tab” on page 39

• “Debug Server tab” on page 39

Databases tabThis tab lists all databases and CCM servers that are used to start Web mode sessions. You can perform the following operations:

• “Assigning databases to other servers” on page 38

• “Removing relationships between databases and servers” on page 39

• “Adding databases to the database list” on page 39

You can only modify the databases that are assigned to the current server or the databases where the assigned server of the database is not running.

Assigning databases to other servers

This tab displays the CCM servers and the databases they serve. You can assign a database to another server. For example, if you have a large number of users on a CCM server, you can start a new CCM server on a new physical system and assign a database to that server for better scalability. By default, when you unpack a database, it is automatically associated to the database on the default CCM server on the machine where the database was created.

Note An alternative way to perform this operation is to run the/url server_url option with the ccmdb load, ccmdb unpack, and ccmdb upgrade commands.

To assign a database to another server:

1. Click Change.2. In Server, type the server URL.Click Save.


Using the Web Administrator User interface

Removing relationships between databases and servers

To remove a relationship between a database and a server:

1. Click Delete.2. Click OK.

Adding databases to the database list

To add a database to the database list:

1. Click Add Database.2. In Database, type the database path.3. Click Save.

Archive Conversion tab

Use this tab to convert the data from previous Rational Synergy releases that is stored in the old archive format.See the IBM Rational Synergy Upgrade Instructions document for more information.

Debug Server tabUse this tab for debugging.

Caution Contact IBM Rational Software Support before using the features provided in this tab.


http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsphttp://www.ibm.com/software/awdtools/synergy/support/


Tuning the CCM serverThis section discusses the settings that can be changed to tune the CCM server to fit your environment. All server settings are located in the ccm.server.properties file, under the server $CCM_HOME/etc directory, in the Web server settings section of the file.

Note The server must be restarted so that the changed values take effect.

To change the server configuration, first stop the server, and then edit the ccm.server.properties file to change the settings. Then restart the server.The following settings can be configured. They govern the behavior of the back-end sessions managed by the CCM server.

Changing the number of back-end sessionsSeveral factors affect how many back-end sessions are needed for each database. Back-end sessions are started and stopped based on the loads of each database. So, if a database is heavily used, the server keeps more back-end sessions for that database. The server does stop excessive sessions when the load is not that heavy.The following sections describe which settings in the ccm.server.properties file can be changed to tune the number of back-end sessions the server uses. Many of these settings allow a global setting that sets the value for all databases, and a database specific setting which only affect individual databases. When both settings exist for a database, the database specific value will be used.

Controlling the maximum back-end sessions

This setting controls the maximum number of back-end session the server starts for each database. To change this value for all databases, modify the cm.webserver.max.sessions value in the ccm.server.properties file.To set a different value for a specific databases, create a new key called cm.webserver.max.sessions.database name in the ccm.server.properties file and assign the new value. For example,

cm.webserver.max.sessions.mydb = 50

sets the ma

IBM Rational Synergy - Castalia Camp · 2020. 2. 26. · IBM® Rational® Synergy Administration...

Documents

Transcript of IBM Rational Synergy - Castalia Camp · 2020. 2. 26. · IBM® Rational® Synergy Administration...