TIBCO Hawk™

Plug-in Guide
Software Release 4.6
August 2005
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 THE
TIBCO HAWK ADMINISTRATOR’S GUIDE). 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.
TIB, TIBCO, Information Bus, The Power of Now, TIBCO Adapter, 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, J2EE, JMS 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. Please see the readme.txt 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.
Copyright © 1996-2005 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
 | iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
TIBCO Hawk Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

Chapter 1 Hawk Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
All Alerts Console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Invoking TIBCO Hawk Microagent Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 2 Monitoring Management Plug-in. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Using the Monitoring Archive Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Monitoring Management Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Creating a Monitoring Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Updating a Monitoring Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Deploying a Monitoring Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Deleting a Monitoring Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Using the ConfigureMonitoring Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

TIBCO Hawk Plug-in Guide

iv
| Contents

TIBCO Hawk Plug-in Guide

 |v

Preface

This manual describes the TIBCO Hawk plug-ins, Hawk Console and Monitoring
Management. These plug-ins are accessed via TIBCO Administrator.

Topics

• Related Documentation, page vi

• How to Contact TIBCO Customer Support, page viii

TIBCO Hawk Plug-in Guide

vi
| Related Documentation

Related Documentation

This section lists documentation resources you may find useful.

TIBCO Hawk Documentation

The following documents form the TIBCO Hawk documentation set:
• TIBCO Hawk Release Notes Contains late-breaking news and information, as
well as descriptions of new features, migration paths, and open and closed
issues.
• 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 Guide Contains detailed descriptions of the TIBCO
Hawk plug-ins accessed via TIBCO Administrator: Hawk Console and
Monitoring Management.
• 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 Plug-in Guide

 Preface vii
|

• 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.

Other TIBCO Product Documentation

You 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 Adapter SDK™
— TIBCO Adapter SDK Concepts
— TIBCO Adapter SDK Programmer’s Guide
• TIBCO Administator™
— TIBCO Administrator Installation Guide
• TIBCO Runtime Agent ™
— TIBCO Runtime Agent Installation Guide

TIBCO Hawk Plug-in Guide

viii
| How to Contact TIBCO Customer Support

How to Contact TIBCO Customer Support

For 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:
http://support.tibco.com
Entry to this site requires a username and password. If you do not have a
username, you can request one.

TIBCO Hawk Plug-in Guide

 |1

Chapter 1 Hawk Console

This chapter describes the Hawk Console plug-in.

Topics

• Overview, page 2
• All Alerts Console, page 4
• Invoking TIBCO Hawk Microagent Methods, page 8

TIBCO Hawk Plug-in Guide

2
| Chapter 1 Hawk Console

Overview

The Hawk Console plug-in provides functionality which lets you view all TIBCO
Hawk alerts generated in your TIBCO Administrator domain and provides a
mechanism to invoke microagent methods on the machines in your domain.
The TIBCO Hawk alerts are accessed via the All Alerts console in TIBCO
Administrator. For details, see All Alerts Console on page 4.
The Hawk Console plug-in adds a tab Agent to the View Machine dialog. The
Agent tab lists the available microagents and the rulebases defined for the TIBCO
Hawk agents corresponding to the machines in the domain. See Invoke
Microagent Methods on page 9 for details.

Installation
The Hawk Console plug-in is installed by the TIBCO Hawk 4.6 installation
process and is accessed via TIBCO Administrator.

TIBCO Administrator Access for Hawk Console Functionality

Security access determines whether a user can perform an operation on a
managed object in your domain. TIBCO Administrator users that have
Administer access can access all Hawk Console functionality.
Users with read access can view alerts on the All Alerts console, only the users
that have write access can suspend alerts.

It is strongly recommended that only administrators have access to the All Alerts
console and Hawk. Console.

When accessing TIBCO Hawk methods using the Machines console, if a user has
read access to the Machines console, only those methods where the Impact type is
IMPACT_INFO are listed. If the user have read-write access to the Machines
console, all TIBCO Hawk methods for the microagent are listed. When a method
is listed, then the user can invoke or subscribe to that method.

Security between TIBCO Administrator and TIBCO Hawk

Security is enabled between TIBCO Administrator and TIBCO Hawk by
specifying a Java class that implements your security policy. This security policy
is specified by the -security_policy option in the hawkagent.cfg
configuration file. This configuration file is located in:<HAWK_HOME>\bin. For
more information on TIBCO Hawk security see TIBCO Hawk Installation and
Configuration Guide.

TIBCO Hawk Plug-in Guide

 Overview 3
|

When invoking or subscribing to TIBCO Hawk microagent methods, the security

that is enforced is based on the user that started the TIBCO Administrator server
and not the user accessing TIBCO Hawk microagent methods.

TIBCO Hawk Plug-in Guide

4
| Chapter 1 Hawk Console

All Alerts Console

You can view all TIBCO Hawk alerts generated in your domain from this console.
Here you can specify search conditions to filter the alerts that are displayed. This
console is accessed by clicking Application Management>All Alerts from the
left-hand pane of TIBCO Administrator.
See TIBCO Administrator Access for Hawk Console Functionality on page 2 for
the permissions required to access the All Alerts Console.

Alerts
This console contains the following fields:
State — Choose either Any, Active, Cleared, or Custom.
Add Search Condition — The following options are available:
• Date/Time — Specify the date and time before or after which you want to
filter the alerts.
• Level — Lowest level of the alert. Possible choices are High, Medium, Low,
Notification or Custom.

This level indicates the lowest alert level that you want to search for.
For example, if you choose medium, both medium and high alerts will be
displayed and if you choose low, all alerts will be displayed.
• Agent — Name of the agent.
• Rulebase — Name of the rulebase that generated the alert.
• Deployment — Name of the deployment.
• Component Instance — Name of the component.
When more than one selection condition can be specified, one of the following
options must also be chosen:
• Show entries where ALL conditions are true
• Show entries where ANY conditions are true
Search — Click this button to apply the chosen search conditions to the list of
generated alerts.
Purge Cleared Alerts — Used to purge alerts that have been cleared.

Alerts that are cleared will stay in the list for 30 minutes if user does not click the purge
alert button.

TIBCO Hawk Plug-in Guide

 All Alerts Console 5
|

List of Alerts
For each alert, the following information is displayed:
Date/ Time — Date and Time of the alert.
Domain — The domain where this alert originated.
Cleared — Whether this alert has been cleared. If the alert is cleared a X is
displayed in this column.
Alert Level — Level of the alert represented by the alert icons. Table 1, Alert Icons,
on page 6 list the alert icons.
Text — Text belonging to the alert.
detail — Click on this field to view details about the generated alert.

Alert Details
This dialog lists details of the chosen alert.

Details
Date/ Time — Date and Time of the alert.
Alert Level — Level of the alert represented by the alert icons. Table 1, Alert Icons,
on page 6 list the alert icons.
Text — Text belonging to the alert.

Properties
Domain — The domain where this alert originated.
Agent — The TIBCO Hawk Agent which generated this alert.
Rulebase — The TIBCO Hawk rulebase which generated this alert.
DataIndex — If the alert was generated from a rule with composite data sources,
this value is ’_’. If the alert was generated from a rule with a tabular data source,
this value is _<indexField>:<indexValue>. Where <indexField> and
indexValue> refer to values in the tabular data source.

Action — The number corresponding to its position in the action list for the test as
defined in the rulebase.
Rule — The rule which uses the specified datasource to test for certain conditions.
DataSource — The datasource for the rulebase.
Test — The test performed on the datasource.

TIBCO Hawk Plug-in Guide

6
| Chapter 1 Hawk Console

The following properties are displayed if a rulebase is configured for a service

instance through TIBCO Administrator.
Action.Deployment — The deployment name of the service instance.
Action.ComponentInstance — The name of the service instance.
Action.ComponentInstanceID — The ID of the service instance.

Suspend
Reason — The reason for suspending the alert.
Suspend Interval — The duration in seconds for which the alert should be
suspended.
Suspend — Click this button to suspend the alert.
For more information on suspending alerts, refer to TIBCO Hawk Administrator’s
Guide.

Alert Icons
Any alert generated by the TIBCO Hawk agent corresponding to the managed
object is displayed. The color of the managed object icon reflects that of the alert.
The colors are either yellow, amber, or red representing low, medium, or high
alerts respectively. Within the managed object icon, alerts are additionally
represented by a series of alert icons. The color of these icons reflects the color of
the managed object. The color of these icons reflects the color of the managed
object.

Table 1 Alert Icons

Icon Description
There are no alerts generated.

Low alert.

Medium alert.

High alert.

TIBCO Hawk Plug-in Guide

 All Alerts Console 7
|

Table 1 Alert Icons

Icon Description
Unable to communicate with the TIBCO Hawk Agent.

TIBCO Hawk Plug-in Guide

8
| Chapter 1 Hawk Console

Invoking TIBCO Hawk Microagent Methods

You can invoke microagent methods on the machines in your domain. Click
Resource Management> Machines for the list of machines in your domain and
then click the machine name.
Clicking on a machine name brings up the View Machine dialog. This dialog has
an additional tab: Agent.
See TIBCO Administrator Access for Hawk Console Functionality on page 2 for
the permissions required to access the Agent tab.

Agent Tab
This dialog lists the available microagents and the rulebases defined for the agent.

Microagents
Displays the available microagents and for each microagent the following
information is displayed:
• Name — Name of the microagent.
• Instance — Number to identify the running instance
• Description — Description of the microagent.
Click on a microagent name for the list of associated microagent methods.

Rulebases
A list of the loaded rulebases is displayed.
Rulebases — The name of the rulebase. Click on this field to sort the rulebase
names.
Click on a rulebase name to view details of the rulebase.

Hawk Microagent Methods

This dialog lists the available microagent methods. You can choose to display only
those microagent methods that match a search criteria. You can use the ’*’
character as a wildcard.

Methods
The following fields are displayed for the microagent methods:

TIBCO Hawk Plug-in Guide

 Invoking TIBCO Hawk Microagent Methods 9
|

• Name — Name of the microagent methods.

• Description — Description of the microagent method.
To invoke a microagent method click on the method name. See Invoke Microagent
Methods for details.

Invoke Microagent Methods

This dialog displays information about the microagent method and provides
fields you can specify input parameters when either invoking or subscribing to
the method.

Method
Displays general information about the microagent method:
• Name —The name of the microagent method.
• Description — Description of the microagent method.
• Type — Type of the microagent method, either Synchronous or
Asynchronous.
• Impact — The function performed by the method and can be one of the
following types:
— IMPACT_INFO returns information.
— IMPACT_ACTION performs an action on the TIBCO Hawk system.
— IMPACT_ACTION_INFO both returns information and performs an action
based on it.
• Time Out — The method invocation timeout value in milliseconds.

Invocation
Parameters — Displays the following elements for the parameters:
— Name — Name of the input argument.
— Value — Value of the input argument.
— Type — Data type of the argument.
Description — Description of the argument.
Subscribe — Available for methods of type IMPACT_INFO and
IMPACT_ACTION_INFO. You cannot subscribe to methods of type IMPACT_ACTION.
Information is returned by the method either synchronously or asynchronously.

TIBCO Hawk Plug-in Guide

10
| Chapter 1 Hawk Console

If the Subscribe checkbox is selected, the following fields are displayed along with
the default values:
— Data Interval — The time interval for collection data points. Available
when subscribing to synchronous methods.
— History — The number of data points you want to see for historical data set.
Even though a method may return data asynchronously, the result will not be
updated until the page is refreshed.

TIBCO Hawk Plug-in Guide

 | 11

Chapter 2 Monitoring Management Plug-in

This chapter describes the Monitoring Management plug-in.

Topics

• Overview, page 12
• Monitoring Management Console, page 20
• Using the ConfigureMonitoring Utility, page 27
• Using the Monitoring Archive Utility, page 14

TIBCO Hawk Plug-in Guide

12
| Chapter 2 Monitoring Management Plug-in

Overview

The Monitoring Management plug-in provides functionality to import and

configure applications to monitor other TIBCO applications in your TIBCO
Administrator domain.
The plug-in uses a Monitoring Archive (MAR) file to create a monitoring
application. A MAR file is a collection of one or more monitoring configurations.
A monitoring configuration is a TIBCO Hawk rulebase template. The MAR file is
created using the command-line Monitoring Archive utility (MAR utility). For
details, see Using the Monitoring Archive Utility on page 14.
You add a MAR file to your domain using the Monitoring Management Console
to create a monitoring application that can be deployed to any target in your
domain. Within the context of this plug-in, a target is either a machine or a
deployed application (such as TIBCO BusinessWorks or TIBCO Adapters) within
your domain.

Installation
The Monitoring Management Console is plug-in is installed by the TIBCO Hawk
4.6 installation process and is accessed via TIBCO Administrator.
If you delete the Application Domain for the plug-in using the Resource
Management> Application Domains dialog, you would need to re-start TIBCO
Administrator.
If you update the plug-in by first removing it and then adding it, log out of TIBCO
Administrator and log back in before using the plug-in.

If using a TIBCO Administrator domain with a database backend, make sure you
set the value for Maximum Connections in the Database Configuration tab of
the DomainUtility to be at least 10. Refer to the TIBCO Runtime Agent
DomainUtility User’s Guide for details.

TIBCO Administrator Access for Monitoring Management Functionality

Security access determines whether a user can perform an operation on a
managed object in your domain. Only users with read-write access can use the
Monitoring Management console and the ConfigureMonitoring command-line
utility.
If your TIBCO Administrator domain or if the Application domain used for the
Monitoring Management Console uses a file based repository, then read-write
permissions have to be assigned to the Data Access folder.

TIBCO Hawk Plug-in Guide

 Overview 13
|

The Data Access folder is accessed by selecting (through TIBCO Administrator)

User Management> Security> TIBCO Administrator> Permissions
Within this folder, assign read-write access to the Sys--<domainName> repository
file.

TIBCO Hawk Plug-in Guide

14
| Chapter 2 Monitoring Management Plug-in

Using the Monitoring Archive Utility

The monitoring archive, MAR file, contains one or more monitoring

configurations. A monitoring configuration is a TIBCO Hawk rulebase template.
The MAR utility converts TIBCO Hawk rulebases into templates so that they can
be deployed to any target within any TIBCO Administrator domain. A rulebase
template, in a MAR file, has the extension .hrt.
The rulebases can contain two types of rules:
• Application-specific
These rules use the data source of the microagents belonging to TIBCO
applications, such as TIBCO BusinessWorks or TIBCO Adapters. Each of these
applications have an unique type.
• Agent-specific or non-application specific.
These rules do not use the data source of the microagents belonging to TIBCO
applications.
If a rulebase contains multiple application-specific rules, the MAR utility splits a
single rulebase into multiple rulebases where each rulebase contains rules with
the data source from the same adapter type. The name of the templatized rulebase
will be suffixed the type of the TIBCO application. For example, if the rulebase
myRulebase.hrb contains rules using the microagents belonging to TIBCO
BusinessWorks (of type bwengine) and TIBCO Adapter for Active Database (of
type adb), then the resulting rulebases will be myRulebase-bwengine.hrt and
myRulebase-adb.hrt.

If a rulebase contains only agent-specific rules, the rulebase is not split into
separate rulesbases and neither is the rulebase name suffixed with any type. If
you want the name of such a rulebase to be assigned a specific type, use the
-Xtype option when creating the monitoring archive file.

If the rulebase contains one agent-specific rulebase and one application-specific

rulebase, the rulebase is not split but the rulebase name will contain the suffix for
the TIBCO application type.

The MAR utility will convert any six part data source to a seven part data source
in the input rulebases.
For Example, if the data source in a rulebase is:
COM.TIBCO.ADAPTER.<NAME>.<TIBCO_DEPLOYMENT>.<TIBCO_COMPONENT_INSTA
NCE>,

the MAR utility will convert this data source to the following:

TIBCO Hawk Plug-in Guide

 Using the Monitoring Archive Utility 15
|

COM.TIBCO.ADAPTER.<NAME>.<DOMAIN>.<TIBCO_DEPLOYMENT>.<TIBCO_COMPON
ENT_INSTANCE>.

If a rulebase contains a rule that has an action that invokes a method from a TIBCO
application which is different from the TIBCO application used in the data source, the
rulebase will not be templatized and an error is generated.To allow other rules in the
rulebase to be templatized, separate the rule that caused the error and run the mar tool
again.
Rulebases that use posted conditions will not work as expected if the posted condition is
posted and referred to by rules with different adapter types in the same rulebase as the
rulebase will be split into multiple rulebases.

The MAR utility, mar, is located in the <HAWK_HOME>\bin directory, where

<HAWK_HOME> is the TIBCO Hawk installation directory. The MAR utility
requires TIBCO Runtime Agent 5.3 to be installed.
Using the MAR utility you can:
• Create a MAR file
To create a MAR file, use the command
mar c[v]f <marfilename> <inputfiles> [-Xoptions]
mar c[v]df <description> <marfilename> <inputfiles>
[-Xoptions]

Examples:
— mar cvf myMarFile.mar ./

This command creates a MAR file myMarFile.mar that contains all

rulebases in the current directory.
— mar cdf "My test MAR file" myMarFile.mar ./

This command creates a MAR file myMarFile.mar that contains all

rulebases in the current directory and includes the provided description.
— mar cvf myMarFile.mar bw.hrb agent.hrb -Xtype=adb

This command creates MAR file myMarFile.mar of type adb and contains
two rulebases adb.hrb and agent.hrb.
— mar cvf myMarFile.mar ./ -Xasis

This command creates a MAR file myMarFile.mar that contains all

rulebases in the current directory but without converting into them into
rulebase templates.
• Update a MAR file
To update a MAR file, use the command

TIBCO Hawk Plug-in Guide

16
| Chapter 2 Monitoring Management Plug-in

mar u[v]f <marfilename> <inputfiles> [-Xoptions]

mar u[v]df <description> <marfilename> <inputfiles>
[-Xoptions]

Example:
— mar uf myMarFile.mar newRB.hrb

This command add the rulebase newRB.hrb to the existing MAR file,
myMarFile.mar.

• Extract MAR file

To extract a MAR file, use the command
mar x[v]f <marfilename> <inputfiles> [-Xoptions]
mar x[v]pf <propertiesfile> <marfilename> <inputfiles>
[-Xoptions]

Example:
— mar xf myMarFile.mar testRB.hrb

This command extracts the rulebase testRB.hrb from the specified MAR
file. Any other rulebase contained in the MAR file is not extracted.
— mar xpf myprop.properties myMarFile.mar testRB.hrb

This command extracts the rulebase testRB.hrb from the specified MAR
file and substitute the variables in the rulebase using the key-value pair
specified in myprop.properties file.
Any other rulebase contained in the MAR file is not extracted.
Following are the contents of a sample properties file used for variable
substitution:
TIBCO_DOMAIN=MyHawkdomain
TIBCO_DEPLOYMENT=myDeployment
TIBCO_COMPONENT_INSTANCE=myComponentInstance
• List a MAR file
To extract a MAR file, use the command
mar t[v]f <marfilename>

Example:
— mar tf myMarFile.mar

This command lists all rulebases contained in the specified file.

TIBCO Hawk Plug-in Guide

 Using the Monitoring Archive Utility 17
|

The following table describes the input parameters and options for the MAR
utility.

Table 2 MAR Utility: Input parameters and Options

Input Description and Usage
marfilename The name of the MAR file.

inputfiles
The files or directories, separated by spaces, that are
combined into or extracted from the MAR file.
All directories are processed at the top level only. Only files
with .hrb extension are processed.

description The description for the MAR file. If specify, the description
must be placed within quotes (").
If the d option is specified, you have to provide a
description. In the command, the options d and f must
appear in the same order as the description and MAR file.

propertiesfile The properties file containing the name-value pairs to be

used for substituting variables in the rulebase template
when the rulebase is extracted.
If the p option is specified, you have to specify the
properties file. In the command, the options p and f must
appear in the same order as the properties file and MAR file.

c Creates a new archive file.

u Updates an existing MAR file by adding to it the files and

directories specified by <inputfiles> parameter.
If the MAR file does not exist and the command results in
adding a file, the MAR file will be created.

x Extracts files from a MAR file. If input files is specified, only

those files are extracted; otherwise, all files are extracted.
If a properties file is specified, the values in the properties
file are used for substituting variables when the rulebases
are extracted. When a rulebase is extracted, the file
extension changes to .hrb from .hrt.

t Lists the rulebases in the MAR file.

v Generates verbose output to standard output.

TIBCO Hawk Plug-in Guide

18
| Chapter 2 Monitoring Management Plug-in

Table 2 MAR Utility: Input parameters and Options

Input Description and Usage

p Specifies the properties file that contains name-value pairs
that will be used for substituting variables in the rulebase
template.

f Specifies the name of the MAR file.

-Xtype=<type>, This option is only valid for rulebase that contain

where type is the unique agent-specific rules.
identifier assigned to For rulebases that contain application-specific rules, this
TIBCO applications. option will not apply.
For rulebases that contain agent-specific rules and an
application-specific rule, option will have no effect on this
rulebase.
This option will never override known type (where the type
is determined from the data source of the rule).
See Table 3, Types Assigned to TIBCO Applications, page 18
for the list of valid types.

-Xasis Do not templatized the rulebases.

Normally all the rulebases are templatized before adding to
the mar file. This option will add the rulebase to the MAR
file as is without parsing the rulebase for the data source
type.
This option is useful for deploying rulebases created for a
specific deployment or a component instance.

The MAR utility recognizes the datatype of any rule in a rulebase whose
datasource name is in the following format:
COM.TIBCO.ADAPTER.<NAME>.<TIBCO_DEPLOYMENT>.<TIBCO_COMPONENT_INSTA
NCE> or
COM.TIBCO.ADAPTER.<NAME>.<DOMAIN>.<TIBCO_DEPLOYMENT>.<TIBCO_COMPON
ENT_INSTANCE>.

The following table lists valid values for some TIBCO applications that you can
use when assigning a type to the MAR file.

Table 3 Types Assigned to TIBCO Applications

TIBCO Application Type
TIBCO Businessworks bwengine

TIBCO Hawk Plug-in Guide

 Using the Monitoring Archive Utility 19
|
Table 3 Types Assigned to TIBCO Applications

TIBCO Application Type

TIBCO Adapter for Active adb
Database

TIBCO Adapter for Siebel adsbl

TIBCO Adapter for Files adfiles

TIBCO Adapter for Oracle adoraapps

Applications

TIBCO Adapter for SWIFT adswift

TIBCO Adapter for EJB adejb

TIBCO Adapter for COM adcom

TIBCO Adapter for CORBA adcorba

TIBCO Adapter for Teradata adtera

TIBCO Adapter for Tuxedo adtuxedo

TIBCO Adapter for Infranet adinfra

TIBCO Adapter for PeopleSoft8 adpsft8

TIBCO Hawk Plug-in Guide

20
| Chapter 2 Monitoring Management Plug-in

Monitoring Management Console

This console lists the monitoring applications that have been added to your
domain.
To create a monitoring application you must first create a monitoring archive file
(MAR file). This archive is created using the MAR utility and contains TIBCO
Hawk rulebases that monitor your applications. See Using the Monitoring
Archive Utility, page 14 for details on using the MAR utility.
You can use the same MAR file to create multiple monitoring applications and
deploy them separately onto different machines in your domain.
See TIBCO Administrator Access for Monitoring Management Functionality on
page 12 for the permissions required to access the Monitoring Management
Console.

Creating a Monitoring Application

1. Click Application Management>Monitoring Management.
2. Click Add.
3. Click Browse and select a monitoring archive file and click OK.
The following figure shows the new application that is ready for deployment.

TIBCO Hawk Plug-in Guide

 Monitoring Management Console 21
|

Click Change MAR File if you want to select a different monitoring archive
file.
Select the Quick Configure checkbox if you want to identify the targets where
the monitoring configuration can be deployed. These targets are identified
using the type of the rulebase (monitoring configuration) contained in the
monitoring archive file. The type is determined by the data source of the
microagents belonging to TIBCO application being monitored. If the Quick
Configure checkbox is selected, the Deploy on Save field is enabled.
Note that you will be able to deploy the monitoring configurations only on
machines running TIBCO Runtime Agent 5.3.
Select the Deploy on Save checkbox to deploy the monitoring configurations
contained in the MAR file on the identified targets.

TIBCO Hawk Plug-in Guide

22
| Chapter 2 Monitoring Management Plug-in

For each monitoring configuration contained in the monitoring archive, the

following information is displayed:
— Type
This is the type of the TIBCO application for the monitoring configuration.
Each TIBCO application has a unique type associated with it.
— No. of Selected Targets
If you select Quick Configure, this field reflects the targets (within the
domain) where the monitoring configuration can be deployed.
— No. of Deployed Targets
The number of targets where this monitoring configuration is deployed.
Initially this field is always zero (0).
4. Click Save.
The chosen monitoring archive file is now added to the main Monitoring
Management dialog.

Updating a Monitoring Application

A monitoring application contains one or more monitoring configurations. If you
want to delete an existing configuration or add a new one, you must update the
monitoring application for the changes to take effect. Before you proceed to
update a monitoring application, make sure all its constituent monitoring
configurations are in the Deployable state.
To update a monitoring application:

1. Click Application Management > Monitoring Management.

2. Click the application that you want to update.
The details of the monitoring application (MAR file) are displayed.
3. Click Update.
4. Click Browse and select the updated monitoring archive file and then click
OK.
The updated monitoring archive file and its monitoring configurations are now
available for deployment.

TIBCO Hawk Plug-in Guide

 Monitoring Management Console 23
|

Deploying a Monitoring Configuration

When you create a monitoring application, you can use the Deploy on Save
option to deploy the contained monitoring configurations. Any global variables
shared between the target application and the monitoring configuration are
resolved at the time of deployment. If you do not use the Deploy on Save option,
you can explicitly deploy the monitoring configuration.
To deploy an application

1. Click Application Management > Monitoring Management.

2. Click an application name to select it for deployment.
The details of the application are displayed as shown in the following figure:

3. Choose a Monitoring Configuration by clicking on it.

If Quick Configure was selected when adding the monitoring application, the
targets for this configuration will be listed as shown in the following figure:

TIBCO Hawk Plug-in Guide

24
| Chapter 2 Monitoring Management Plug-in

If Quick Configure was not selected when adding the monitoring application,
the targets have to be manually added using the Add Target. See Adding
Targets for more information.
4. Select one or more targets and click Deploy.
If the monitoring configuration is successfully deployed, the Status changes
from Deployable to Deployed (loaded).
If the target application is not running, the status is changed to Deployed (Not
Loaded). When the target application starts, the status changes from
Deployed (Not Loaded) to Deployed (Loaded).
For a deployed monitoring configuration, if the TIBCO Hawk agent on the
target machine stops running, the status changes to Deployed (Unknown).
In order to successfully deploy a monitoring configuration, the TIBCO Hawk
Agent on the target machine must be running.
5. Click OK.

Adding Targets for a Monitoring Configuration

If the Quick Configure checkbox was not selected when adding the monitoring
application to the domain, you have to manually choose the machines (targets)
where each monitoring configuration contained within the monitoring
application can be deployed.
To add targets for a monitoring configuration:

1. Click Application Management > Monitoring Management.

2. Select the Monitoring Application that you want to deploy.

TIBCO Hawk Plug-in Guide

 Monitoring Management Console 25
|

3. Select a monitoring configuration. The following screen is displayed, where

the list of targets is empty:

4. Click Add Target.

The Add Targets dialog is displayed as shown in the following screen. The
Available Targets pane lists the potential targets (within the domain) where
the monitoring configuration can be deployed.

5. Select the checkbox for the target(s) and click Add.

The selected targets are moved to the Selected Targets pane.
To remove a target from the Selected Targets pane, select the checkbox for the
target and click Remove.
6. Click OK.
7. Choose the targets and click Deploy.
8. Click OK.

TIBCO Hawk Plug-in Guide

26
| Chapter 2 Monitoring Management Plug-in

Deleting a Monitoring Application

Before a monitoring application can be deleted, each of its constituent monitoring
configurations have to be undeployed from each target where it was deployed.
See To Undeploy a Monitoring Configuration on page 26 for details.
To delete a monitoring application:

1. Click Application Management > Monitoring Management.

2. Select the Monitoring Application that you want to delete and click Remove.
This select monitoring application is now removed from your domain.

To Undeploy a Monitoring Configuration

1. Click Application Management > Monitoring Management.
2. Select the Monitoring Application that you want to delete.
3. Select a monitoring configuration
4. Select the check box for each target listed whose status is Deployed (Loaded)
and click UnDeploy.
5. Perform step 3 and step 4 for each monitoring configuration included in the
application.
6. Click Done.

Variable Substitution
The following variables, if used, will be substituted when the monitoring
configuration is deployed:
• TIBCO_DOMAIN
• TIBCO_DEPLOYMENT
• TIBCO_COMPONENT_INSTANCE
• TIBCO_COMPONENT_TYPE
• TIBCO_DOMAIN_HOME
• TIBCO_COMPONENT_INSTANCE_TRACE_FILE

TIBCO Hawk Plug-in Guide

 Using the ConfigureMonitoring Utility 27
|

Using the ConfigureMonitoring Utility

The command-line utility, ConfigureMonitoring, provides an alternative

mechanism for deploying and undeploying monitoring configurations. This
utility is located in the <HAWK_HOME>/bin directory. The log file for this utility is
<TRA_HOME>/domain/<domain_name>/logs/Administrator.log,

where <TRA_HOME> is the TIBCO Runtime Agent installation directory, and

<domain_name> is your TIBCO Administrator domain name.
See TIBCO Administrator Access for Monitoring Management Functionality on
page 12 for the permissions required to use the ConfigureMonitoring utility.
Using the ConfigureMonitoring utility you can:
• Upload a single MAR file into TIBCO Administrator
The -upload command uploads a single MAR file into TIBCO Administrator.
If this is a new MAR file, a new monitoring application is created with the
same name as the MAR file. If it already exists and if the contained monitoring
configuration are in the Deployable state, the existing data is overwitten.It
cannot update if any of the monitoring configurations in the deployed state.
Example: ConfigureMonitoring.exe -upload -mar myMarFile.mar
-domain myHawkDomain -user admin -pw adminpw

• Retrieve all potential targets for all monitoring configurations within the
specified monitoring application.
The -getTargets command retrieves all potential targets for a given
monitoring application in the TIBCO Administrator domain. An XML file
containing the targets is created in the current directory. The name of the XML
file has the format <MAR_file_name>-targets.xml, where <MAR_file_name>
is the MAR file for which the targets are retrieved.
Example: ConfigureMonitoring.exe -getTargets -monitoringAppName
myMarFile -domain myHawkDomain -user admin -pw adminpw

This command creates the XML file myMarFile-targets.xml.

You can edit the XML file created by the -getTargets options to delete a target,
effectively choosing to not deploy the monitoring configuration on that target.

• Deploy monitoring configurations

TIBCO Hawk Plug-in Guide

28
| Chapter 2 Monitoring Management Plug-in

The -deploy command configures and deploys the monitoring configurations

on the targets specified in the target file. The status of deploying each
monitoring configuration on each identified target is displayed.
Example: ConfigureMonitoring.exe -deploy -targets
myMarFile-targets.xml -monitoringAppName myMarFile -domain
myHawkDomain -user admin -pw adminpw

• Undeploy monitoring configurations

The -undeploy command undeploys the monitoring configurations from the
targets specified in the target file. The status of undeploying each monitoring
configuration from each identified target is displayed.
Example: ConfigureMonitoring.exe -undeploy -targets myMarFile
-targets.xml -monitoringAppName myMarFile -domain myHawkDomain
-user admin -pw adminpw

• Delete monitoring applications (MAR file)

The -delete command deletes the specified monitoring application from the
TIBCO Administrator domain. To remove a monitoring application, none of
its monitoring configurations and its targets should be in the deployed state.
Example: ConfigureMonitoring.exe -delete -monitoringAppName
myMarFile -domain myHawkDomain -user admin -pw adminpw

The following table describes the input parameters for the ConfigureMonitoring
utility.

Table 4 ConfigureMonitoring Utility: Input parameters

Input Description
-domain The TIBCO Administrator domain name.

-mar The MAR file name. If the MAR file is not located in the
current directory, specify the complete path name.

-user An authenticated TIBCO Administrator user having

Read-Write permissions.

-pw The password for the TIBCO Administrator user specified

by the -user option. The password could be either plain
text or obfuscated. Passwords can be obfuscated using
password obfuscation tool, obfuscate.exe, provided in
tra/bin

TIBCO Hawk Plug-in Guide

 Using the ConfigureMonitoring Utility 29
|

Table 4 ConfigureMonitoring Utility: Input parameters

Input Description
-targets The file containing targets for a MAR file.

-monitoringAppName The monitoring application name.

-cred The credential file containing user credentials (user and pw)
specified as properties. The password can be specified either
in plain text or obfuscated form.

TIBCO Hawk Plug-in Guide

30
| Chapter 2 Monitoring Management Plug-in

TIBCO Hawk Plug-in Guide

 | 31

Index

A M
Agent tab 8 monitoring application
Alerts creating 20
icons 6 deploying 23
suspending 6 updating 22
All Alerts Monitoring Archive Utility 14
alert details 5 commands 15
viewing alerts 4 input parameters and options 17
monitoring configuration
adding targets to 24
Monitoring Management
C about 12
installation considerations 12
ConfigureMonitoring Utility 27
input parameters 28
customer support viii
Q
Quick Configure 21
D
Deploy on Save 21
S
support, contacting viii
H
Hawk Console
about 2 T
installation considerations 2
Hawk microagent methods technical support viii
invoking 9
list 8

TIBCO Hawk Plug-in Guide

32
| Index

TIBCO Hawk Plug-in Guide