Tib Hawk Installation Configuration

225
TIBCO Hawk ® Installation and Configuration Software Release 4.9 November 2010

Transcript of Tib Hawk Installation Configuration

Page 1: Tib Hawk Installation Configuration

TIBCO Hawk®

Installation and ConfigurationSoftware Release 4.9November 2010

Page 2: Tib Hawk Installation Configuration

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Hawk, TIBCO Designer, TIBCO Rendezvous, TIBCO Enterprise Message Service, TIBCO Runtime Agent, TIBCO Administrator, TIBCO ActiveEnterprise and TIBCO Repository are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.Copyright © 1996-2010 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

Page 3: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvTIBCO Hawk Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xviThird Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xixHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xixHow to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xixHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xix

Chapter 1 Overview of the TIBCO Hawk System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Components of the TIBCO Hawk System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2 Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Installer Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Installation Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Installing TIBCO Hawk over Previous Releases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Universal Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Uninstalling TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Product Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Uninstallation Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 3 Installing on Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10User Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Disk Space and Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Installing TIBCO Hawk. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Page 4: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

iv | Contents

Installation Media. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Installation Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Installation Profile Selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Installation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Post-Installation Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Reboot the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Verify the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17External JRE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Configure Microsoft Windows Services Logon Account (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 4 Installing on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Supported Operating Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Installer Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Disk Space and Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Reconfigure Two-Button Mouse Devices (Solaris Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Installing TIBCO Hawk on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Installation Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Installation Profile Selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Installation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Post-Installation Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Starting TIBCO Hawk Components Automatically at System Boot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Solaris Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32HP-UX Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32AIX Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33LINUX Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Mac OS X Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Chapter 5 Installing on IBM i5/OS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Supported Operating Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Preparing for Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Installing TIBCO Hawk on IBM i5/OS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Starting TIBCO Hawk Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Chapter 6 Configuring TIBCO Hawk Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Startup Scripts/Wrappers and Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

TIBCO Hawk Display Configuration File (hawkdisplay.cfg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

TIBCO Hawk Agent Configuration File (hawkagent.cfg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Page 5: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Contents | v

-M Self . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54-M RuleBaseEngine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61-M AMIService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65-M LogService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66-M TIBProtocolAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67-M Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68-M LogfileMicroAgent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68-M CustomMicroAgent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

TIBCO Hawk HMA Configuration File (hawkhma.cfg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

TIBCO Hawk Event Service Configuration File (hawkevent.cfg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Configuring the Event Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Configuring the Event Service with an External Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Creating a TIBCO Hawk Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Creating a TIBCO Rendezvous Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Default Session Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Setting up a TIBCO Rendezvous Daemon Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Chapter 7 Using the Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

Configuration Utility Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

General Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Domain Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91HMA Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Advanced Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Transport Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Primary Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Using TIBCO EMS as the Transport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Connecting to TIBCO EMS using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100TIBCO Rendezvous Daemon Session Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102AMI Rendezvous Session Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

TIBCO Hawk Display Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

TIBCO Hawk Agent Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Configuration Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111MicroAgent Plugins. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Page 6: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

vi | Contents

Logfile Microagent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Heartbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

TIBCO Hawk Event Service Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Agent Dead Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Event Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114AMI Rendezvous Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Fault Tolerance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Logging File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Disabling and Enabling the Event Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Chapter 8 Using the TIBCO Hawk Messaging Microagent . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Configuration File Elements and Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Specifying Field Names in Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Chapter 9 Using TIBCO Hawk Across Nets or Subnets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Agents and the Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Configuring for Network Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Configuring Hawk Rendezvous Subjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Monitoring TIBCO Hawk Agents Using TIBCO Rendezvous and TIBCO EMS . . . . . . . . . . . . . . . . . . . . . . 138Routing TIBCO Hawk Messages with EMS server Across Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Setting up Network Communication on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Routing Daemon Configuration for UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Setting Up Network Communication in Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Installing a Routing Daemon as a Microsoft Windows Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Starting the Routing Daemon Service Automatically in Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . 141Making TIBCO Hawk Services Depend on the Routing Daemon Microsoft Windows Service . . . . . . . . . . 142

Using the TIBCO Hawk Display over a Dial-up Network Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Establishing a Dial-up Connection in UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Establishing a Dial-up Connection in Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Chapter 10 TIBCO Hawk Sample Rulebases and Applications . . . . . . . . . . . . . . . . . . . . . . . . 147

Using the Sample TIBCO Hawk Rulebases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Using the TIBCO Hawk Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

The Sample AMI API Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151TIBCO Hawk AMI C API Sample Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151TIBCO Hawk AMI C++ API Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152TIBCO Hawk AMI Java API Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Page 7: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Contents | vii

Using the Sample Programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Chapter 11 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Trusted Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Authorization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Using both Trusted and TrustedWithDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

To Use the Trusted Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Access Control File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Disable Custom Microagent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Trusted.txt and TrustedWithDomain File Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Running with a localhost rvd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Trusted Security Sample Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Chapter 12 Configuring Plugins and Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171

Configuring TIBCO Hawk Java Virtual Machine MicroAgent Plug-in. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

Configuring TIBCO Hawk Common Logging Publisher MicroAgent Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Configuring TIBCO Hawk AMXHost MicroAgent Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

Appendix A Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175

Migration Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Re-Linking C and C++ Applications to Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Changing the Codepage Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Using 3.x and 4.x Agents Together. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Using the Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Converting Commands from Previous Releases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Appendix B Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179

UNIX Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Microsoft Windows Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Packet Fragmentation Errors with Multicast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182String Variable Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Incompatible Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

General Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Appendix C TIBCO Hawk Directories and Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189

TIBCO Hawk Directory Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Appendix D Code Page Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195

Page 8: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

viii | Contents

Code Page Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Page 9: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Figures | ix

Figures

Figure 1 General Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Figure 2 Advanced Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Figure 3 Transport Configuration using TIBCO Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Figure 4 Transport Configuration using TIBCO Enterprise Message Service . . . . . . . . . . . . . . . . . . . . . . . . 97

Figure 5 Add AMI Rendezvous Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Figure 6 Display Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Figure 7 Agent Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Figure 8 Rulebase Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Figure 9 TIBCO Hawk Event Service Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Figure 10 Sample Routing Daemon Configuration for TIBCO Hawk Messaging . . . . . . . . . . . . . . . . . . . . . . 137

Page 10: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

x | Figures

Page 11: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Tables | xi

Tables

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Table 2 Supported Microsoft Windows Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Table 3 Installation Package Filenames for Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Table 4 Supported UNIX Platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Table 5 Required Disk Space in the Temp and Installation Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Table 6 UNIX Installation tar Package Filenames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Table 7 TIBCO Hawk Components, Startup Scripts/Wrappers, and Configuration Files . . . . . . . . . . . . . . 42

Table 8 hawkdisplay.cfg Functions and Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Table 9 hawkagent.cfg Modules and Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Table 10 -M Self Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Table 11 -M RuleBaseEngine Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Table 12 -M TIBProtocolAdapter Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Table 13 -M LogfileMicroAgent Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Table 14 -M CustomMicroAgent Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Table 15 hawkhma.cfg Functions and Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Table 16 hawkevent.cfg Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Table 17 Database Configuration Value: Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Table 18 Database Configuration Value: Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Table 19 TIBHAWK_AMI Element Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Table 20 microagent Element Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Table 21 method Element Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Table 22 inputParameter Element Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Table 23 valueChoices Element Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Table 24 legalValueChoices Element Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Table 25 constantParameter Element Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Table 26 outputParameter Element Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Table 27 Access Control File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Table 28 TIBCO_HOME Files and Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Page 12: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

xii | Tables

Table 29 TIBCO HAWK_HOME Files and Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Table 30 CONFIG_FOLDER Files and Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Table 31 Code Page Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Page 13: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| xiii

Preface

This manual covers the installation of the TIBCO Hawk® software on Microsoft Windows 2003, Microsoft Windows XP, Microsoft Windows Vista, Solaris, HP-UX, AIX, UNIX, Linux, and i5/OS. Custom configuration is also covered in this manual.

This manual assumes you are familiar with TIBCO Rendezvous architecture and the concepts of system monitoring.

Topics

• Changes from the Previous Release of this Guide, page xiv

• Related Documentation, page xv

• Typographical Conventions, page xvii

• Connecting with TIBCO Resources, page xix

This software may be available on multiple operating systems. However, not all operating system platforms for a specific software version are released at the same time. Please see the readme file for the availability of this software version on a specific operating system platform.

Page 14: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

xiv | Changes from the Previous Release of this Guide

Changes from the Previous Release of this Guide

This section itemizes the major changes from the previous release of this guide.

• A new chapter on how to configure the TIBCO Hawk Java Virtual Machine MicroAgent, TIBCO Hawk Common Logging Publisher MicroAgent, and TIBCO Hawk AMXHost MicroAgent Plug-ins, is added. For details, refer to Chapter 12, Configuring Plugins and Adapters.

• TIBCO Hawk Configuration Utility provides a new option Advanced > Custom Microagent that allows you to load the microagents selectively. The custom microagent configuration module deals with the -timeout command line option which relates to the timeout value. For details, refer to Chapter 6, Configuring TIBCO Hawk Software.

Page 15: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Preface | xv

Related Documentation

This section lists documentation resources you may find useful.

TIBCO Hawk DocumentationThe following documents form the TIBCO Hawk documentation set:

• TIBCO Hawk Installation and Configuration Read this book first. It contains step-by-step instructions for installing TIBCO Hawk software on various operating system platforms. It also describes how to configure the software for specific applications, once it is installed. An installation FAQ is included.

• TIBCO Hawk Administrator’s Guide This manual includes basic descriptions of TIBCO Hawk concepts, instructions for using TIBCO Hawk Display, monitoring strategies with examples, a comprehensive FAQ, and a glossary. All books in the documentation set refer to features explained in this book.

• TIBCO Hawk Plug-in for TIBCO Administrator Contains detailed descriptions of the TIBCO Hawk plug-ins accessed via TIBCO Administrator.

• TIBCO Hawk Programmer’s Guide All programmers should read this manual. It covers the AMI protocol, AMI messages, the AMI Workbench development tool, and the TIBCO Hawk security framework and its classes. Programmers should then refer to the appropriate language reference for the AMI API. The TIBCO Hawk Application Management Interface (AMI) exposes internal application methods to TIBCO Hawk.

• TIBCO Hawk AMI C Reference Contains detailed descriptions of each datatype and function in the TIBCO Hawk C AMI API.

• TIBCO Hawk AMI C++ Reference Contains detailed descriptions of each datatype and function in the TIBCO Hawk C++ AMI API.

• TIBCO Hawk AMI Java Reference Contains detailed descriptions of each class and method in the TIBCO Hawk Java AMI API.

• TIBCO Hawk Console API Reference Contains detailed descriptions of each class and method in the TIBCO Hawk Console API, a set of Java interfaces that allow you to manage and interact with TIBCO Hawk agents and monitor alerts generated by these agents.

• TIBCO Hawk Configuration Object API Reference Contains detailed descriptions of each class and method in the TIBCO Hawk Configuration Object API.

• TIBCO Hawk Methods Reference A reference to the microagents and methods used by a TIBCO Hawk Agent for system and application monitoring.

Page 16: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

xvi | Related Documentation

• TIBCO Hawk HTTP Adapter User’s Guide Contains information about performing discovery, monitoring of agent status, monitoring of agent alerts, method invocation, method subscription, and many more activities on TIBCO Hawk and third-party products.

• TIBCO Hawk Enterprise Message Service Administrator Plug-in Microagent Reference Contains details about the microagent methods that are used to administer and monitor the TIBCO Enterprise Message Service server.

• TIBCO Hawk Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release.

Other TIBCO Product DocumentationYou may find it useful to read the documentation for the following TIBCO products:

• TIBCO Rendezvous®

— TIBCO Rendezvous Concepts

— TIBCO Rendezvous Administration

— TIBCO Rendezvous Configuration Tools

• TIBCO Enterprise Message Service™

— TIBCO Enterprise Message Service Installation

— TIBCO Enterprise Message Service User’s Guide

• TIBCO Administator™

— TIBCO Administrator Installation Guide

Third Party DocumentationYou may find the following third-party documentation useful.

• The Java Language Specification by Gosling, Joy, and Steele

Page 17: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Preface | xvii

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

TIBCO_HOME

CONFIG_FOLDER

HAWK_HOME

Many TIBCO products CAN be installed within the same directory. This directory is referenced in documentation as TIBCO_HOME. The value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco.

Incompatible products and multiple instances of the same product should be installed into different installation environments.

A TIBCO configuration folder stores configuration data generated by TIBCO products. Configuration data can include sample scripts, session data, configured binaries, logs, and so on. This folder is referenced in documentation as CONFIG_FOLDER.

TIBCO Hawk installs into a directory within <TIBCO_HOME>. This directory is referenced in documentation as HAWK_HOME. The value of HAWK_HOME depends on the operating system. For example on Windows systems, the default value is C:\tibco\hawk\4.9.

code font Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code font Bold code font is used in the following ways:

• In procedures, to indicate what a user types. For example: Type admin.

• In large code samples, to indicate the parts of the sample that are of particular interest.

• In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable | disable]

Page 18: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

xviii | Typographical Conventions

italic font Italic font is used in the following ways:

• To indicate a document title. For example: See TIBCO BusinessWorks Concepts.

• To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal.

• To indicate a variable in a command or code syntax that you must replace. For example: MyCommand pathname

Key combinations Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

Table 1 General Typographical Conventions (Cont’d)

Convention Use

Page 19: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Preface | xix

Connecting with TIBCO Resources

How to Join TIBCOmmunityTIBCOmmunity is an online destinaton for TIBCO customers, partners, and resident experts—a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to http://www.tibcommunity.com.

How to Access All TIBCO DocumentationAfter you join TIBCOmmunity, you can access the documentation for all supported product versions here:

http://docs.tibco.com/TibcoDoc

How to Contact TIBCO SupportFor comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows.

• For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site:

http://www.tibco.com/services/support

• If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you can request one.

Page 20: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

xx | Connecting with TIBCO Resources

Page 21: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 1

Chapter 1 Overview of the TIBCO Hawk System

This chapter gives a basic overview of the TIBCO Hawk monitoring system, its components, and the components supported on the various platforms. Not all components run on all platforms, so determine what is supported on your system before beginning installation and configuration.

This book provides instructions for installing the TIBCO Hawk software on each software platform, as well as how to configure the software for specific applications after installation.

Topics

• Components of the TIBCO Hawk System, page 2

Page 22: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

2 | Chapter 1 Overview of the TIBCO Hawk System

Components of the TIBCO Hawk System

The TIBCO Hawk monitoring system consists of the following main software components.

TIBCO Hawk Agent

A TIBCO Hawk agent is an autonomous process that resides on each computer and monitors systems and applications on that computer. Agents run independently of the TIBCO Hawk Display.

Agents operate autonomously and are active whenever the operating system they monitor is active. Agents use sets of rules, called rulebases, to configure system management, status, and automation tasks.

A TIBCO Hawk agent must be installed on each computer you wish to monitor.

TIBCO Hawk Microagent

A TIBCO Hawk Microagent (HMA) is a partner process to the TIBCO Hawk agent and provides the local agent with methods for monitoring the host operating system.

Like the agent, a TIBCO Hawk Microagent is generally installed on each computer you wish to monitor.

TIBCO Hawk Display Program

The TIBCO Hawk Display program is used by system administrators to view network health and to create rulebases (sets of rules that automate monitoring activities).

A TIBCO Hawk Display should be installed on any computers you wish to use for monitoring the network or for building rulebases.

TIBCO Hawk Event Service

The TIBCO Hawk Event Service is a process that records TIBCO Hawk alerts and changes in agent status. When communication with an agent is lost, the Event Service can invoke a user-provided script. Alerts and notifications can be recorded to log files or a database.

Typically, the TIBCO Hawk Event Service is installed on a minimal number of computers in the network.

Page 23: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 3

Chapter 2 Installation Overview

This chapter provides an overview of the installer program.

Appendix C, TIBCO Hawk Directories and Files, contains a complete list of the files and folders installed for the various platforms.

Topics

• Installer Overview, page 4

• Uninstalling TIBCO Hawk, page 6

Installing TIBCO Hawk on Microsoft Windows updates the system path to include TIBCO Rendezvous 8.3. If you have TIBCO applications installed that use Java, and if those applications are using the TIBCO Rendezvous bundled in TRA 5.1.x (instead of a separately installed TIBCO Rendezvous), the applications will not be able to start the TIBCO Rendezvous daemon, rvd.exe, after you install TIBCO Hawk.

To allow the previous TIBCO applications to start rvd.exe again, remove the TIBCO Rendezvous 8.3 directory from the system path (for example, c:\tibco\tibrv\bin). This will not affect the operation of TIBCO Hawk.

TIBCO applications that use Java include TIBCO Adapter 4.x, TIBCO Designer 4.x, TIBCO ActiveMatrix BusinessWorks 5.x, and others.

Page 24: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

4 | Chapter 2 Installation Overview

Installer Overview

Installation DirectoryIf this is the first TIBCO software product you are installing on the system, you can specify the installation directory where TIBCO Hawk will be installed. On Microsoft Windows, the default installation directory is C:\tibco. On UNIX, the default installation directory is /opt/tibco.

If you already have a TIBCO ActiveEnterprise 5.x product on your machine, you can install TIBCO Hawk on any other specified location of your choice other than the default location.

install-path

The directory into which you install TIBCO Hawk is referred to in this documentation as install-path.

For example, if you accept the default installation path on Microsoft Windows, install-path is C:\tibco\hawk\<version>.

config-path

The directory CONFIG_FOLDER is the folder where all the configuration files of TIBCO Hawk are located.

The default config folder for TIBCO Hawk is CONFIG_FOLDER/tibco/cfgmgmt/hawk.

If the plugin folder does not exist under CONFIG_FOLDER/tibco/cfgmgmt/hawk, you need to create it.

Installing TIBCO Hawk over Previous Releases

You do not need to uninstall the previous or current version of TIBCO Hawk on the system before installing the new version.

The new version of TIBCO Hawk Universal Installer now does not detect the previously installed versions of the product. However, it enables you to install the product into multiple TIBCO homes on the same machine.

See Uninstalling TIBCO Hawk on page 6.

If TIBCO Hawk 4.9 is installed over existing TIBCO Hawk installation, the previously installed Windows services will be replaced by the services of the new installation.

Page 25: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Installer Overview | 5

Universal InstallerUniversal Installer enables TIBCO Hawk 4.9 to be installed in multiple TIBCO_HOME. During installation, you can select the existing TIBCO_HOME or create a new TIBCO_HOME. If the existing TIBCO_HOME is selected, it may have other products installed including TIBCO Hawk. However, incase of a pre-installed Hawk installation in the TIBCO_HOME, the existing installation will:

• Replace, if the same version (major, minor) is installed.

• Upgrade to the latest version, if the patch version is latest.

• Add, incase of newer major or minor version.

The installer is responsible to create and setup directories under HAWK_HOME/4.9. All the files under HAWK_HOME/4.9 should not be modified by any other component except the installer. An installation properties file that includes settings required for runtime is placed in the installation directory.

Installation Property File

During the installation, the installer creates or updates the properties file named install.properties under the installation directory. This file contains the settings that will be used by TIBCO Hawk runtime modules.

Only Windows installation uses this file to replace the registry entries setup by the previous version on the installer.

Page 26: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

6 | Chapter 2 Installation Overview

Uninstalling TIBCO Hawk

The uninstaller removes all files that were installed as a part of TIBCO Hawk installation, even if those files were modified by the user or the application. Files that were created by the user are not deleted or modified.

Product DependenciesTIBCO Designer (only version 2.x) and TIBCO Runtime Agent (TRA) are dependent on TIBCO Hawk being present on the machine.

When multiple products like TIBCO Runtime Agent 5.7 and TIBCO Hawk 4.9 are installed under the same TIBCO_HOME, there is only one uninstaller for both under TIBCO_HOME_uninstall.

• Uninstall TIBCO Hawk (TIBCO_HOME/_uninstall).

If both TRA and TIBCO Hawk are selected for uninstallation, TIBCO Hawk will be uninstalled first followed by TIBCO Runtime Agent .

If you have TIBCO Designer or TRA installed on your machine and you want to uninstall only TIBCO Hawk, uninstall them in the following order:

1. Uninstall TIBCO Runtime Agent (tra-install-path\version\_uninst) and any of its product dependencies.

2. Uninstall TIBCO Hawk (TIBCO_HOME/_uninstall).

If you do not have TIBCO Designer or TRA installed on your machine, you can uninstall TIBCO Hawk without prerequisite.

Uninstallation Instructions

Microsoft Windows

Uninstall TIBCO Hawk using one of the following methods:

• Use Add/Remove Programs from the Control Panel.

• Navigate to the _uninstall directory located in install-path and invoke the universal_uninstall.exe program.

Make sure you have a backup of user-modified files before proceeding with the uninstallation.

Page 27: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Uninstalling TIBCO Hawk | 7

UNIX Systems

Uninstall TIBCO Hawkby navigating to the _uninst directory located in universal_uninstall.bin program.

IBM i5 SystemsDLTLICPGM LICPGM(1TIBHK1)

This will uninstall directory path /usr/tibco/hawk/4.9 and library TIBHAWK.

Page 28: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

8 | Chapter 2 Installation Overview

Page 29: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 9

Chapter 3 Installing on Microsoft Windows

This chapter explains how to install and uninstall TIBCO Hawk on computers running the Microsoft Windows 2003, 2008, or XP operating system. Information in this chapter applies to all three platforms unless otherwise noted.

Topics

• Installation Prerequisites, page 10

• Installing TIBCO Hawk, page 13

• Post-Installation Tasks, page 17

Page 30: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

10 | Chapter 3 Installing on Microsoft Windows

Installation Prerequisites

Read this section before you start installation.

Supported Operating SystemsThe following tables lists the supported Microsoft Windows platforms:

Table 2 Supported Microsoft Windows Platforms

User PrivilegesYou must have administrator privileges to install TIBCO Hawk. If you do not, the installer will exit. You must then log out of the system and log in as a user with administrator privileges.

Installing to a Networked Drive

If you intend to install the product onto a networked drive, you must have permissions to write to that drive.

If you do not know how to do this, go to the machine so you can install locally, or consult Microsoft Windows online help.

Disk Space and MemoryThis section lists the minimum free disk space and memory required for each platform.

OS Hardware

Microsoft Windows 7 x86

(32-bit and 64-bit)Microsoft Windows XP

Microsoft Windows Vista

Microsoft Windows 2003 Server

Microsoft Windows 2008 Server

Microsoft Windows 2008 Server R2 x86 (64-bit)

Page 31: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Installation Prerequisites | 11

During installation, the entire package is extracted into a temporary directory, typically one of the following:

• SystemDrive:\Temp

• SystemDrive:\Documents & Settings\user_name\Local Settings\Temp

Before actually installing the files, the installer calculates the disk space that the selected components will require in the installation directory. The installer will proceed only if sufficient free disk space is available in the installation directory.

If some of the required disk space is taken by another process during installation, the installer may fail and display a failure message.

Temp Directory

At least 150 MB free space is required in the temp directory.

Installation Directory

At least 150 MB free space is required in the TIBCO Hawk installation directory.

RAM

All platforms require at least 512 MB RAM.

SoftwareThe following software is required as indicated on the target machine.

TIBCO Software

• TIBCO Rendezvous 8.1.1 or above is required, with any available patches.

If you have already installed TIBCO Rendezvous software on a network-wide basis, you will not need additional TIBCO Rendezvous licenses unless you will be running TIBCO Rendezvous Routing Daemon (RVRD) processes on a particular machine. In this case, you need a valid RVRD license in the tibrv.tkt file for that machine.

During installation, TIBCO Rendezvous is automatically installed if not present. Any earlier version of TIBCO Rendezvous will be upgraded to the version 8.3.

TIBCO Rendezvous is used for inter-process communication even if TIBCO Enterprise Message Service (EMS) is chosen as the primary transport.

• (Optional) TIBCO Enterprise Message Service 5.1.5 and 6.0.0.

Page 32: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

12 | Chapter 3 Installing on Microsoft Windows

IF you plan to use TIBCO EMS as the primary messaging transport, at least one EMS server must be installed on the network and you must select to install the TIBCO EMS Java client during installation on every machine running TIBCO Hawk Agent and TIBCO Hawk Console applications.

• (Optional) TIBCO Administrator 5.4.0, 5.6.1

• (Optional) TIBCO Runtime Agent 5.5.4, 5.6.2

If you plan to use any Hawk plug-ins, TIBCO Administrator and TIBCO Runtime Agent are required.

JRE

TIBCO Hawk bundles Java Runtime Environment (JRE) version 1.6 or above, with any available patches, on the target machine. It is not a pre-requisite as during the installation process, you can uncheck the JRE checkbox in the Hawk Component, if JRE is already installed on your machine.

Page 33: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Installing TIBCO Hawk | 13

Installing TIBCO Hawk

Before you begin installation, close all open TIBCO programs (including all TIBCO Rendezvous processes). If any errors appear during installation, consult Appendix B, Troubleshooting, page 179, for possible solutions.

Installation MediaYou can either download the TIBCO Hawk installation package or install the components from a CD.

Installation PackagesThe following table lists the installation packages

Table 3 Installation Package Filenames for Microsoft Windows

Installation Profile SelectionDuring installation, you can choose from the following installation profiles.

• Hawk Agent- This installation profile installs only Hawk Agent related components.

• Hawk Components- This installation profile installs all Hawk components.

• Hawk Display- This installation profile installs only Hawk Display.

• Hawk SDK- This installation profile installs only Hawk development tools to build the microagent, AMI, or the console application.

OS Package Filename

Microsoft Windows XP

Microsoft Windows 2003 Server

Microsoft Windows 2008 Server

(32-bit)

TIB_hawk_<version_num>_win_x86_vc8.zip

Microsoft Windows XP

Microsoft Windows 2003 Server

Microsoft Windows 2008 Server (64-bit)

TIB_hawk_<version_num>_win_x86_64_vc8.zip

For developers using Visual Studio 2005.

Page 34: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

14 | Chapter 3 Installing on Microsoft Windows

The following sections discuss the different modes of installing TIBCO Hawk.

Installation ModesThe installer allows you to install in different modes. Each mode is supported on all platforms.

• GUI mode allows you to select which components to install, where to install them, and so on. GUI mode is the installer’s default mode.

• Console mode allows you to run the installer from the command line and allows you to select which components to install.

• Silent mode installs using values in .silent file. Silent mode installs in console mode without prompting you for input. It installs using either the default settings or a response file that was saved during an earlier installation.

You can use any of the following options to install TIBCO Hawk:

• Install Using GUI, page 28

• Install Using Console, page 28

• Install in Silent Mode, page 28

These options and the instructions for installing TIBCO Hawk are provided in the following sections. The following examples use the 32-bit installation package Microsoft Windows.

Install Using GUI

GUI mode performs the installation in an interactive graphical interface. The installer prompts you for values specific to your environment.

To install, doubleclick the icon named

TIBCOUniversalInstaller.exe.

Install Using Console

Console mode allows you to install the software from a Microsoft Windows command window. The installer prompts you for values. When installing in console mode you move through the installation process as shown:

• Enter moves forward in the installer.

• 2 returns to the previous screen.

• 3 cancels the installer and exits the installation or uninstallation.

• 4 redisplays the current screen.

Page 35: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Installing TIBCO Hawk | 15

To install from a Microsoft Windows command window, type:

TIBCOUniversalInstaller -console

Install in Silent Mode

The following procedure explains how to install a TIBCO Hawk product in silent mode. It installs TIBCO Hawk using default values. The TIBCOUniversalInstaller.silent file is packaged in the directory that contains the universal installer. You must edit the file with information for your environment before launching the silent installation. The file includes comments that describe the installation properties you can set.

While you can use the TIBCOUniversalInstaller.silent file, it is a good practice to copy the file to a different name and edit that file for the silent install.

If errors occur during installation, they will be listed in the installation log file (see the User_Home/.TIBCO directory).

1. Open the physical media or download the TIBCO Hawk product package.

2. Extract the TIBCO Hawk product archive file to a temporary directory.

3. Using a console window, navigate to the temporary directory that contains the universal installer.

4. Copy the TIBCOUniversalInstaller.silent file and rename the copy.

5. Using a text editor, open the copied file and update the install location, and features to install.

6. Run the installer using this command line:

TIBCOUniversalInstaller.exe -silent

A line similar to the following is written to the installer log file when installation completes:... Install, com.tibco.installer.util.TIBCOInstaller, dbg.Debug, Executing Event:::OnEndInstall

New in .silent file

The following elements can be set to "true" or "false" in the .silent file for installing your choice of components.

If .silent file is not named TIBCOUniversalInstaller.silent then the command to call silent installation is TIBCOUniversalInstaller.exe -silent -V responseFile="<pathAndFilename>" where <pathAndFilename> is the absolute directory path and file name to the .silent file.

Page 36: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

16 | Chapter 3 Installing on Microsoft Windows

• <entry key="feature_Runtime_rv">true</entry>

• <entry key="feature_JRE_hawk">true</entry>

• <entry key="feature_Agent_hawk">true</entry>

• <entry key="feature_Display_hawk">true</entry>

• <entry key="feature_Event Service_hawk">true</entry>

• <entry key="feature_SDK_hawk">true</entry>

• <entry key="feature_Samples_hawk">true</entry>

• <entry key="feature_TIBCO Hawk Documentation_hawk">true</entry>

• <entry key="feature_Adapters and Plug-ins_hawk">true</entry>

Page 37: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Post-Installation Tasks | 17

Post-Installation Tasks

After the installation program has finished, it automatically starts the TIBCO Hawk configuration utility, described in Chapter 7, Using the Configuration Utility.

Before using the configuration utility, perform the following post-installation tasks as noted.

Reboot the SystemIf you upgraded to TIBCO Rendezvous 8.1.1 during installation, reboot the system now.

Verify the InstallationTo verify the installation, check that all directories and files have been added correctly. For details, see Appendix C, TIBCO Hawk Directories and Files, page 189.

External JREFor JVM, CLEvent, and AMXHost microagents: If you have specified external JRE 1.6.0 when installing TIBCO Hawk, then tools.jar in the .hma file must point to a JDK installation location.

If you have installed JRE 1.6.0 from the TIBCO Hawk 4.9 installer, then tool.jar is present under the lib folder.

Configure Microsoft Windows Services Logon Account (Optional)The TIBCO Hawk software components (TIBCO Hawk agent, HMA, and TIBCO Hawk Event Service) are installed as Microsoft Windows services. The Microsoft Windows services run independently of any logged-on user and, therefore, require a Microsoft Windows user account, under which the service can log on and run.

Windows services must be in a running state from the latest installation, if you install TIBCO Hawk into multiple TIBCO_HOME on a single machine. Also, the tibhawkconfig utility from all the installations will use the same configurations.

Page 38: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

18 | Chapter 3 Installing on Microsoft Windows

By default, the installation program configures the TIBCO Hawk Microsoft Windows services to use the built-in system account. This is the account used by the majority of Microsoft Windows services. If you don’t want to use the system account, you must do the following:

a. Set up the Administrator User Account.

b. Give the Administrative User the "Log On as Service" Privilege.

c. Change the Logon Account for TIBCO Hawk Windows Services.

These instructions follow.

Task A Set up the Administrator User Account

You can use an existing user account or create a new one under which to run the TIBCO Hawk services. If you want to use an existing account that doesn’t already have administrator privileges, you must assign administrative privileges to it.

The following steps allow you to set up the administrator account on Windows:

1. Click Start>Administrative Tools>Computer Management>System Tools>Local Users and Groups.

2. If you are adding administrator privileges to an existing account, skip to step 3. If you are creating a new user to be the administrator, proceed as follows:

a. Choose the User>New User menu item. You see the New User dialog.

b. Complete the New User dialog and click OK to return to the User Manager window. (Refer to the Windows documentation for help on the fields required by the New User dialog.)

These steps may differ on other Windows Operating System, hence refer to Windows OS Guide for details.

— On Windows XP, click Start>Programs>Administrative Tools>User Manager.

— On Windows 7, click Start>Control Panel>User Accounts or Start>Control Panel>Administrative Tools>Computer Management>System Tools>Local Users and Groups.

— On Windows 2008 R2, click Start>Control Panel>User Accounts or Start>Control Panel>Administrative Tools>Computer Management>System Tools>Local Users and Groups.

Page 39: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Post-Installation Tasks | 19

3. In the lower half of the User Manager window, double-click the Administrators group. You see the Local Group Properties dialog.

4. Click Add to access the Add Users and Groups dialog.

5. Select the desired user account and click Add. The selected user account appears in the Add Names list in the lower half of the dialog.

6. Click OK to add the user to the group and return to the Group Properties dialog. The user account is now in the Members list.

7. Click OK to return to the User Manager window.

Task B Give the Administrative User the "Log On as Service" Privilege

If your administrator user account doesn’t already have the "Log on as a service" right, give it this right as follows.

1. In the User Manager window, choose the menu item Policies>User Rights. You see the User Rights Policy dialog.

2. In the User Rights Policy dialog do the following:

a. Click the Show Advanced User Rights check box.

b. From the drop-down list labeled Right, choose the line Log on as a service.

c. Click Add. The Add Users and Groups dialog appears.

3. Navigate to the desired user name and select it, as follows:

a. In the List Names From list box, select your machine name, if it is not selected.

b. In the Names box, select the Administrators group and click Members. The Local Group Members box appears.

c. Select the desired user account and click Add.

The desired user account appears in the Add Names box at the bottom of the Add Users and Groups dialog.

4. Click OK to grant the selected user the "Log on as a service" right and return to the User Rights Policy dialog. The user account you selected now appears in the Grant To box.

5. Click OK to return to the User Manager window, then choose User>Exit to leave this window.

Page 40: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

20 | Chapter 3 Installing on Microsoft Windows

Task C Change the Logon Account for TIBCO Hawk Windows Services

Now you must change the logon account for the TIBCO Hawk Windows services to the selected administrative user account, as follows.

1. Choose Start>Settings>Control Panel and double-click on the Services icon. You see the Services dialog.

2. Select the desired TIBCO Hawk service from the list, right-click, and click Properties. You see the Service dialog.

3. In the Log On As tab, click This Account and enter the desired user account and password.

4. Click OK to save your action and return to the Services dialog.

5. Repeat from step 2 for each TIBCO Hawk Windows service in the services list.

Task D Configure Processes to Run in Foreground

You can now configure processes started by the TIBCO Hawk agent to run in the foreground. This is optional; if you don’t want to do this, skip to step 4.

1. Select the TIBCO Hawk Agent service from the list and click Startup. You see the Service dialog.

2. In the Log On As tab, click System Account and Allow Service to Interact with Desktop enter the desired user account and password.

3. Click OK to save your action and return to the Services dialog.

4. Click Close to exit the Services dialog, then close the Control Panel window.

You must reboot the machine for the TIBCO Hawk service configuration changes to take effect.

Page 41: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 21

Chapter 4 Installing on UNIX

This chapter explains how to install and uninstall the TIBCO Hawk monitoring system on computers running the UNIX operating system.

Topics

• Installation Prerequisites, page 22

• Installing TIBCO Hawk on UNIX, page 26

• Post-Installation Tasks, page 30

• Starting TIBCO Hawk Components Automatically at System Boot, page 32

Page 42: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

22 | Chapter 4 Installing on UNIX

Installation Prerequisites

Read this section before you start installation.

Supported Operating SystemsThe following platforms are supported, with patches required as listed.

Make sure that all patches required by other TIBCO products or third-party software (such as the JRE) are installed before installing TIBCO Hawk.

Table 4 Supported UNIX Platforms

OS Hardware Patches

Solaris 8

Solaris 9

Solaris 10

SPARC (32- and 64-bit) None required for TIBCO Hawk.

Solaris 10 x86 None required for TIBCO Hawk.

HP-UX 11i

(v1, v2,v3)

PA-RISC If using TIBCO Rendezvous: PHNE_26250, ARPA patch PHNE_20436 (PHNE_17662), and streams patch PHNE_20008 (PHNE_17794) are required.

For HP-UX 11.00 64 bit systems, HP-UX kernel patch PHKL_27282 is required.

HP-UX 11i

(v2 and v3)

IA64 (Itanium) None required for TIBCO Hawk.

AIX 5.3

AIX 6.1

POWER

(32-bit and 64-bit)Apply 5.0.0.4 xlC libraries as indicated by

APAR IY14529

Red Hat Enterprise Linux 4, 5

SUSE 10, 11

IBM i5 OS

x86

(32-bit and 64-bit)

(32-bit and 64-bit)

None required for TIBCO Hawk.

Mac OS X 10.5, 10.6 x86

(32-bit and 64-bit)None required for TIBCO Hawk.

Page 43: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Installation Prerequisites | 23

Installer PrivilegesTIBCO Hawk can be installed by a regular (non-root) user or super-user (root).

If a non-root user installs TIBCO Hawk, change the permissions and ownership of the tibhawkhma binary to root after installation, as shown:

#> chmod 4555 tibhawkhma#> chown root:bin tibhawkhma

Different users can install the same product at different locations.

Product dependencies at install time are resolved at user level through the installation registry maintained at user's home directory.

TIBCO Hawk HMA Process Runs as root

The TIBCO Hawk HMA process must run as user root to operate correctly. The installation program, accordingly, creates setuid permissions with root ownership for the TIBCO Hawk HMA binary.

The HMA only reads system information and cannot perform any actions. It cannot manipulate, modify, or stop processes.

Disk Space and MemoryDuring installation, the entire package is extracted into a temporary directory. Before actually installing the files, the installer calculates the disk space that the selected components will require in the installation directory. The installer will proceed only if sufficient free disk space is available in the installation directory.

If some of the required disk space is taken by another process during installation, the installer may fail and display a failure message.

If your system does not have sufficient free disk space in the temp directory listed in the table below, you can use a different temp directory by including the following option when starting the installer, where /new_tmp has sufficient free disk space:

If 64-bit kernel is used and you have installed 32-bit TIBCO Hawk, some statistics will remain undefined.

If the required JRE version is already on your system, significantly less disk space is required in the temp directory.

Page 44: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

24 | Chapter 4 Installing on UNIX

-is:tempdir /new_tmp

Home Directory

The user's home directory must at least have 150 MB of free disk space for the installation registry.

RAM

All platforms require at least 512 MB RAM.

SoftwareThe following software is required as indicated.

TIBCO Software

• TIBCO Rendezvous 8.1.1 or above is required, with any available patches.

If you have already installed TIBCO Rendezvous software on a network-wide basis, you will not need additional TIBCO Rendezvous licenses unless you will be running TIBCO Rendezvous Routing Daemon (RVRD) processes on a particular machine. In this case, you need a valid RVRD license in the tibrv.tkt file for that machine.

During installation, TIBCO Rendezvous is automatically installed if not present. Any earlier version of TIBCO Rendezvous will be upgraded to version 8.3.

TIBCO Rendezvous is used for inter-process communication even if TIBCO Enterprise Message Service (EMS) is chosen as the primary transport.

Table 5 Required Disk Space in the Temp and Installation Directories

Operating System Temp Directory Free SpaceInstallation Directory Free Space

Solaris 150 MB in /var/tmp 150 MB

HP-UX 200 MB in /var/tmp 200 MB

AIX 150 MB in /tmp 150 MB

LINUX 150 MB in /tmp 150 MB

Mac OS X 150 MB 150 MB

Page 45: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Installation Prerequisites | 25

• (Optional) TIBCO Enterprise Message Service 5.1.5 and 6.0.0.

IF you plan to use TIBCO EMS as the primary messaging transport, at least one EMS server must be installed on the network and you must select to install the TIBCO EMS Java client during installation on every machine running TIBCO Hawk Agent and TIBCO Hawk Console applications.

• (Optional) TIBCO Administrator 5.4.0, 5.6.0, or above

• (Optional) TIBCO Runtime Agent 5.5.4, 5.6.2

If you plan to use either any Hawk plug-ins, TIBCO Administrator and TIBCO Runtime Agent are required.

GUI Environment (Optional)

If you are running the installer in GUI mode, a GUI environment such as CDE (X Windows) is required. It is not required for a console or silent installation. Also see DISPLAY Variable Error on page 180.

JRE

Required. JRE 1.6.0 is packaged with TIBCO Hawk as a convenience.

Reconfigure Two-Button Mouse Devices (Solaris Only)Solaris systems using a two-button mouse must be configured with the three-button mouse setting. Configure the two-button mouse as follows:

1. Log in as superuser (root).

2. From the command-line prompt, enter kdmconfig and select Built in PS/2 [3 button mouse].

3. Reboot the system.

Page 46: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

26 | Chapter 4 Installing on UNIX

Installing TIBCO Hawk on UNIX

Before you begin installation, close all open applications. If any errors appear during installation, consult Appendix B, Troubleshooting, for possible solutions.

On all UNIX platforms, if you are upgrading to TIBCO Rendezvous 8.1.1, stop all TIBCO Rendezvous processes before installing TIBCO Hawk.

Installation PackagesCopy the appropriate tar file from the download site or the CD and unpack it on your system. The following table lists the platform-specific installation packages, where <version_num> is the TIBCO Hawk software release number.

Table 6 UNIX Installation tar Package Filenames

OS tar Package Filename

Solaris 8, 9, 10 (Sun SPARC) (32-bit)

TIB_hawk_<version_num>_sol8_sparc.zip

Solaris 8, 9, 10 (Sun SPARC) (64-bit)

TIB_hawk_<version_num>_sol8_sparc_64.zip

Solaris 10 (x86)

(32-bit)

TIB_hawk_<version_num>_sol10_x86.zip

Solaris 10 (x86)

(64-bit)

TIB_hawk_<version_num>_sol10_x86_64.zip

HP-UX 11i (32-bit) TIB_hawk_<version_num>_hpux111_hppa.zip

HP-UX 11i (64-bit) TIB_hawk_<version_num>_hpux111_hppa_64.zip

HP-UX IA64 (32-bit) TIB_hawk_<version_num>_hpux112_ia64_32.zip

HP-UX IA64 (64-bit) TIB_hawk_<version_num>_hpux112_ia64.zip

AIX (32-bit) TIB_hawk_<version_num>_aix52_power.zip

AIX (64-bit) TIB_hawk_<version_num>_aix52_power_64.zip

Linux (32-bit) TIB_hawk_<version_num>_linux26gl23_x86.zip

Linux (64-bit) TIB_hawk_<version_num>_linux26gl23_x86_64.zip

Page 47: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Installing TIBCO Hawk on UNIX | 27

Installation Profile SelectionDuring installation, you can choose from the following installation profiles.

• Hawk Agent- This installation profile installs only Hawk Agent related components.

• Hawk Components- This installation profile installs all Hawk components.

• Hawk Display- This installation profile installs only Hawk Display.

• Hawk SDK- This installation profile installs only Hawk development tools to build the microagent, AMI, or the console application.

The following sections discuss the different modes of installing TIBCO Hawk.

Installation ModesThe installer allows you to install in different modes. Each mode is supported on all platforms.

• GUI mode allows you to select which components to install, where to install them, and so on. GUI mode is the installer’s default mode.

• Console mode allows you to run the installer from the command line and allows you to select which components to install. You can create a response file or template file using console mode.

• Silent mode installs in console mode without prompting you for input. It installs using either the default settings or a response file that was saved during an earlier installation.

You can use any of the following options to install TIBCO Hawk:

• Install Using GUI, page 28

• Install Using Console, page 28

• Install in Silent Mode, page 28

These options and the instructions for installing TIBCO Hawk are provided in the following sections. The following examples use the installation package for SUN SPARC Solaris 2.8.

Mac OS X 10.5 (32-bit) TIB_hawk_<version_num>_macosx_x86.zip

Mac OS X 10.5 (64-bit) TIB_hawk_<version_num>_macosx_x86_64.zip

Table 6 UNIX Installation tar Package Filenames (Cont’d)

OS tar Package Filename

Page 48: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

28 | Chapter 4 Installing on UNIX

Install Using GUI

GUI mode performs the installation in an interactive graphical interface. The installer prompts you for values specific to your environment.

To install, doubleclick the icon

TIBCOUniversalInstaller-sol-sparc.bin.

Install Using Console

Console mode allows you to install the software from a UNIX terminal window. The installer prompts you for values. When installing in console mode you move through the installation process as shown:

• Enter moves forward in the installer.

• 2 returns to the previous screen.

• 3 cancels the installer and exits the installation or uninstallation.

• 4 redisplays the current screen.

To install from a UNIX terminal window, type:

TIBCOUniversalInstaller-sol-sparc.bin -is:javaconsole -console

Install in Silent Mode

The following procedure explains how to install a TIBCO Hawk product in silent mode. The TIBCOUniversalInstaller.silent file is packaged in the directory that contains the universal installer. You must edit the file with information for your environment before launching the silent installation. The file includes comments that describe the installation properties you can set.

While you can use the TIBCOUniversalInstaller.silent file, it is good practice to copy the file to a different name and edit that file for the silent install.

If errors occur during installation, they will be listed in the installation log file (see the User_Home/.TIBCO directory).

1. Open the physical media or download the TIBCO Hawk product package.

2. Extract the TIBCO Hawk product archive file to a temporary directory.

3. Using a console window, navigate to the temporary directory that contains the universal installer.

4. Copy the TIBCOUniversalInstaller.silent file and rename the copy.

5. Using a text editor, open the copied file and update the install location, and features to install.

Page 49: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Installing TIBCO Hawk on UNIX | 29

6. Run the installer using this command line:TIBCOUniversalInstaller-sol-sparc.bin -is:silent -silent

If you are using the TIBCOUniversalInstaller.silent file (rather than a copy), you need not supply the file name and can use this command line:

TIBCOUniversalInstaller -silent

A line similar to the following is written to the installer log file when installation completes:... Install, com.tibco.installer.util.TIBCOInstaller, dbg.Debug, Executing Event:::OnEndInstall

Page 50: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

30 | Chapter 4 Installing on UNIX

Post-Installation Tasks

After installing TIBCO Hawk on UNIX, the root user must perform the following post-installation tasks as noted.

Task A Verify the Installation

Check that all directories and files have been added correctly. For details, see TIBCO Hawk Directories and Files, page 189.

Task B Modify Permission for tibhawkhma

Modify the permissions of the TIBCO Hawk HMA (tibhawkhma) as shown:

cd $TIBCO_HAWK_HOME/bin/tibhawkhmachown root tibhawkhmachmod u+s tibhawkhma

On AIX and MacOS platforms, the tibhawkhma must be run as root and must not use setuid.

On all other platforms, the TIBCO Hawk HMA (tibhawkhma) is dynamically linked with the TIBCO Rendezvous client libraries. Follow these steps to enable the tibhawkhma to find the libraries:

• HP-UX 11i PA-RISC 32-bit

Add RV library path to:

/etc/dld.sl.conf file which contains trusted paths to search the libraries. If you have the September 2005 Quality Pack patch bundle installed, specifiy a list of trusted paths in /etc/dld.sl.conf. If a path in an environment variable is a trusted path, it will be searched for libraries as usual.

• Linux x86 32-bit/64-bit

Update the /etc/ld.so.conf file add $RVHOME/lib to the list. This must be the actual path and not $RVHOME variable.

Run ldconfig.

Page 51: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Post-Installation Tasks | 31

• Solaris

Add the $RVHOME/lib directory to the trusted list using the crle command on the 32-bit and 64-bit platforms.

The crle command can be used as follows:

— Solaris 8-10 SPARC 32-bit/64-bit - The crle command can be used as follows:

Run "crle -u -s $RVHOME/lib" or "crle -u -s $RVHOME/lib -64"

— Solaris 10 x86 32-bit/64-bit - The crle command can be used as follows:

Run "crle -u -s $RVHOME/lib" or "crle -u -s $RVHOME/lib -64"

where:

-u specifies that the configuration file needs to be updated.

-s specifies the new trusted directory for the secure objects.

Page 52: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

32 | Chapter 4 Installing on UNIX

Starting TIBCO Hawk Components Automatically at System Boot

The TIBCO Hawk agent and TIBCO Hawk HMA components can be configured to start automatically during the system boot cycle. A sample autostart script, Hawk2, is provided in the $HAWK_ROOT/samples/etc directory. It invokes the starthma and startagent scripts during the boot cycle. You can modify this script for your environment. It can be used on all supported UNIX platforms.

The following sections list the steps involved in starting TIBCO Hawk components automatically at system boot. Refer to the correct section for your operating system.

• Solaris Instructions on page 32

• HP-UX Instructions on page 32

• AIX Instructions on page 33

• LINUX Instructions on page 33

• Mac OS X Instructions on page 34

Solaris InstructionsThis section describes how to start TIBCO Hawk components automatically at system boot on a SUN SPARC Solaris or Intel Solaris operating system.

1. Copy the hawk2 file as follows: cp $HAWK_ROOT/samples/etc/hawk2 /etc/init.d/hawk2

2. Modify (if not already present) tibhawkagent.tra file.Change "application.args -file hawkagent.cfg" to

"application.args -file $CONFIG_FOLDER/tibco/cfgmgmt/hawk/bin/hawkagent.cfg"

3. Create a link as follows:ln -s /etc/init.d/hawk2 /etc/rc2.d/S99hawk

4. Use root user to modify /etc/inittab to match system boots level.

HP-UX InstructionsThis section describes how to start TIBCO Hawk components automatically at system boot on an HP operating system.

1. Copy the hawk2 file as follows: cp $HAWK_ROOT/samples/etc/hawk2 /sbin/init.d/hawk2

Page 53: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Starting TIBCO Hawk Components Automatically at System Boot | 33

2. Modify (if not already present) tibhawkagent.tra file.

Change "application.args -file hawkagent.cfg" to

"application.args -file $CONFIG_FOLDER/tibco/cfgmgmt/hawk/bin/hawkagent.cfg"

3. Create a link as follows: ln -s /etc/init.d/hawk2 /etc/rc2.d/S99hawk

4. Use root user to modify /etc/inittab to match system boots level.

AIX InstructionsThis section describes how to start TIBCO Hawk components automatically at system boot on an IBM operating system.

1. Modify (if not already present) tibhawkagent.tra file.

Change "application.args -file hawkagent.cfg" to

"application.args -file $CONFIG_FOLDER/tibco/cfgmgmt/hawk/bin/hawkagent.cfg"

2. Add an entry to the /etc/inittab file as follows:

"hawk:2:once:<HAWK_ROOT>/samples/etc/hawk2 start > /dev/console2>&1"

LINUX InstructionsThis section describes how to start TIBCO Hawk components automatically at system boot on a LINUX operating system.

1. Copy the hawk2 file as follows: cp $HAWK_ROOT/samples/etc/hawk2 /etc/init.d/hawk2

2. Modify (if not already present) tibhawkagent.tra file.

Change "application.args -file hawkagent.cfg" to

"application.args -file $CONFIG_FOLDER/tibco/cfgmgmt/hawk/bin/hawkagent.cfg"

3. Create a link as follows: ln -s /etc/init.d/hawk2 /etc/rc2.d/S98hawk

4. Use root user to modify /etc/inittab.

By default, the run level on RHEL is 5. Change this to 2, such as

id:2:initdefault:

Page 54: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

34 | Chapter 4 Installing on UNIX

Mac OS X InstructionsThis section describes how to start TIBCO Hawk components automatically at system boot on a Mac 0S X 10.3.x operating system.

1. Create a directory under /System/Library/StartupItems as follow:mkdir /System/Library/StartupItems/hawk2

2. Copy the hawk2 file as follows:cp $HAWK_ROOT/samples/etc/hawk2 /System/Library/StartupItems/hawk2/hawk2

3. Copy the StartupParameters.plist file as follows:cp $HAWK_ROOT/samples/etc/StartupParameters.plist /System/Library/StartupItems/hawk2/StartupParameters.plist

Running Hawk2 as Service at System Boot

To run Hawk2 as service when system boots:

1. Modify (if not already present) tibhawkagent.tra file.

Change "application.args -file hawkagent.cfg"

to

"application.args -file $CONFIG_FOLDER/tibco/cfgmgmt/hawk/bin/hawkagent.cfg"

2. Copy hawk2 to /etc/init.d and create a softlink to /etc/rc2.d as mentioned in the following sections.

3. Use root user to modify /etc/inittab.

By default, the run level on RHEL is 5. Change this to 2, such as id:2:initdefault:

Install JRE 1.6 or above before installing TIBCO Hawk.

Page 55: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 35

Chapter 5 Installing on IBM i5/OS

This chapter explains how to install the TIBCO Hawk monitoring system on computers running the IBM i5/OS operating system.

Topics

• Installation Prerequisites, page 36

• Installing TIBCO Hawk on IBM i5/OS, page 38

• Starting TIBCO Hawk Components, page 39

• Starting TIBCO Hawk Components, page 39

Page 56: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

36 | Chapter 5 Installing on IBM i5/OS

Installation Prerequisites

Read this section before you start installation.

Supported Operating SystemsTIBCO Hawk supports IBM i5/OS version V5R3MO or higher.

SoftwareThe following software is required as indicated.

TIBCO Software

• TIBCO Rendezvous 8.1.1 or above is required, with any available patches.

If you have already installed TIBCO Rendezvous software on a network-wide basis, you will not need additional TIBCO Rendezvous licenses unless you will be running TIBCO Rendezvous Routing Daemon (RVRD) processes on a particular machine. In this case, you need a valid RVRD license as TIBRV(TKT) that is member TKT in file TIBRV.

• (Optional) The Java client for TIBCO Enterprise Message Service 4.4.2 with any available patches.

JRE

TIBCO Hawk requires Java Runtime Environment (JRE) version 1.6 or above with any available patches, on the target machine.

JRE is not included with the TIBCO Hawk installation package.

The tibhawkpassword utility (which encrypts the user password for connecting to the EMS server) is not supported on IBM i5/OS.

Page 57: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Preparing for Installation | 37

Preparing for Installation

The installation package for IBM i5 is delivered in file xxx.zip. This zip file contains savefile TIBHAWKSF which contains all the objects required to install the TIBCO Hawk product on IBM i5.

Here is a sample set of steps for downloading the savefile to the IBM i5.

On IBM i5:

1. Login to your IBM i5 machine using your personal user profile.

2. Create a library for receiving the savefile. For this exercise, let us assume that the library is called MYHAWKLIB.— CRTLIB MYHAWKLIB

— or, use a library that you already have access to.

On Windows:

1. Unzip the distribution archive on a Microsoft Windows system.

— Extract file TIBHAWKSF.sav from xxx.zip to one of your directories and name it as for example, md c:\myHawkDir

Extract file TIBHAWKSF.sav from xxx.zip to c:\myHawkDir2. cd C:\myHawkDir

3. ftp <hostname of ibm i>

4. Enter personal user profile and password.

5. Quote site namefmt 16. cd MYHAWKLIB.LIB

7. bin

8. put TIBHAWKSF.sav TIBHAWKSF.savf

9. Quit.

Page 58: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

38 | Chapter 5 Installing on IBM i5/OS

Installing TIBCO Hawk on IBM i5/OS

To install the software, follow these steps:

1. Signin as QSECOFR.

2. Perform the installation using the command RSTLICPGM as follows:RSTLICPGM LICPGM(1TIBHK1) DEV(*SAVF) SAVF(MYHAWKLIB/TIBHAWKSF)

This will restore both the product library, TIBHAWK, and all files in the IFS, /usr/tibco/hawk/4.9.

Page 59: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Starting TIBCO Hawk Components | 39

Starting TIBCO Hawk Components

To Start TIBCO Hawk Microagent

• ADDLIBLE TIBHAWK

• SBMJOB CMD(CALL PGM(TIBHKHMA) PARM('-rvd_session' '7474' ''

'tcp:7474')) JOBQ(QUSRNOMAX) MSGQ(*USRPRF) ALWMLTTHD(*YES)

To Start TIBCO Hawk Agent

• ADDLIBLE TIBHAWK

• Edit the default hawkagent.cfg file EDTF STMF('/usr/tibco/hawk/4.9/bin/hawkagent.cfg')

— Change occurrence of "%TIBCO_HAWK_ROOT_ESC%/config" to "/usr/tibco/hawk/4.9/config"

• CALL PGM(TIBHKAGT) PARM( 1.6 )

ALWMLTTHD(*YES) must be specified to enable the multi-threaded application.

Ensure that JOBQ(QUSRNOMAX) is active in your environment.

• The default codepage used for reading output from the TIBCO Hawk methods Custom::ExecuteForString and Custom::ExecuteForNumber is Cp037. You can override this default value by specifying the codepage in the Java property customMA.codepage.

For example, to change the code page to Cp500, add the following line

-DcustomMA.codepage="Cp500"

before specifying the classpath in the startagent script.

• When using TIBCO EMS as the primary transport, TIBCO Hawk agent cannot be started using CL script. You have to start TIBCO Hawk agent using Q shell (qsh).

Page 60: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

40 | Chapter 5 Installing on IBM i5/OS

Page 61: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 41

Chapter 6 Configuring TIBCO Hawk Software

This chapter describes how to edit the configuration files for the TIBCO Hawk Display, Agent, HMA and Event Service components on Microsoft Windows and UNIX platforms. It also describes how to use the startup scripts, create a TIBCO Hawk domain, and create a TIBCO Rendezvous session.

On Microsoft Windows platforms, you can alternatively use a GUI interface to configure TIBCO Hawk General, Display, Agent, and Event Service components. This is described in Chapter 7, Using the Configuration Utility.

Topics

• Startup Scripts/Wrappers and Configuration Files, page 42

• TIBCO Hawk Display Configuration File (hawkdisplay.cfg), page 45

• TIBCO Hawk Agent Configuration File (hawkagent.cfg), page 52

• TIBCO Hawk HMA Configuration File (hawkhma.cfg), page 70

• TIBCO Hawk Event Service Configuration File (hawkevent.cfg), page 73

• Creating a TIBCO Hawk Domain, page 84

• Creating a TIBCO Rendezvous Session, page 85

Page 62: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

42 | Chapter 6 Configuring TIBCO Hawk Software

Startup Scripts/Wrappers and Configuration Files

Please read this chapter and determine your system’s particular configuration and setup requirements before changing any values.

A set of startup wrappers/scripts and configuration files is provided with the TIBCO Hawk software. A startup wrapper/scripts and default configuration file are supplied for each component. The configuration files and options are described in the next sections.

Startup wrappers and configuration files are located in TIBCO_CONFIG_FOLDER/tibco/cfgmgmt/hawk/bin.

On UNIX platform, user should edit the .cfg files to modify the configurations. On Windows, user should use tibhawkconfig.exe to modify the configurations.

This chapter describes the command line options you can use in the configuration files. If no command line options are specified, the startup wrappers use the supplied default values in the configuration files (as shipped) by default.

Table 7 TIBCO Hawk Components, Startup Scripts/Wrappers, and Configuration Files

Component Startup Scripts/Wrapper Configuration File Described

on Page

TIBCO Hawk Display

tibhawkdisplay hawkdisplay.cfg 45

TIBCO Hawk Agent

tibhawkagent hawkagent.cfg 52

TIBCO Hawk HMA

tibhawkhma (Windows)

starthma (UNIX)

hawkhma.cfg 70

TIBCO Hawk Event Service

tibhawkevent hawkevent.cfg 73

In the configuration files, if any folder or file has to be configured with a space in it, then the full path has to be provided within double quotes.

On Mac OS X, TIBCO Hawk display must be started using startdisplay script instead of tibhawkdisplay.

Page 63: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Startup Scripts/Wrappers and Configuration Files | 43

Wrapper Help

Handling Passwords for TIBCO EMS Transport

On Microsoft Windows, the password entered from the Configuration Utility is obfuscated before it is stored in the Microsoft Windows registry.

In order to use the EMS password encrypt/decrypt functionality, all TIBCO Hawk components (including the tibhawkpassword wrapper) have to use JRE 1.6 or above.

If you need to change the username and password information for the EMS server after installation, a utility is provided to encrypt your password. The following steps detail the use of this utility:

1. Invoke the command line using the syntaxtibhawkpassword -encrypt <string>

where <string> is the password you want to encrypt.

2. Copy and paste the output of the utility within quotes ("") into the configuration file.

For example, -ems_transport tcp://emsServer:7222 username "#!FrHOG/QbvQMdVk4/wMv/1DA0"

3. Re-start the TIBCO Hawk component whose configuration file you updated in step 2.

Using AMI applications with TIBCO EMS Transport

Applications implementing the TIBCO Hawk Application Management Interface (AMI) for manageability by a TIBCO Hawk Agent use TIBCO Rendezvous as the messaging transport. As it is much more efficient to keep all AMI-related messages within the same machine as the Agent and the AMI application, TIBCO Rendezvous will continue to be used for AMI communication even if TIBCO EMS is used for all external TIBCO Hawk messaging.

If it is desired to isolate all TIBCO Rendezvous traffic, including the TIBCO Rendezvous Advisory messages, to the local machine when using TIBCO EMS as a network transport, the TIBCO Rendezvous network parameter should be set to use the loopback interface (127.0.0.1) address for all AMI applications and the Agent's AMI Rendezvous transports.

For example, the ami_rvd_session option would be configured as:

-ami_rvd_session 7474 127.0.0.1 tcp:7474

Page 64: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

44 | Chapter 6 Configuring TIBCO Hawk Software

Using TIBCO Hawk in the TIBCO Runtime Agent Environment

The configuration file for TIBCO Hawk agent (hawkagent.cfg) is located in the directory <TIBCO_HOME>/tra/domain/<your domain name>.

For example (on Microsoft Windows) , c:\tibco\tra\domain\qaserver\hawkagent.cfg

The executable used by the configuration file is hawkagent_<your domain name> (on the Microsoft Windows platform, it is hawkagent_<your domain name>.exe)

For example, hawkagent_qaserver.

The default rulebase configuration is Automatic Configuration. Any rulebases deployed by TIBCO Administrator are stored in specified auto configuration directory.

The configuration file should be edited in the same manner as a TIBCO Hawk agent configuration file. For instructions on customizing the configuration file see, TIBCO Hawk Agent Configuration File (hawkagent.cfg), on page 52.

Page 65: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Display Configuration File (hawkdisplay.cfg) | 45

TIBCO Hawk Display Configuration File (hawkdisplay.cfg)

The options in the hawkdisplay.cfg configuration file are used to configure the following functions related to TIBCO Hawk Display. The functions and options are described in the next sections.

Table 8 hawkdisplay.cfg Functions and Options

Function Options

TIBCO Hawk Domain -hawk_domain <TIBCO Hawk domain name>

TIBCO Rendezvous (RVD) Session

-rvd_session <service> <network> <daemon>

TIBCO Enterprise Message Service (EMS) Transport

-ems_transport <ems transport parameters>

TIBCO Enterprise Message Service (EMS) Transport using SSL

-ssl_vendor <name of the vendor>-ssl_no_verify_host

-ssl_trusted <file-name>

-ssl_expected_hostname <host-name>

-ssl_identity <file-name>

-ssl_private_key <file-name>

-ssl_password <string>-ssl_no_verify_hostname

-ssl_ciphers <suite-name(s)>

Character Encoding -character_encoding <character encoding string>

Logging Information -logdir <directory for display logs>

-logmaxsize <maximum size of single display log>

-logmaxnum <maximum number of display logs>

-log_format <Hawk or ActiveEnterprise format>

Display File -display_file <directory for display files>

Security Policy -security_policy <class implementing security>

Variables -variables <External variables property file>

Page 66: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

46 | Chapter 6 Configuring TIBCO Hawk Software

TIBCO Hawk Domain

-hawk_domain <TIBCO Hawk domain name>

Separate domains create independent TIBCO Hawk systems. Agents and the display must share the same Hawk Domain name in order to communicate. The default is to monitor an entire network as one group. To use the default, omit the -hawk_domain option. See Creating a TIBCO Hawk Domain, page 84, for more details.

TIBCO Rendezvous (RVD) Session

-rvd_session <service> <network> <daemon>

This option must be omitted if using TIBCO EMS as the primary transport.

Because the TIBCO Hawk software uses the functionality of the TIBCO Rendezvous system, it must connect to a TIBCO Rendezvous daemon by creating a session.

If TIBCO Rendezvous is only used on one network and no special TIBCO Rendezvous sessions are needed, use the TIBCO Rendezvous daemon session default values. To use the default TIBCO Hawk session parameters, omit the -rvd_session command-line options.

If you use this option, all three parameters must be present and separated by white space. Use a semicolon (;) to indicate a null value, or use an empty string, for example: -rvd_session 7474 "" tcp:7474

See Creating a TIBCO Rendezvous Session, page 85, for more details.

TIBCO Enterprise Message Service Transport

Specifies that the TIBCO Hawk Display should use TIBCO EMS for communicating with the agent. This option must be omitted if using TIBCO Rendezvous as the primary transport.

There are two ways to specify the TIBCO EMS transport parameters:

• Specify only the location of the EMS server.

For example,

-ems_transport tcp://server1:7222

If communicating with the EMS server using SSL, specify the location of the EMS server as follows for the above example -ems_transport ssl://server1:7222

Page 67: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Display Configuration File (hawkdisplay.cfg) | 47

and also specify the additional options as outlined in TIBCO Enterprise Message Service (EMS) Transport using SSL on page 48.

• Specify the location of the EMS server and a valid username and password for the EMS server. These parameters are separated by a space and can be an empty string to indicate a null value.

For example, -ems_transport tcp://server1:7222 admin "#!NhAD1NBC"

For instructions to modify the password which was specified during installation, see Handling Passwords for TIBCO EMS Transport on page 43.

If communicating with the EMS server using SSL, specify the location of the EMS server as follows for the above example -ems_transport ssl://server1:7222 admin "#!NhAD1NBC"

and also specify the additional options as outlined in TIBCO Enterprise Message Service (EMS) Transport using SSL on page 48.

Re-Connection Setup

To ensure the TIBCO EMS client attempts re-connection after losing connection to the EMS server, repeat the server URL in the URL list. For example,

-ems_transport tcp://H1:7222,tcp://H1:7222

Fault Tolerance Setup

You can specify backup servers to connect to in the event of the failure of the primary server. The serverURLs for the primary and backup server(s) are specified as a comma-separated list of URLs.

For example,

-ems_transport tcp://server1:7222,tcp://server2:7344

If a connection to the first URL fails, the next URL in the list is used to attempt a reconnection. The connections in the list are attempted in sequence (wrapping to the start of the list, if the first connection was not the failed connection) until all URLs have been tried. If no connection is established after all URLs have been tried, the connection fails.

In addition to specifying the -ems_transport options, the following parameters in the EMS server configuration file, tibemsd.conf, should be considered:

• ft_active, the name of the active server.

• ft_reconnect_timeout, the amount of time a backup server waits for clients to reconnect.

• store, the directory to store TIBCO EMS data.

For more information, see TIBCO Enterprise Message Service documentation.

Page 68: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

48 | Chapter 6 Configuring TIBCO Hawk Software

TIBCO Enterprise Message Service (EMS) Transport using SSL

Specifies the SSL parameters used by TIBCO Hawk Display when connecting to the EMS server.

If the -ems_tranport parameter is not used, the following options are ignored.

-ssl_vendor <name of the vendor>

The name of the vendor of the SSL implementation. The valid choices are— j2se-default

Use this option when you want to use the default JCE bundled with the Java JRE.

On IBM platforms (such as AIX), this option defaults to ibm.— j2se

— entrust61

Use this option when you want to use the Entrust libraries.— ibm

On non-IBM platforms, this option can be used only if the IBM version of JCE is installed.

-ssl_ciphers <suite-name(s)>

When specifying this option to specify the cipher suites that can be used, use the ^ qualifier instead of a - qualifier. For more information on specifying cipher suites, refer to the TIBCO Enterprise Message Service documentation.

In addition, the following sets of options are used:

For TIBCO Hawk components to verify the EMS server-ssl_no_verify_host

If this option is present, it this indicates that the TIBCO Hawk component should not verify the server. Conversely, if this option is not included in the configuration file, it indicates that TIBCO Hawk component should verify the server.

-ssl_trusted

The option specifies the file name of the server certificates. This option can be repeated if more than one certificate file is used.

-ssl_no_verify_hostname

This option specifies that the client should not verify the name in the CN field of the server certificate. Conversely, if this option is not included in the configuration file, it indicates that TIBCO Hawk component should verify the name in the CN field of the server certificate.

Page 69: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Display Configuration File (hawkdisplay.cfg) | 49

-ssl_expected_hostname

The name that is expected in the name of the CN field of the server certificates is specified by this option. The value of this option is used when the -ssl_no_verify_hostname option absent from the configuration file.

For the EMS server to verify TIBCO Hawk components-ssl_identity

This option specifies the digital certificate of the TIBCO Hawk components.-ssl_private_key

This option indicates the private key of the TIBCO Hawk component. If the key is included in the digital certificate in -ssl_identity, then you may omit this parameter.

-ssl_password

The password to decrypt the identity file of the Hawk component. For details, see Handling Passwords for TIBCO EMS Transport on page 43.

Character Encoding

-character_encoding <character encoding string>

Specifies the character encoding to be used for strings sent over all TIBCO Rendezvous transports.

Logging Information

-logdir <directory for display logs>

-logmaxsize <maximum size of single display log>

-logmaxnum <maximum number of display logs>

-log_format <Hawk or ActiveEnterprise format>

The TIBCO Hawk system creates rolling log files for display events (display.log) in the directory named in the -log_dir option.

When one file has reached the size specified in the -logmaxsize option, it is closed and renamed, and a new log file with the same name is started. When the number of log files exceeds the number set in the -logmaxsize option, log entries roll over to reuse the oldest log file.

If the -ssl_no_verify_host is not specified, the option -ssl_trusted has to be used. Along with the option-ssl_trusted specify either -ssl_no_verify_hostname or -ssl_expected_hostname.

Page 70: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

50 | Chapter 6 Configuring TIBCO Hawk Software

By default, the unit of measure for -logmaxsize is kilobytes and the default size is 1024. To specify a value in megabytes, use the suffix m or M. For example, 10M specifies ten megabytes. Note that the maximum log file size is 2097151 kilobytes.

You can enter at minimum 5 and at maximum 999 as a value for -logmaxnum. If, for example, you have configured a maximum of five log files, log files roll over until there are five files (named file1, file2… file5). At this point, the next rollover eliminates file5 and renames file4 to file5, thus maintaining a total of five rollover files. The log thus retains the latest log information and discards the oldest.

The -log_format option allow you to select the format of log file entries. Either the existing Hawk format or the ActiveEnterprise format can be specified.

Display File

-display_file <display file path and name>

Specify the location of a display file to be loaded automatically. To use the default, omit this option.

Security Policy

-security_policy <class implementing security>

Because security needs vary greatly, the TIBCO Hawk system provides a mechanism by which you can develop your own security policy plug-in. To create a security policy, you must write a Java class that implements a security policy specific to your needs. For more information on creating a security policy class, see the TIBCO Hawk Programmer’s Guide.

Depending on your security needs, complete the -security_policy option as follows.

• If you are not using a security policy, omit this option.

• To use a specific security policy, on each machine where you want to use the policy, specify the name of the security policy class. Do not enter the file extension. For example, if your Java class file is named ASecurityPolicy.class you would specify ASecurityPolicy.

• To use the TIBCO Hawk Trusted Security Policy, use:COM.TIBCO.hawk.security.trusted.Trusted

orCOM.TIBCO.hawk.security.trusted.TrustedWithDomain

For more information on the Trusted security policy that comes with TIBCO Hawk software, see Chapter 11 on page 155.

Page 71: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Display Configuration File (hawkdisplay.cfg) | 51

Variables

-variables <External variables property file>

Use the Variables option to specify a variables file. The variables file can pass data to define external variables to be used in either host or tool menu commands.

On UNIX systems, the env command outputs environment values in the correct format. However, in Microsoft Windows, the following restrictions apply to external variables:

• The variables file to support External variables in the agent must conform to the Java properties file format.

• Variables and variable names cannot include spaces or any of the following characters: equals sign (=), period (.), or forward slash(\).

• Any special characters must be escaped to be evaluated properly.

For example, to use a variable for c:\tibco\hawk, you would specify in the file: HAWK_ROOT=c:\\tibco\\hawk. Also, due to the Java file path separator format, HAWK_ROOT=c:/tibco/hawk will also work properly on the Microsoft Windows platform.

Page 72: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

52 | Chapter 6 Configuring TIBCO Hawk Software

TIBCO Hawk Agent Configuration File (hawkagent.cfg)

The options in the hawkagent.cfg configuration file relate to agent functionality. The agent command line options are organized in a modular fashion. Each section of the file begins with -M followed by the module name, such as -M Self. Within each modular section are command line options relating to the function of the module.

The command line options within each module of the TIBCO Hawk agent configuration file are described in the next sections.

Table 9 hawkagent.cfg Modules and Options

Module Name Options Page

-M Self -cluster <cluster name>

-agent_name <agent name>

-agent_domain <agent domain name>

-hawk_domain <TIBCO Hawk domain name>

-rvd_session <service> <network> <daemon>

-ems_transport <ems transport parameters>

-ssl_vendor <name of the vendor>-ssl_no_verify_host

-ssl_trusted <file-name>

-ssl_expected_hostname <host-name>

-ssl_identity <file-name>

-ssl_private_key <file-name>

-ssl_password <string>-ssl_no_verify_hostname

-ssl_ciphers <suite-name(s)>

-use_thread_pool <number>

-character_encoding <character encoding string>

-hma_plugin_dir <directory>

-file <configuration file>

54

Page 73: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration File (hawkagent.cfg) | 53

-M RuleBaseEngine -rulebases <rulebase> <rulebase> . . .

-config_path <list of directories to use as configuration sources>

-auto_config_dir <directory to autoload rulebases at startup>

-repository_path <list of repositories to use as configuration sources>

-repository_cache_dir <repository cache directory>

-variables <property file>

61

-M AMIService -ami_rvd_session <service> <network> <daemon> 65

-M LogService -log_dir <directory to store TIBCO Hawk logs>

-log_max_size <maximum size of one TIBCO Hawk log>

-log_max_num <maximum number of TIBCO Hawk logs>

-log_format <Hawk or ActiveEnterprise format>

66

-M TIBProtocolAdapter -interval <heartbeat interval in seconds>

-security_policy <class that implements security>

67

-M Repository -repository_name <repository name>

-repository_dir <repository directory>

68

-M LogfileMicroAgent -scan_rate <rate in seconds>

-block_size < size in kilobytes>

-eval_rate <rate in seconds>

Note:

On Windows: If using .cfg file to configure, then comment/un-comment: • -M LogfileMicroAgent

• -scan_rate 10

On UNIX: If using configurationutility, set the scan rate to zero or non-zero value to disable/enable LogfileMicroAgent.

68

-M CustomMicroAgent -time_out <time in seconds> 69

Table 9 hawkagent.cfg Modules and Options

Module Name (Cont’d) Options Page

Page 74: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

54 | Chapter 6 Configuring TIBCO Hawk Software

-M SelfThis module of the agent configuration file deals with the following command line options which relate to the agent itself:

Table 10 -M Self Options

Option Description

-cluster <cluster name> The name of the container in which this agent will appear in the display by default. The display will create the container if it does not already exist. Allows for grouping of multiple agents.

The default name for the container is the IP subnet address. The cluster name must be enclosed within quotes, if the name contains spaces.

-agent_name <agent name> The agent name as it appears in the TIBCO Hawk Display. The default name for the TIBCO Hawk agent is the host name of the computer on which it is installed.

Each agent being managed must have a unique combination of agent_name, agent_domain, and hawk_domain values.

To use the host name as the agent name, omit this option. To use a different name, specify a name as desired.

Note: Agent names with multiple words separated by dots are not supported.

-agent_domain <agent domain name>

Sets the agent domain name. The default value is "none". Each agent being managed must have a unique combination of agent_name, agent_domain, and hawk_domain values.

An agent domain must be specified when two computers within the same TIBCO Hawk domain have the same name but reside in different network domains. For example, you might specify this option as: -agent_domain pa.tibco.com.

Page 75: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration File (hawkagent.cfg) | 55

-hawk_domain <TIBCO Hawk domain name>

Sets the hawk domain name. The agents and the display must have the same hawk domain value in order to communicate. Each agent being managed must have a unique combination of agent_name, agent_domain, and hawk_domain values.

Separate domains create independent TIBCO Hawk systems. Agents and the display must share the same Hawk Domain name in order to communicate. The default is to monitor an entire network as one group. To use the default, omit the -hawk_domain option. See Creating a TIBCO Hawk Domain, page 84, for more details.

-rvd_session <service> <network> <daemon>

Specifies the primary TIBCO Rendezvous transport used by the agent. Because the TIBCO Hawk software uses the functionality of the TIBCO Rendezvous system, it must connect to a TIBCO Rendezvous daemon by creating a session.

If TIBCO Rendezvous is only used on one network and no special TIBCO Rendezvous sessions are needed, use the TIBCO Rendezvous daemon session default values. To use the default TIBCO Hawk session parameters, omit the -rvd_session command-line options.

If you use this option, all three parameters must be present and separated by white space. Use an empty string to indicate a null value, for example: -rvd _session 7474 "" tcp:7474

See Creating a TIBCO Rendezvous Session, page 85, for more details.

When using TIBCO EMS as the primary transport, if neither -rvd_session nor -ami_rvd_session is specified, a TIBCO Rendezvous session for the AMI instrumented applications is created using null values. If -rvd_session is specified but not the -ami_rvd_session, TIBCO Rendezvous session for the AMI instrumented applications uses the one created by the -rvd_session parameter.

When using TIBCO EMS as the primary transport, it is recommended that the loopback interface address (127.0.0.1) be used as the network parameter.

Table 10 -M Self Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 76: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

56 | Chapter 6 Configuring TIBCO Hawk Software

-ems_transport <ems transport parameters>

Specifies the TIBCO EMS transport parameters used by the agent.

There are 2 ways of specifying the EMS transport

• Using only one argument, serverURL, for example

-ems_transport tcp://dev_server:7222

If communicating with the EMS server using SSL, specify the location of the EMS server as follows for the above example:

-ems_transport ssl://server1:7222

• Specify the location of the EMS server and a valid username and password for the EMS server. These parameters are separated by a space and can be an empty string to indicate a null value.

-ems_transport tcp://dev_srv:7222 admin "#!NhAD1C"

For instructions to modify the password which was specified during installation, see Handling Passwords for TIBCO EMS Transport on page 43.

If communicating with the EMS server using SSL, specify the location of the EMS server as follows for the above example :-ems_transport ssl://server1:7222 admin "#!NhAD1NBC"

Re-Connection Setup

To ensure the TIBCO EMS client attempts re-connection after losing connection to the EMS server, repeat the server URL in the URL list. For example, -ems_transport tcp://H1:7222,tcp://H1:7222

However, the agent tries to reconnect for a maximum of 1800 times even if multiple server URLs are not specified for -ems_transport.

Table 10 -M Self Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 77: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration File (hawkagent.cfg) | 57

-ems_transport <ems transport parameters> Contd

Fault Tolerance Setup

You can specify backup servers to connect to in the event of the failure of the primary server. The serverURLs for the primary and backup server(s) are specified as a comma-separated list of URLs.

For example,-ems_transport tcp://server1:7222,tcp://server2:7344

If a connection to the first URL fails, the next URL in the list is used to attempt a reconnection. The connections in the list are attempted in sequence (wrapping to the start of the list, if the first connection was not the failed connection) until all URLs have been tried. If no connection is established after all URLs have been tried, the connection fails.

In addition to specifying the -ems_transport options, the following parameters in the EMS server configuration file, tibemsd.conf, should be considered:

• ft_active, the name of the active server.

• ft_reconnect_timeout, the amount of time a backup server waits for clients to reconnect.

• store, the directory to store TIBCO EMS data.

For more information, refer to the TIBCO Enterprise Message Service documentation.

When using TIBCO EMS as the primary transport, if neither -rvd_session nor -ami_rvd_session is specified, a TIBCO Rendezvous session for the AMI instrumented applications is created using null values. If -rvd_session is specified but not the -ami_rvd_session, TIBCO Rendezvous session for the AMI instrumented applications uses the one created by the -rvd_session parameter.

Table 10 -M Self Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 78: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

58 | Chapter 6 Configuring TIBCO Hawk Software

-ems_transport <ems transport parameters> Contd

Using SSL to connect to the EMS Server

When using SSL to connect to the EMS Server, the following options are used:-ssl_vendor

-ssl_cipher

In addition, the following sets of options are used:

For TIBCO Hawk components to verify the EMS server-ssl_no_verify_host

-ssl_trusted

-ssl_no_verify_hostname

-ssl_expected_hostname

If the -ssl_no_verify_host is not specified, the option -ssl_trusted has to be used. Along with the option-ssl_trusted specific either -ssl_no_verify_hostname or -ssl_expected_hostname.

For the EMS server to verify TIBCO Hawk components:-ssl_identity

-ssl_private_key

-ssl_password

-use_thread_pool <number> This option optimizes the number of threads the agent creates for every microagent it discovers. It is advisable to turn this option on if the agent is going to discover over 100 microagents. The default value is 256. This value is OS dependent and should be set to the maximum number of threads allowable per process.

Table 10 -M Self Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 79: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration File (hawkagent.cfg) | 59

-ssl_vendor <name of the vendor>

Specifies the name of the vendor of the SSL implementation.

The valid choices are:• j2se-default

Use this option when you want to use the default JCE bundled with the Java JRE.

On IBM platforms (such as AIX), this option defaults to ibm.• j2se

• entrust61

Use this option when you want to use the Entrust libraries.• ibm

On non-IBM platforms, this option can be used only if the IBM version of JCE is installed.

-ssl_no_verify_host Specifies that the TIBCO Hawk component should not verify the server. Conversely, if this option is not included in the configuration file, it indicates that TIBCO Hawk component should verify the server.

-ssl_trusted <file-name> Specifies the file name of the server certificates. This option can be repeated if more than one certificate file is used.

-ssl_expected_hostname <host-name>

Specifies the name that is expected in the name of the CN field of the server certificates.

The value specified by this option is used when the -ssl_no_verify_hostname option absent from the configuration file.

-ssl_identity <file-name> Specifies the digital certificate of the TIBCO Hawk components

-ssl_private_key

<file-name> Specifies the private key of the TIBCO Hawk component.

If the key is included in the digital certificate in -ssl_identity, then you may omit this parameter.

-ssl_password <string> Specifies the password to decrypt the identity file of the Hawk component.

For details, see Handling Passwords for TIBCO EMS Transport on page 43.

Table 10 -M Self Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 80: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

60 | Chapter 6 Configuring TIBCO Hawk Software

-ssl_no_verify_hostname Specifies that the client should not verify the name in the CN field of the server certificate. Conversely, if this option is not included in the configuration file, it indicates that TIBCO Hawk component should verify the name in the CN field of the server certificate.

-ssl_ciphers <suite-name(s)> Specifies the cipher suites that can be used. When specifying this option, use the ^ qualifier instead of a - qualifier. For more information on specifying cipher suites, refer to the TIBCO Enterprise Message Service documentation.

-character_encoding <character encoding string>

Specifies the character encoding to be used for strings sent over all TIBCO Rendezvous transports.

-hma_plugin_dir <directory> Specifies the directory the TIBCO Hawk Agent should search when loading microagent plug-ins.

-file <configuration file> Read more command line arguments from a config file. The contents of the file have the same syntax and semantics as command lines. Multiple lines are permitted. All characters from # to the end of a line are treated as a comment. This option is not allowed in a config file. You may supply no more than one -file parameter.

Table 10 -M Self Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 81: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration File (hawkagent.cfg) | 61

-M RuleBaseEngineThis module of the agent configuration file deals with the following command line options which relate to the rulebases used by this agent.

Three mutually-exclusive configuration modes are available for determining which configuration objects to use. Combining these options to implement each configuration mode is discussed in the following sections:

• Automatic Configuration Mode on page 62

• Manual Configuration Mode on page 63

• Repository Configuration Mode on page 64

If you are using the rulebase map, you usually do not need to list any rulebases in the -rulebases option. Using both a rulebase map and the -rulebases option increases the complexity of managing your monitoring configuration.

The -rulebases option is provided to maintain backward compatibility with previous versions of TIBCO Hawk that do not contain the rulebase map feature.

Table 11 -M RuleBaseEngine Options

Option Description

-rulebases <rulebase> <rulebase> . . .

Typically used only if rulebase map is not being used

If manual or repository configuration mode is used, specify a list of rulebases to be loaded at startup.

If -rulebases option is used, you must omit the -auto_config_dir option and use either manual configuration mode or repository configuration mode options.

Do not use a file extension when entering rulebase names. The .hrb extensions are only used for rulebase files.

When entering more than one rulebases, the rulebase names should be separated by a space.

See RuleBaseEngine:loadRuleBase() and RuleBaseEngine:loadRuleBaseFromFile() for more information

-config_path <list of directories to use as configuration sources>

If manual configuration mode is used, specify the path to be searched for configuration objects. The delimiter for path entries is a colon (:). The default used if this option is omitted is the current working directory.

If -config_path is used, omit the -auto_config_dir, -repository_path, and -repository_cache_dir options.

Page 82: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

62 | Chapter 6 Configuring TIBCO Hawk Software

Automatic Configuration Mode

This section explains how you use the -M RuleBaseEngine options to implement an Automatic Configuration mode. This is one of three mutually-exclusive modes available for determining which configuration objects to use. The other two modes are Manual Configuration and Repository Information, both of which are types of manual configuration mode.

To use Automatic configuration, specify the -auto_config_dir option.

When Automatic Configuration mode is used, all load-by-reference rulebase loading mechanisms are disabled. Therefore, you will omit the following options: -rulebases

-auto_config_dir

<directory to autoload rulebases at startup>

If this option is present, the agent will run in automatic configuration mode.

Specify the directory from which rulebase and schedule configuration objects will be loaded at startup. The default directory, <TIBCO Hawk installation directory>/autoconfig, is used if a value is omitted.

If you use automatic configuration, omit the following options:

-config_path, -repository_path, -repository_cache_dir, -rulebases

-repository_path <list of repositories to use as configuration sources>

If repository configuration mode is used, specify the path to be searched for repositories. The delimiter for path entries is a colon (:). The default used if this option is omitted is the current working directory.

If -repository_path is used, omit the -auto_config_dir and -config_path options.

-repository_cache_dir

<repository cache directory>If repository configuration mode is used, all configuration objects loaded from the repository may be cached in a local directory, specified in this option. This cache is used in the event of a repository failure, and also to minimize network traffic.

If -repository_cache_dir is used, omit the -auto_config_dir and -config_path options.

-variables <property file> Use this option to specify a variables file. The variables file can pass data to define external variables to be passed to rules for use in rulebase configurations.

Table 11 -M RuleBaseEngine Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 83: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration File (hawkagent.cfg) | 63

-config_path

-repository_path

-repository_cache_dir

In addition, the RuleBaseInclude feature, rulebase maps, and the RuleBaseEngine:loadRuleBase() microagent method are not used. However, the microagent method RuleBaseEngine:loadRuleBaseFromFile() is allowed. See the TIBCO Hawk Administrator’s Guide and the TIBCO Hawk Methods Reference for more on these features and microagent methods.

With automatic configuration, the agent will load the Schedule configuration file and all rulebase configuration files from the automatic configuration directory at startup. The only other mechanism by which an agent can load a rulebase after this point is through invocation of RuleBaseEngine:loadRuleBaseFromFile() using fully qualified filenames, or by using SendTo from the Display.

When a rulebase is sent to an agent via SendTo or Apply Changes from the Display, the rulebase is stored in the autoconfiguration directory. When a rulebase is removed from an agent via the Display, the rulebase is also removed from the autoconfiguration directory. Use of the methods RuleBaseEngine:loadRuleBaseFromFile() and RuleBaseEngine:unloadRuleBase() do not affect the autoconfiguration directory.

Manual Configuration Mode

This section explains how you use the -M RuleBaseEngine options to implement a Manual Configuration mode. This is one of three mutually exclusive modes available for determining which configuration objects to use. The other two modes are Automatic Configuration and Repository Information. Manual Configuration and Repository Information are both types of manual configuration mode.

To use manual configuration, specify a configuration path and a list of rulebases, using the -rulebases and -config_path options.

When Manual Configuration mode is used, omit the following options:-auto_config_dir

-repository_path

-repository_cache_dir

Use of -rulebases is optional. However, if no RuleBase Map is supplied by the repository, the use of -rulebases is recommended.

Page 84: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

64 | Chapter 6 Configuring TIBCO Hawk Software

When manual configuration is selected, the agent searches the Manual Configuration Path for the Schedule file and the rulebase map file at startup. After evaluating the rulebase map, the agent has a list of rulebase names. It searches for these using the Manual Configuration Path.

Note that the loaded startup rulebases may have RuleBaseInclude lists that will trigger further searches of the manual configuration path for additional rulebases. Also at startup, the agent searches the path for any rulebases specified in the Rulebases dialog and loads them.

Note that any rulebases loaded by the agent are not written to a local cache. There is no notion of an autoconfiguration directory. The only rulebases an agent may load at startup are those specified by the rulebase map, those listed in the Rulebases dialog, and rulebases in any contained RuleBaseIncludes.

See the TIBCO Hawk Administrator’s Guide for more on these features. Note that manual configuration mode is also known as Configuration Path mode.

Repository Configuration Mode

This section explains how you use the -M RuleBaseEngine options to implement a Repository Configuration mode. This is one of three mutually-exclusive modes available for determining which configuration objects to use. The other two modes are Automatic Configuration and Manual Configuration. Manual Configuration and Repository Information are both types of manual configuration mode.

To use repository configuration, specify a repository path and a repository cache directory, using the -repository_path and -repository_cache_dir options, and a list of rulebases, using the -rulebases option.

When Repository Configuration mode is used, omit the following options:-config_path

-auto_config_dir

Repository mode is also a type of manual configuration mode and operates in a similar way to Manual Configuration mode. Instead of a configuration path, you specify a repository path. The agent communicates with a list of repositories in this path to obtain all configuration objects (rulebases, schedules, and rulebase maps). Repositories are kept on the network and can be accessed by multiple agents. See the TIBCO Hawk Administrator’s Guide for an explanation of repositories.

Use of -rulebases is optional. However, if no RuleBase Map is supplied by the repository, the use of -rulebases is recommended.

Page 85: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration File (hawkagent.cfg) | 65

Unlike Manual Configuration Mode, with Repository mode all configuration objects loaded from the Repository may be cached in a local directory, specified in the -repository_cache_dir option. This cache is used in the event of a repository failure, and also to minimize network traffic. Agents can determine if a configuration object in their cache is identical to the one in the repository and will load it directly from the cache or update it from the Repository as appropriate.

-M AMIServiceThis module of the agent configuration file deals with the following command line option which relates to monitoring an AMI-instrumented application.

-ami_rvd_session <service> <network> <daemon>

Applications instrumented with AMI must create and use a TIBCO Rendezvous session to connect with a TIBCO Rendezvous daemon (rvd).

To monitor an AMI instrumented application that uses the same session parameters as those used in the Self section of the agent configuration file (the primary session), omit the AMIService options.

To monitor AMI instrumented applications that use different session parameters than those used in the TIBCO Hawk configuration, you must create additional AMI sessions.

If you use these options, all three parameters must be present and separated by white space. Use an empty string to indicate a null value, for example: -ami_rvd_session 7474 "" tcp:7474

You can specify any number of additional TIBCO Rendezvous sessions for a TIBCO Hawk agent to monitor. Applications using these sessions appear as primary sessions in the TIBCO Hawk Display in the same list as managed applications (and microagents). TIBCO Hawk agents can use rulebases that refer to the applications, as long as those applications are running.

See Creating a TIBCO Rendezvous Session, page 85, for more on defining sessions.

When using TIBCO EMS as the primary transport, if neither -rvd_session nor -ami_rvd_session is specified, a TIBCO Rendezvous session for the AMI instrumented applications is created using null values. If -rvd_session is specified but not the -ami_rvd_session, TIBCO Rendezvous session for the AMI instrumented applications uses the one created by the -rvd_session parameter.

When using TIBCO EMS as the primary transport, it is recommended that the loopback interface address (127.0.0.1) be used as the network parameter. For example,

-ami_rvd_session 7474 127.0.0.1 tcp:7474.

Page 86: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

66 | Chapter 6 Configuring TIBCO Hawk Software

-M LogServiceThis module of the agent configuration file deals with the following command line options which relate to log files used by this agent.

-log_dir <directory to store TIBCO Hawk logs>

-log_max_size <maximum size of one TIBCO Hawk log>

-log_max_num <maximum number of TIBCO Hawk logs>

-log_format <Hawk or ActiveEnterprise format>

The TIBCO Hawk system creates rolling log files for agent events (Hawk.log) in the directory named in the -log_dir option.

When one file has reached the size specified in the -log_max_size option, it is closed and renamed, and a new log file with the same name is started. When the number of log files exceeds the number set in the -log_max_size option, log entries roll over to reuse the oldest log file.

By default, the unit of measure for -logmaxsize is kilobytes and the default size is 1024. To specify a value in megabytes, use the suffix m or M. For example, 10M specifies ten megabytes.

If, for example, you have configured a maximum of five log files, log files roll over until there are five files (named file1, file2… file5). At this point, the next rollover eliminates file5 and renames file4 to file5, thus maintaining a total of five rollover files. The log thus retains the latest log information and discards the oldest.

The -log_format option allows you to select the format of log file entries. Either the existing Hawk format or the Active Enterprise format can be specified.

Page 87: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration File (hawkagent.cfg) | 67

-M TIBProtocolAdapterThis module of the agent configuration file deals with the following command line options which relate to agent heartbeat and security used by this agent.

Table 12 -M TIBProtocolAdapter Options

Option Description

-interval

<heartbeat interval in seconds>

The TIBCO Hawk agent heartbeat interval can be set on each computer where an agent is installed. The TIBCO Hawk Display uses this value to determine when to mark an agent dead.

To use the default value of 30 seconds, omit this option. To use a different value, enter a number of seconds, as desired.

-security_policy

<class that implements security>

TIBCO Hawk provides a mechanism by which you can develop your own security policy plug-in. To create a security policy, you must write a Java class that implements a security policy specific to your needs.

(For more information on creating a security policy class, see the TIBCO Hawk Programmer’s Guide. For more information on the Trusted security policy, see Chapter 11 on page 155.)

Depending on your security needs, complete this option as follows:

• If you are not using a security policy, omit this option.

• To use the TIBCO Hawk Trusted Security Policy, specify:COM.TIBCO.hawk.security.trusted.Trusted

orCOM.TIBCO.hawk.security.trusted.TrustedWithDomain

To use a specific security policy, specify the name of the security policy class on each machine where you want to use the policy. Ensure that this class file is placed in <TIBCO Hawk installation directory>/Java. Do not enter the file extension. For example, if your Java class file is named ASecurityPolicy.class you would specify ASecurityPolicy.

Note: If your security policy class is not part of the default package (for example, if you used the Java "package" directive in your code), you will need to create the appropriate directory structure beneath <TIBCO Hawk installation directory>/Java that corresponds to your package name and place your class file in the appropriate location. For example, if your fully qualified class name is com.mycorp.MySecurity, you will place MySecurity.class in <TIBCO Hawk installation directory>/Java/com/mycorp.

Page 88: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

68 | Chapter 6 Configuring TIBCO Hawk Software

-M RepositoryThis module of the agent configuration file deals with the following command line options which relate only to agents used as repositories for the TIBCO Hawk system.

-repository_name <repository name>

-repository_dir <repository directory>

If a TIBCO Hawk agent is to act as a repository for the TIBCO Hawk system, enter a name (with no spaces or periods) for the repository and a path for storage of the configuration object files.

If these options are not specified, the agent does not start as a repository.

-M LogfileMicroAgentThis module of the agent configuration file deals with the following command line options which relate to agent heartbeat and security used by this agent. We can also selectively load or unload the custom microagent by commenting or uncommenting the -M LogfileMicroAgent option.

Table 13 -M LogfileMicroAgent Options

Option Description

-scan_rate <rate in seconds> The TIBCO Hawk agent scan rate is the rate at which logfiles are scanned. The default scan rate is 10 seconds. To use the default value of 10 seconds, omit this option. To use a different value, enter a number in the range of 0 to 2147483647 (seconds).

-block_size < size in kilobytes> The TIBCO Hawk agent block size is the maximum number of kilobytes to read on each scan. The default value is 16 kilobytes. To use the default value of 16 kilobytes, omit this option. To use a different value, enter a number in the range of 1 to 2147483647 (KB).

-eval_rate <rate in seconds> The TIBCO Hawk agent eval rate is the rate at which all the logfiles being monitored are re-evaluated. The default eval rate is 300 seconds. To use the default value of 300 seconds, omit this option. To use a different value, enter a number in the range of 300 to 2147483647 (seconds).

Page 89: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration File (hawkagent.cfg) | 69

-M CustomMicroAgentThis module of the agent configuration file deals with the following command line option which relates to the timeout value. We can also selectively load or unload the custom microagent by commenting or uncommenting the -M CustomMicroAgent option.

Table 14 -M CustomMicroAgent Options

Option Description

-timeout <time in seconds> The timeout value for commands executed by the custom microagent.

Page 90: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

70 | Chapter 6 Configuring TIBCO Hawk Software

TIBCO Hawk HMA Configuration File (hawkhma.cfg)

The options in the hawkhma.cfg configuration file are used to configure microagent-related functions:

TIBCO Rendezvous (RVD) Session

-rvd_session <service> <network> <daemon>

Because the TIBCO Hawk software uses the functionality of the TIBCO Rendezvous system, it must connect to a TIBCO Rendezvous daemon by creating a session.

If TIBCO Rendezvous is only used on one network and no special TIBCO Rendezvous sessions are needed, use the TIBCO Rendezvous daemon session default values. To use the default session parameters (specified in the Self module of the agent configuration file), omit the -rvd_session command-line options.

If you use this option, all three parameters must be present and separated by white space. Use an empty string to indicate a null value, for example:

-rvd_session 7474 "" tcp:7474

See Creating a TIBCO Rendezvous Session, page 85, for more details.

Table 15 hawkhma.cfg Functions and Options

Function Options

TIBCO Rendezvous (RVD) Session

-rvd_session <service> <network> <daemon>

Logging Information -logdir <directory to store HMA logs>

-logmaxsize <maximum size of one HMA log>

-logmaxnum <maximum number of HMA logs>

-log_format <Hawk or ActiveEnterprise format>

Timeout -timeout <milliseconds>

Trace Level -tracelevel <desired trace level>

UNIX Signal Handling -ignore_sigint

-ignore_sigterm

-ignore_sigabrt

Page 91: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk HMA Configuration File (hawkhma.cfg) | 71

Logging Information

-logdir <directory to store HMA logs>

-logmaxsize <maximum size of one HMA log>

-logmaxnum <maximum number of HMA logs>

-log_format <Hawk or ActiveEnterprise format>

The TIBCO Hawk system creates rolling log files for microagent events in the directory named in the -logdir option.

The HMA produces a log file for each of its microagents and names them using the format hawk_<microagentname>.log, for example, hawk_performance.log. When one file has reached the size specified in the -logmaxsize option, it is closed and renamed, and a new log file with the same name is started. When the number of log files exceeds the number set in the -logmaxsize option, log entries roll over to reuse the oldest log file.

By default, the unit of measure for -logmaxsize is kilobytes and the default size is 1024. To specify a value in megabytes, use the suffix m or M. For example, 10M specifies ten megabytes.

If, for example, you have configured a maximum of five log files, log files roll over until there are five files (named file1, file2… file5). At this point, the next rollover eliminates file5 and renames file4 to file5, thus maintaining a total of five rollover files. The log thus retains the latest log information and discards the oldest.

The -log_format option allow you to select the format of log file entries. Either the existing Hawk format or the Active Enterprise format can be specified.

Timeout

-timeout <milliseconds>

Specifies the amount of time the Hawk Agent should wait for HMA method invocations to complete before timing them out. The default is 10000 milliseconds. Normally there is no need to change this value, however, on machines under extreme stress where method invocations are timing out, this new option allows the timeout value to be increased

Trace Level

-tracelevel <desired trace level>

Page 92: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

72 | Chapter 6 Configuring TIBCO Hawk Software

Specifies the level of diagnostic trace output. You can choose -1 to enable all tracing, 0 to enable no tracing, or calculate a desired trace level by adding together values from the following table:

The default value for tracing is 7, or 1+2+4 (information, warning and error).

UNIX Signal Handling

-ignore_sigint

-ignore_sigterm

-ignore_sigabrt

These options specify that the TIBCO Hawk HMA should ignore the SIGINT, SIGTERM, and SIGABRT signals, respectively. These options will cause the HMA to set the disposition of the corresponding signal to SIG_IGN.

By default, the HMA installs a signal handler for these signals that performs a graceful shutdown of the HMA in response to one of these signals. For most circumstances, this is the desired behavior and these options would not be specified.

These options can be used to configure the HMA not to shutdown or terminate in response to any of these signals. For example, the HMA can be started as a background process from a UNIX console with -ignore_sigint so that the HMA will not be shutdown if Ctrl-C is entered from the console.

Value Purpose

1 enables information level trace messages

2 enables warning level trace messages

4 enables error level trace messages

8 enables debug level trace messages

16 enables AMI level trace messages

32 adds source filename and line numbers to all trace messages

Page 93: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Event Service Configuration File (hawkevent.cfg) | 73

TIBCO Hawk Event Service Configuration File (hawkevent.cfg)

The TIBCO Hawk Event Service has two main purposes: to record the activity of TIBCO Hawk agents, and to detect and respond to agent termination.

The event service records:

• all alerts raised and cleared by TIBCO Hawk agents across the network, as well as changes in an agent’s alert level (as would be shown by a color in the TIBCO Hawk Display)

• all instances of agent activation and expiration

The event service also can call a script (using the -script option in the Event Service configuration file) when the heartbeat of a TIBCO Hawk agent is lost (not received for a specified length of time). This usually means that the agent process has terminated or that network communication has been interrupted. This facility could be used to send an e-mail or page, or to take some other automated action.

You will normally run the TIBCO Hawk Event Service on a single system in a TIBCO Hawk managed network. Multiple instances can be run on separate systems for fault tolerance.

If you want to configure the TIBCO Hawk Event Service to write Hawk alerts and changes in agent status to a database, make sure you have specified values for the following fields:

• -JDBCdriverClassName

• -JDBCuserName

• -JDBCpassword

• -JDBCurl

• -JDBCalertTableFields

See Table 16, hawkevent.cfg Options, on page 74 for a description of these fields. Additionally make sure the JAR files for the database client have been included in the classpath.

Be careful not to confuse TIBCO Hawk Event Service data files (Event.dat) with Event Service log files (Event.log).

• Event.dat data files contain the data produced by the Event Service.

• Event.log log files record the state of the Event Service itself.

The Event.log file is discussed in the TIBCO Hawk Administrator’s Guide.

Page 94: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

74 | Chapter 6 Configuring TIBCO Hawk Software

Configuring the Event ServiceThe Event Service is configured through a command-line interface. The options are described below.

Table 16 hawkevent.cfg Options

Option Description

-hawk_root The TIBCO Hawk root installation directory.

-hawk_domain Sets the hawk domain name. The agents and the event service must have the same hawk domain value in order to communicate.

The default is to monitor an entire network as one group. To use the default, omit this option. See the TIBCO Hawk Installation and Configuration Guide for more details.

Separate domains create independent TIBCO Hawk systems.

-rvd_session Specifies the TIBCO Rendezvous session used by TIBCO Hawk Event Service.

This option must be omitted if using TIBCO EMS as the primary transport.

If you use this option, the following three parameters must be present and separated by white space:

-rvd_session <service> <network> <daemon>

Use an empty string to indicate a null value. For example: -rvd _session 7474 "" tcp:7474

The default session uses null values.

If TIBCO Rendezvous is only used on one network and no special TIBCO Rendezvous sessions are needed, you can omit this parameter to use the default TIBCO Rendezvous daemon session values. Those values are specified in the Self module of the agent configuration file.

See the TIBCO Hawk Installation and Configuration Guide for more details.

Page 95: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Event Service Configuration File (hawkevent.cfg) | 75

-ems_transport Specifies the TIBCO EMS transport parameters used by TIBCO Hawk Event Service.

There are 2 ways of specifying the TIBCO EMS transport

• Using only one argument, serverURL, for example

-ems_transport tcp://dev_server:7222

If communicating with the EMS server using SSL, specify the location of the EMS server as follows for the above example:

-ems_transport ssl://server1:7222

• Specify the location of the EMS server and a valid username and password for the EMS server. These parameters are separated by a space and can be an empty string to indicate a null value.

-ems_transport tcp://dev_srv:7222 admin "#!NhAD1C"

If communicating with the EMS server using SSL, specify the location of the EMS server as follows for the above example :

-ems_transport ssl://server1:7222 admin "#!NhAD1NBC"

For instructions to modify the password which was specified during installation, see Handling Passwords for TIBCO EMS Transport on page 43.

Re-Connection Setup

To ensure the TIBCO EMS client attempts re-connection after losing connection to the EMS server, repeat the server URL in the URL list. For example,

-ems_transport tcp://H1:7222,tcp://H1:7222

Table 16 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 96: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

76 | Chapter 6 Configuring TIBCO Hawk Software

-ems_transport

(Contd)

Fault Tolerance Setup

You can specify backup servers to connect to in the event of the failure of the primary server. The serverURLs for the primary and backup server(s) are specified as a comma-separated list of URLs.

For example,

-ems_transport tcp://server1:7222,tcp://server2:7344

If a connection to the first URL fails, the next URL in the list is used to attempt a reconnection. The connections in the list are attempted in sequence (wrapping to the start of the list, if the first connection was not the failed connection) until all URLs have been tried. If no connection is established after all URLs have been tried, the connection fails.

In addition to specifying the -ems_transport options, the following parameters in the EMS server configuration file, tibemsd.conf, should be considered:

• ft_active, the name of the active server.

• ft_reconnect_timeout, the amount of time a backup server waits for clients to reconnect.

• store, the directory to store TIBCO EMS data.

For more information, refer to the TIBCO Enterprise Message Service documentation.

Using SSL to connect to the EMS Server

When using SSL to connect to the EMS Server, the following options are used:-ssl_vendor

-ssl_cipher

Table 16 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 97: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Event Service Configuration File (hawkevent.cfg) | 77

-ems_transport

(Contd)

In addition, the following sets of options are used:

For TIBCO Hawk components to verify the EMS server-ssl_no_verify_host

-ssl_trusted

-ssl_no_verify_hostname

-ssl_expected_hostname

If the -ssl_no_verify_host is not specified, the option -ssl_trusted has to be used. Along with the option -ssl_trusted specify either -ssl_no_verify_hostname or -ssl_expected_hostname.

For the EMS server to verify TIBCO Hawk components:-ssl_identity

-ssl_private_key

-ssl_password

-ssl_vendor <name of the vendor>

Specifies the name of the vendor of the SSL implementation.

The valid choices are:• j2se-default

Use this option when you want to use the default JCE bundled with the Java JRE.

On IBM platforms (such as AIX), this option defaults to ibm.• j2se

• entrust61

Use this option when you want to use the Entrust libraries.• ibm

On non-IBM platforms, this option can be used only if the IBM version of JCE is installed.

-ssl_no_verify_host Specifies that the TIBCO Hawk component should not verify the server. Conversely, if this option is not included in the configuration file, it indicates that TIBCO Hawk component should verify the server.

-ssl_trusted <file-name> Specifies the file name of the server certificates. This option can be repeated if more than one certificate file is used.

Table 16 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 98: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

78 | Chapter 6 Configuring TIBCO Hawk Software

-ssl_expected_hostname <host-name>

Specifies the name that is expected in the name of the CN field of the server certificates.

The value specified by this option is used when the -ssl_no_verify_hostname option absent from the configuration file.

-ssl_identity <file-name> Specifies the digital certificate of the TIBCO Hawk components.

-ssl_private_key

<file-name> Specifies the private key of the TIBCO Hawk component.

If the key is included in the digital certificate in -ssl_identity, then you may omit this parameter.

-ssl_password <string> Specifies the password to decrypt the identity file of the Hawk component.

For details, see Handling Passwords for TIBCO EMS Transport on page 43.

-ssl_no_verify_hostname Specifies that the client should not verify the name in the CN field of the server certificate. Conversely, if this option is not included in the configuration file, it indicates that TIBCO Hawk component should verify the name in the CN field of the server certificate.

-ssl_ciphers <suite-name(s)>

Specifies the cipher suites that can be used. When specifying this option, use the ^ qualifier instead of a - qualifier. For more information on specifying cipher suites, refer to the TIBCO Enterprise Message Service documentation.

-ami_rvd_session Specifies the TIBCO Rendezvous (rvd) session used by the TIBCO Hawk Event Service for AMI communications. If this options is used, all three parameters must be present and separated by whitespace but any of them may be an empty string to indicate a null value.

When using TIBCO EMS as the primary transport, it is recommended that the loopback interface address (127.0.0.1) be used as the network parameter. For example,

-ami_rvd_session 7474 127.0.0.1 tcp:7474.

See Using AMI applications with TIBCO EMS Transport on page 43 for details.

The default ami_rvd_session uses rvd_session values.

Table 16 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 99: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Event Service Configuration File (hawkevent.cfg) | 79

-character_encoding Specifies the character encoding to be used for strings sent over all TIBCO Rendezvous transports.

-datadir The directory in which TIBCO Hawk will create rolling data files (event.dat) for the event service. Default is <install-path>/data.

-datamaxnum The maximum number of rolling data files to keep. The default is 5. Values lower than the default number are ignored, and the default is used instead.

-datamaxsize When one rolling data file has reached this size, it is closed and renamed, and a new data file with the original name is started.

By default, the unit of measure for -datamaxsize is kilobytes and the default size is 1024. To specify a value in megabytes, use the suffix m or M. For example, 10M specifies ten megabytes. Values lower than the default size are ignored, and the default is used instead. You can, however, enter a value greater than the default.

-ft Fault Tolerant weight for TibrvFtMember. Default is no fault tolerance.

-ft_rvd_session Specifies the TIBCO Rendezvous session used for fault tolerance by TIBCO Hawk Event Service.

If you use this option, the following three parameters must be present and separated by white space:

-ft_rvd_session <service> <network> <daemon>

Use an empty string to indicate a null value. For example: -ft_rvd _session 7474 "" tcp:7474

When using TIBCO EMS as the primary transport, a Rendezvous session using default values is created.

When using TIBCO Rendezvous as the primary transport, if this field is not specified, the primary Rendezvous session is used for fault tolerance.

When specifying a remote daemon, use the fully qualified domain name of the host. For example,

-ft_rvd _session 7474 "" tcp:host1.mycompany.com:7474

This option is ignored if the -ft option is not specified.

Table 16 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 100: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

80 | Chapter 6 Configuring TIBCO Hawk Software

-JDBCalertTableFields User-defined, comma-separated alert action property fields of type VARCHAR(256) to be created as additional columns in the HawkAlertClearInfo table. When the event service receives an "onAlert" event that contains the specified properties, the corresponding values are inserted into the database. For example, the command

-JDBCalertTableFields x, y, z

creates three additional columns (x, y and z) of type VARCHAR(256) in the HawkAlertClearInfo table.

-JDBCdriverClassName Class name for the vendor's JDBC driver as described in Table 17.

-JDBCuserName User name to connect to the database.

-JDBCpassword User password to connect to the database.

-JDBCurl URL that identifies the database connection as specified in Table 18.

-JDBCdbType Database vendor name. Supported values are SQLSERVER, ORACLE, DB2, INFORMIX and SYBASE.

-log_format The format of log file entries. Valid values are default (Hawk format) or ae4 (Active Enterprise format).

-logdir The directory in which to store Event.log files generated by TIBCO Hawk Event Service. To print all log messages to the screen, omit this option.

-logmaxnum The maximum number of rolling log files to keep. When the number of rolling log files exceeds this number, log entries roll over to reuse the oldest log file. The default is 4. Values lower than the default number are ignored, and the default is used instead.

-logmaxsize When one rolling log file has reached this size, it is closed and renamed, and a new log file with the original name is started.

By default, the unit of measure for -logmaxsize is kilobytes and the default size is 1024. To specify a value in megabytes, use the suffix m or M. For example, 10M specifies ten megabytes.

-script The script to execute on lost agent heartbeat. Hawk passes the agent hostname and IP address to the script to identify which agent died.

Table 16 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Page 101: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Event Service Configuration File (hawkevent.cfg) | 81

Configuring the Event Service with an External DatabaseBefore starting any tasks, you must obtain the JDBC driver from the database vendor, and deploy it in a location that is listed in the classpath. We recommend placing the driver .jar file one of these directories (as appropriate):

• TIBCO_HOME /tibcojre/1.6.0/lib/ext

• TIBCO_HOME/tibcojre64/1.6.0/lib/ext

Configuration Values

This section presents values that you must enter when you do the configuration steps in subsequent sections.

After configuration, start the Event Service with the hawkevent.cfg file that is passed as the config file parameter - file.

Driver

-file Reads more command line arguments from this file. The file has exactly the same syntax and semantics as if it were a continuation of the command line. If you supply -file, it must be the last parameter on the command line. You may supply no more than one -file parameter.

-help Prints a help message.

Table 16 hawkevent.cfg Options (Cont’d)

Option (Cont’d) Description (Cont’d)

Table 17 Database Configuration Value: Driver

Database Driver String

Oracle 10g, 11g

Oracle RAC

oracle.jdbc.OracleDriver

MS SQL Server 2008 com.microsoft.sqlserver.jdbc.SQLServerDriver

DB2 9.x com.ibm.db2.jcc.DB2Driver

Sybase 15.x com.sybase.jdbc3.jdbc.SybDriver

Page 102: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

82 | Chapter 6 Configuring TIBCO Hawk Software

Connection String

The connection strings in Table 18 incorporate elements that can vary:

• Hostname identifies the database host computer.

• PortNumber is the TCP port where the database accepts connections. (Unless you specify a port, Microsoft configures port 1433.)

• DatabaseName identifies the database. This element is required.

• DBinstance identifies a specific database instance within Microsoft SQL Server 2008.

Table 18 Database Configuration Value: Connection (Sheet 1 of 2)

Database Connection String

Oracle 10g, 11g jdbc:oracle:thin:@Hostname:PortNumber:DatabaseName

Oracle has a synonym for the DatabaseName—the system ID (SID).

Oracle RAC Use either of these two formats.

• If you know the service name of the Oracle RAC, use this format:

jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOS

T=Hostname_1)(PORT=PortNumber_1))(ADDRESS=(PROTOCOL=TCP)(HOST=Hostname_2)(PORT=PortNumber_2))(LOAD_BALANCE=yes)(FAILOVER=on)(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=ServiceName)))

• If you know the SID names of the Oracle RAC nodes, use this format:

jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOS

T=Hostname_1)(PORT=PortNumber_1)(SID=DatabaseName_1))(ADDRESS=(PROTOCOL=TCP)(HOST=Hostname_2)(PORT=PortNumber_2))(LOAD_BALANCE=yes)(CONNECT_DATA=(SID=DatabaseName_2)))

You can add as many ADDRESS clauses as needed.

MS SQL Server 2008 jdbc:sqlserver://Hostname\DBinstance:PortNumber;DatabaseName=DatabaseName;

If your database is not configured with instances, you may omit the DBinstance, and the preceding backslash (\) character. The default value is the null string (which corresponds to the default instance, MSSQLSERVER).

You may omit the PortNumber, and the preceding colon (:) character. The default value is port 1433.

Page 103: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Event Service Configuration File (hawkevent.cfg) | 83

DB2 9.x jdbc:db2://Hostname:PortNumber/DatabaseName

Sybase 15.x jdbc:sybase:Tds:Hostname:PortNumber/DatabaseName

Table 18 Database Configuration Value: Connection (Sheet 2 of 2)

Database Connection String

Page 104: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

84 | Chapter 6 Configuring TIBCO Hawk Software

Creating a TIBCO Hawk Domain

Create a TIBCO Hawk domain if you wish to isolate groups of TIBCO Hawk agents into independent monitoring sets. Remember that each TIBCO Hawk agent can belong to only one TIBCO Hawk domain and cannot communicate with the TIBCO Hawk Display program on other domains.

The default is to monitor an entire network as one group. To use the default, omit the -hawk_domain option.

Testing a Domain

To test the domain option, temporarily set the TIBCO Hawk domain on a single system to a name such as test, then start (or restart) the TIBCO Hawk Display. If you entered a unique domain name, only one discovered host should appear in the TIBCO Hawk Display main window. This shows that only the local agent and the local TIBCO Hawk Display are using the test domain.

If the domain is as desired, you can now install it on the network systems where you want to assign specific computers to that domain. All systems assigned to that TIBCO Hawk domain appear on the Display as part of that domain.

When finished with testing, change back to the default domain and restart the TIBCO Hawk Display to verify that it was correctly restored.

Page 105: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Creating a TIBCO Rendezvous Session | 85

Creating a TIBCO Rendezvous Session

A TIBCO Rendezvous session is a direct conduit through which an application and a TIBCO Rendezvous daemon communicate.

Default Session ValuesIf TIBCO Rendezvous is only used on one network and no special TIBCO Rendezvous sessions are needed, use the TIBCO Rendezvous daemon session default values.

To use the default TIBCO Hawk session parameters with port 7474, omit the -rvd_session command-line options.

If you use this option, all three parameters must be present and separated by white space. Use an empty string to indicate a null value, for example: -rvd _session 7474 "" tcp:7474

Setting up a TIBCO Rendezvous Daemon SessionThis section provides a brief overview of session parameters used to set up a TIBCO Rendezvous Daemon (RVD) session for TIBCO Hawk monitoring. The Service parameter specifies which User Datagram Protocol (UDP) service group the TIBCO Rendezvous daemon should use for session communications. The default configuration uses the service port number 7474. A service can be specified either by its name or its port number.

• The Network parameter specifies what network to use for outbound session communications when a computer is connected to more than one network. A network can be specified by its name or by its IP address. This parameter is also used to specify the multicast groups to use for communication.

When using TIBCO EMS as the primary transport, it is recommended that the loopback interface address (127.0.0.1) be used as the network parameter. For more information, see Using AMI applications with TIBCO EMS Transport on page 43.

• The Daemon parameter specifies which TIBCO Rendezvous daemon is to handle communication for the session. A local daemon is specified by the communications type (always tcp) and a socket number (e.g., 7474). The default configuration uses the local daemon with the TCP socket number 7474.

Specify a remote daemon by inserting its host name or IP address between the tcp entry and the port number of the daemon parameter, for example:

Page 106: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

86 | Chapter 6 Configuring TIBCO Hawk Software

tcp:remote_computer:7800

For more information on interacting with TIBCO Rendezvous daemons and sessions, refer to the books TIBCO Rendezvous Concepts and the TIBCO Rendezvous Administrator’s Guide.

Page 107: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 87

Chapter 7 Using the Configuration Utility

This chapter explains how to configure TIBCO Hawk using the Configuration Utility GUI.

Topics

• Configuration Utility Overview, page 88

• General Configuration, page 89

• Transport Configuration, page 95

• TIBCO Hawk Display Configuration, page 105

• TIBCO Hawk Agent Configuration, page 107

• TIBCO Hawk Event Service Configuration, page 113

The Configuration Utility GUI interface is available only on Windows platforms. For UNIX, all TIBCO Hawk configuration is done by modifying the .cfg files. This is discussed in Chapter 6, Configuring TIBCO Hawk Software.

Page 108: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

88 | Chapter 7 Using the Configuration Utility

Configuration Utility Overview

When the TIBCO Hawk installation program is finished on Microsoft Windows, it automatically starts the TIBCO Hawk configuration utility. The configuration utility can also be run at any time by selecting Start > Programs > <TIBCO_HOME Name> > TIBCO Hawk <version> > Hawk Configuration.

The tabs in the configuration utility correspond to the four configuration files described in Chapter 6, Configuring TIBCO Hawk Software.

Page 109: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

General Configuration | 89

General Configuration

The General tab contains basic TIBCO Hawk configuration items common to all TIBCO Hawk components. When you start TIBCO Hawk, the fields in these dialogs are populated with values appropriate for your configuration. In most cases, you do not need to change those values.

Figure 1 General Configuration

Domain InformationSeparate domains create independent TIBCO Hawk systems. Each TIBCO Hawk agent can belong to only one TIBCO Hawk domain and cannot communicate with TIBCO Hawk Display programs monitoring on other domains. Use TIBCO Hawk domains if you want to isolate groups of TIBCO Hawk agents into independent monitoring sets.

Leave the Hawk Domain field blank to use the default domain.

Page 110: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

90 | Chapter 7 Using the Configuration Utility

To give the agent a domain name, enter the desired name in the Hawk Domain field. Give this same name to all agents that you want to include in the domain, when you configure them on the systems where they are installed. The domain you enter here is used for both the TIBCO Hawk agent and for any instance of the TIBCO Hawk Display program running on that system.

Security Because security needs vary greatly, the TIBCO Hawk system provides a mechanism by which you can develop your own security policy plug-in. To create a security policy, you must write a Java class that implements a security policy specific to your needs. For more information on creating a security policy class, see the TIBCO Hawk Programmer’s Guide.

For more information on the Trusted and Certified security policies that come with TIBCO Hawk software, see Chapter 11 on page 155.

Depending on your security needs, complete the Security Policy field as follows.

• If you are not using a security policy, leave the Security Policy Class field blank.

• To use the TIBCO Hawk Trusted Security Policy, enter:COM.TIBCO.hawk.security.trusted.Trusted

orCOM.TIBCO.hawk.security.trusted.TrustedWithDomain

• To use a specific security policy, on each machine where you want to use the policy, enter the name of the security policy class. Ensure that this class file is placed in <TIBCO Hawk installation directory>\Java. Do not enter the file extension. For example, if your Java class file is named ASecurityPolicy.class you would enter ASecurityPolicy.

If your security policy class is not part of the default package (for example, if you used the Java "package" directive in your code), you will need to create the appropriate directory structure beneath <TIBCO Hawk installation directory>\Java that corresponds to your package name and place your class file in the appropriate location. For example, if your fully qualified class name is com.mycorp.MySecurity, you will place MySecurity.class in <TIBCO Hawk installation directory>\Java\com\mycorp.

Page 111: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

General Configuration | 91

LoggingThe TIBCO Hawk system logs specific events as they occur. The events are categorized as errors, warnings, or informational events. The logs provide a detailed picture of the status and health of each of the TIBCO Hawk components to aid in diagnosing problems.

The settings configured in the Logging panel control logging of the following components:

• The TIBCO Hawk agent (Hawk.log).

• The TIBCO Hawk Display (Display.log).

• The TIBCO Hawk Event Service (Event.log).

Log to Windows Event Log

Enable this setting to log TIBCO Hawk events in the Application section of the Windows Event Log.

These events can be viewed using the Windows Event Viewer. To access the viewer, select Start>Programs>Administrative Tools>Event Viewer, then select Log>Application from the Event Viewer menu to view Application events.

Events logged by the TIBCO Hawk system contain the component name (for example, the TIBCO Hawk agent) under the Source column.

Log to Hawk Log Files

Enable this setting to log TIBCO Hawk events using a set of log files in the directory you specify in the Log Files Directory field.

The TIBCO Hawk system creates rolling log files for each component; when one file has reached the size specified in the Maximum Size of Log Files field, it is closed and renamed, and a new log file with the same name is started. When the number of log files exceeds the number set in the Maximum Number of Log Files field, log entries roll over to reuse the oldest log file. If, for example, you have configured a maximum of five log files, log files roll over until there are five files (named file1, file2… file5). At this point, the next rollover eliminates file5 and renames file4 to file5, thus maintaining a total of five rollover files. The log thus retains the latest log information and discards the oldest.

• Log Files Directory

Enter the name of the directory where the TIBCO Hawk system should place its log files. The default value is TIBCO_CONFIG_FOLDER\tibco\cfgmgmt\hawk\log.

• Maximum Number of Files

Page 112: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

92 | Chapter 7 Using the Configuration Utility

Enter the maximum number of rolling log files to create. You can enter at minimum 5 and at maximum 999. The default value is 5.

• Maximum Size of Log File

In this edit field, enter the maximum log file size, in kilobytes. Enter only digits. The default is 1024. Note that the maximum log file size is 2097151 kilobytes.

Log Message Format

This field allow you to select the format of log file entries. Either the existing Hawk format (Default) or the ActiveEnterprise format (ae4) can be specified.

HMA Configuration

AMI Timeout

Specifies the amount of time the Hawk Agent should wait for HMA method invocations to complete before timing them out. The default is 10000 milliseconds. Normally there is no need to change this value, however, on machines under extreme stress where method invocations are timing out, this option allows the timeout value to be increased.

Codepage

The Codepage configuration option indicates the desired character encoding to be used by the HMA when converting multi-byte characters (MBCS) to UNICODE. The default codepage identifier is 65001, which is the Microsoft Windows ID for UTF-8, and which will work for all locales.

The only reason to change this value is for compatibility with other TIBCO Rendezvous applications not using UTF-8. This value is specified using Microsoft Windows code page values, as listed at the following URL:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/intl/unicode_81rn.asp

If you change the Codepage value, you must also change the value of the Character Encoding, page 94. For example, if you want to specify Latin-1 locales (such as French), the Codepage value must be 1252 and the Character Encoding value must be ISO-8859-1. See Code Page Identifiers on page 195 for the list of code page identifiers.

Page 113: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

General Configuration | 93

Advanced ConfigurationOn the General configuration tab, click the Advanced button to access the Advanced Configuration dialog.

Figure 2 Advanced Configuration

Configuration File Options

This section allows you to specify configuration files (such as hawkagent.cfg). When you specify a configuration file, the values in that file override the corresponding values entered into the configuration utility.

For example, if an option in the configuration file you select is blank but a custom value is specified for that option in the configuration utility, TIBCO Hawk will use the default (blank) value for that option.

Page 114: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

94 | Chapter 7 Using the Configuration Utility

Character Encoding

The Character Encoding configuration option indicates the desired character encoding to be used by the Agent, Display, and Event Service. This is also the encoding used for the character data that TIBCO Hawk transmits over TIBCO Rendezvous.

The default setting of UTF-8 will work for all locales. The only reason to change this setting is for compatibility with other TIBCO Rendezvous applications. If you change this value, you must also change the Codepage value, which sets the character encoding for the TIBCO Hawk HMA.

Possible Character Encoding values are listed in Table 31, Code Page Identifiers, on page 196.

Custom Microagent Configuration

Select or unselect the Enable checkbox in the Advanced Configuration dialog box to selectively load or unload the custom microagent.

Page 115: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Transport Configuration | 95

Transport Configuration

This tab contains information specific to the chosen messaging transport.

Primary TransportYou can specify either TIBCO Rendezvous or TIBCO EMS as the primary transport. The communication between TIBCO Hawk HMA and primary AMI session remains through TIBCO Rendezvous. Which means that if you choose TIBCO EMS as the primary transport, you still have to specify the TIBCO Rendezvous settings for the TIBCO Hawk HMA and primary AMI session.

Using TIBCO Rendezvous as the Transport

This tab contains details of the TIBCO Rendezvous settings which will be used for communication by all TIBCO Hawk components. Because the TIBCO Hawk software uses the functionality of the TIBCO Rendezvous system, it must connect to a TIBCO Rendezvous daemon by creating a session.

The following processes in the TIBCO Hawk system communicate with a TIBCO Rendezvous daemon through sessions:

• TIBCO Hawk Agent

• TIBCO Hawk HMA

• TIBCO Hawk Display

• TIBCO Hawk Event Service

Page 116: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

96 | Chapter 7 Using the Configuration Utility

Figure 3 Transport Configuration using TIBCO Rendezvous

Rendezvous Settings for All Hawk Components

A TIBCO Rendezvous session is a direct conduit through which an application and a TIBCO Rendezvous daemon communicate.

For details on the parameters of the TIBCO Rendezvous session used by the TIBCO Hawk HMA for communicating with the primary AMI session see TIBCO Rendezvous Daemon Session Parameters on page 102.

Rendezvous Settings for Addition AMI Sessions

Applications instrumented with AMI must create and use a TIBCO Rendezvous session to connect with a TIBCO Rendezvous daemon (rvd).

To monitor an AMI-instrumented application that uses the same session parameters as those used in the TIBCO Hawk configuration, no additional action is required.

Page 117: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Transport Configuration | 97

To monitor AMI-instrumented applications that use different session parameters than those used in the TIBCO Hawk configuration, you must create additional AMI sessions as required. See AMI Rendezvous Session Configuration on page 102 for details.

Using TIBCO EMS as the TransportThis tabs contains details of the TIBCO EMS settings which will be used for communication by all TIBCO Hawk components including TIBCO Hawk HMA. TIBCO Hawk HMA uses TIBCO Rendezvous for communicating with the primary AMI session.

Figure 4 Transport Configuration using TIBCO Enterprise Message Service

EMS Settings for Console Communication

The following processes in the TIBCO Hawk system communicate using TIBCO EMS:

• TIBCO Hawk Agent

• TIBCO Hawk Display

Page 118: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

98 | Chapter 7 Using the Configuration Utility

• TIBCO Hawk Event Service

This following parameters are used to connect to the EMS server. For more information on TIBCO EMS, refer to the books TIBCO EMS Installation Guide and TIBCO EMS User’s Guide.

• The Server URL parameter is used to connect to the EMS server at the specified location.

• When the TIBCO EMS server has authentication enabled, valid username and password parameters enable you to connect to the EMS server.

Re-Connection Setup

To ensure the TIBCO EMS client attempts re-connection after losing connection to the EMS server, repeat the server URL in the URL list. For example,

tcp://H1:7222,tcp://H1:7222

Fault Tolerance Setup

You can specify backup servers to connect to in the event of the failure of the primary server. The serverURLs for the primary and backup server(s) are specified as a comma-separated list of URLs.

For example,

tcp://server1:7222,tcp://server2:7344

If a connection to the first URL fails, the next URL in the list is used to attempt a reconnection. The connections in the list are attempted in sequence (wrapping to the start of the list, if the first connection was not the failed connection) until all URLs have been tried. If no connection is established after all URLs have been tried, the connection fails.

In addition to specifying the -ems_transport options, the following parameters in the EMS server configuration file, tibemsd.conf, should be considered:

— ft_active, the name of the active server.

— ft_reconnect_timeout, the amount of time a backup server waits for clients to reconnect.

— store, the directory to store TIBCO EMS data.

For more information, refer to the TIBCO Enterprise Message Service documentation.

When connecting to the EMS server using SSL, specify the Server URL parameter as follows:

ssl://<server url>:port

and click the Configure SSL button to specify additional SSL parameters. See Connecting to TIBCO EMS using SSL on page 100 for details.

Page 119: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Transport Configuration | 99

The concepts of specifying the user credentials (when the EMS server has authentication enabled), re-connection setup, and fault tolerance setup as explained in the earlier sections are also applicable when using SSL to connect to the EMS server.

Rendezvous Settings for HMA and Primary AMI Session

A TIBCO Rendezvous session is a direct conduit through which an application and a TIBCO Rendezvous daemon communicate.

For details on the parameters of the TIBCO Rendezvous session used by the TIBCO Hawk HMA for communicating with the primary AMI session see TIBCO Rendezvous Daemon Session Parameters on page 102.

Rendezvous Settings for Addition AMI Session

Applications instrumented with AMI must create and use a TIBCO Rendezvous session to connect with a TIBCO Rendezvous daemon (rvd).

To monitor an AMI-instrumented application that uses the same session parameters as those used by the TIBCO Hawk HMA, no additional action is required.

To monitor AMI-instrumented applications that use different session parameters than those used by TIBCO Hawk HMA, you must create additional AMI sessions as required. See AMI Rendezvous Session Configuration on page 102 for details.

DefaultsThis button clears all fields and returns them to their default values.

Page 120: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

100 | Chapter 7 Using the Configuration Utility

Connecting to TIBCO EMS using SSLThis dialog contains details of the SSL settings used when connecting to the EMS server.

SSL Configuration

Specify the name of the vendor of the SSL implementation in the Vendor field. The valid choices are— j2se-default

Use this option when you want to use the default JCE bundled with the Java JRE.

On IBM platforms (such as AIX), this option defaults to ibm.— j2se

— entrust61

Use this option when you want to use the Entrust libraries.— ibm

On non-IBM platforms, this option can be used only if the IBM version of JCE is installed.

In the Ciphers field specify the cipher suites that can be used. When specifying the cipher suite, use the ^ qualifier instead of a - qualifier. For more information on specifying cipher suites, refer to the TIBCO Enterprise Message Service documentation.

Page 121: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Transport Configuration | 101

Settings for Hawk Components to verify EMS server

Select the Authenticate EMS Server checkbox if you want the TIBCO Hawk components to verify the server.

If you want the TIBCO Hawk components to verify the name in the CN field of the server certificate, specify it in the Server Name field.

Maintain the list of server certificates in the Trusted field using the Add, Edit, and Delete buttons.

Settings for EMS server to verify Hawk Components

Specify the digital certificate of the TIBCO Hawk components in the Identity field.

The private key of the TIBCO Hawk component is specified in the Private Key field.

The password to decrypt the identity file of the TIBCO Hawk component is specified in the Password field.

Page 122: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

102 | Chapter 7 Using the Configuration Utility

TIBCO Rendezvous Daemon Session ParametersThis section describes the session parameters used to set up a TIBCO Rendezvous Daemon (RVD) session for TIBCO Hawk monitoring. If TIBCO Rendezvous is only used on one network and no special TIBCO Rendezvous sessions are needed, use the TIBCO Rendezvous daemon session default values.

• The Service parameter specifies which User Datagram Protocol (UDP) service group the TIBCO Rendezvous daemon should use for session communications. The default configuration uses the service port number 7474. A service can be specified either by its name or its port number.

• The Network parameter specifies what network to use for outbound session communications when a computer is connected to more than one network. A network can be specified by its name or by its IP address. This parameter is also used to specify the multicast groups to use for communication.

When using TIBCO EMS as the primary transport, it is recommended that the loopback interface address (127.0.0.1) be used as the network parameter. For more information, see Using AMI applications with TIBCO EMS Transport on page 43.

• The Daemon parameter specifies which TIBCO Rendezvous daemon is to handle communication for the session. A local daemon is specified by the communications type (always tcp) and a socket number (e.g., 7474). The default configuration uses the local daemon with the TCP socket number 7474.

Specify a remote daemon by inserting its host name or IP address between the tcp entry and the port number of the daemon parameter, for example:tcp:remote_computer:7800.

For more information on interacting with TIBCO Rendezvous daemons and sessions, refer to the books TIBCO Rendezvous Concepts and the TIBCO Rendezvous Administrator’s Guide.

AMI Rendezvous Session ConfigurationTo monitor AMI-instrumented applications that use different session parameters than those used in the TIBCO Hawk configuration, you must create additional AMI sessions.

You can specify any number of additional TIBCO Rendezvous sessions for a TIBCO Hawk agent to monitor. Applications using these sessions appear as primary sessions in the TIBCO Hawk Display in the same list as managed applications (and microagents). TIBCO Hawk agents can use rulebases that refer to the applications, as long as those applications are running.

Page 123: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Transport Configuration | 103

You can add, edit, and delete sessions using the AMI Rendezvous Session Configuration dialog. The next section describes how to add a session. All sessions in the list will be accessible to the TIBCO Hawk agent.

To Create an AMI Session

The Rendezvous Setting for Additional Agent’s AMI Sessions panel of the Transport tab of the TIBCO Hawk Configuration Utility lists any AMI Rendezvous sessions already created.

1. Do one of the following:

— To create a new session click Add. You see the Add AMI Rendezvous Session dialog.

— To create a new session based on an existing one, highlight the desired session and click Derive. You see the Add AMI Rendezvous Session dialog (Figure 5), showing the values for the session you selected. Change the Session Name and other values as required (see next steps).

Figure 5 Add AMI Rendezvous Session

2. Enter a Session Name.

3. In the Session Parameters panel, enter values for Service, Network, and Daemon. Use the same values as those used by the application to initialize its TIBCO Rendezvous daemon session. To determine these values, check the application’s configuration files or documentation. (Although AMI session parameters are named differently from their non-AMI counterparts, the arguments are the same and the resulting sessions are similar.)

Page 124: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

104 | Chapter 7 Using the Configuration Utility

The default values for an AMI session are RVD, with session parameters specified as

— Service: 7474

— Network: ;

— Daemon: TCP: 7474

4. Click OK to close the AMI Session window and add the AMI session to the list of sessions.

Page 125: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Display Configuration | 105

TIBCO Hawk Display Configuration

The Display tab allows you to specify a previously created layout to be loaded automatically at startup and to specify a variables file.

Figure 6 Display Configuration

Display Use the Display option to specify the previously created layout you want loaded automatically at startup.

Variables Use the Variables option to specify a variables file. The variables file can pass data to define external variables to be used in either host or tool menu commands. The format of the file is that used by the standard Java class java.util.Properties. There is one line per variable where each line has the format variablename=value.

Page 126: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

106 | Chapter 7 Using the Configuration Utility

DefaultsThis button clears all fields and returns them to their default values.

Page 127: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration | 107

TIBCO Hawk Agent Configuration

The Agent tab allows you to configure options specific to the TIBCO Hawk agent.

Figure 7 Agent Configuration Tab

Identification

Agent Name

The agent name appears in the TIBCO Hawk Display. The default name for the TIBCO Hawk agent is the host name of the computer on which it is installed.

To use the host name as the agent name, leave the Agent Name field blank. To use a different name, enter a name as desired.

Agent names with multiple words separated by dots are not supported.

Page 128: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

108 | Chapter 7 Using the Configuration Utility

Agent Domain

An agent domain must be specified when two computers within the same TIBCO Hawk domain have the same name but reside in different network domains. To specify an agent domain for a TIBCO Hawk agent, enter the desired domain in the Agent Domain field, for example, pa.tibco.com.

Cluster

Enter the container name in which this agent is to appear in the TIBCO Hawk Display. The default name for the container is the IP subnet address. The cluster name must be enclosed within quotes, if the name contains spaces.

Configuration ModesUse the options in this panel to set up what mode the agent is to use when it searches for configuration objects. The default is to use Automatic configuration.

Automatic, Manual, and Repository configuration modes are mutually exclusive. When the radio button for one of these modes is selected, the other options are disabled.

The delimiter for path entries is a semicolon ( ; ).

Automatic Configuration Mode

To use Automatic configuration, enable the Auto radio button. You can either use the default auto configuration directory (TIBCO_CONFIG_FOLDER\tibco\cfgmgmt\hawk\autoconfig) or specify another directory.

When Automatic Configuration mode is enabled, all load-by-reference rulebase loading mechanisms are disabled. Therefore, the Manual Configuration Path, Repository Path, Repository Cache Directory, and the Rulebases button are not enabled. In addition, the RuleBaseInclude feature, rulebase maps, and the RuleBaseEngine:loadRuleBase() microagent method are not used. However, the microagent method RuleBaseEngine:loadRuleBaseFromFile() is allowed.

If you are using the rulebase map, you usually do not need to list any rulebases in the rulebase list dialog. Using both a rulebase map and the rulebase list dialog increases the complexity of managing your monitoring configuration.

The rulebase list dialog (which corresponds to the UNIX or file config option -rulebases) is provided to maintain backward compatibility with previous versions of TIBCO Hawk that do not contain the rulebase map feature.

Page 129: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration | 109

See the TIBCO Hawk Administrator’s Guide and the TIBCO Hawk Methods Reference for more on these features and microagent methods. See the TIBCO Hawk Console API Reference for information on configuring microagent plug-ins.

With automatic configuration, the agent will load the Schedules configuration file and all rulebase configuration files from the automatic configuration directory at startup. The only other mechanism by which an agent can load a rulebase after this point is through invocation of RuleBaseEngine:loadRuleBaseFromFile() or via SendTo from the Display, using fully qualified filenames.

When a rulebase is sent to an agent via SendTo or Apply Changes from the Display, the rulebase is stored in the autoconfiguration directory. When a rulebase is removed from an agent via the Display, the rulebase is also removed from the autoconfiguration directory. Use of the methods RuleBaseEngine:loadRuleBaseFromFile() and RuleBaseEngine:unloadRuleBase() do not affect the autoconfiguration directory.

Manual Configuration Mode

When manual configuration is selected, at startup, the agent searches the Manual Configuration Path for the Schedule file and the rulebase map file. After evaluating the rulebase map, the agent has a list of rulebase names. It searches for these using the Manual Configuration Path. Note that the loaded startup rulebases may have RuleBaseInclude lists that will trigger further searches of the manual configuration path for additional rulebases. Also at startup, the agent searches the path for any rulebases specified in the Rulebases dialog and loads them.

See the TIBCO Hawk Administrator’s Guide for more on these features. Note that manual configuration mode is also known as Configuration Path mode.

Any rulebases loaded by the agent are not written to a local cache. There is no notion of an autoconfiguration directory. The only rulebases an agent may load at startup are the ones:

• specified by the rulebase map.

• listed in the Rulebases dialog.

• contained in any RuleBaseIncludes.

To set up manual configuration, you specify a configuration path to use, and a list of rulebases, as follows.

1. Select the Manual radio button.

2. In the Manual Configuration Path field, specify a list of directories to be searched by separating directory entries with semicolons. The default directory is TIBCO_CONFIG_FOLDER\tibco\cfgmgmt\hawk\config.

Page 130: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

110 | Chapter 7 Using the Configuration Utility

3. Click Rulebases to bring up the Rulebase Configuration dialog

Figure 8 Rulebase Configuration Dialog

4. Do either of the following until your list is as desired, then click OK:

— To add a rulebase to the list, click Add, enter a a rulebase filename, and click OK.

— To remove a rulebase from the list, select it and click Delete.

Repository Configuration Mode

Repository mode is also a type of manual configuration mode and operates in a similar way to Manual Configuration mode. Instead of a configuration path, you specify a repository path. The agent communicates with a list of repositories in this path to obtain all configuration objects (rulebases, schedules, and rulebase maps). You can also specify a list of rule bases. Repositories are kept on the network and can be accessed by multiple agents. See the TIBCO Hawk Administrator’s Guide for an explanation of repositories.

Unlike Manual Configuration Mode, with Repository mode all configuration objects loaded from the Repository may be cached in a local directory, specified in the Repository Cache Directory field. This cache is used in the event of a repository failure, and also to minimize network traffic. Agents can determine if a configuration object in their cache is identical to the one in the repository and will load it directly from the cache or update it from the Repository as appropriate.

Do not use a file extension when entering rulebase names. The .hrb extensions are only used for rulebase files. See RuleBaseEngine:loadRuleBase() and RuleBaseEngine:loadRuleBaseFromFile() for more information.

Page 131: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Agent Configuration | 111

To use repository mode, specify a path for the repository and a repository cache to use in case the repository is off-line, and a list of rulebases, as follows.

1. Select the Repository radio button.

2. In the Repository Path field, specify the list of repositories to be searched. The list should consist of the repository names separated by semicolons (;).

3. In the Repository Cache Directory field, specify a repository cache directory. The default is TIBCO_CONFIG_FOLDER\tibco\cfgmgmt\hawk\cache.

4. Click Rulebases to bring up the Rulebase Configuration dialog (Figure 8). Do either of the following until your list is as desired, then click OK:

— To add a rulebase to the list, click Add, enter a a rulebase filename, and click OK.

— To remove a rulebase from the list, select it and click Delete.

RepositoryIf a TIBCO Hawk agent is to act as a repository for the TIBCO Hawk system, enter a name (with no spaces or periods) for the repository and a path for storage of the configuration object files. The default is TIBCO_CONFIG_FOLDER\tibco\cfgmgmt\hawk\Repository.

MicroAgent PluginsUse the Plugins Directory option to specify the directory that the TIBCO Hawk Agent should search when loading microagent plugins.

VariablesUse the Variables option to specify a variables file. The variables file can pass data to define external variables to be passed to rules for use in rulebase configurations.

Step 4 is optional. However, if no rulebase map is supplied by the repository, this step is recommended.

Page 132: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

112 | Chapter 7 Using the Configuration Utility

Logfile Microagent

Scan Rate (secs)

The rate at which the log file that is being monitored is scanned for new entries. The default is 10 seconds.

Block Size (KB)

The size of the block that is read from the log file each time it is scanned. The default is 16 KB.

Evaluation Rate (secs)

The rate at which all the logfiles being monitored by the agent are evaluated. The default is 300 seconds.

Heartbeat The TIBCO Hawk agent heartbeat interval can be set on each computer where an agent is installed. The default heartbeat interval is 30 seconds. The TIBCO Hawk Display uses this value to determine when to mark an agent dead.

To use the default value of 30 seconds, leave the value in the Interval field set to 30. To use a different value, enter a number of seconds, as desired.

DefaultsThis button clears all fields and returns them to their default values.

Page 133: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Event Service Configuration | 113

TIBCO Hawk Event Service Configuration

The Event Service tab allows you to configure options specific to the TIBCO Hawk Event Service.

Figure 9 TIBCO Hawk Event Service Dialog

Agent Dead HandlingThe Event Service can call a command-line script or executable when the heartbeat of a TIBCO Hawk agent is lost (not received for a specified length of time). This usually means that the agent process has terminated or that network communication has been interrupted. This facility could be used to send an e-mail or page, or to take some other automated action.

Script File

Specify the name of this script file. By default, this field is blank and no script is called when the agent does not respond.

Page 134: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

114 | Chapter 7 Using the Configuration Utility

Two command-line arguments are sent to the script, in this order:

1. The name of the agent (by default, identical to the name of the computer on which the agent is installed).

2. The IP address of the computer on which the agent is installed.

Event DataCheck the Enable Event Service Data Files box to enable logging. The TIBCO Hawk Event Service writes to rolling data files in the same way that the standard TIBCO Hawk logging system writes to rolling log files (see Logging, page 91).

As with TIBCO Hawk log files, you can set the following options:

• The directory in which to store data files. The default data file directory is TIBCO_CONFIG_FOLDER\tibco\cfgmgmt\hawk\Data.

• The maximum number of data files to keep. The default is five.

• The maximum size of a data file. The default maximum is 1024 kilobytes.

AMI Rendezvous SessionCheck Enable Dedicated AMI Session if your Event Service process needs to use a dedicated Rendezvous session for AMI transport. When the session is enabled, specify the following values. You can leave a parameter field empty (blank) to indicate a null value.

• Service number

• Network

• TCP daemon

For more information on these, see TIBCO Rendezvous Daemon Session Parameters on page 102.

Database ConfigurationCheck the Enable Event Persistence box to enable event persistence.

When this feature is enabled, fill in the following fields:

• User Name: User name to connect to the database.

• Password: User password to connect to the database.

• Database Type: The database vendor. Select the appropriate vendor from the dropdown menu.

Page 135: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Event Service Configuration | 115

• Database Connection: URL that identifies the database connection.

• JDBC Driver Class Name: Class name for the vendor's JDBC driver. For example, com.microsoft.jdbc.sqlserver.SQLServerDriver. You need to add the vendor’s JDBC drivers to your classpath using the Advanced dialog in the General tab.

• TIBCO Hawk Event Service logs alerts generated by Agents in the Hawk domain. If you want to add any additional alert action property field, click Define Column and enter the property name in the Add Alert Property dialog. The user-defined property field is added as an additional column in the HawkAlertClearInfo table.

Fault ToleranceCheck the Enable Fault Tolerance box to enable fault tolerance on this instance.

This instance joins a fault tolerant group named HawkEventService:hawkdomain, where hawkdomain is the value specified in the General tab.

Weight

Assign the weight of this instance using a positive integer. The member with the highest weight receives rank 1 (so it outranks all other members). When an instance fails, the next-highest instance is activated and the member with the next highest weight receives rank 2; and so on. When two or more members have the same weight, Rendezvous fault tolerance software ranks them in a way that is opaque to programs.

Enable Dedicated FT Session

Check the Enable Dedicated FT Session checkbox to specify the dedicated Rendezvous session for fault tolerance.

• Service number

• Network

• TCP daemon

When specifying a remote daemon, use the fully qualified domain name of the host. For example, tcp:host1.mycompany.com:7555.

If using TIBCO EMS as the primary transport and fault tolerance is enabled but a

Separate instances of TIBCO Hawk must be running on at least two machines in order to use fault tolerance. Fault tolerance must be enabled on each instance.

Page 136: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

116 | Chapter 7 Using the Configuration Utility

Dedicated FT Session is not specified, a Rendezvous session is created using default values.

If using TIBCO Rendezvous as the primary transport and fault tolerance is enabled but a Dedicated FT Session is not specified, the primary Rendezvous session is used for fault tolerance.

For more information on these, see TIBCO Rendezvous Daemon Session Parameters on page 102.

DefaultsThis button clears all fields and returns them to their default values.

Logging FileThe event service records the following items:

• All alerts raised and cleared by TIBCO Hawk agents across the network, as well as changes in an agent’s alert level (as would be shown by a color in the TIBCO Hawk Display).

• All instances of agent activation and expiration.

Some example event.dat log file service entries are shown below.

MICROAGENT_REMOVED : AgentID={ host-name=hk-win05.tibco.com, dns=none, host-ip=10.107.196.28, network-ip=WINDOWS }, MicroAgentID=COM.TIBCO.hawk.hma.TibRendezvous:2 ## Wed Jul 02 12:30:24 PDT 2004 ##

RULEBASE_STATE_CHANGED : AgentID={ host-name=PPRASAD-LT, dns=none, host-ip=10.105.160.131, network-ip=10.105.160.131 }, rulebase=HawkWindowsEventLog, new-rulebase-state=50 ## Wed Jul 07 15:31:34 PDT 2004 ##

Note the following considerations:

• Each TIBCO Hawk Event Service instance in the fault tolerance group must be assigned a weight.

• Each weight must be a positive integer, starting with 1.

• Each service should have a unique weight.

• The weights do not need to be consecutive.

If two or more TIBCO Hawk Event Services have the same weight, Rendezvous fault tolerance software assigns a rank to them but does not update the Weight field in this dialog with the new value.

Page 137: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Event Service Configuration | 117

MICROAGENT_ADDED : AgentID={ host-name=hkwin05.tibco.com, dns=none, host-ip=10.107.196.28, network-ip=WINDOWS }, MicroAgentID=COM.TIBCO.hawk.hma.TibRendezvous:3 ## Wed Jun 07 12:50:27 PDT 2004 ##

ALERT_RECEIVED : alert={ agent={ host-name=IMLOAN.TIBCO.COM, dns=none, host-ip=10.107.138.30, network-ip=AS400 }, alert-id=113, rulebase=Stress-Custom-AS400, alert-state=0, alert-text=Return string Wed Jul 07 14:31:12 2004 , time-received=Wed Jul 07 15:31:43 PDT 2004 } ## Wed Jul 07 15:31:59 PDT 2004 ##

MICROAGENT_ADDED : AgentID={ host-name=SMITH-LT, dns=none, host-ip=10.105.152.146, network-ip=10.105.114.0 }, MicroAgentID=TomcatMBeanTester:1 ## Wed Jul 07 15:41:15 PDT 2004 ##

ALERT_CLEARED : agent={ host-name=hkwin05.tibco.com, dns=none, host-ip=10.107.196.28, network-ip=WINDOWS } alert-id=1050, reason=Valid DataSource is now available: MicroAgentID{name=COM.TIBCO.hawk.hma.Process, displayName=Process, instance=3, isService=false, checksum=3743856314, hostingAgent=Agent{name=hk-win05.tibco.com, dns=none, hawkDomain=mmdomain1, starttime=1085445353093}} ## Mon Jul 12 04:10:27 PDT 2004 ##

AGENT_EXPIRED : agent={ host-name=SMITH-LT, dns=none, host-ip=10.105.152.146, network-ip=10.105.114.0 } ## Tue Jul 13 15:51:37 PDT 2004 ##

RULEBASE_REMOVE : AgentID={ host-name=ultrahawk1, dns=none,host-ip=160.101.246.16, network-ip=160.101.246.0 }, rulebase=Solaris2x,at Sun Jul 18 11:50:05 EST 2004

AGENT_REINITIALIZED : agent={ host-name=lexus, dns=nytek.com,host-ip=160.101.110.169, network-ip=160.101.110.0 }, alert-state=50, atMon Jul 19 11:50:36 EST 2004

AGENT_ALIVE : agent={ host-name=hk-win05, dns=none, host-ip=10.107.196.28, network-ip=10.107.196.0 }, alert-state=75 ## Wed Jul 28 08:35:55 PDT 2004 ##

RULEBASE_ADDED : AgentID={ host-name=hk-win05, dns=none, host-ip=10.107.196.28, network-ip=10.107.196.0 }, rulebase=HawkWindowsEventLog, state=75 ## Wed Jul 28 08:35:55 PDT 2004 ##

Disabling and Enabling the Event ServiceThe Event Service is not enabled by default. You must manually enable it.

Enabling theEvent Service

To enable the TIBCO Hawk Event Service,

1. Choose Start>Settings>Control Panel, then double-click on the Services icon.

Page 138: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

118 | Chapter 7 Using the Configuration Utility

2. Select TIBHawk Event in the list of services and click Startup.

3. In the Service window, click the Automatic radio button, then click OK. The service is shown in the list as Automatic.

4. Click Start to start the Event Service. The service is shown in the list as Started.

Disabling theEvent Service

To disable the TIBCO Hawk Event Service, disable the TIBCO Hawk Event Service in the Windows Services control panel as follows:

1. Choose Start>Settings>Control Panel, then double-click on the Services icon.

2. Select TIBHawk Event in the list of services and click Startup.

3. In the Service window, click the Disabled radio button, then click OK. The service is shown in the list as disabled.

4. If the service is already running, click Stop to stop it. The status in the list is blank, indicating the service is stopped.

Be careful not to confuse TIBCO Hawk Event Service data files (Event.dat) with Event Service log files (Event.log).

• Event.dat data files contain the data produced by the Event Service.

• Event.log log files record the state of the Event Service itself.

The Event.log file is discussed in the TIBCO Hawk Administrator’s Guide.

Page 139: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 119

Chapter 8 Using the TIBCO Hawk Messaging Microagent

The Messaging microagent provides methods to send and receive messages using either TIBCO Rendezvous or TIBCO EMS. This chapter gives an overview of this microagent and describes how to configure and use the microagent.

Topics

• Overview, page 120

• Configuration File Elements and Attributes, page 121

• Specifying Field Names in Parameters, page 133

Page 140: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

120 | Chapter 8 Using the TIBCO Hawk Messaging Microagent

Overview

The Messaging microagent provides methods to send and receive messages using either TIBCO Rendezvous or TIBCO EMS. For a detailed description of these methods refer TIBCO Hawk Method Reference Guide.

Using XML configuration files, you can specify the subject and message structure to be sent or received for each method. If transport parameters are not specified in the configuration files, the transport specified for TIBCO Hawk Agent will be used. If using RVCM, the transport parameters have to be specified in the method element for each method. If using EMS as the default transport, only messages send or received with JMS topic are supported.

A set of sample configuration files are copied to the installation area in the samples/msghma directory. These files contain sample methods, as well as several default method definitions that are helpful for performing routine tasks. The configuration file, msghma.xml, used by the default Messaging microagent is located in the TIBCO_CONFIG_FOLDER/tibco/cfgmgmt/hawk/bin directory. You can configure additional Messaging microagents by using the TIBCO Hawk plug-in microagent mechanism. To configure additional Messaging microagents:

1. Copy the .hma file for the microagent to the plugin directory. The plugin directory is specified by the -hma_plugin_dir option in the hawkagent.cfg file. If using the Configuration Utility, the plugin directory is specified by the Plugin field in the Agent tab.

2. Make sure the xml file specified in the hma file is present in the expected location.

3. Re-start the TIBCO Hawk Agent.

Configuration files of the TIBCO Hawk Rendezvous Messaging Adapter can be used as-is. However, any non-applicable attributes will be ignored and if more than one microagent is defined, only the first microagent configuration will be loaded.

Do not edit or delete the msghma.xml file used by the default Messaging microagent.

Page 141: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuration File Elements and Attributes | 121

Configuration File Elements and Attributes

The msghma.dtd file defines the grammar for all the constructs used in an microagent XML configuration file. With this file included, the XML configuration file can be syntax checked using any validating XML parser.

The following tables describe the attributes that can be set in an XML configuration file:

• TIBHAWK_AMI Element Attributes

• microagent Element Attributes

• method Element Attributes

• inputParameter Element Attributes

• valueChoices Element Attribute

• legalValueChoices Element Attribute

• constantParameter Element Attributes

• outputParameter Element Attributes

The top level element, TIBHAWK_AMI describes transport parameters and tracing attributes that can applied to all microagents. Some of the attributes can be redefined for an individual method in the method element.

You can specify different transport parameters for each method as attributes of the method element. The attributes of the method element take precedence over those specified by the microagent or TIBHAWK_AMI elements.

Table 19 TIBHAWK_AMI Element Attributes

Attribute Type Description

dtd_type enumeration

REQUIRED. (MSGHMA).

dtd_version enumeration

REQUIRED. (1.0).

xml_file_version string IMPLIED. Can be used to identify the version of this XML file. It must be in the form of <major>.<minor>.<update>, for example, 1.1.0.

Page 142: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

122 | Chapter 8 Using the TIBCO Hawk Messaging Microagent

ami_rvd_service ami_rvd_network ami_rvd_daemon

string IMPLIED. These attributes together configure the TIBCO Rendezvous parameters for creating an TIBCO Rendezvous transport for the communication with the TIBCO Hawk agent.

These attributes are maintained for backward compatibility only and is not used.

rvService

rvNetwork

rvDaemon

string IMPLIED. These attributes together configure the TIBCO Rendezvous parameters for creating a TIBCO Rendezvous transport.

ems_url

ems_uid

ems_pw

string These attributes together configure the TIBCO EMS parameters for creating a TIBCO EMS transport.

ssl_trace

ssl_debug_trace

ssl_vendor

ssl_trusted

ssl_expected_hostname

ssl_identity

ssl_identity_encoding

ssl_password

ssl_verify_hostname

ssl_verify_host

ssl_cipher

string These attributes are used when using SSL to connect to the EMS server.

When specifying values for attributes ssl_verify_hostname and ssl_verify_host, valid values are enabled and disabled.

When specifying values for attributes for ssl_trace and ssl_debug_trace, valid values are true and false.

Table 19 TIBHAWK_AMI Element Attributes

Attribute Type Description

Page 143: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuration File Elements and Attributes | 123

cmName

cmLedgerName

string IMPLIED. These attributes together form an RVCM (TIBCO Rendezvous Certified Message) transport. All methods in this microagent that use RVCM will use this RVCM transport.

cmName is the RVCM reusable name which represents a persistent correspondent.

If cmLedgerName is specified, it must be a valid file name. The cmLedgerName attribute is ignored if cmName is not specified.

rvAdvisoryTraceLevel enumeration

IMPLIED. One of: ERROR, WARN or INFO. Specifies the lowest level of TIBCO Rendezvous advisory messages to be tracked by the microagent.

For example, if WARN is specified, then all WARN or ERROR advisory messages are tracked by this microagent.

The default value WARN. If an advisory message not tracked by the microagent is received, it will be sent to the microagent standard output if of class WARN or ERROR and discarded if of class INFO.

rvAdvisoryForward string IMPLIED. Either true or false. Specifies whether a tracked advisory message will be sent to the TIBCO HAWK Agent as an unsolicited message.

The default is false, which means tracked advisory messages are logged to the adapter's log file.

ftGroupName string IMPLIED. Specifies the name of the TIBCO Rendezvous fault tolerance group.

This attribute is maintained for backward compatibility only and is not used.

Table 19 TIBHAWK_AMI Element Attributes

Attribute Type Description

Page 144: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

124 | Chapter 8 Using the TIBCO Hawk Messaging Microagent

At least one method must be defined for the microagent. .

ftWeight

ftActiveGoal

ftHeartbeatInterval

ftPrepInterval

ftActiveInterval

string IMPLIED. These attributes together define TIBCO Rendezvous fault tolerance parameters. The default values are:

• ftWeight 100.

• ftActiveGoal 1

• ftHeartbeatInterval 30 seconds

• ftPrepInterval 60 seconds

These attributes are used only if the ftGroupName is specified.

These attributes are maintained for backward compatibility only and are not used.

traceFile

traceFileMaxSize

traceFileMaxNumber

traceLevel

string IMPLIED. These attributes together specify the tracing parameters. If not defined, tracing is sent to stdout.

traceFile. Absolute pathname of the trace file.

traceFileMaxSize. Maximum size (in KB) the trace file is allowed to grow.

traceFileMaxNumber. Maximum number of roll over trace files to be maintained.

traceLevel. Starting trace level.

Table 20 microagent Element Attributes

Attribute Type Description

name string REQUIRED. Name for the microagent.

help string IMPLIED. Help text describing the microagent. Each help attribute is paired with a name attribute. If not defined, the name attribute value is used as the help text.

Table 19 TIBHAWK_AMI Element Attributes

Attribute Type Description

Page 145: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuration File Elements and Attributes | 125

displayName string IMPLIED. Name that is displayed in the TIBCO Hawk Display.

rvService,

rvNetwork, and

rvDaemon

or

ems_url

ems_uid

ems_pw

ssl_trace

ssl_debug_trace

ssl_vendor

ssl_trusted

ssl_expected_hostname

ssl_identity

ssl_private_key

ssl_password

ssl_verify_hostname

ssl_verify_host

ssl_cipher

string IMPLIED. These attributes together configure the transport parameters for the microagent.

If any of the attributes are specified differently from those specified for the TIBHAWK_AMI element, a new rvd transport is created and all the methods belong to this microagent will use the new transport.

If the attributes are not specified, the values specified for the corresponding attributes associated with the TIBHAWK_AMI element are used.

When specifying values for attributes ssl_verify_hostname and ssl_verify_host, valid values are enabled and disabled.

When specifying values for attributes for ssl_trace and ssl_debug_trace, valid values are true and false.

Table 20 microagent Element Attributes

Attribute Type Description

Page 146: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

126 | Chapter 8 Using the TIBCO Hawk Messaging Microagent

cmName

cmLedgerName

string IMPLIED. These attributes together form an RVCM (TIBCO Rendezvous Certified Message) transport. All methods in this microagent that use RVCM will use this RVCM transport.

cmName is the RVCM reusable name which represents a persistent correspondent.

If cmLedgerName is specified, it must be a valid file name. The cmLedgerName attribute is ignored if not specified.

maxThreads string IMPLIED. Defines the maximum number of threads a microagent can have to perform method invocations in parallel. The default value is 1.

This attribute is maintained for backward compatibility only and is not used.

traceFile

traceFileMaxSize

traceFileMaxNumber

traceLevel

string IMPLIED. These attributes together specify the tracing parameters for this microagent. If not defined, tracing is sent to stdout. The attributes override the corresponding attributes associated with the TIBHAWK_AMI element.

• traceFile. Absolute pathname of the trace file.

• traceFileMaxSize. Maximum size (in KB) the trace file is allowed to grow.

• traceFileMaxNumber. Maximum number of roll over trace files to be maintained.

• traceLevel. Starting trace level.

These attributes are maintained for backward compatibility only and are not used.

Table 20 microagent Element Attributes

Attribute Type Description

Page 147: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuration File Elements and Attributes | 127

If a method has parameters, the method must have at least one input or constant parameter. If a method has a return value, it must have at least one output parameter.

Table 21 method Element Attributes

Attribute Type Description

name string REQUIRED. The method name.

help string IMPLIED. Help text describing the method. Each help attribute is paired with a name attribute. If not defined, the name attribute value is used as the help text.

index string IMPLIED. If a method returns more than one row of information, the index attribute must be specified with the name of the output parameter which can uniquely identify each row.

If multiple output parameters are required to uniquely identify a row (that is, a composite index), the index attribute must be specified with parameter names separated by commas.

subject string IMPLIED. Specifies the subject to subscribe or to publish. For a subscription subject, the subject name segments may contain "*", and the last segment may be ">".

The attribute is required if the first input parameter is not named Subject or if the method publishes RVCM messages.

timeout string IMPLIED. The timeout attribute is meaningful (and required) only for RPC methods. If the timeout interval expires and no reply is received, the first return timeout parameter is set to true.

Note that the thread executing the RPC is blocked while waiting for the reply. If a microagent expects multiple simultaneous RPC calls, the maxThreads attribute for the microagent must be adjusted higher accordingly.

Page 148: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

128 | Chapter 8 Using the TIBCO Hawk Messaging Microagent

heartbeatInterval

string IMPLIED The heartbeatInterval attribute (in seconds) is meaningful only for publisher methods. If this heartbeatInterval attribute exists, in additional to the normal behavior, at every heartbeat interval, a message is published. Note that this kind of method can not have inputParameters; only constantParameter's can be used.

handlerType enumeration

REQUIRED. One of: P, SU, RPC, DS, T or S

Specifies how a method should be handled:

• P. Publishers sending messages.

• SU. Subscribers receiving messages.

• RPC. RPC client sending messages, then waiting for the reply.

• DS. Used for the factory provided methods tibrvlisten, tibrvecho and dynamicSubscribe.

• T. Used for the factory provided method timeoutTest only.

• S. Used for factory provided system methods, which include reviewLedger and shutdown.

For subscriber and RPC methods (with handlerType SU and RPC respectively) the specified fields must have a one to one correspondence with the method’s return (output) parameters.

For publisher methods (with handlerType P and RPC respectively), the message publish subject and all fields must be specified in the message.

useCM string IMPLIED. If set to true, the method is an RVCM publisher or subscriber. If not specified, RVCM is not used.

Table 21 method Element Attributes

Attribute Type Description

Page 149: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuration File Elements and Attributes | 129

For methods with handlerType SU, P, or RPC, if the first inputParameter is named Subject, it is used as the subject for subscription or publish. (Note: In this case, the subject attribute for the method should not be defined.) This allows subjects to be specified at runtime.

For each parameter, you can define either one or more acceptable choices in a valueChoices element, or one or more legal choices in a legalValueChoices element. If one of these elements is included in the parameter definition, users can select method argument values from a dropdown list in TIBCO Hawk Display. If neither is included, the corresponding method argument is represented by an editable field.

cmListenerList string IMPLIED. Only meaningful if the useCM attribute is set to true and the method handlerType value is P (is a publisher method). The cmListenerList attribute specifies a list of cmName names in the form:

<name1>, <name2>, <name3>, ...

Table 22 inputParameter Element Attributes

Attribute Type Description

name string REQUIRED. Name for the input parameter.

help string IMPLIED. Help text describing the input parameter. Each help attribute is paired with a name attribute. If not defined, the name attribute value is used as the help text.

type enumeration

REQUIRED. The supported datatypes are:

BOOL, F32, F64, I8, I16, I32, I64, U8, U16, U32, STRING, XML

fieldName string IMPLIED. Must be in the form of F1[.F2[...[.FN]]] where F1 - FN are the message field names in each nested level.

If the fieldName attribute is not specified, it is assumed to be the same as the name attribute.

See Specifying Field Names in Parameters, page 133 for details.

Table 21 method Element Attributes

Attribute Type Description

Page 150: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

130 | Chapter 8 Using the TIBCO Hawk Messaging Microagent

An input parameter may have an optional element, valueChoices or legalValueChoices but not both.

The valueChoices element defines some acceptable values for an inputParameter element. These values are included in the dropdown list for method arguments in TIBCO Hawk Display. Users can also type a value not in the list. This element is optional, and can only be used if the legalValueChoices element is not specified

The legalValueChoices element defines the only possible values that can be specified in an inputParameter method. This element is optional, and can only be used if valueChoices is not specified. Use this element to limit users to specific values, which are included in the dropdown list for method arguments in TIBCO Hawk Display. Users can only specify values included in the list.

pattern string IMPLIED. Specifies a pattern to convert string data to a desired form. The pattern syntax is based on the java.text.MessageFormat class specification.

For example, a pattern {0, number} KB could be used to convert a string 123 KB to a number 123 (not a string). If the pattern in the example is {0} KB, a string of 123 is extracted.

Note that only the first argument placeholder (that is, {0..} ) is used to extract the value for the parameter and others are ignored.

Table 23 valueChoices Element Attribute

Attribute Type Description

value string IMPLIED. Defines suggested values. The values are separated by comma characters. For example: 0, 30, 45, 60, 90

Table 24 legalValueChoices Element Attribute

Attribute Type Description

value string IMPLIED. Defines legal values only. The values are separated by comma characters. For example: 0, 30, 45, 60, 90

Table 22 inputParameter Element Attributes

Attribute Type Description

Page 151: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuration File Elements and Attributes | 131

Constant parameters are not exposed to the TIBCO Hawk Agent or TIBCO Hawk Display. Constant parameter values are passed to the msghma method internally. This type of parameters are used when some fixed constant values need to be passed to msghma methods.

Constant parameters are used to fill in constant value fields in the message.

For subscriber methods (with method handlerType SU or DS), there are three special outputParameter names:

• Subscription Subject. Returns the subject used in the subscription. It can contain wild card characters.

• Message Subject. Returns the actual subject used by the publisher to publish the received message.

• Reply Subject. Returns the reply subject of the received message. The reply subject is blank if the sender does not specify a reply subject

Table 25 constantParameter Element Attributes

Attribute Type Description

name string REQUIRED. Name for the constant parameter.

help string IMPLIED. Help text describing the input parameter. Each help attribute is paired with a name attribute. If not defined, the name attribute value is used as the help text.

type enumeration

REQUIRED. The supported datatypes are:

BOOL, F32, F64, I8, I16, I32, I64, U8, U16, U32, STRING, XML

fieldName string IMPLIED. Must be in the form of F1[.F2[...[.FN]]] where F1 - FN are the message field names in each nested level.

If the fieldName attribute is not specified, it is assumed to be the same as the name attribute.

See Specifying Field Names in Parameters, page 133 for details.

Page 152: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

132 | Chapter 8 Using the TIBCO Hawk Messaging Microagent

For RPC methods (with method handlerType RPC), there is a special outputParameter with the name Timeout and type BOOL. It is required and must be the first outputParameter. It is used to indicate whether a timeout has occurred while waiting for the reply.

Table 26 outputParameter Element Attributes

Attribute Type Description

name string REQUIRED. Name for the output parameter.

help string IMPLIED. Help text describing the input parameter. Each help attribute is paired with a name attribute. If not defined, the name attribute value is used as the help text.

type enumeration

REQUIRED. The datatypes follow the TIBCO Rendezvous 6.x datatypes convention:

BOOL, F32, F64, I8, I16, I32, I64, U8, U16, U32, STRING

fieldName string IMPLIED. Must be in the form of F1[.F2[...[.FN]]] where F1 - FN are the message field names in each nested level.

If the fieldName attribute is not specified, it is assumed to be the same as the name attribute.

See Specifying Field Names in Parameters, page 133 for details.

pattern string IMPLIED. Specifies a pattern to convert string data to a desired form. The pattern syntax is based on the java.text.MessageFormat class specification.

For example, a pattern {0, number} KB could be used to convert a string 123 KB to a number 123 (not a string). If the pattern in the example is {0} KB, a string of 123 is extracted.

Note that only the first argument placeholder (that is, {0..} ) is used to extract the value for the parameter and others are ignored.

Page 153: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Specifying Field Names in Parameters | 133

Specifying Field Names in Parameters

The fieldName attribute in an inputParameter, outputParameter, or constantParameter element can specify a single field name, nested fields, repeating fields or arrays.

The following example shows how to specify a single field name:

<constantParametername = "A first level field"fieldName = "STR_FIELD"type = "STRING"value = "test"

></constantParameter>

A nested field must be in the form of F1[.F2[...[.FN]]] where F1 - FN are the message field names in each nested level. For example, a message has a field NESTED_FIELD, which is another message and that message has a field L2. For a parameter corresponding to the value of the field L3 in NESTED_FIELD.L2, its fieldName attribute should be:

<constantParametername = "A nested field"fieldName = "NESTED_FIELD.L2.L3"type = "I8"value = "1">

</constantParameter>

If a field is a repeating field, the instance number (starting from 1) must also be specified using the notation of {instance number} appended after the field name. For example, NESTED_FIELD.L2.L3R{1} means the field L3R belongs to the first instance of the repeating field L3R of NESTED_FIELD.L2. In the second example, NESTED_FIELD.L2.L3R{2} means the field L3R belongs to the second instance of the repeating field L3R of NESTED_FIELD.L2.

<constantParametername = "First repeating field L3R in L2"fieldName = "NESTED_FIELD.L2.L3R{1}"type = "I16"value = "2"

></constantParameter><inputParameter

name = "Second repeating field L3R in L2"fieldName = "NESTED_FIELD.L2.L3R{2}"type = "I64"

></inputParameter>

Page 154: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

134 | Chapter 8 Using the TIBCO Hawk Messaging Microagent

If a field is an array, a parameter can be used to represent only one element in an array. The element index number (starting from 0) must be specified using the notation of [index number] appended after the field name. For example, NESTED_FIELD.L2.L3A[0] means the first array element in field L3A where L3A is a field of L2 and L2 is field of NESTED_FIELD. In the second example, NESTED_FIELD.L2.L3A[1] means the second array element in field L3A where L3A is a field of L2 and L2 is field of NESTED_FIELD.

<constantParametername = "First array element of L3A in L2"fieldName = "NESTED_FIELD.L2.L3A[0]"type = "U32"value = "4"

></constantParameter><inputParameter

name = "Second array element of L3A in L2"fieldName = "NESTED_FIELD.L2.L3A[1]"type = "U8"

></inputParameter>

Note that the type of "array of TibrvMsg" is not supported and a fieldName such as F1.F2[2].F3 is not valid. When repeating fields or array fields appear in the input or constant parameters (for sending), the sequence numbers or the index numbers must be in order, that is., no skipping is allowed.

Page 155: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 135

Chapter 9 Using TIBCO Hawk Across Nets or Subnets

This chapter explains how to configure TIBCO Hawk monitoring for use across networks or subnets when using TIBCO Rendezvous as the primary transport. It also explains how to access TIBCO Hawk monitoring through a dial-up connection.

Topics

• Agents and the Network, page 136

• Configuring for Network Communication, page 137

• Setting up Network Communication on UNIX, page 140

• Setting Up Network Communication in Microsoft Windows, page 141

• Using the TIBCO Hawk Display over a Dial-up Network Connection, page 144

Page 156: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

136 | Chapter 9 Using TIBCO Hawk Across Nets or Subnets

Agents and the Network

The TIBCO Rendezvous messaging software that TIBCO Hawk uses operates within either IP Broadcast or IP Multicast protocols. Network traffic for these protocols is not generally routed openly between subnets or networks.

IP Multicast traffic can be passed through configuration of the network routers, but IP Broadcast must use other means to reach other subnets. TIBCO Rendezvous software uses a process known as a routing daemon (rvrd) to allow TIBCO Rendezvous messages to transcend multiple networks.

If all TIBCO Hawk agents are installed on computers within one subnet, no configuration changes are necessary, but if the TIBCO Hawk agents are installed on computers in different subnets or networks, you must change their configuration to allow them to communicate using the routing daemon, rvrd.

Page 157: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuring for Network Communication | 137

Configuring for Network Communication

Figure 10 shows a sample routing daemon implementation where all TIBCO Hawk messages are available throughout the network, and there is only one TIBCO Hawk domain. Host B acts as the hub. All other rvd processes in each subnet will obtain information from the other subnets through rvrd processes on host A, B or C, as applicable.

On these machines, the rvrd process would replace the regular rvd process. However, in addition to its routing functions, the rvrd will support the local applications just as rvd would.

Figure 10 Sample Routing Daemon Configuration for TIBCO Hawk Messaging

Configuring Hawk Rendezvous Subjects When creating Rendezvous routing daemon (rvrd) routes between networks, you must specify the Rendezvous message subject names that can be passed between the networks. These are configured using the routing daemon's Browser Configuration Interface. For details on using the Browser Administration Interface and creating Rendezvous routes, see TIBCO Rendezvous Administration.

For TIBCO Hawk networks, the routed subjects can be used to control which agents can be discovered by TIBCO Hawk Console instances located on different parts of the network.

Subnet 1 Subnet 2 Subnet 3

Router

Router

hostA

(hub)

hostB

hostC

neighborconnection

Page 158: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

138 | Chapter 9 Using TIBCO Hawk Across Nets or Subnets

Full Visibility

The simplest TIBCO Hawk routing configuration is full visibility of all agents from any TIBCO Hawk Console, anywhere on the network. In this case, the subject configuration of the Rendezvous routing daemons is identical across all routing daemons, as shown:

Import and Export: "_HAWK.>"

If Hawk Event service is used in the fault tolerant mode across networks, the subject configuration is as follows:

Import and Export: "_RVFT.>"

Isolated Spokes and DMZ networks

In many large enterprises, application groups may be allowed to discover TIBCO Hawk agents on their own networks, but not on networks outside their control. However, a central hub network can be used to view all agents for the purposes of TIBCO Hawk alert management, centralized rulebase administration, and so on. In this case, the routing daemons running on the spoke networks are configured to allow traffic in only from the central hub network consoles. This is configured as shown, with references to Figure 10:

On the spoke networks (Hosts A and C):

Import: "_HAWK.*.nl.pa.p1.console.>"Export: "_HAWK.*.nl.pa.p1.agent.>"Export: "_HAWK.*.nl.pa.p1.agent4.>"

On the central hub network (Host B):

Export: "_HAWK.*.nl.pa.p1.console.>"Import: "_HAWK.*.nl.pa.p1.agent.>"Import: "_HAWK.*.nl.pa.p1.agent4.>"

If a Hawk Repository is used, add the following to both sides:

Import and Export: "_HAWK.*.nl.repository.>"

The second subject segment, * , is the Hawk Domain parameter.

When used on DMZ networks, this subject configuration will prevent any of the "inside" agents being discovered in the event a Hawk Console is launched from the "outside."

Monitoring TIBCO Hawk Agents Using TIBCO Rendezvous and TIBCO EMSIn a network where some TIBCO Hawk agents use TIBCO EMS as the primary transport and some use TIBCO Rendezvous as the primary transport, the EMS server needs to be set up to allow a TIBCO Hawk monitoring application or a console application such as the TIBCO Hawk display to see all the TIBCO Hawk

Page 159: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuring for Network Communication | 139

agents. The console application may use TIBCO EMS or TIBCO Rendezvous as the primary transport. The operations that enable the EMS server for this to happen are the Import and Export TIBCO Hawk messages. Importing and exporting messages on an EMS server is based on topics and all TIBCO Hawk messages have a topic. The topics of the TIBCO Hawk messages when TIBCO EMS is used as the transport has same the subject as that of the TIBCO Hawk messages when TIBCO Rendezvous is used as the transport.

There are files that are involved on EMS server for importing and exporting messages: (assuming using the default filenames)

• tibemsd.conf

The parameter tibrv_transports has to be enabled to exchange messages with TIBCO Rendezvous.

• transports.conf

In this file, specify transport definitions that will be used. For example

[RVHAWK]type = tibrvservice =7475network =;daemon =tcp:7475

The network, service, daemon parameters used in the transport definition should match the TIBCO Rendezvous parameters used by TIBCO Hawk agent.

• topics.conf

This file contains the import and export definitions. For example,

_HAWK.> global,import=RVHAWK,export=RVHAWK

For more information, see TIBCO Enterprise Message Service documentation.

Routing TIBCO Hawk Messages with EMS server Across NetworksEMS servers can be configured to route messages between networks where rvrd is not setup to do so. In order to do this both networks must have an EMS server running. Messages from one network are routed to the other via the EMS server instead of the rvrd.

For more information, see TIBCO Enterprise Message Service User’s Guide.

To route TIBCO Hawk messages, each EMS server needs to be setup for importing and exporting TIBCO Hawk topics. For more information, see Monitoring TIBCO Hawk Agents Using TIBCO Rendezvous and TIBCO EMS on page 138.

Page 160: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

140 | Chapter 9 Using TIBCO Hawk Across Nets or Subnets

Setting up Network Communication on UNIX

When starting the rvrd process, use the -store <file name> argument, which is specific to TIBCO Rendezvous, to store the parameters that configure rvrd. rvrd reads this file when the process starts, and writes this file each time you change the configuration using the browser administration interface. For details on using the Browser Administration Interface, see TIBCO Rendezvous Administration.

Routing Daemon Configuration for UNIXWhen any Rendezvous application starts, the libraries will cause a Rendezvous daemon (rvd) process to start if one is not already running. Once the rvd process is running, a Rendezvous routing daemon (rvrd) process cannot be started with the same transport parameters. This can cause coordination issues in starting the rvrd prior to any applications, and becomes a problem if the rvrd dies during run time and an rvd is restarted in its place.

You can avoid these problems by creating a simple wrapper script to always start the rvrd process in lieu of an rvd process. When the Rendezvous libraries search the PATH for an executable named rvd, they will find the rvrd wrapper script instead of the rvd process itself. This will always ensure that the rvrd process is started or restarted properly.

To set up the script:

1. Move or rename the rvd binary from the rv_install_dir/bin directory.

2. Create a shell script named rvd that starts the rvrd process with the desired command line arguments.

3. Place the rvd script in the rv_install_dir/bin directory of each machine where an rvrd process is required to run.

For details on the routing daemon command line parameters, see TIBCO Rendezvous Administration.

A TIBCO Rendezvous license file is required to use TIBCO Hawk with rvrd.

Page 161: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Setting Up Network Communication in Microsoft Windows | 141

Setting Up Network Communication in Microsoft Windows

Installing a Routing Daemon as a Microsoft Windows ServiceBecause TIBCO Hawk processes are installed as Microsoft Windows services, you must install the TIBCO Rendezvous routing daemon as a Microsoft Windows service and configure the TIBCO Hawk services to depend on it. If this is not done, the TIBCO Hawk services may start first, causing an rvd to launch and preventing the rvrd from running.

To configure the appropriate command line parameters for the rvrd process and install it as a Microsoft Windows service, use the TIBCO Rendezvous Services Configuration Program, rv_install_dir\bin\rvntscfg.exe. For further details on this program and routing daemon command line parameters, see TIBCO Rendezvous Administration.

Starting the Routing Daemon Service Automatically in Microsoft WindowsOnce you have configured the rvrd process as a Microsoft Windows service, set it up to start automatically when the operating system starts, as shown in the following steps:

1. Choose Start > Settings > Control Panel > Services.

2. Select the service in the list of services.

3. Click Startup.

4. Click the Automatic radio button.

5. Click OK.

It is recommended that you make the TIBCO Hawk services dependent on the EMS server service when it is installed on the same machine. To make the TIBCO Hawk services depend on the EMS server service, follow steps outlined in Making TIBCO Hawk Services Depend on the Routing Daemon Microsoft Windows Service, page 142, adding the EMS server service name in step 7.

For TIBCO Hawk to use rvrd, the daemon parameter specified in the -rvd_session option should match the port that rvrd is listening to.

For example, if the arguments for rvrd include -listen 7555 then specify the rvd_session for TIBCO Hawk as

-rvd_session <service> <network> tcp:7555, where <service> and <network> are your service and network parameters.

Page 162: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

142 | Chapter 9 Using TIBCO Hawk Across Nets or Subnets

Making TIBCO Hawk Services Depend on the Routing Daemon Microsoft Windows Service

Once the rvrd service has been installed, add a DependOnService parameter in the service registry to each of the installed TIBCO Hawk services (TIBHawkAgent, TIBHawkHMA, and TIBHawkEvent), as shown in the following steps.

1. Log on with administrative privileges.

2. Run the Microsoft Windows registry editor, regedt32, as follows:

a. Select Start > Run.

b. In the Run dialog that appears, enter regedt32 in the Open drop-down list box and click OK.

3. In the registry editor, navigate through the hierarchy to the TIBCO Hawk service.

The following figure shows the service:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\TIBHawkAgent

4. Right click and choose New>Multi-String Value.

Page 163: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Setting Up Network Communication in Microsoft Windows | 143

5. Rename this value to DependOnService.

6. Double-click this new value to bring up its Multi-String Editor dialog box.

7. Add the name of the service to the Value data edit box.

8. Click OK.

9. Exit regedt32.

10. Reboot your system.

Page 164: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

144 | Chapter 9 Using TIBCO Hawk Across Nets or Subnets

Using the TIBCO Hawk Display over a Dial-up Network Connection

The TIBCO Hawk system supports remote monitoring. If you are using a machine that has dial-in access to your network, you can monitor your network remotely. Standard connection techniques such as PPP and a simple configuration change are all that are required. The dial-in computer must have an IP address on the network, and should only run the TIBCO Hawk Display, and no other TIBCO Hawk services (such as HMA, agent, or event service).

The remote host must already be running a correctly configured TIBCO Rendezvous daemon. You cannot spawn a remote daemon. The easiest way to achieve a dial-up connection is to choose a machine that already has a properly configured TIBCO Hawk agent or TIBCO Hawk Display running.

This procedure can also be used for remote networks without an rvrd.

Establishing a Dial-up Connection in UNIXTo establish a dial-up connection using UNIX, supply the command-line option -rvd_session to the startdisplay script:

startdisplay -rvd_session <service> <network> tcp:<internal rvd host>:<port>

For example:

startdisplay -rvd_session 7474 123.123.123 tcp:office_computer:7474

or

startdisplay -rvd_session 7474 123.123.123 tcp:123.123.123.12:7474

When the dial-up connection is established, restart the TIBCO Hawk Display.

Establishing a Dial-up Connection in WindowsBy setting the TIBCO Hawk daemon parameter to point to a TIBCO Rendezvous daemon on your network, you effectively make your TIBCO Hawk Display appear to be located on that system.

1. From the offsite system, enter the Windows TIBCO Hawk Configuration program.

2. Enter the remote computer’s name as part of the Daemon parameter, as follows:

tcp:<internal rvd host>:<port>

Page 165: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Using the TIBCO Hawk Display over a Dial-up Network Connection | 145

where <internal rvd host> is any computer on the internal network which a TIBCO Rendezvous daemon process is running. For example:

tcp:office_computer:7474

or

tcp:123.123.123.12:7474

3. When the dial-up connection is established, restart the TIBCO Hawk Display.

Page 166: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

146 | Chapter 9 Using TIBCO Hawk Across Nets or Subnets

Page 167: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 147

Chapter 10 TIBCO Hawk Sample Rulebases and Applications

If, on UNIX, the TIBCO Hawk software is installed in any location other than the default path of /usr/tibco/hawk, you must update all rules using the logfile:onNewLine data source in the sample rulebases. For example, HawkAgent-Unix (in the directory $HAWK_INSTALLATION/samples) must be updated to reflect the correct path to $HAWK_ROOT/log.

Topics

• Using the Sample TIBCO Hawk Rulebases, page 148

• Using the TIBCO Hawk Sample Applications, page 149

• The Sample AMI API Applications, page 151

Page 168: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

148 | Chapter 10 TIBCO Hawk Sample Rulebases and Applications

Using the Sample TIBCO Hawk Rulebases

The TIBCO Hawk sample rulebases are installed in the directory $HAWK_INSTALLATION/samples/rulebases. To use any of these rulebases, follow the instructions below:

1. In the TIBCO Hawk Display, right-click on the desired agent and select Get Configuration>Rulebases from the menu.

The Rulebase List for Agent dialog displays.

2. Choose File>Load From File.

The Open dialog displays.

3. Navigate to the desired rulebase file and click Open.

— If a rulebase with this name is not already loaded, it is added to the Rulebase List.

— If a rulebase with this name is loaded on the agent, a dialog displays your options. Click OK to overwrite the existing rulebase, or Cancel to leave the dialog.

4. To save changes to memory, click Apply Changes to Agent.

If you are using Automatic Configuration mode, the loaded rulebase is copied to your auto-configuration directory and will be loaded at startup.

NoDataSource errors can result if any rules in the rulebase use data sources that are unavailable on the agent where the rulebase is loaded. You cannot edit those rules.

On UNIX, if the TIBCO Hawk software is not installed in the default location (/usr/tibco/hawk), you must update all rules using the logfile:onNewLine data source in the sample rulebases. For example, HawkAgent-Unix (in the directory $HAWK_INSTALLATION/samples) must be updated to reflect the correct path to $HAWK_ROOT/log.

Page 169: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Using the TIBCO Hawk Sample Applications | 149

Using the TIBCO Hawk Sample Applications

The TIBCO Hawk software distribution includes source code for sample applications that demonstrate the use of the TIBCO Hawk Application Management Interface (AMI). AMI is used to instrument applications so that TIBCO Hawk agents can directly monitor them. AMI is a specification of TIBCO Rendezvous messages that define the interactions that take place between a TIBCO Hawk agent and an AMI application. Please refer to the TIBCO Hawk Programmer's Guide for a complete description of AMI.

Using AMI Protocol Versus the AMI APIs

There are two ways to write an AMI application. You can use the TIBCO Rendezvous APIs to directly implement the AMI protocol or you can use the TIBCO Hawk AMI APIs which implement the AMI protocol for you.

Use of the TIBCO Hawk AMI APIs is recommended because they handle all the TIBCO Rendezvous and AMI details for you, making programming AMI simpler and more foolproof. Use of the APIs also ensures that your applications will be compatible with future releases of TIBCO Hawk and AMI.

Configuring TIBCO Rendezvous Session Parameters

All the sample applications require TIBCO Rendezvous session parameters in order for those applications to establish a TIBCO Rendezvous session with the local TIBCO Hawk agent. These session parameters must match the primary session parameters configured for the TIBCO Hawk agent or one of the AMI sessions configured for the TIBCO Hawk agent.

The TIBCO Rendezvous session parameters are hard-wired into the code of these sample applications. To change the session parameters you must edit the files and change the values of the TIBCO Rendezvous session constant.

For information on configuring primary and AMI session parameters for a TIBCO Hawk agent on the Windows platform, refer to Using TIBCO Hawk Across Nets or Subnets, page 135. For UNIX, refer to Chapter 6, Configuring TIBCO Hawk Software.

Sample AMI Application Names

These samples, like all AMI applications, have both a display name and an internal name. The internal name is the name by which the TIBCO Hawk system uniquely identifies this AMI application and distinguishes it from other AMI applications. The display name is a user-friendly name that is used in the TIBCO Hawk Display.

Page 170: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

150 | Chapter 10 TIBCO Hawk Sample Rulebases and Applications

• To see the list of AMI application internal names for a particular TIBCO Hawk agent, invoke its Self:getMicroAgentInfo method.

• To view the display name, right-click on the desired agent in TIBCO Hawk Display, and select GetMicroAgents from the menu. The MicroAgents, Methods, and Arguments dialog appears. When the sample applications are successfully executed you should see their names appear on the associated TIBCO Hawk agent.

TIBCO Rendezvous License Tickets and AMI

TIBCO Rendezvous software is licensed using license tickets, which are character strings that encode licensing information. License tickets are stored in files such as tibrv.tkt (for the TIBCO Rendezvous daemon and routing daemon). TIBCO Hawk employs an embedded TIBCO Rendezvous license that allows the TIBCO Hawk software to use the TIBCO Rendezvous solely in support of the TIBCO Hawk product. A TIBCO Rendezvous license ticket is not required to run the TIBCO Hawk product with the TIBCO Rendezvous daemon (rvd). The use of TIBCO Hawk with the TIBCO Rendezvous routing daemon (rvrd), however, still requires a valid TIBCO Rendezvous license ticket.

The AMI APIs allow applications to be AMI instrumented so that they use the same embedded TIBCO Rendezvous license as the TIBCO Hawk product. This license only allows the AMI instrumented application to use TIBCO Rendezvous in support of the AMI communication with the TIBCO Hawk agent. Any other use of TIBCO Rendezvous by the AMI application would require a valid TIBCO Rendezvous license ticket.

Page 171: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

The Sample AMI API Applications | 151

The Sample AMI API Applications

The TIBCO Hawk AMI API sample applications can be found in the directory: $HAWK_INSTALLATION/samples/ami_api directory

This directory contains three sub-directories c, cpp, and java that contain sample applications for the C, C++, and Java TIBCO Hawk AMI APIs, respectively. These applications are discussed in the following sections.

TIBCO Hawk AMI C API Sample ApplicationsThe TIBCO Hawk AMI C API sample directory contains four sample applications. They have the following filenames and AMI application names, with the numbers 1-4 substituted for the x:

TIBCO Hawk AMI C API sample x:

— Filename: ami_samplex.c

— Display name: ami_samplex

— Internal name: COM.TIBCO.hawk.ami_api.c.ami_samplex

The four sample applications can be built by following the instructions in the Makefile.sample file, which is also located in the sample directory.

• ami_sample1.c

This sample shows how to AMI instrument a non-Rendezvous application. The AMI API does all the Rendezvous work under the covers.

This method limits the number of dispatching threads to one thread. This is the only thread which will call the user applications AMI API callback functions. As a result, the users application can be single threaded. If the users application is to be multi-threaded then the code in this sample would run on a dedicated thread. The users application would be responsible for thread safety regarding any of its own data structures.

• ami_sample2.c

This sample shows how to AMI instrument a Rendezvous application. The users application creates a Rendezvous transport and queue and is responsible for dispatching that queue.

The users application is free to be single or multiple threaded. The users application is responsible for synchronizing access to user application data in the multi-threaded case.

• ami_sample3.c

Page 172: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

152 | Chapter 10 TIBCO Hawk Sample Rulebases and Applications

This sample is identical to ami_sample1.c except that it demonstrates how to create methods that return tabular data.

• ami_sample4.c

This sample shows how to create an asynchronous AMI method for a synchronous data source. This technique is used when synchronous data needs to be polled at a certain rate, possibly calculations performed on the data across samples, and the results returned at that rate or another rate. This technique makes use of the auto-invoke feature of the AMI C API.

Executing Sample Programs

• To execute, for example, ami_samplex program, use the following command line:ami_samplex

Using Sample Applications on IBM i5/OS

The names of the TIBCO Hawk AMI C API sample programs have been truncated to fit the IBM i5/OS name limit. On IBM i5/OS, the sample programs have the following names, with the numbers 1-4 substituted for the x:ami_samplx.c

A sample CL program is provided to compile the sample programs. This sample CL program is included with the HAWKAMI library in QCSRC. The sample CL program assumes the source for the sample programs is present in TIBHAWK/QCSRC.

To compile the sample programs, execute the following command:CALL TIBHAWK/AMICMP AMI_SAMPL1

You can execute the TIBCO HAWK AMI C sample programs as a job or from qsh.

To submit a job, execute the following command:SBMJOB CMD(CALL PGM(TIBHAWK/AMI_SAMPL1)) JOBQ(QUSRNOMAX) MSGQ(*USRPRF) ALWMLTTHD(*YES)

TIBCO Hawk AMI C++ API Sample ApplicationThe TIBCO Hawk AMI C++ API sample directory contains one sample application, which has the following filename and AMI application names:

• AmiSample1.cpp

Filename: AmiSample1.cpp

Page 173: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

The Sample AMI API Applications | 153

Display name: AmiSample1

Internal name: COM.TIBCO.hawk.ami_api.cpp.AmiSample1

This sample creates an AMI session to support methods that demonstrate how to:

— pass data to an instrumented application,

— receive data from an instrumented application,

— return tabular data,

— return data asynchronously, and

— shutdown an application.

The sample application can be built by following the instructions in the Makefile.sample file, also located in the sample directory.

Executing the Sample Program

• To execute AmiSample1 program, use the following command line:AmiSample1

TIBCO Hawk AMI Java API Sample ApplicationThe TIBCO Hawk AMI Java API sample directory contains the following files:

• AmiSample.Java:a sample application designed to illustrate how to instrument a Java application using the TIBCO Hawk AMI API for Java.

• Spot.java: a simple GUI application using TIBCO Hawk AMI API for Java.

• SpotAmi.java: AMI Java API instrumentation for the Spot application.

This sample demonstrates how an existing application, Spot.java, can be instrumented with the AMI Java API.

The AMI sample spot.java has the following AMI application names:

• Display name: Spot

• Internal name: COM.TIBCO.hawk.ami_api.java.Spot

Executing the Sample Program

In order to compile and execute this sample, the following must be in your Java CLASSPATH:

• ami.jar and util.jar from the TIBCO Hawk java directory

Page 174: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

154 | Chapter 10 TIBCO Hawk Sample Rulebases and Applications

• tibrvj.jar from the TIBCO Rendezvous java directory

The Spot application is executed with the following command:

java Spot -rvd_session <service> <network> <daemon>

Using the Sample ProgramsEach sample program represents a separate application. Compile and link them using your C/C++ development environment.

Do not use any class libraries (such as MFC) in your build; make the application a console application only.

To Compile the Program Samples

See the TIBCO Hawk AMI C Reference and TIBCO Hawk AMI C++ Reference books for information about compiling the program samples.

It is recommended that you use Java 1.6 or higher.

Page 175: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 155

Chapter 11 Security

This chapter discusses the two security models supplied with the TIBCO Hawk system. For details on creating a custom security model, refer to the TIBCO Hawk Programmer’s Guide.

Topics

• Overview, page 156

• Trusted Model, page 157

• To Use the Trusted Model, page 159

Page 176: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

156 | Chapter 11 Security

Overview

The TIBCO Hawk product supports a security mechanism which enables all method invocation requests made of a TIBCO Hawk agent to be verified for authenticity and integrity and then authorized (or not) based on the identity of the user making the request.

The security implementation you choose will depend on your security requirements for authorization, authentication, integrity and privacy. You can use one of the security models provided with the TIBCO Hawk product (Trusted or Certified), or develop a custom security model (as explained in the TIBCO Hawk Programmer's Guide).

The definitions of security terms used in this manual are as follows:

Authentication

Authentication is the practice of determining that an entity (e.g. person, process, etc.) is who they say they are.

Integrity

Data integrity is the ability to guarantee that the content of a message that is sent from one party to another is received just as it was sent.

Authorization

Authorization is the practice of granting and denying privileges to users of a service or resource. The ability to authorize a request requires two pieces of information: the identity of the user and the nature of the request. The system can then determine if the user has sufficient privileges for the request.

Privacy

Privacy is the ability to guarantee that the content of a message that is sent from one party to another is hidden from other parties.

Page 177: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Trusted Model | 157

Trusted Model

The Trusted model provides a simple yet effective mechanism for addressing authorization concerns. It addresses security issues as follows:

• Authentication: the Trusted security model does not guarantee the authenticity of the request.

• Integrity: the Trusted security model does not guarantee the integrity of the request.

• Authorization: the Trusted security model guarantees that only authorized users can perform restricted actions. See below.

• Privacy: the Trusted security model does not address the privacy of the request. All requests are sent using plain text.

AuthorizationThe Trusted model uses an ASCII file as a simple yet effective entitlement server. This has the benefit of being easily distributed to all nodes, making it a very scalable mechanism. A scan of the ASCII file for information about the user determines if the request will be granted.

Users are explicitly granted or denied access through the access control file. A user who is not in this file is not allowed to perform any operations on the TIBCO Hawk system. Access control information is in a plain ASCII file located in the TIBCO_HOME\hawk\<version>\samples\security folder.

Copy this file to TIBCO_CONFIG_FOLDER/tibco/cfgmgmt/hawk/security manually. See Access Control File, page 160, for more details.

LoggingAll trusted requests (both Trusted and TrustedWithDomain) can be logged to rolling log files in a directory of your choice.

The current log file is named Trusted.log. When it reaches the maximum size (size), it is closed and renamed Trusted1.log, and a new Trusted.log is started. When the number of logs exceeds the maximum (n), log entries roll over to reuse the oldest log file.

To activate logging, add the following line to the access control file:

<LogService> -log_dir <logDir> -log_max_size <size> -log_max_num <n>

Page 178: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

158 | Chapter 11 Security

where:

Example Log File Entries

This is an example log entry for an authorized request:

Tue Dec 31 11:14:13 EST 2002: Trusted operation: userID=HAWK-TRUSTDMN\hawkuser, node=hawkuser-DT:none:default, microagent=COM.TIBCO.hawk.microagent.SysInfo, method= getOperatingSystem.

This is an example of an entry for an unauthorized request:

Tue Dec 31 11:19:54 EST 2002: Trusted operation: userID= HAWK-TRUSTDMN\hawkuser, node=hawkuser-DT:none:default, microagent= COM.TIBCO.hawk.microagent.Repository, method= getRBMap - permission denied.

Using both Trusted and TrustedWithDomainAn agent using the Trusted or TrustedWithDomain security model allows users with either Trusted or TrustedWithDomain to access the agent.

• To allow access to a user who starts Hawk Display (or the Console API application) in Trusted security mode, the entry for <user> specified in the agent’s Trusted.txt or TrustedWithDomain.txt should not include the domain of the user who actually starts Hawk Display (or the Console API application).

• To allow access to a user who starts Hawk Display in TrustedWithDomain security mode, the entry for <user> specified in the agent’s Trusted.txt or TrustedWithDomain.txt should include the domain of the user who actually starts Hawk Display.

Option Description

logDir The directory where the log file is saved.

Make sure this directory exists before you activate logging.

size The maximum size of the rolling log file in KB. The suffix m or M can be used for indicating MB.

n The maximum number of rolling log files.

Page 179: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

To Use the Trusted Model | 159

To Use the Trusted Model

Two sample access control files are included with TIBCO Hawk.

• Trusted.txt can be used on UNIX or Microsoft Windows. It is used when the command line specifies Trusted.

• TrustedWithDomain.txt is for use on Microsoft Windows only, and is used when the command line specifies TrustedWithDomain.

The access control files, Trusted.txt and TrustedWithDomain.txt, are described in the next section.

To use the Trusted model:

If you have multiple Hawk agents running on a machine and these Hawk agents, in turn, belong to different Hawk domains, you can specify separate access control files for each domain.

1. For each Hawk domain create a directory:

TIBCO_CONFIG_FOLDER/tibco/cfgmgmt/hawk/domain/<domain-name>/sec

urity where <domain-name> is the name of the Hawk domain.

2. Modify the appropriate sample access control file, Trusted.txt or TrustedWithDomain.txt, according to the requirements of your system.

3. Save the modified file in the directory you created, without changing the filename. The program automatically searches for the access control file in this directory.

4. Start the TIBCO Hawk agent and Display as follows:

— On UNIX, specify the following in the agent configuration file:

COM.TIBCO.hawk.security.trusted.Trusted

— On Microsoft Windows, enter one of the following in the Security Policy Class dialog of the Microsoft Windows Configuration Utility:

COM.TIBCO.hawk.security.trusted.Trusted

or

COM.TIBCO.hawk.security.trusted.TrustedWithDomain

The Trusted model is now in effect. The security policy will stay in force as long as the process is running.

Page 180: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

160 | Chapter 11 Security

Access Control FileTo store access control information, the Trusted model uses an ASCII file. Two sample access control files are included with TIBCO Hawk: Trusted.txt and TrustedWithDomain.txt.

Sample access control files are shipped with the TIBCO Hawk software, in the directory <TIBCO Hawk installation directory>/samples/security/.

Trusted.txt

This access control file can be used with UNIX or with Microsoft Windows XP.

The user for authorization is the login ID of the TIBCO Hawk Display owner.

TrustedWithDomain.txt

This file can only be used with Microsoft Windows XP, and only when specified in the command used to start TIBCO Hawk agent and Display, as in -security_policy COM.TIBCO.hawk.security.trusted.TrustedWithDomain.

The user is the login ID and the domain where the user is logged on. For example, for user1 in domainX, the user is <domainX>\user1.

Group Operations

A group operation effectively performs a method invocation simultaneously on all of the specified target microagents. It is useful for affecting a group of microagents in a single operation. There are two kinds of group operation: network query and network action. See the TIBCO Hawk Administrator’s Guide for more details.

Wildcard characters + and * affect permissions on group operations and point-to-point invocations as shown in Access Control File Settings, page 161.

• Use + in node access to allow access to group operations.

• Use * in node access to allow access to point-to-point invocations.

• Use + in method access to allow access to all INFO and ACTION methods.

• Use * in method access to allow access.

Access Control File Conventions

The access control file uses the following conventions to grant or deny access.

• Explicit access for a particular resource implicitly denies access to all other resources in the same class. The defined classes are nodes, microagents, and methods.

Page 181: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

To Use the Trusted Model | 161

• Explicit restriction for a particular resource implicitly allows access to all other resources in the same class, provided they have been explicitly granted. The defined classes are nodes, microagent, and methods.

• Permissions always default to the most restrictive case.

File Settings for the Trusted Model

This table presents how individual restrictions and permissions are defined for nodes, microagents, and methods. Individual node, microagent, and method names can be specified. In addition, wildcard characters can be used as shown in the table.

Each individual setting is represented by one line in the access control file. Complex permissions and restrictions can be defined using sets of related lines. For example, you can give a user access to all methods on a node in one line, then in the following line, restrict that user’s access to one of those methods. See Disable Custom Microagent, page 164, for further details.

Permissions are granted to a user using the user name. Restrictions are defined by prefixing a bang (!) character to the user name, as shown in the table.

Table 27 Access Control File Settings

Effect User Node Microagent Method

Full Access

Grants full access to all methods on all microagents on all nodes, including group operations.

<user>

Full Restriction

Denies access to all methods on all microagents on all nodes, including group operations

!<user>

Node Access: All Nodes

Grants point-to-point and group operation invocation access to all methods on all microagents.

<user> +

Node Access: All Nodes

Grants point-to-point invocation access to all methods on all microagents.

Does not grant group operation invocation access.

<user> *

Page 182: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

162 | Chapter 11 Security

Node Access: Named node

Grants invocation access to all methods on all microagents on the named node.

You can add several lines for one user to provide access to a set of nodes.

<user> <node>

Node Restriction: All Nodes

Denies point-to-point and group operation invocation access to all methods on all microagents.

!<user> *

Node Restriction: All Nodes

Denies group operation invocation access to all methods on all microagents. (Does not deny point-to-point operation invocations.)

!<user> +

Node Restriction: Named node

Denies invocation access to all methods on all microagents on the named node. You can add several lines for one user to provide access to a set of nodes.

!<user> <node>

Microagent Access

Grants access to all methods on the specified microagent.

Wildcard characters can be used in place of a specific node name. See Node Access above.

<user> <node> <microagent>

Microagent Restriction

Denies access to all methods on the specified microagent.

Wildcard characters can be used in the Node columns. See Node Restriction above.

!<user> <node> <microagent>

Table 27 Access Control File Settings (Cont’d)

Effect (Cont’d) User Node Microagent Method

Page 183: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

To Use the Trusted Model | 163

Method Access

Grants access to all ACTION and INFO methods on the specified microagent (but not ACTIONINFO methods).

Wildcard characters can be used in the Node and Microagent columns.

<user> <node> <microagent> +

Method Access

Grants access to all INFO methods on the specified microagent (but not ACTION or ACTIONINFO methods).

Wildcard characters can be used in the Node and Microagent columns.

<user> <node> <microagent> *

Method Access

Grants access to the specified method on the specified microagent.

Wildcard characters can be used in the Node and Microagent columns.

<user> <node> <microagent> <method>

Method Restriction

Denies access to all methods on the specified microagent.

Wildcard characters can be used in the Node and Microagent columns.

!<user> <node> <microagent> *

Method Restriction

Denies access to all ACTION and ACTION_INFO methods on the specified microagent.

Wildcard characters can be used in the Node and Microagent columns.

!<user> <node> <microagent> +

Table 27 Access Control File Settings (Cont’d)

Effect (Cont’d) User Node Microagent Method

Page 184: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

164 | Chapter 11 Security

Disable Custom MicroagentThe Custom microagent can be disabled by leveraging the Security TrustModel supported by TIBCO Hawk. Users are explicitly granted or denied access through the access control file.

The following steps describe how to disable Custom microagent execution.

1. If multiple Hawk agents are running on a machine and these Hawk agents in turn belong to different Hawk domains, specify separate access control files for each domain.

For each Hawk domain create a directory HAWK_HOME/domain/<domain-name>/security where <domain-name> is the name of the Hawk domain.

2. According to the requirements of your system copy the HAWK_HOME/samples/secuirty/Trusted.txt or HAWK_HOME/samples/secuirty/TrustedWithDomain.txt to TIBCO_CONFIG_FOLDER/tibco/cfgmgmt/hawk/security/.

3. Modify the file to add the following lines:

* * **none * COM.TIBCO.hawk.microagent.Custom +

The first line grants access to all users, on all nodes, and for all microagent methods.

The second line grants access only to the user none, on all nodes for the Custom microagent, where none is a non-existant user. This effectively prevents anyone from executing the Custom microagent.

4. Start the TIBCO Hawk agent and display as follows:

On UNIX, specify the following in the agent configuration file: COM.TIBCO.hawk.security.trusted.Trusted

Method Restriction

Denies access to the specified method on the specified microagent.

Wildcard characters can be used in the Node and Microagent columns.

!<user> <node> <microagent> <method>

Table 27 Access Control File Settings (Cont’d)

Effect (Cont’d) User Node Microagent Method

Page 185: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

To Use the Trusted Model | 165

On Microsoft Windows, enter one of the following in the Security Policy Class dialog of the Microsoft Windows Configuration Utility:

COM.TIBCO.hawk.security.trusted.Trusted or COM.TIBCO.hawk.security.trusted.TrustedWithDomain

Trusted.txt and TrustedWithDomain File ExamplesThe following example files demonstrates how a Trusted.txt and TrustedWithDomain.txt access control file might be constructed. The permissions and restrictions defined in this file are explained in the previous section.

Explanation of Settings

The settings in the example files below provide access to the following users as shown here:

• Grant user1 point-to-point access to all methods on all microagents, except:

— All ACTION methods on the Custom microagent on all nodes.

— The specified methods on the Repository microagent on all nodes.

— The specified methods on the RuleBaseEngine microagent on nodeA.

• Grant user2 point-to-point and group operation invocation access to all methods on all microagents, except:

— All ACTION methods on the Custom microagent on all nodes.

— All ACTION methods on the Repository microagent on all nodes.

— All ACTION methods on the RuleBase microagent on all nodes.

• Grant user3 point-to-point and group operation invocation access to all methods on all microagents on all nodes, except:

— group operation invocation access to all ACTION methods on the RuleBase microagent.

• Grant user4 full access to all methods on all microagents on nodeB.

• Grant user5 point-to-point access to all INFO methods on all microagents on all nodes.

Trusted.txt Example File

## This file is used by agent running with COM.TIBCO.hawk.security.trusted.Trusted

Page 186: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

166 | Chapter 11 Security

# security model.### Explanation of Settings:## Grant "user1" point-to-point access to all methods on all Microagents, EXCEPT# - all ACTION methods on the Custom microagent on all nodes.# - the specified methods on the Repository microagent on all nodes.# - the specified methods on the RuleBaseEngine microagent on "nodeA".## Grant "user2" point-to-point and network access to all methods on all # Microagents, EXCEPT# - all ACTION methods on the Custom microagent on all nodes.# - all ACTION methods on the Repository microagent on all nodes.# - all ACTION methods on the RuleBase microagent on all nodes.## Grant "user3" point-to-point and network access to all methods on all# Microagents on all nodes, EXCEPT# - network access to all ACTION methods on the RuleBase microagent.## Grant "user4" full access to all methods on all microagents on nodeB.## Grant "user5" point-to-point access to all INFO methods on all microagents# on all nodes. ### Wildcard characters + and * usage:## - Use + in node access for allowing access to group operations.# - Use * in node access for allowing access to point-to-point invocations.# - Use + in method access for allowing access to all INFO and ACTION methods.# - Use * in method access for allowing access to all INFO methods only.# ## File format:## user node microagent method# access access access# & & &# restrictions restrictions restrictions#user1 *!user1 * COM.TIBCO.hawk.microagent.Custom +!user1 * COM.TIBCO.hawk.microagent.Repository addRuleBase!user1 * COM.TIBCO.hawk.microagent.Repository updateRuleBase!user1 * COM.TIBCO.hawk.microagent.Repository deleteRuleBase!user1 * COM.TIBCO.hawk.microagent.Repository setSchedules!user1 * COM.TIBCO.hawk.microagent.Repository setRBMap!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine addRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine updateRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine deleteRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine loadRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine unloadRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine loadRuleBaseFromFile!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine setSchedules!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine setRBMap

Page 187: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

To Use the Trusted Model | 167

user2 + * +!user2 * COM.TIBCO.hawk.microagent.Custom +!user2 * COM.TIBCO.hawk.microagent.Repository +!user2 * COM.TIBCO.hawk.microagent.RuleBaseEngine +

user3!user3 + COM.TIBCO.hawk.microagent.RuleBaseEngine +

user4 nodeB

user5 * * *

## To activate logging, uncomment the following:# <LogService> -log_dir logDir -log_max_size size -log_max_num n## where: logDir is the directory where the log file will be stored# size is the maximum size of a rotating log file in KB. # A suffix m or M can be used for indicating MB .# n is the maximum number of rotating log files.

TrustedWithDomain.txt Example File

## This file is used by agent running with # COM.TIBCO.hawk.security.trusted.TrustedWithDomain security model.## To allow a user running with COM.TIBCO.hawk.security.trusted.TrustedWithDomain # security model on Windows platform to access this agent, the user # specified should include the domain of the user. # For example, for user1 in domainX, the user should be specified as # "domainX\user1". ## Note that agents using the TrustedWithDomain security model also allow# users running with COM.TIBCO.hawk.security.trusted.Trusted security model # to access this agent. For these users, the domain should not be # included in the user.### Explanation of Settings:## Grant "user1" point-to-point access to all methods on all Microagents, EXCEPT#- all ACTION methods on the Custom microagent on all nodes.# - the specified methods on the Repository microagent on all nodes.# - the specified methods on the RuleBaseEngine microagent on "nodeA".## Grant "user2" point-to-point and network access to all methods on all # Microagents, EXCEPT#- all ACTION methods on the Custom microagent on all nodes.#- all ACTION methods on the Repository microagent on all nodes.#- all ACTION methods on the RuleBase microagent on all nodes.## Grant "user3" point-to-point and network access to all methods on all

Page 188: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

168 | Chapter 11 Security

# Microagents on all nodes, EXCEPT#- network access to all ACTION methods on the RuleBase microagent.## Grant "user4" full access to all methods on all microagents on nodeB.## Grant "user5" point-to-point access to all INFO methods on all microagents# on all nodes. ### Wildcard characters + and * usage:## - Use + in node access for allowing access to group operations.# - Use * in node access for allowing access to point-to-point invocations.# - Use + in method access for allowing access to all INFO and ACTION methods.# - Use * in method access for allowing access to all INFO methods only.# ## File format:## user node microagent method# access access access# & & &# restrictions restrictions restrictions#user1 *!user1 * COM.TIBCO.hawk.microagent.Custom +!user1 * COM.TIBCO.hawk.microagent.Repository addRuleBase!user1 * COM.TIBCO.hawk.microagent.Repository updateRuleBase!user1 * COM.TIBCO.hawk.microagent.Repository deleteRuleBase!user1 * COM.TIBCO.hawk.microagent.Repository setSchedules!user1 * COM.TIBCO.hawk.microagent.Repository setRBMap!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine addRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine updateRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine deleteRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine loadRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine unloadRuleBase!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine loadRuleBaseFromFile!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine setSchedules!user1 nodeA COM.TIBCO.hawk.microagent.RuleBaseEngine setRBMap

user2 + * +!user2 * COM.TIBCO.hawk.microagent.Custom +!user2 * COM.TIBCO.hawk.microagent.Repository +!user2 * COM.TIBCO.hawk.microagent.RuleBaseEngine +

user3!user3 + COM.TIBCO.hawk.microagent.RuleBaseEngine +

user4 nodeB

user5 * * *

## To activate logging, uncomment the following:# <LogService> -log_dir logDir -log_max_size size -log_max_num n## where: logDir is the directory where the log file will be stored

Page 189: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

To Use the Trusted Model | 169

# size is the maximum size of a rotating log file in KB. # A suffix m or M can be used for indicating MB .# n is the maximum number of rotating log files.

Running with a localhost rvdAs a further precaution, AMI applications will be required to specify localhost as part of the TIBCO Rendezvous daemon parameter in order to prevent remote connections to its rvd daemon. Instructions to do this for UNIX and Microsoft Windows platforms are given below.

UNIX Procedure

1. Add a command to start the localhost rvd prior to starting any TIBCO Hawk processes, as follows:

rvd -listen tcp:127.0.0.1:<daemon>

2. Modify hawkagent.cfg and hawkhma.cfg and, in the -rvd_session parameter, specify the following:

tcp:127.0.0.1:<daemon>

Microsoft Windows Procedure

Use rvntsreg.exe to install a localhost rvd as a Microsoft Windows service. The procedure is similar to that given in Setting Up Network Communication in Microsoft Windows, page 141. See that section for a fuller description.

1. Create an rvd service using rvntsreg.exe. See Installing a Routing Daemon as a Microsoft Windows Service, page 141, for details. Use the following parameters:

-listen tcp:127.0.0.1:<daemon>

2. Make all TIBCO Hawk services dependent upon this new rvd service. See Making TIBCO Hawk Services Depend on the Routing Daemon Microsoft Windows Service, page 142, for details.

3. In the Configuration Utility, modify the daemon parameter to the following:

tcp:127.0.0.1:<daemon>

Page 190: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

170 | Chapter 11 Security

Trusted Security Sample Implementation

The sample implements the Trusted model describes in Trusted Model. This implementation is similar to the default security model provided by Hawk.

Code

The sample implementation for Trusted Security is provided in the /samples/security directory.

Compile

While compiling the security sample, your CLASSPATH must include console.jar from TIBCO Hawk lib folder.

Run

To enable the security for the Hawk Agent and Display, refer to -security_policy on page 53 for more details.

Page 191: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuring Plugins and Adapters | 171

Chapter 12 Configuring Plugins and Adapters

This chapter provides a detailed procedure to install and configure the Plugins and Adapters. Adapter and plugins are installed to their repective "adapters" and "plugins" folder. Within the folder, there is a readme.txt file that describes what configuration needs to be edited before manually copying it to the Webapps or plugin directory.

Topics

• Configuring TIBCO Hawk Java Virtual Machine MicroAgent Plug-in, page 172

• Configuring TIBCO Hawk Common Logging Publisher MicroAgent Plug-in, page 173

• Configuring TIBCO Hawk AMXHost MicroAgent Plug-in, page 174

Page 192: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

172 | Chapter 12 Configuring Plugins and Adapters

Configuring TIBCO Hawk Java Virtual Machine MicroAgent Plug-in

TIBCO Hawk Java Virtual Machine Plug-in software enables TIBCO Hawk to monitor and manage Java virtual machine processes started by the same user on the local machine.

To configure this plug-in into your TIBCO Hawk installation:

1. Copy the hawkvm.hma file from <tibco-home>/hawk/4.9/plugin/jvm to <tibco-cfgmgmt>/hawk/plugin.

2. Edit and verify hawkvm.hma in <tibco-cfgmgmt>/hawk/plugin to correct version and path of jars and Trace Log Configuration.

<!--Trace Configuration -->

<arg>--traceDir</arg>

<arg>%TIBCO_HAWK_HOME_ESC%/plugin/jvm/log</arg>

<arg>--traceFilename</arg>

<arg>jvmhma.log</arg>

<!-- Trace Level -->

<!-- ALL = -1, ALWAYS=0, INFO=1, WARNING=2, ERROR=4 DEBUG=8 -->

<!-- Default is INFO + WARNING + ERROR -->

<arg>--traceLevel</arg>

<arg>7</arg>

3. Edit <tibco-cfgmgmt>/hawk/bin/tibhawkagent.tra to add <JAVA_HOME_ESC>/lib/tools.jar in tibco.class.path.extended, if using external JRE and not already added.

4. Make sure the -hma_plugin_dir property is uncommented and have a value "<tibco-home>/hawk/4.9/plugin" in <tibco-cfgmgmt>/hawk/bin/hawkagent.cfg.

5. Make sure the "application.args -file hawkagent.cfg" uncommented in <tibco-cfgmgmt>/hawk/bin/tibhawkagent.tra.

6. Restart the Hawk Agent.

Page 193: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Configuring TIBCO Hawk Common Logging Publisher MicroAgent Plug-in | 173

Configuring TIBCO Hawk Common Logging Publisher MicroAgent

Plug-in

TIBCO Hawk Common Logging Event Publisher Plug-in software enables TIBCO Hawk to emit events from Hawk using TIBCO Common Logging in Base Event Format (BEF)/Common Base Event (CBE), default is Base Event Format.

To configure this plug-in into your TIBCO Hawk installation:

1. Copy the hawkcleventpublisher.hma file from <tibco-home>/hawk/4.9/plugin/commonlogging to <tibco-cfgmgmt>/hawk/plugin.

2. Create Event Definitions file to define the Event Publisher details:

a. Create Event Definitions file using commonlogging/eventdefs.xsd and refer the existing sample event definitions file sampleEventdefs.xml.

b. Create Common Logging configurtion file (refer/use existing sample_log4j.xml) and provide entry of file into event defintions file.

3. Edit hawkcleventpublisher.hma in <tibco-cfgmgmt>/hawk/plugin.

a. Provide correct name and path of the event definitions file.

b. Ensure the correct version number of plugins.

4. Copy the -hma_plugin_dir in hawkagent.cfg to <tibco-cfgmgmt>/hawk/plugin.

5. Restart the Hawk Agent.

Page 194: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

174 | Chapter 12 Configuring Plugins and Adapters

Configuring TIBCO Hawk AMXHost MicroAgent Plug-in

TIBCO Hawk AMXHost Plug-in software enables the TIBCO Hawk to monitor and manage TIBCO ActiveMatrix 3.0 Host Instance.

To configure this plug-in into your TIBCO Hawk installation:

1. Copy the hawkamxhpa.hma file from <tibco-home>/hawk/4.9/plugin/amx to <tibco-cfgmgmt>/hawk/plugin.

2. To provide AMX Host Management URL and other details, edit the AMXHostPluginConfig.xml in <tibco-home>/hawk/4.9/plugin/amx.

3. Edit and verify hawkamxhpa.hma in <tibco-cfgmgmt>/hawk/plugin to correct

a. Version and path of jars, and

b. Trace Configuration<arg>--traceDir</arg>

<arg>%TIBCO_HAWK_HOME_ESC%/plugin/amx/log</arg> : Make sure this directory exists.<arg>--traceFilename</arg>

<arg>amxhosthma.log</arg>

<!-- Trace Level -->

<!-- ALL = -1, ALWAYS=0, INFO=1, WARNING=2, ERROR=4 DEBUG=8 -->

<!-- Default is INFO + WARNING + ERROR -->

<arg>--traceLevel</arg>

<arg>7</arg>

4. Ensure that the -hma_plugin_dir property is uncommented and has a value "<tibco-home>/hawk/4.9/plugin" in the <tibco-cfgmgmt>/hawk/bin/hawkagent.cfg.

5. Edit <tibco-cfgmgmt>/hawk/bin/tibhawkagent.tra to add <JAVA_HOME_ESC>/lib/tools.jar in the tibco.class.path.extended, if using external JRE and not already added.

6. Ensure that the "application.args -file hawkagent.cfg" is uncommented in tibhawkagent.tra.

7. Restart the Hawk Agent.

Page 195: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 175

Appendix A Migration

This appendix discusses issues related to migration.

Topics

• Re-Linking C and C++ Applications to Libraries, page 176

• Changing the Codepage Setting, page 176

• Using 3.x and 4.x Agents Together, page 176

• Using the Scheduler, page 176

• Converting Commands from Previous Releases, page 176

Page 196: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

176 | Appendix A Migration

Migration Issues

The following considerations apply when migrating from a previous version of TIBCO Hawk.

Re-Linking C and C++ Applications to LibrariesThe AMI C and C++ libraries were renamed to eliminate a naming conflict with OS libraries. After installing TIBCO Hawk, all AMI C or C++ applications must be re-linked against the renamed libraries.

Changing the Codepage Setting(Microsoft Windows only)

The TIBCO Hawk installation program automatically retains your previous configuration. If the previous version of TIBCO Hawk specified a codepage setting for the HMA other than 65001 (Microsoft Windows identifier for UTF-8), you will need to manually change the codepage setting to 65001 after installing this version. UTF-8 is now the default for all TIBCO Hawk components.

Using 3.x and 4.x Agents TogetherYou can include TIBCO Hawk 4.x and 3.x Agents in the same environment. However, if you load the same rulebase on each agent, TIBCO Hawk Display will show the rulebases as being different versions.

Using the SchedulerThe Scheduler in TIBCO Hawk 4.1 uses 1-minute intervals instead of 15-minute intervals, as were used in 4.0.x. TIBCO Hawk 4.0.x agents using schedules that are sent to 4.1 will be converted to minutes instead of the 15-minute interval. Likewise, TIBCO Hawk 4.1 schedules that are send to a 4.0.x agent will have the minute converted to the nearest 15-minute interval.

Converting Commands from Previous ReleasesCommands created prior to the TIBCO Hawk 4.1.0 will automatically be converted when executed using the current release.

• If an agent command in a previous release has Append Agent Name checked, the variable ${Internal.Agent Name} will be appended to the command.

Page 197: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Migration Issues | 177

• If an agent command in a previous release has Append Agent IP Address checked, the variable ${Internal. Agent IP Address} will be appended to the command.

Page 198: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

178 | Appendix A Migration

Page 199: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 179

Appendix B Troubleshooting

This appendix presents some common problems and error conditions encountered during TIBCO Hawk installation and describes how to resolve them.

Topics

• UNIX Errors, page 180

• Microsoft Windows Errors, page 182

• General Errors, page 184

Page 200: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

180 | Appendix B Troubleshooting

UNIX Errors

This section lists possible installation errors on UNIX along with solutions.

DISPLAY Variable Error

(Only when installing in a GUI environment)

The installer on UNIX must open an additional window, generally for graphics. It uses the DISPLAY environment variable to tell it on which computer to open the window. If the environment variable is not set, the installer will either wait or abort after displaying the following message:

InstallShield WizardInitializing InstallShield Wizard...Preparing Java(tm) Virtual Machine.................................................................................

The DISPLAY variable must be set to the IP address or name of the computer (on which the installer graphics window are to be displayed), followed by a screen address, which can be :0.0. For example:

# Bourne shellDISPLAY=<ip_address>:0.0; export DISPLAY

# Korn shellexport DISPLAY=<ip_address>:0.0

# C-shellsetenv DISPLAY <ip_address>:0.0

For example, consider a scenario where you install TIBCO Hawk on a remote HP-UX machine (named itaska). Because you have a Solaris machine (named alaska) with a video card and monitor, you can run an X-window application on it. So you decide to telnet to itaska from alaska.

When you telnet to itaska, you will not get access to itaska's monitor and will be unable to display an X-window application. That is why you must set the DISPLAY variable, which instructs the X-server to redirect all windows to the computer set in the variable. Before doing so, the computer (specified in the DISPLAY variable) must give permissions to share its monitor.

alaska> xhost + # give permission for all to its share monitoralaska> telnet itaskaWelcome to HPUX itaska 11.00User:Password:itaska> export DISPLAY=alaska:0.0 # set display on alaskaitaska> TIB_hawk-simple_4.6.0_s4_56.bin

Page 201: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

UNIX Errors | 181

PID Error (HP-UX 11.00 64 bit Platform Only)

Installation on a HP-UX 11.00 64 bit system may crash with the following error message:

Pid nnn killed due to trashed stack.Pid nnn was killed due to failure in writing the signal context.

If this error occurs, install HP-UX kernel patch PHKL_27282 and then install TIBCO Hawk.

Assertion Failed Error (HP-UX Only)

When installing as root user on HP-UX, you may get the following error:

Assertion failed: so->so_hard_contents, file softobj.c, line 363

If this happens, reinstall TIBCO Hawk as non-root user.

The following error can occur only on HP-UX 11.00 64 bit systems. It does not happen on an HP-UX 11.00 32 bit system or an HP-UX 11.11 (or 11.i) system.

Page 202: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

182 | Appendix B Troubleshooting

Microsoft Windows Errors

This section lists possible installation errors on Microsoft Windows along with solutions.

Packet Fragmentation Errors with MulticastYou may encounter packet fragmentation errors when using multicast on Microsoft Windows XP. This is due to a known issue in Microsoft Windows.

You may need to apply a Microsoft hot fix. Information about obtaining the fix is in Microsoft Knowledge Base Article Q319627.

String Variable ErrorIn Microsoft Windows, a command line has a limit of 1024 characters. The startup command for TIBCO Hawk (which includes the installation path and a large number of required jar files) may be longer than 1024 characters if TIBCO Hawk was installed into a directory with a long installation pathname.

If the startup command is too long, the following error message appears when you try to start TIBCO Hawk:

String variable is not large enough for string.Check the string declarations.Error 401

In this case, you must reinstall Hawk with a shorter installation path.

Incompatible LibrariesIf the versions of libeay32.dll and ssleay32.dll in the directory C:\Windows\system32 are not compatible with TIBCO Rendezvous, then TIBCO applications may fail when trying to use TIBCO Rendezvous. When running or installing TIBCO applications, the following message appears.

Ordinal xxxx could not be found in the dynamic link library

LIBEAY32.dll.

or

Ordinal xxxx could not be found in the dynamic link library

SSLEAY32.dll.

Page 203: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Microsoft Windows Errors | 183

Rename, remove, or replace the files libeay32.dll and ssleay32.dll in the C:\Windows\system32 directory with the files in TIBCO_RV_HOME\bin. Be sure to rename, remove, or replace both files or the problem will persist.

Page 204: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

184 | Appendix B Troubleshooting

General Errors

This section lists installation errors that can occur on both UNIX and Microsoft Windows.

Errors Using the Password Script

On UNIX platforms, if TIBCO Runtime Agent is the first installed TIBCO product and you use the <HAWK_HOME>/bin/tibhawkpassword script, you see the following error :Exception in thread "main" java.lang.NoClassDefFoundError: com/tibco/security/AXSecurityException

This error is because the script is unable to locate the TIBCO EMS libraries. Install the TIBCO EMS Java client and set the EMS_ROOT environment variable (either from the command-line or in your login shell) with the location of TIBCO EMS directory before using the script.

Directory Path Too Long

The command line for starting the Java processes specifies the Hawk directory path you provide during installation, along with the names of a number of jar files. The installer checks the length of the directory path as you enter it during installation. If the Hawk directory path plus the jar files result in a Java process command line longer than 1024 characters (the Microsoft Windows limit), the installer displays the following error message after you enter the directory path:

String variable is not large enough for string.Check the string declarations.Error 401

Specify a shorter installation path. Also make sure the jar files specified in the command line are all required files.

Cannot Initialize Display

TIBCO Hawk Display stops after the Initializing subscriptions screen and displays the message Unable to Initialize TIBCO Hawk Display.

This is usually caused by missing files in the CLASSPATH. Check your CLASSPATH environment variable and make sure it includes the file:

<TIBCO Rendezvous installation directory>/lib/tibrvj.jar

Specify only tibrvj.jar in your CLASSPATH.

Page 205: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

General Errors | 185

TIBCO Hawk Service Failed to Install (Error 1057)

Either form of the following error message can be generated by the Microsoft Windows Service Manager:

Hawk agent service failed to install. Error code is 1057Event Service Failed to Install. Status is 1057

This means that the user account specified for starting the TIBCO Hawk services does not have sufficient privileges to start the services.

Because this error occurs during installation, you will not be able to change the account used to start the services (the services will not appear in the list of services in your Services control panel).

To resolve the situation, uninstall the TIBCO Hawk software, then install the software again giving a valid account. To uninstall the software, select Start>Programs>TIBCO Hawk Software>UnInstall.

No Administrator Privilege

During TIBCO Hawk installation on Microsoft Windows, if you encounter the following message:

Severe - You must have administrator privilege to install Hawk

Services.

You need to log back into the machine as a user with local administrator privileges to correctly install TIBCO Hawk software.

Installation Problems (Error 1073)

If you encounter any of the following messages, you need to re-install TIBCO Hawk:• HMA Service failed to install. Error code is 1073

• Hawk Agent Service failed to install. Error code is 1073

• Event Service failed to install. Status is 1073

Service Not Started (Error 1069)

The system displays the following message:

Could not start the TIBCO Hawk service ... Error 1069: The service did not start due to a logon failure."

This error indicates one of the following situations:

• An invalid account was specified.

• The account on which the TIBCO Hawk services are being run does not have administrative privileges.

Page 206: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

186 | Appendix B Troubleshooting

• The account on which the TIBCO Hawk services are being run does not have "Log on as a service" privileges. Make sure the account has the correct privileges.

• The wrong password was given for the account on which the TIBCO Hawk services are being run.

See Installing on Microsoft Windows, page 9, for more information on these settings.

TIBCO Hawk Services Fail to Start After Installation

After you have completed TIBCO Hawk installation on Microsoft Windows, if none of the TIBCO Hawk services will start, use the Event Viewer to check for error messages related to the TIBCO Hawk services in the Application Log.

If any messages contain the text "... could not be spawned", make sure that TIBCO Rendezvous is correctly installed, and that you rebooted the machine after both the TIBCO Rendezvous and TIBCO Hawk installations. (After each new installation or re-installation of TIBCO Rendezvous or TIBCO Hawk software on Microsoft Windows, you must reboot the machine before using the software.)

Internal Error 2140

The system displays the following message:

Error 2140: An internal Windows error occurred.

This message probably means the services cannot find crucial TIBCO Rendezvous files. Usually this is because one of two environment variables, CLASSPATH or PATH, is set incorrectly.

To view and change environment variables:

1. Choose Start>Settings>Control Panel, double-click the System icon, and click the Environment tab.

2. In System Variables, check that your CLASSPATH variable includes the file <TIBCO Rendezvous installation directory>\lib\tibrvj.jar.

3. In System Variables, check that your PATH environment variable includes the directory <TIBCO Rendezvous installation directory>\bin.

To change an environment variable:

1. Select the variable in the System Variables list.

2. Change the text in the edit box labeled Value.

3. Click Set.

If, after checking these variables, you still get the error, try removing all other files

Page 207: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

General Errors | 187

from your CLASSPATH, so that it includes only the tibrvj.jar file (writing down the names of the removed files is recommended, to make sure none are omitted on re-installation). Reboot and try the services again. If this corrects the error, re-add other files to the CLASSPATH one at a time, after the TIBCO Rendezvous file.

You can also determine your CLASSPATH and PATH settings by opening a DOS command-line window and typing echo %CLASSPATH% or echo %PATH%.

Because TIBCO Hawk is a Microsoft Windows service, all changes made to the environment and registry require that the Microsoft Windows machine be rebooted for the changes to propagate to the Microsoft Windows Service.

If you have checked all of these possibilities, and you still get Error 2140, verify that the Microsoft Windows Service Pack 4 was reinstalled after any recent major changes were made, before contacting TIBCO Hawk technical support.

Initial Never Received

When using TIBCO EMS as the primary transport, you see the following error message when starting TIBCO Hawk Display

Initial Never Received

Make sure tibrvjms.jar is placed before tibrvj.jar in your CLASSPATH.

Failed to connect to EMS server. Exception: <error message>

When using TIBCO EMS as the primary transport, if the EMS server has authentication enabled and you are using multiple URLs to specify the EMS transport parameters and you may get the error:

Failed to connect to EMS server. Exception <error message>.

Make sure the username and password specified in the EMS transport parameters are valid even though the error does not mention failed user authentication to be the cause of the error message.

Page 208: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

188 | Appendix B Troubleshooting

Page 209: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 189

Appendix C TIBCO Hawk Directories and Files

This appendix lists the files installed with TIBCO Hawk on Microsoft Windows and UNIX platforms.

Topics

• TIBCO Hawk Directory Structure, page 190

Page 210: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

190 | Appendix C TIBCO Hawk Directories and Files

TIBCO Hawk Directory Structure

This section explains the directory structure and general placement of files in TIBCO_HOME, HAWK_HOME and CONFIG_FOLDER.

Table 28 explains the directory structure and general placement of files in the TIBCO_HOME of TIBCO Hawk software installation subdirectories. The data directory is created only if the TIBCO Hawk event service is installed, and files are placed in it only when the event service is started.

Table 28 TIBCO_HOME Files and Directories

Directory Description Contents

TIBCO_HOME = <TIBCO Hawk Installation Directory>

The directory in which TIBCO Hawk software is installed.

TIBCO_HOME\components\shared\1.0.0

Contains all the features and eclipse plug-ins required by Hawk components like AMXHPAMicroAgent, JVMMicroagent and CLEventPublisherMicroAgent. It also contains plug-ins shared by components such as common logging, JMS, TIBCO Rendezvous, and so on.

\features

\plugins

\uninstaller_archives

TIBCO_HOME\components\shared\1.0.0\features

Contains all the features required for Hawk components.

TIBCO_HOME\components\shared\1.0.0\plugins

Contains all the Eclipse plugins required for Hawk features.

TIBCO_HOME\hawk\<version> = TIBCO_Hawk_HOME

Stores all the files and folders for TIBCO Hawk.

tib_hawk_<version>_readme.txt

tib_hawk_release_notes.pdf

TIBCO_HOME\tibcojre Contains files used by JRE.

TIBCO_HOME\tibrv Contains files used by TIBCO Rendezvous.

Page 211: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Directory Structure | 191

Table 29 explains the directory structure and general placement of files in the HAWK_HOME.

TIBCO_HOME\tools \lib

\machinemodel

\scripts

\universal_installer

\vcredist_x86

\wrapper

TIBCO_HOME\uninstaller_archives

TIBCO_HOME\_installInfo

\assembly_registry

rv_8.3_prodInfo.xml

hawk_4.9_prodInfo.xml

TIBCO_HOME\_uninstall

Table 28 TIBCO_HOME Files and Directories (Cont’d)

Directory Description Contents

Table 29 TIBCO HAWK_HOME Files and Directories

Directory Description Contents

TIBCO_Hawk_HOME\adapters\http

Contains all the files required by HTTP Adapter.

\css

\jsp

\META-INF

\TIBHawk

\WEB-INF

\xsd

\xsl

index.html

readme.txt

TIBCO_Hawk_HOME\admin-plugins

Contains the files for the Hawk plug-ins. allalertconsole.war

hawkconfig.war

monitoringconsole.war

Page 212: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

192 | Appendix C TIBCO Hawk Directories and Files

TIBCO_Hawk_HOME\ami_api

Contains all header files required for sample programs.

\bin

Note: There is no bin folder on UNIX based system after installation.

\include

\lib

Note: Files differ on Windows and UNIX based system after installation.

\src

TIBCO_Hawk_HOME\autoconfig

Used to store rulebase files that will be loaded by the TIBCO Hawk agent automatically at startup.

<platform>.hrb

schedules.hsf

TIBCO_Hawk_HOME\bin Contains TIBCO Hawk executable files and starting scripts.

Additional files for UNIX, Linux, and IBM i5/OS

ConfigureMonitoring

mar

spot

tibhawkagent

tibhawkdisplay

tibhawkhma

starthma

Additional files for Microsoft Windows

EventLogClass.dll

HawkRandomAccessFile.dll

HawkTrustedUserID.dll

msvcr80.dll

tibhawkconfig.exe

tibhawkmsg.dll

tibhawkregistry.dll

tibhawkservice.dll

TIBCO_Hawk_HOME\config

Used to store rulebase files if using manual rulebase configuration.

TibRendezvous.hrb

Table 29 TIBCO HAWK_HOME Files and Directories (Cont’d)

Directory Description Contents

Page 213: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

TIBCO Hawk Directory Structure | 193

TIBCO_Hawk_HOME\data

Contains TIBCO Hawk event service data files. Files are placed in this directory only when the event service is started.

Event.dat

Event1.dat

.

TIBCO_Hawk_HOME\doc Contains TIBCO Hawk documentation in HTMl and PDF format.

\html

\pdf

license.pdf

TIBCO_Hawk_HOME\lib Contains TIBCO Hawk Java class jar files.

TIBCO_Hawk_HOME\plugin

Contains files used by plugins of TIBCO Hawk.

\amx

\commonlogging

\ems

\jvm

TIBCO_Hawk_HOME\resource

Contains files used by TIBCO Hawk Display.

HawkGui.properties

TIBCO_Hawk_HOME\samples

Contains sample applications with AMI interfaces, sample rulebases, scripts, and other files.

ami_api

console_api

ma_plugin

msghma

rbmap_api

rulebase_api

rulebases

schedule_api

security

TIBCO_Hawk_HOME\setup

install.properties

install.properties_backup

install.properties_template

post-install.xml

TIBCO_Hawk_HOME\uninstaller_archives

Lists the archives that will be removed during uninstallation.

Table 29 TIBCO HAWK_HOME Files and Directories (Cont’d)

Directory Description Contents

Page 214: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

194 | Appendix C TIBCO Hawk Directories and Files

Table 30 explains the directory structure and general placement of files in the CONFIG_FOLDER.

TIBCO_Hawk_HOME\_uninstall

Contains executable for universal uninstaller.

universal_uninstaller.exe

Table 29 TIBCO HAWK_HOME Files and Directories (Cont’d)

Directory Description Contents

Table 30 CONFIG_FOLDER Files and Directories

Directory Description Contents

cfgmgmt\hawk Contains configuration files. autoconfig

bin

cache

config

data

log

plugin

resource

security

Page 215: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 195

Appendix D Code Page Identifiers

This appendix lists code page identifiers that can be specified to indicate the locale of the machine running the HMA.

Topics

• Code Page Identifiers, page 196

Page 216: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

196 | Appendix D Code Page Identifiers

Code Page Identifiers

Code page identifiers are specified as a value in the Codepage field. See Codepage on page 92 for details.

Table 31 Code Page Identifiers

Identifier Name

037 IBM EBCDIC - U.S./Canada

437 OEM - United States

500 IBM EBCDIC - International

708 Arabic - ASMO 708

709 Arabic - ASMO 449+, BCON V4

710 Arabic - Transparent Arabic

720 Arabic - Transparent ASMO

737 OEM - Greek (formerly 437G)

775 OEM - Baltic

850 OEM - Multilingual Latin I

852 OEM - Latin II

855 OEM - Cyrillic (primarily Russian)

857 OEM - Turkish

858 OEM - Multilingual Latin I + Euro symbol

860 OEM - Portuguese

861 OEM - Icelandic

862 OEM - Hebrew

863 OEM - Canadian-French

864 OEM - Arabic

Page 217: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Code Page Identifiers | 197

865 OEM - Nordic

866 OEM - Russian

869 OEM - Modern Greek

870 IBM EBCDIC - Multilingual/ROECE (Latin-2)

874 ANSI/OEM - Thai (same as 28605, ISO 8859-15)

875 IBM EBCDIC - Modern Greek

932 ANSI/OEM - Japanese, Shift-JIS

936 ANSI/OEM - Simplified Chinese (PRC, Singapore)

949 ANSI/OEM - Korean (Unified Hangeul Code)

950 ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)

1026 IBM EBCDIC - Turkish (Latin-5)

1047 IBM EBCDIC - Latin 1/Open System

1140 IBM EBCDIC - U.S./Canada (037 + Euro symbol)

1141 IBM EBCDIC - Germany (20273 + Euro symbol)

1142 IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)

1143 IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)

1144 IBM EBCDIC - Italy (20280 + Euro symbol)

1145 IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)

1146 IBM EBCDIC - United Kingdom (20285 + Euro symbol)

1147 IBM EBCDIC - France (20297 + Euro symbol)

1148 IBM EBCDIC - International (500 + Euro symbol)

1149 IBM EBCDIC - Icelandic (20871 + Euro symbol)

1200 Unicode UCS-2 Little-Endian (BMP of ISO 10646)

Table 31 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)

Page 218: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

198 | Appendix D Code Page Identifiers

1201 Unicode UCS-2 Big-Endian

1250 ANSI - Central European

1251 ANSI - Cyrillic

1252 ANSI - Latin I

1253 ANSI - Greek

1254 ANSI - Turkish

1255 ANSI - Hebrew

1256 ANSI - Arabic

1257 ANSI - Baltic

1258 ANSI/OEM - Vietnamese

1361 Korean (Johab)

10000 MAC - Roman

10001 MAC - Japanese

10002 MAC - Traditional Chinese (Big5)

10003 MAC - Korean

10004 MAC - Arabic

10005 MAC - Hebrew

10006 MAC - Greek I

10007 MAC - Cyrillic

10008 MAC - Simplified Chinese (GB 2312)

10010 MAC - Romania

10017 MAC - Ukraine

10021 MAC - Thai

Table 31 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)

Page 219: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Code Page Identifiers | 199

10029 MAC - Latin II

10079 MAC - Icelandic

10081 MAC - Turkish

10082 MAC - Croatia

12000 Unicode UCS-4 Little-Endian

12001 Unicode UCS-4 Big-Endian

20000 CNS - Taiwan

20001 TCA - Taiwan

20002 Eten - Taiwan

20003 IBM5550 - Taiwan

20004 TeleText - Taiwan

20005 Wang - Taiwan

20105 IA5 IRV International Alphabet No. 5 (7-bit)

20106 IA5 German (7-bit)

20107 IA5 Swedish (7-bit)

20108 IA5 Norwegian (7-bit)

20127 US-ASCII (7-bit)

20261 T.61

20269 ISO 6937 Non-Spacing Accent

20273 IBM EBCDIC - Germany

20277 IBM EBCDIC - Denmark/Norway

20278 IBM EBCDIC - Finland/Sweden

20280 IBM EBCDIC - Italy

Table 31 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)

Page 220: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

200 | Appendix D Code Page Identifiers

20284 IBM EBCDIC - Latin America/Spain

20285 IBM EBCDIC - United Kingdom

20290 IBM EBCDIC - Japanese Katakana Extended

20297 IBM EBCDIC - France

20420 IBM EBCDIC - Arabic

20423 IBM EBCDIC - Greek

20424 IBM EBCDIC - Hebrew

20833 IBM EBCDIC - Korean Extended

20838 IBM EBCDIC - Thai

20866 Russian - KOI8-R

20871 IBM EBCDIC - Icelandic

20880 IBM EBCDIC - Cyrillic (Russian)

20905 IBM EBCDIC - Turkish

20924 IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)

20932 JIS X 0208-1990 & 0121-1990

20936 Simplified Chinese (GB2312)

21025 IBM EBCDIC - Cyrillic (Serbian, Bulgarian)

21027 Extended Alpha Lowercase

21866 Ukrainian (KOI8-U)

28591 ISO 8859-1 Latin I

28592 ISO 8859-2 Central Europe

28593 ISO 8859-3 Latin 3

28594 ISO 8859-4 Baltic

Table 31 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)

Page 221: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Code Page Identifiers | 201

28595 ISO 8859-5 Cyrillic

28596 ISO 8859-6 Arabic

28597 ISO 8859-7 Greek

28598 ISO 8859-8 Hebrew

28599 ISO 8859-9 Latin 5

28605 ISO 8859-15 Latin 9

29001 Europa 3

38598 ISO 8859-8 Hebrew

50220 ISO 2022 Japanese with no halfwidth Katakana

50221 ISO 2022 Japanese with halfwidth Katakana

50222 ISO 2022 Japanese JIS X 0201-1989

50225 ISO 2022 Korean

50227 ISO 2022 Simplified Chinese

50229 ISO 2022 Traditional Chinese

50930 Japanese (Katakana) Extended

50931 US/Canada and Japanese

50933 Korean Extended and Korean

50935 Simplified Chinese Extended and Simplified Chinese

50936 Simplified Chinese

50937 US/Canada and Traditional Chinese

50939 Japanese (Latin) Extended and Japanese

51932 EUC - Japanese

51936 EUC - Simplified Chinese

Table 31 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)

Page 222: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

202 | Appendix D Code Page Identifiers

51949 EUC - Korean

51950 EUC - Traditional Chinese

52936 HZ-GB2312 Simplified Chinese

54936 Microsoft Windows XP: GB18030 Simplified Chinese (4 Byte)

57002 ISCII Devanagari

57003 ISCII Bengali

57004 ISCII Tamil

57005 ISCII Telugu

57006 ISCII Assamese

57007 ISCII Oriya

57008 ISCII Kannada

57009 ISCII Malayalam

57010 ISCII Gujarati

57011 ISCII Punjabi

65000 Unicode UTF-7

65001 Unicode UTF-8

Table 31 Code Page Identifiers (Cont’d)

Identifier Name (Cont’d)

Page 223: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

| 203

Index

A

Adding AMI sessions 96, 99agent heartbeat interval

Setting 140, 144, 144, 144agent name 140, 144, 144, 144-ami_rva_session 96, 99-ami_rvd_session 96, 99automatically, Starting the routing daemon

service 141

C

changes from the previous release xiv-cluster 140, 144, 144, 144Communicating with EMS server using SSL 46, 48, 56,

59, 75, 98, 100Configuration File

hawkagent.cfg 52, 52hawkdisplay.cfg 45hawkevent.cfg 73hawkhma.cfg 70

configuration on Unix, Setting up the routing daemon 144

configuration, Planning TIBCO Hawk 88Csh users 32customer support xvii, xix

D

daemon configuration for TIBCO Hawk messaging, Example TIBCO Rendezvous routing 137

daemon configuration on Unix, Setting up the routing 144

daemon service automatically, Starting the

routing 141daemon service, Making TIBCO Hawk services

depend on the routing 142default container for the TIBCO Hawk Display 140,

144, 144, 144default TIBCO Hawk agent name (-host), Overriding

the 140, 144, 144, 144depend on the routing daemon service, Making

TIBCO Hawk services 142Designating a security policy 140, 144, 144, 144dial-up network connection, Using the TIBCO Hawk

Display over a 140, 144, 144, 144Disk Space and Memory 10, 23, 36

E

Example TIBCO Rendezvous routing daemon config-uration for TIBCO Hawk messaging 137

H

heartbeat intervalSetting 140, 144, 144, 144

-host 140, 144, 144, 144

I

Install and Generate a Response File 29Install and Generate a Template File 29Install in Silent Mode 15, 28Install Using a Response File 29Install Using Console 14, 28Install Using GUI 14, 28

Page 224: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

204 | Index

Installation Directories 4Installation Directory 11Installation Media 13, 26Installation Options 14, 27-interval 140, 144, 144, 144

L

license tickets 150

M

Messaging microagentconfiguration 121overview 120

N

network connection, Using the TIBCO Hawk Display over a dial-up 140, 144, 144, 144

O

over a dial-up network connection, Using the TIBCO Hawk Display 140, 144, 144, 144

Overriding the default TIBCO Hawk agent name 140, 144, 144, 144

P

Planning TIBCO Hawk configuration 88

R

RAM 11, 24routing daemon configuration for TIBCO Hawk mes-

saging, Example TIBCO Rendezvous 137routing daemon configuration on Unix, Setting up

the 144routing daemon service automatically, Starting

the 141routing daemon service, Making TIBCO Hawk ser-

vices depend on the 142-rva_session 96, 99-rvd_session 96, 99

S

security policy, designating 140, 144, 144, 144security_policy 140, 144, 144, 144service, Making TIBCO Hawk services depend on the

routing daemon 142services depend on the routing daemon service, Mak-

ing TIBCO Hawk 142Setting the TIBCO Hawk agent heartbeat interval 140,

144, 144setting the TIBCO Hawk agent heartbeat interval 144Setting up a TIBCO Rendezvous session 96, 99Setting up the routing daemon configuration on

Unix 144Software 11, 24, 36Starting the routing daemon service automatically 141support, contacting xvii, xix

T

technical support xvii, xixTemp Directory 11TIBCO Hawk agent heartbeat interval (-interval),

Setting 140, 144, 144, 144TIBCO Hawk agent name (-host), Overriding the

default 140, 144, 144, 144TIBCO Hawk configuration, Planning 88

Page 225: Tib Hawk Installation Configuration

TIBCO Hawk Installation and Configuration

Index | 205

TIBCO Hawk Display over a dial-up network connec-tion, Using the 140, 144, 144, 144

TIBCO Rendezvous routing daemon configuration for TIBCO Hawk messaging, Example 137

TIBCO Software 11, 24, 36TIBCO_HOME xviiTrace level 71tracing 72

U

UNIX installation 21User Privileges 10, 22, 36Using SSL to connect to EMS server 48, 58, 76, 100

EMS server verifying TIBCO Hawk components 49, 58, 77, 101

TIBCO Hawk components verifying EMS server 48, 58, 77, 101

Using the TIBCO Hawk Display over a dial-up net-work connection 140, 144, 144, 144

Using TIBCO EMS as primary transport 46, 56, 75, 97