Top Banner
TIBCO Administrator™ EMS Plug-in Reference Software Release 5.4 November 2006
66
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Tib Admin Ems Usr

TIBCO Administrator™

EMS Plug-in ReferenceSoftware Release 5.4November 2006

Page 2: Tib Admin Ems Usr

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH 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 THIS DOCUMENT). 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 Administrator, TIBCO BusinessWorks, TIBCO Designer, TIBCO Enterprise Message Service, TIBCO Rendezvous, TIBCO Repository, and TIBCO Runtime Agent 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.

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 © 1999-2006 TIBCO Software Inc. ALL RIGHTS RESERVED.

Page 3: Tib Admin Ems Usr

| iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viTIBCO Administrator Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viTIBCO Runtime Agent Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viTIBCO Enterprise Message Service Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

Chapter 1 EMS Plug-in Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2EMS Server Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Security Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Server Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Main Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3View and Edit Server Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Queues Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Main Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12New, View or Edit Queues Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Topics Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Main Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23New, View or Edit Topics Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Durables Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Main Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31View or Add Durable Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Connection Factories Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Main Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33New, Edit or View Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Connections Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Main Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Producers and Consumers Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Main Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Destination Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Routes Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Main Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39New, Edit or View Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

TIBCO Administrator EMS Plug-in Reference

Page 4: Tib Admin Ems Usr

iv | Contents

Bridges Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44New Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Transports Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Transactions Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Users and Groups Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Synchronizing User Information With TIBCO Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Creating Users and Setting Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Adding Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Adding a User or Group to a Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

JNDI Bindings Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

TIBCO Software Inc. End User License Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

TIBCO Administrator EMS Plug-in Reference

Page 5: Tib Admin Ems Usr

| v

Preface

This guide explains how to use the TIBCO Enterprise Message Service server plug-in in TIBCO Administrator. The guide does not introduce or explain the TIBCO Enterprise Message Service software. The software is documented in the Enterprise Message Service documentation set.

Topics

• Related Documentation, page vi

• Typographical Conventions, page viii

• How to Contact TIBCO Customer Support, page x

TIBCO Administrator EMS Plug-in Reference

Page 6: Tib Admin Ems Usr

vi | Related Documentation

Related Documentation

This section lists documentation resources you may find useful.

TIBCO Administrator DocumentationYou may find it useful to read the following TIBCO Administrator documentation. The documentation is available from the install-path/tibco/administrator/n.n/doc folder.• TIBCO Administrator Release Notes Read the release notes for a list of new and

changed features. This document also contains lists of known and closed issues for this release.

• TIBCO Administrator User’s Guide An introduction to TIBCO Administrator functionality including user, resource and application management.

• TIBCO Administrator Server Configuration Guide Information for system administrators allowing customization of the server.

• TIBCO Administrator Installation Read the relevant sections of this manual before installing this product.

TIBCO Runtime Agent DocumentationThe TIBCO Runtime Agent Domain Utility User’s Guide explains how to add, modify or remove the TIBCO Enterprise Message Service plug-in to an administration domain. The guide is available from the install-path/tibco/tra/n.n/doc folder.

TIBCO Enterprise Message Service DocumentationThe following documents form the TIBCO Enterprise Message Service documentation set. The documentation is available from the install-path/tibco/ems/doc folder.

• TIBCO Enterprise Message Service User’s Guide Read this manual to gain an overall understanding of the product, its features, and configuration.

• TIBCO Enterprise Message Service Installation Read the relevant sections of this manual before installing this product.

• TIBCO Enterprise Message Service Application Integration Guide This manual presents detailed instructions for integrating TIBCO Enterprise Message Service with third-party products.

TIBCO Administrator EMS Plug-in Reference

Page 7: Tib Admin Ems Usr

Preface | vii

• TIBCO Enterprise Message Service C API Reference The C API reference is available in HTML and PDF formats.

• TIBCO Enterprise Message Service Java API Reference The Java API reference is available as JavaDoc, and you can access the reference only through the HTML documentation interface.

• TIBCO Enterprise Message Service .NET API Reference The .NET API reference is available in PDF and HTML format.

• TIBCO Enterprise Message Service Release Notes Release notes summarize new features, changes in functionality, and closed issues. This document is available only in PDF format.

TIBCO Administrator EMS Plug-in Reference

Page 8: Tib Admin Ems Usr

viii | Typographical Conventions

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

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 the username admin.

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

• In command syntax, to indicate the default value.

italic font Italic font is used in the following ways:

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

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

TIBCO Administrator EMS Plug-in Reference

Page 9: Tib Admin Ems Usr

Preface | ix

Table 2 Syntax Typographical Conventions

Convention Use

[ ] An optional item in a command or code syntax.

For example:

MyCommand [optional_parameter] required_parameter

| A logical ’OR’ that separates multiple items of which only one may be chosen.

For example, you can select only one of the following parameters:

MyCommand para1 | param2 | param3

bold code

font In command syntax, indicates the default parameter for a command.

For example, if no parameter is specified, MyCommand is enabled:

MyCommand [enable | disable]

{ } A logical group of items in a command. Other syntax notations may appear within each logical group.

For example, the following command requires two parameters, which can be either param1 and param2 or param3 and param4:

MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4:

MyCommand {param1 | param2} {param3 | param4}

In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4.

MyCommand param1 [param2] {param3 | param4}

TIBCO Administrator EMS Plug-in Reference

Page 10: Tib Admin Ems Usr

x | 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 Services as follows.

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

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

• 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 Administrator EMS Plug-in Reference

Page 11: Tib Admin Ems Usr

| 1

Chapter 1 EMS Plug-in Reference

This chapter explains the TIBCO Enterprise Message Service server parameters that can be set using the EMS Plug-in for TIBCO Administrator.

Topics

• Overview, page 2

• Server Parameters, page 3

• Queues Parameters, page 12

• Topics Parameters, page 23

• Durables Parameters, page 31

• Connection Factories Parameters, page 33

• Connections Parameters, page 37

• Producers and Consumers Parameters, page 38

• Routes Parameters, page 39

• Bridges Parameters, page 44

• Transports Parameters, page 45

• Transactions Parameters, page 46

• Users and Groups Parameters, page 47

• JNDI Bindings Parameters, page 51

TIBCO Administrator EMS Plug-in Reference

Page 12: Tib Admin Ems Usr

2 | Chapter 1 EMS Plug-in Reference

Overview

This guide provides a reference description of the fields available in the EMS Server plug-in. See the TIBCO Enterprise Message Service documentation set for a full description of the software.

The EMS Plug-in is installed into an administration domain using the TIBCO Domain Utility. See the TIBCO Runtime Agent Domain User’s Guide for information about adding, modifying or removing the EMS Plug-in.

EMS Server Configuration FilesThere are a number of configuration files on disk that the EMS server reads when it starts up. Two examples of such a file are tibemsd.conf and topics.conf.

• A running EMS server does not monitor its configuration files after startup. For example, if you add a user manually to users.conf while the EMS server is running, the EMS server will not detect the change in the file and alter its running configuration. Moreover, it is possible that your manual change will be overwritten when the EMS server next saves its running configuration to disk.

• Updating to a new version of the EMS server will overwrite the default configuration files that are installed in the EMS bin directory. As a result, you should view those configuration files as examples or as a starting point; you should not use the files in that location for your production server instance.

Security DialogThe security dialog allows you to set access rights to an object. Each panel in the EMS Server plug-in has a security tab when rights can be set. See the TIBCO Administrator User’s Guide for information about setting security access.

When adding the EMS Plug-in to a TIBCO Administrator administration domain in a 64-bit environment, you must edit the tra file generated for the EMS Plug-in to point to the 64 bit library. See the TIBCO Runtime Agent Installation Guide for more information.

TIBCO Administrator EMS Plug-in Reference

Page 13: Tib Admin Ems Usr

Server Parameters | 3

Server Parameters

Main PaneThis pane displays the following information about the server instance:

Parameter Description

Server Name Name of this TIBCO Enterprise Message Service server.

Version TIBCO Enterprise Message Service version used.

Up Time Time this server has been running.

Start Time Time at which this server was started.

Process Id Process identifier assigned to the server by the operating system.

State Indicates the server’s current state, whether it is active or not.

Asynchronous Storage Size

Current size of the asynchronous message store.

Synchronous Storage Size

Current size of the synchronous message store.

Backup Server TIBCO Enterprise Message Service server name and hostname of fault tolerant backup server, if any.

Connections Current number of connections to the server.

Queues Current number of queues in the server.

Topics Current number of topics in the server.

Durables Current number of durable subscribers in the server

Inbound Byte Rate

Current number of bytes received per second by this server.

Inbound Message Count

Number of messages received by this server as a whole since it was started.

TIBCO Administrator EMS Plug-in Reference

Page 14: Tib Admin Ems Usr

4 | Chapter 1 EMS Plug-in Reference

View and Edit Server PanesClick View on the View Service Instance pane to access the View Server pane. To edit parameters on the View Server pane, click the Edit button. Apply changed parameter settings by clicking the Save button.

Inbound Message Rate

Current number of messages received per second by this server.

Outbound Byte Rate

Current number of bytes sent per second by this server.

Outbound Message Count

Number of messages sent by this server as a whole since it was started.

Outbound Message Rate

Current number of messages sent per second by this server.

Pending Message Count

Current number of messages in this server pending consumption by client.

Pending Message Size

Current total size of pending messages.

Log File Name Name of log file in which events are logged.

Log File Size Current size of the log file.

Log File Maximum Size

Recommended maximum log file size before log file is rotated.

Parameter Description

Parameter Description

General

Server Name Displays the server name.

Server Version Displays the server software version.

URL Displays the URL or machine and port on which the server is running.

TIBCO Administrator EMS Plug-in Reference

Page 15: Tib Admin Ems Usr

Server Parameters | 5

Maximum Message Memory

Maximum memory the server can use for messages. This parameter allows you to limit the amount of memory used by the server for messages so that the server memory usage does not grow beyond the system’s memory capacity.

Messages sent to the server are stored in memory. When the total amount of memory used by messages reaches the limit specified by this parameter, the server may swap messages to disk.

In most situations, the server should not reach the maximum message memory as long as this parameter is set to a reasonable amount of memory for your system.

Message Pool Block Size

Message Pool Block Size

To lessen the overhead costs associated with malloc and free, the server pre-allocates pools of storage for messages. These parameters determine the behavior of these pools. Performance varies depending on operating system platform and usage patterns.

The Message Pool Block Size determines the approximate number of internal message structs that a block or pool can accommodate (not the number of bytes).

It instructs the server to allocate an expandable pool. Each time the server exhausts the pool, the server increases the pool by this size, as long as additional storage is available. The value may be in the range 32K to 64K.

The Message Pool Size instructs the server to allocate a fixed pool. After the server exhausts this pool, the server calls malloc each time it requires additional storage. The value may be in the range 16K to 1024M.

When neither parameter is present, the default is Message Pool Block Size 128 (an expandable pool).

When both parameters are present, Message Pool Block Size supersedes Message Pool Block Size; the result is an expandable pool.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 16: Tib Admin Ems Usr

6 | Chapter 1 EMS Plug-in Reference

Message Swapping

When this parameter is selected and the maximum memory limit specified by the Maximum Message Memory parameter is met, messages that aren’t currently being handled can be temporarily swapped out to disk. You can disable message swapping by clearing this checkbox.

Swapping messages to disk allows the server to free memory for incoming messages and handle a greater total message size than allowed by this parameter. Each swapped message is stored on disk, but a small footprint of the message remains in memory. If the maximum memory specified by this parameter is reached and all messages are swapped out to disk (leaving no way for the server to free memory for new messages), the server does not accept new messages and message producers receive an error when attempting to send new messages.

Server Store Directory

The directory to store TIBCO Enterprise Message Service data.

Server Store Minimum Size

Preallocates file storage space for TIBCO Enterprise Message Service. If Store Truncate Enabled is selected, the storage is not truncated below the minimum size specified in these parameters.

Store CRC When selected, CRC checksum data is checked when reading, and the checksum is calculated and stored in storage when writing into it.

Store Truncate Specifies whether TIBCO Enterprise Message Service should attempt to truncate the storage files. When selected, the storage files may be truncated, but not below the size specified in the Server Store Minimum Size parameter.

Flow Control Specifies whether flow control for destinations is enabled or disabled. By default, flow control is disabled.

When flow control is selected, the flowControl property on each destination specifies the target maximum storage for pending messages on the destination.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 17: Tib Admin Ems Usr

Server Parameters | 7

FSync Indicates whether or not the fsync mode is used by the server when writing data to its store file.

On most platforms, this is not the most efficient way to write the store file.

Routing When selected, this parameter enables routing functionality for this server.

Route Recover Interval

The amount of time allocated for route recovery.

TIBCO RV Transports

When selected indicates that the TIBCO Rendezvous transports defined in transports.conf are enabled. By default, all transports are disabled and will not send or receive messages to or from external systems.

Track Correlation Ids

Select to track messages by correlation ID.

Enabling this parameter allows you to display messages using the show messages <correlationID> command in the administration tool.

Track Message Ids

Select to track messages by message ID.

Enabling this parameter allows you to display messages using the show message <messageID> command in the administration tool.

Client Trace Administrators can trace a connection or group of connections. When this property is selected, the server generates trace output for opening or closing a connection, message activity, and transaction activity. This type of tracing does not require restarting the client program.

The server sends trace output to <location>, which may be either stderr (the default) or stdout.

You can specify a filter to selectively trace specific connections. The <filter> can be user, connid or clientid. The <value> can be a user name or ID (as appropriate to the filter).

When the filter and value clause is absent, the default behavior is to trace all connections.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 18: Tib Admin Ems Usr

8 | Chapter 1 EMS Plug-in Reference

Security

Server Password Click set... to change the password used to connect to the TIBCO Enterprise Message Service server.

SSL Password Click set... to change the private key or PKCS#12 password.

Fault-Tolerant SSL Password

Click set... to change the private key or password for private keys.

Authorization Authorization is disabled by default. Select to verify user credentials and permissions on secure destinations.

Statistics

Collect Statistics Select to enable statistic gathering for producers, consumers, destinations, and routes.

Disabling statistic gathering resets the total statistics for each object to zero.

Detailed Statistics Producers

Select to enable detailed statistic tracking for producers.

Detailed Statistics Consumers

Select to enable detailed statistic tracking for consumers.

Detailed Statistics Routes

Select to enable detailed statistic tracking for routes.

Maximum Statistics Memory

Specify the maximum amount of memory to use for detailed statistic gathering.

Once the maximum memory limit is reached, the server stops collecting detailed statistics. If statistics are deleted and memory becomes available, the server resumes detailed statistic gathering.

Rate Interval (ms)

Set the interval over which statistics for routes, destinations, producers, and consumers are averaged. Setting this parameter to zero disables the average calculation.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 19: Tib Admin Ems Usr

Server Parameters | 9

Server Rate Interval

Set the interval over which overall server statistics are averaged. This parameter can be set to any positive integer greater than zero.

Overall server statistics are always gathered, so this parameter cannot be set to zero.

Setting this parameter allows you to average message rates and message size over the specified interval.

Statistics Cleanup Interval

Specifies how long the server should keep detailed statistics if the destination has no activity. When the specified interval is reached, statistics for destinations with no activity are deleted.

Log and Console Trace Flags

ACL Select to print a message when a user attempts to perform an unauthorized action. For example, if the user attempts publish a message to a secure topic for which the user has not been granted the publish permission.

Admin Select to print a message whenever an administration function is performed.

Config Select to print a message if the server detects any errors while reading the config files.

Connect Select to print a message when a user attempts to connect to the sever.

Connect Error Select to print a message when an error occurs on a connection.

Debug Select to print debug messages.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 20: Tib Admin Ems Usr

10 | Chapter 1 EMS Plug-in Reference

Default Select to set the trace options to the default set. This includes:

• INFO

• WARNING

• ACL

• LIMITS

• ROUTE

• ADMIN

• RVADV

• CONNET_ERROR

• CONFIG

• MSG

Destination Select to print a message when a dynamic destination is created or destroyed.

Info Select to print messages as the server performs various internal housekeeping functions, such as creating a configuration file, opening the persistent database files, and purging messages. Also prints a message when tracking by message ID is enabled or disabled.

Limits Select to print a message when a limit is exceeded, such as the maximum size for a destination.

ProdCons Select to print a message when a client creates or closes a producer or consumer.

Route Select to print a message when routes are created or when a route connection is established.

Route Debug Select to print a message for each message that is sent over a route.

RV Advisory Select to print TIBCO Rendezvous advisory messages whenever they are received.

SSL Select to print detailed messages of the SSL process, including certificate content.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 21: Tib Admin Ems Usr

Server Parameters | 11

SSL Debug Select to print messages that trace the establishment of SSL connections.

TX Select to print a message when a client performs a transaction.

TX Debug Select to print debug messages when a client performs a transaction.

Warn Select to print a message when a failure of some sort occurs, usually because the user attempts to do something illegal. For example, a message is printed when a user attempts to publish to a wildcard destination name.

XA Select to print XA messages.

XA Debug Select to print debug XA messages.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 22: Tib Admin Ems Usr

12 | Chapter 1 EMS Plug-in Reference

Queues Parameters

The Queues pane allows you to view and change information about queues associated with this server.

• To add a new queue, click the New button.

• To delete a queue, select the check box next to it and click the Delete button.

• To purge a queue, select it and click the Purge button.

Click Search to limit the display if a large number of names are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

Main DisplayThe following information is displayed in the main display. Click the queue name for more information, or to make changes to the queue.

Do not remove $TMP queues. TIBCO Administrator connections use them to function. When you delete $TMP queues, you may be selectively removing the JMS admin connections of other components including the JMSWrapper's admin connection. As a result it eventually quits and stops the EMS server. (The JMS admin connection cannot be removed.)

During this process TIBCO Administrator may show an error state or eventually the stopped state. You can either stop the EMS server manually or let it eventually return to the stopped state, and then run it again.

Parameter Description

Name Name of a queue. Click this name to view additional information about the queue and to modify the queue.

Static When selected, indicates the queue is a static queue.

Temp When selected, indicates the queue is a temporary queue.

Receiver Count Number of active receivers on this queue.

Consumer Count Number of active consumers on this queue.

Pending Msg Count

Number of messages pending for this queue.

TIBCO Administrator EMS Plug-in Reference

Page 23: Tib Admin Ems Usr

Queues Parameters | 13

New, View or Edit Queues PaneWhen you click the queue name, a detail window for that queue allows you to view additional information. You can click the Edit button and make changes if you are authorized to do so. Be sure to click Save for the changes to take effect.

Pending Msg Size

Total size of pending messages for this queue.

Delivered Msg Count

Number of messages delivered.

In Transit Msg Count

Number of messages in transit.

In Byte Rate Number of bytes per second arriving for this queue.

In Msg Rate Number of messages per second arriving for this queue.

In Total Bytes Total number of bytes that arrived since this queue was started.

In Total Msgs Total number of messages that arrived since this queue was started.

Out Byte Rate Number of bytes per second sent by this queue.

Out Msg Rate Number of messages per second sent by this queue.

Out Total Bytes Total number of bytes that were sent since this queue was started.

Out Total Msgs Total number of messages that were sent since this queue was started.

Parameter Description

Parameter Description

Properties

Name Name of the queue.

Description Allows you to enter a description for the queue.

Static A check mark indicates the queue is static.

TIBCO Administrator EMS Plug-in Reference

Page 24: Tib Admin Ems Usr

14 | Chapter 1 EMS Plug-in Reference

Temporary A check mark indicates the queue is temporary.

Fail Safe TIBCO Enterprise Message Service provides two modes for persisting topic/queue messages in external storage. These two modes are:

• normal

• fail safe

Normal mode writes all messages into the file on disk in asynchronous mode. In this mode, the data may remain in system buffers for a short time before it is written to disk.

Asynchronous mode storage includes a small probability that, in case of software or hardware failure, some data may be lost without the possibility of recovery. In many applications, when a rare loss of a few messages is acceptable, this mode provides the best combination of performance and reliability.

For situations in which any loss of data is not acceptable, the administrator should set the Fail Safe property for the topic or the queue. In fail safe mode, all data for that queue or topic are written into external storage in synchronous mode. In synchronous mode, a write operation is not complete until the data is physically recorded on the external device.

The Fail Safe property ensures that no messages are ever lost in case of server failure. Although fail safe mode guarantees no messages are lost, it also significantly affects the performance.

Global Messages destined for a topic or queue with the Global property set are routed to the other servers that are participating in routing with this server.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 25: Tib Admin Ems Usr

Queues Parameters | 15

Secure When set on a destination, specifies permissions should be checked for that destination. When a topic or a queue does not have the secure property turned on, any authenticated user can perform any actions with that topic or queue. When the property is turned on, the administrator can assign permissions to the users.

The secure property does not mean SSL-level security. secure only controls basic authentication and permission verification using unencrypted, non-secure communication between the clients and the server.

User permissions on secure destinations are only checked when the authorization property is enabled in the main configuration file. Therefore, both the authorization configuration parameter and the secure property on the destination must be set for permissions to be enforced for a particular destination.

Sender Name Specifies that the server may include the sender’s username for messages sent to this destination. When this property is enabled, the server takes the user name supplied by the message producer when the connection is established and places that user name into the JMS_TIBCO_SENDER property in the message.

The message producer can override this behavior by specifying a property on a message. If a message producer sets the JMS_TIBCO_DISABLE_SENDER property to true for a message, the server overrides the sender_name property and does not add the sender name to the message.

If authentication for the server is turned off, the server places whatever user name the message producer supplied when the message producer created a connection to the server. If authentication for the server is enabled, the server authenticates the user name supplied by the connection and the user name placed in the message property will be an authenticated user. If SSL is used, the SSL connection protocol guarantees the client is authenticated using the client’s digital certificate.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 26: Tib Admin Ems Usr

16 | Chapter 1 EMS Plug-in Reference

Sender Name Enforced

Specifies that messages sent to this destination must include the sender’s user name. The server retrieves the user name of the message producer using the same procedure described in the sender_name property above. However, unlike, the Sender Name property, there is no way for message producers to override this property.

If the Sender Name property is also set on the destination, this property overrides the sender_name property.

In some business situations, JMS clients may not be willing to disclose the username of their message producers. If this is the case, these clients may wish to avoid sending messages to destinations that have the Sender Name or Sender Name Enforced properties enabled.

In these situations, the EMS administrator should develop a policy for disclosing a list of destinations that have these properties enabled. This will allow JMS clients to avoid sending messages to destinations that would cause their message producer usernames to be exposed.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 27: Tib Admin Ems Usr

Queues Parameters | 17

Exclusive (Inherited)

Defines how the server delivers messages to queue consumers when multiple queue consumers are present. In exclusive mode, the first queue consumer receives all of the messages until the consumer fails. At that point, messages are delivered to the next consumer.

The first queue consumer is the first-activated queue receiver. When that receiver fails in any way, the messages are delivered to the receiver which was activated next. Note that these activations may be in the past; that is, the first-activated and the second-activated are determined at the onset of receiver activation, not at the onset of first-receiver failure.

Non-exclusive queues cause messages to be delivered in a round-robin fashion to the set of queue receivers. This prevents a large buildup of messages at one receiver and thereby balances the load of incoming messages across all queue receivers.

If a message cannot be delivered to a queue receiver (because its pre-fetch limit is reached), TIBCO Enterprise Message Service attempts to deliver the message to the next queue receiver. If the server attempts to deliver the message to all registered queue receivers and none of them can accept the new message, the message is returned to the queue and message delivery is paused until a queue receiver reports that it can accept the message.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 28: Tib Admin Ems Usr

18 | Chapter 1 EMS Plug-in Reference

Prefetch Prefetch sets the maximum number of messages a receiver can receive in the background from the server at any point in time. A message is considered prefetched when it leaves the server. It is no longer considered prefetched when it is delivered to the application by way of the receive method or by callback.

For example, if the prefetch is set to 7, the server ensures that at most 7 messages are prefetched into the client. The prefetch value is the maximum number of messages, not a strict amount. Therefore, as the application receives the messages, the server sends more messages to the client but not necessarily one message for each message received. That is, the server can batch the delivery of messages.

With multiple receivers, the prefetch value is the maximum and should not be used to force a particular delivery pattern. There are too many variable conditions to accurately predict a delivery pattern.

Assigning a larger prefetch number can improve performance by decreasing return message traffic.

You can set the prefetch property to "none" to disable prefetching messages. When a queue has Prefetch set to none specified, the server sends only one message at a time to a receiver. That is, a message is only sent by the server when a receiver calls the receive methods or when the receiver returns from the callback processing the current message. Queues with Prefetch set to none receive messages more slowly than queues where prefetch is set to a positive integer.

Setting Prefetch to 0 or not specifying any Prefetch property specifies that the queue should inherit the prefetch value of its parent. If there are no parents or the parents do not have prefetch set, prefetch is set to the default value of 5.

Setting Prefetch to none is not the same as setting Prefetch to 0.

Max Redelivery Specify the maximum number of times a message should be redelivered.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 29: Tib Admin Ems Usr

Queues Parameters | 19

Max Size Queues can specify the maxbytes property in the form: maxbytes=NNNNN where NNNN is the number of bytes.

For queues, maxbytes defines the maximum size (in bytes) of all messages that can be waiting in the queue. By default, or if maxbytes is set to 0, there is no limit to the size of a queue. If a receiver is off-line for a long time, maxbytes limits the memory allocation for the receiver’s pending messages. Messages that would exceed the limit will not be accepted into storage and an error is returned to the message producer.

Flow Control Max Size

Specify the target maximum storage for pending messages on the destination.

Msg Trace Select the message trace level to use. Either, None, Basic or Detail.

Imported Transports

You can configure queue definitions to use one or more external transports. Messages that arrive on those transports are delivered to the TIBCO Enterprise Message Service server destination.

Bridge Targets Target is name of the destination to which to create a bridge.

Target type is the type of the destination. That is, topic or queue.

Selector is a message selector to limit the messages received by the bridged destination.

JNDI Name Bindings

Set of names through which this queue is available from its connection factory. Click Bind to add a JNDI name or Unbind to remove the selected JNDI name.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 30: Tib Admin Ems Usr

20 | Chapter 1 EMS Plug-in Reference

Permissions

The permissions that have been set for this queue. In Edit mode, click the Add button to add a user with access rights to the queue, then specify her or his permissions. Permissions can be granted to:

• Name entity.

• Assign the entity type, user or group.

• View information for this queue.

• Create dynamic queues, based on this queue. This permission is useful when used with wildcard queue names. This allows the user to create any queue that matches the specified parent.

• Delete this destination.

• Modify the properties for this destination.

• Purge all messages in this queue.

• Send. Permission to create queue senders.

• Receive. Permission to create queue receivers.

• Browse. Permission to create queue browsers.

Monitoring

Receiver Count Number of active receivers on this queue.

Consumer Count Number of consumers for this queue.

Pending Message Count

Number of pending messages.

Pending Message Size

Number of messages pending for this queue.

Delivered Message Count

Number of messages delivered for this queue.

In Transit Message Count

Number of messages in transit for this queue.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 31: Tib Admin Ems Usr

Queues Parameters | 21

Inbound Byte Rate

Number of bytes per second arriving for this queue.

Inbound Message Rate

Number of messages per second arriving for this queue.

Inbound Total Size

Total number of bytes that arrived since this queue was started.

Inbound Total Messages

Total number of inbound messages for this queue.

Outbound Byte Rate

Number of bytes per second being sent by this queue.

Outbound Message Rate

Number of messages per second sent by this queue.

Outbound Total Size

Total number of bytes sent by this queue.

Outbound Total Messages

Total number of messages sent by this queue.

Route Connected Indicates whether the queue is route connected. TIBCO Enterprise Message Service servers can route messages to other servers. Queue messages can travel only one hop to the home queue, and one hop from the home queue.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 32: Tib Admin Ems Usr

22 | Chapter 1 EMS Plug-in Reference

Producers and Consumers

Producers

Consumers

Displays the producers and consumers for this queue in the following fields:

• ID of this producer or consumer.

• Connection ID of this producer or consumer.

• Session ID this producer or consumer is using.

• Destination. Selectable destination for this producer or consumer.

• Byte rate for this queue in relationship to this producer or consumer.

• Total bytes for this queue in relationship to this producer or consumer.

• Message rate for this queue in relationship to this producer or consumer.

• Total messages for this queue in relationship to this producer or consumer.

• Creation time when this queue was created.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 33: Tib Admin Ems Usr

Topics Parameters | 23

Topics Parameters

The Topics pane allows you to view information about topic destinations associated with this server.

• To add a new topic, click the New button.

• To delete a topic, select the check box next to it and click the Delete button.

• To purge a topic, select it and click the Purge button.

Click Search to limit the display if a large number of names are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

Main DisplayThe following information is displayed in the main display.

Parameter Description

Name Name of a topic. Click this name to view additional information about the topic and to modify the topic.

Static When selected, indicates that this topic is a static topic.

Temporary When selected, indicates that this topic is a temporary topic.

Active Durable Count

Current number of active durable subscribers for this topic.

Durable Count Current number of durable subscribers for this topic.

Subscriber Count Current number of subscribers for this topic

Consumer Count Current number of consumers for this topic

Pending Msg Count

Number of messages pending for this topic.

Pending Msg Size

Total size of pending messages for this topic.

In Byte Rate Number of bytes per second arriving for this topic.

TIBCO Administrator EMS Plug-in Reference

Page 34: Tib Admin Ems Usr

24 | Chapter 1 EMS Plug-in Reference

New, View or Edit Topics PaneWhen you click a topic name, a detail pane window for that topic allows you to view additional information. You can click an Edit button and make changes if you are authorized to do so. Be sure to click Save for the changes to take effect.

In Msg Rate Number of messages per second arriving for this topic.

In Total Bytes Total number of bytes that arrived since this topic was started.

In Total Msgs Total number of messages that arrived since this topic was started.

Out Byte Rate Number of bytes per second sent by this topic.

Out Msg Rate Number of messages per second sent by this topic.

Out Total Bytes Total number of bytes that were sent since this topic was started.

Out Total Msgs Total number of messages that were sent since this topic was started.

Parameter Description

Parameter Description

Properties

Name Name of the topic.

Description Allows you to enter a description for the topic.

Static A check mark indicates the topic is static.

Temporary A check mark indicates the topic is temporary.

TIBCO Administrator EMS Plug-in Reference

Page 35: Tib Admin Ems Usr

Topics Parameters | 25

Fail Safe TIBCO Enterprise Message Service provides two modes for persisting topic/queue messages in external storage. These two modes are:

• normal

• fail safe

Normal mode writes all messages into the file on disk in asynchronous mode. In this mode, the data may remain in system buffers for a short time before it is written to disk.

Asynchronous mode storage includes a small probability that, in case of software or hardware failure, some data may be lost without the possibility of recovery. In many applications, when a rare loss of a few messages is acceptable, this mode provides the best combination of performance and reliability.

For situations in which any loss of data is not acceptable, the administrator should set the Fail Safe property for the topic or the queue. In fail safe mode, all data for that queue or topic are written into external storage in synchronous mode. In synchronous mode, a write operation is not complete until the data is physically recorded on the external device.

The Fail Safe property ensures that no messages are ever lost in case of server failure. Although failsafe mode guarantees no messages are lost, it also significantly affects the performance.

Global Messages destined for a topic or queue with the Global property set are routed to the other servers that are participating in routing with this server.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 36: Tib Admin Ems Usr

26 | Chapter 1 EMS Plug-in Reference

Secure When set on a destination, specifies permissions should be checked for that destination. When a topic or a queue does not have the secure property turned on, any authenticated user can perform any actions with that topic or queue. When the property is turned on, the administrator can assign permissions to the users.

The secure property does not mean SSL-level security. secure only controls basic authentication and permission verification using unencrypted, non-secure communication between the clients and the server.

User permissions on secure destinations are only checked when the authorization property is enabled in the main configuration file. Therefore, both the authorization configuration parameter and the Secure property on the destination must be set for permissions to be enforced for a particular destination.

Sender Name Specifies that the server may include the sender’s username for messages sent to this destination. When this property is enabled, the server takes the user name supplied by the message producer when the connection is established and places that user name into the JMS_TIBCO_SENDER property in the message.

The message producer can override this behavior by specifying a property on a message. If a message producer sets the JMS_TIBCO_DISABLE_SENDER property to true for a message, the server overrides the sender_name property and does not add the sender name to the message.

If authentication for the server is turned off, the server places whatever user name the message producer supplied when the message producer created a connection to the server. If authentication for the server is enabled, the server authenticates the user name supplied by the connection and the user name placed in the message property will be an authenticated user. If SSL is used, the SSL connection protocol guarantees the client is authenticated using the client’s digital certificate.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 37: Tib Admin Ems Usr

Topics Parameters | 27

Sender Name Enforced

Specifies that messages sent to this destination must include the sender’s user name. The server retrieves the user name of the message producer using the same procedure described in the sender_name property above. However, unlike, the sender_name property, there is no way for message producers to override this property.

If the sender_name property is also set on the destination, this property overrides the sender_name property.

In some business situations, JMS clients may not be willing to disclose the username of their message producers. If this is the case, these clients may wish to avoid sending messages to destinations that have the sender_name or sender_name_enforced properties enabled.

In these situations, the operator of the JMS server should develop a policy for disclosing a list of destinations that have these properties enabled. This will allow JMS clients to avoid sending messages to destinations that would cause their message producer usernames to be exposed.

Max Size Queues can specify the maxbytes property in the form: maxbytes=NNNNN where NNNN is the number of bytes.

For queues, maxbytes defines the maximum size (in bytes) of all messages that can be waiting in the queue. By default, or if maxbytes is set to 0, there is no limit to the size of a queue. If a receiver is off-line for a long time, maxbytes limits the memory allocation for the receiver’s pending messages. Messages that would exceed the limit will not be accepted into storage and an error is returned to the message producer.

Flow Control Max Size

Specify the target maximum storage for pending messages on the destination.

Msg Trace Select the message trace level to use. Either, None, Basic or Detail.

Imported Transports

You can configure topic definitions to use one or more external transports. Messages that arrive on those transports are delivered to the TIBCO Enterprise Message Service server destination.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 38: Tib Admin Ems Usr

28 | Chapter 1 EMS Plug-in Reference

Bridge Targets • Target is name of the destination to which to create a bridge.

• Target type is the type of the destination. That is, topic or queue.

• Selector is a a message selector to limit the messages received by the bridged destination.

JNDI Name Bindings

Set of names through which this topic is available from its connection factory. Click Bind to add a name or Unbind to remove the selected name.

Permissions

The permissions that have been set for this topic. In Edit mode, click the Add button to add a user with access rights to the queue, then specify her or his permissions. Permissions can be granted to:

• Name the entity.

• Assign the topic type, user or group.

• View information for this topic.

• Create dynamic topics based on this topic. This permission is useful when used with wildcard topic names. This allows the user to create any topic that matches the specified parent.

• Delete this destination.

• Modify the properties for this destination.

• Purge all messages in this topic.

• Publish. Permission to publish on the topic.

• Subscribe. Permission to create non-durable subscribers on the topic

• Durable. Permission to create durable subscribers on the topic.

Monitoring

Active Durable Count

Current number of active durable subscribers for this topic.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 39: Tib Admin Ems Usr

Topics Parameters | 29

Durable Count Current number of durable subscribers for this topic.

Subscriber Count Current number of subscribers for this topic.

Consumer Count Current number of consumers for this topic.

Pending Message Count

Number of messages pending for this topic.

Pending Message Size

Total size of pending messages for this topic.

Inbound Byte Rate

Number of bytes per second arriving for this topic.

Inbound Message Rate

Number of messages per second arriving for this topic.

Inbound Total Size

Total number of bytes that arrived since this topic was started.

Inbound Total Messages

Total number of messages that arrived since this topic was started.

Outbound Byte Rate

Number of bytes per second being sent by this topic.

Outbound Message Rate

Number of bytes per second sent by this topic.

Outbound Total Size

Number of messages per second sent by this topic.

Outbound Total Messages

Total number of messages sent by this topic.

Producers and Consumers

ID ID of this producer or consumer.

Connection ID Connection ID of this producer or consumer.

Session ID ID of the session this producer or consumer is using.

Destination Selectable destination for this producer or consumer.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 40: Tib Admin Ems Usr

30 | Chapter 1 EMS Plug-in Reference

Byte Rate Byte rate for this topic in relationship to this producer or consumer.

Total Bytes Total bytes for this topic in relationship to this producer or consumer.

Msg Rate Message rate for this topic in relationship to this producer or consumer.

Total Msgs Total messages for this topic in relationship to this producer or consumer.

Create Time Time at which this topic was created.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 41: Tib Admin Ems Usr

Durables Parameters | 31

Durables Parameters

The Durables pane allows you to view information about durables associated with this server.

• To add a new durable, click the New button.

• To delete a durable, select the check box next to it and click the Delete button.

• To purge a durable, select it and click the Purge button.

Click Search to limit the display if a large number of names are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

Main DisplayThe following information is displayed in the main display. Click the durable name for more information, or to make changes to the durable.

Parameter Description

Name Name of a durable. Click this name to view additional information about the durable and to modify the durable.

Topic Name of the topic associated with this durable.

Client ID ID associated with the durable.

Static A check mark indicates the durable is static.

Pending Msg Count

Pending message count for the durable subscriber.

Pending Msg Size

Pending message size limit for the durable subscriber.

Active Indicates if the durable subscriber is active.

User Name Name of the user of this durable subscriber. If the durable subscriber is currently offline, the value in this column is offline.

For users defined externally, there is an asterisk in front of the user name.

TIBCO Administrator EMS Plug-in Reference

Page 42: Tib Admin Ems Usr

32 | Chapter 1 EMS Plug-in Reference

View or Add Durable PaneWhen you click a durable name, a detail pane window for that durable allows you to view additional information. You can view the following durable parameters. To add a durable, click New in the Durables pane, supply the following information, and click Create.

Parameter Description

General

Name Name of the durable.

Client ID Client ID associated with this durable.

Topic Name Select the topic for which you wish to create a durable from the pop-up.

Selector When present, this selector narrows the set of messages that the durable subscriber receives.

No Local When present, the subscriber does not receive messages published from its own connection.

Route When present, the subscriber is another server, and the <durable-name> is the name of that server.

When this property is present, no other properties are permitted.

Statistics

Pending Message Count

Number of messages waiting to be delivered to this durable subscription.

Pending Message Size

Total size, in bytes, of messages waiting to be delivered to this durable subscription.

Active No if this durable is not currently active, Yes otherwise.

User Name Name of the authenticated user whose connection this durable subscriber is currently using.

Consumer Id Id assigned to this consumer.

TIBCO Administrator EMS Plug-in Reference

Page 43: Tib Admin Ems Usr

Connection Factories Parameters | 33

Connection Factories Parameters

The following operations are available:

• New—Allows you to configure or define a new connection factory.

• Delete—Deletes the selected factory or factories.

Click Search to limit the display if a large number of JNDI names are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

Main DisplayThe next table lists connection factory information shown in the main display:

New, Edit or View PaneWhen you click the connection factory name, a detail pane window for that connection factory allows you to view additional information and make changes.

You can create, edit or view the following parameters.

Property Description

JNDI Name List of names that this factory is bound to in the default JNDI.

Resource Type Type of the ConnectionFactory: All, Topic, or Queue.

URL The URL string to which connections created by this factory are connected.

Client ID The client ID associated with connections created by this factory.

Parameter Description

General

Resource Type Type of the ConnectionFactory: All, Topic, or Queue.

URL The URL string to which connections created by this factory are connected.

TIBCO Administrator EMS Plug-in Reference

Page 44: Tib Admin Ems Usr

34 | Chapter 1 EMS Plug-in Reference

Client ID The client ID associated with connections created by this factory.

XA Factory If checked, the factory is an XA factory. This change may apply to other places as well. See your TIBCO Enterprise Message Service documentation set for details.

Connect Attempt Count

Sets the number of times that this connection object can attempt to establish a connection to the server.

Connect Attempt Delay

Determines the delay time between successive attempts to establish a connection to the server. Its value is the time (in milliseconds) between connection attempts.

Reconnect Attempt Count

Sets the number of times that this connection object can attempt to reconnect to the server after a network disconnect.

Reconnect Attempt Delay

Determines the delay time between successive attempts to establish a connection to the server. Its value is the time (in milliseconds) between connection attempts.

JNDI Name Bindings

Allows you to view and edit the JNDI name bindings. You can create multiple JNDI name bindings for the same topic or queue.

SSL Parameters

SSL Vendor The SSL vendor name to be used by a Java client.

SSL Identity The server’s digital certificate in PEM, DER, or PKCS#12 format. You can copy the digital certificate into the specification for this parameter, or you can specify the path to a file that contains the certificate in one of the supported formats.

SSL Issuer Certificate chain member for the server. The server reads the certificates in the chain in the order they are presented in this parameter.

The same certificate can appear in multiple places in the certificate chain.

The certificates must be in PEM, DER, PKCS#7, or PKCS#12 format.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 45: Tib Admin Ems Usr

Connection Factories Parameters | 35

SSL Private Key The server’s private key. If it is included in the digital certificate in ssl_identity, then this parameter is not needed.

This parameter supports private keys in the following formats: PEM, DER, PKCS#12.

You can specify the actual key in this parameter, or you can specify a path to a file that contains the key.

SSL Trusted List of trusted certificates. This sets which Certificate Authority certificates should be trusted as issuers of the client certificates.

The same certificate can appear in multiple places in the certificate chain.

The certificates must be in PEM, DER, or PKCS#7 format. You can either provide the actual certificates, or you can specify a path to a file containing the certificate chain.

SSL Verify Host Specifies whether the server should verify the other server’s certificate. The values for this parameter are "enabled" or "disabled". By default, this parameter is enabled, signifying the server should verify the other server’s certificate.

When this parameter is set to "disabled", the server establishes secure communication with the other server, but does not verify the server’s identity.

SSL Verify Host Name

Specifies whether the server should verify the name in the CN field of the other server’s certificate. The values for this parameter are "enabled" and "disabled". By default, this parameter is enabled, signifying the server should verify the name of the connected host or the name specified in the ssl_expected_hostname parameter against the value in the server’s certificate. If the names do not match, the connection is rejected.

When this parameter is set to "disabled", the server establishes secure communication with the other server, but does not verify the server’s name.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 46: Tib Admin Ems Usr

36 | Chapter 1 EMS Plug-in Reference

SSL Expected Host Name

Specifies the name the server is expected to have in the CN field of the server’s certificate. If this parameter is not set, the expected name is the hostname of the server.

This parameter is used when the ssl_verify_hostname parameter is set to enabled.

SSL Ciphers Specifies the cipher suites used by the server; each suite in the list is separated by a colon (:). This parameter can use the OpenSSL name for cipher suites or the longer, more descriptive names.

SSL Entropy Gathering Daemon

The path for the installed entropy gathering daemon (EGD), if one is installed. This daemon is used to generate random numbers for the TIBCO Enterprise Message Service server.

SSL Renegotiate Size

The client initiates a renegotiation when the cumulative size, in bytes, of the data passed between the server and the client reaches the amount specified by this parameter.

The minimum size this parameter can be set to is 64Kb. You can specify Kb, Mb, or Gb for the units.

By default, this parameter is set to 0, signifying renegotiation is disabled.

SSL Renegotiate Interval

The client initiates a renegotiation when the number of seconds specified by this parameter have passed. The renegotiation occurs each time the interval occurs; the time interval starts at the beginning of the SSL connection.

The minimum interval is 15 seconds.

By default, this parameter is set to 0, signifying renegotiation is disabled.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 47: Tib Admin Ems Usr

Connections Parameters | 37

Connections Parameters

The Connections pane allows you to view information about connections associated with this server. To delete a connection, select the check box next to it and click the Delete button.

Click Search to limit the display if a large number of connections are defined. The search works against the Type column. The * wildcard character can be used to represent zero or more characters.

Main DisplayThe following information is displayed in the main display.

Deleting a connection affects all clients using that connection.

Parameter Description

ID Unique connection ID. Each connection is assigned a unique, numeric ID that can be used to delete the connection.

Type Connection type.

Client Type Type of client.

Host Connection's host name.

Address Connection's IP address.

Client Id Client ID of the connection.

Session Count Number of sessions on this connection.

Producer Count Producers associated with this connection.

Consumer Count Consumers associated with this connection.

Up Time Amount of time this connection has been up.

TIBCO Administrator EMS Plug-in Reference

Page 48: Tib Admin Ems Usr

38 | Chapter 1 EMS Plug-in Reference

Producers and Consumers Parameters

The Producers and Consumers pane allows you to view information about producers and consumers associated with this server.

Main DisplayThe following information is displayed in the main display. Click the producer or consumer name for more information, or to make changes to the producer or consumer.

Destination DetailsWhen you click a producer or consumer, the corresponding topic or queue is displayed. See New, View or Edit Queues Pane on page 13 and New, View or Edit Topics Pane on page 24 for information about the fields in that display.

Parameter Description

ID ID for this producer or consumer. Note that producers and consumers are displayed as separate group; each group can be collapsed by clicking on the - sign.

Connection ID Unique connection ID. Each connection is assigned a unique, numeric ID that can be used to delete the connection.

Session ID Session associated with this producer or consumer.

Destination Destination where this producer or consumer sends messages.

Byte Rate Byte rate for this producer or consumer.

Total Bytes Total bytes processed by this producer or consumer.

Msg Rate Message Rate for this producer or consumer

Total Msgs Total messages sent or received by this producer or consumer.

Create Time Time at which this producer or consumer was created.

TIBCO Administrator EMS Plug-in Reference

Page 49: Tib Admin Ems Usr

Routes Parameters | 39

Routes Parameters

The Routes pane allows you to view information about routes associated with this server.

• To add a new route, click the New button.

• To delete a route, select the check box next to it and click the Delete button.

• To promote a passive route to active, select the route and click the Promote to Active button.

Click Search to limit the display if a large number of names are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

Main DisplayThe following information is displayed in the main display. Click the route name for more information, or to make changes to the route.

Parameter Description

Name Name of a route. Click this name to view additional information about the route and to modify the route.

Connection Id Unique connection ID. Each connection is assigned a unique, numeric ID that can be used to delete the connection.

Route Type The zone type is either 1hop or mhop. When omitted, the default value is mhop.

You can set this parameter when creating a route, but you cannot subsequently change it.

In Byte Rate Number of bytes per second coming into this route.

In Msg Rate Number of messages per second coming into this route.

In Total Bytes Total size of messages, in bytes, coming into this route.

In Total Msgs Number of messages coming into this route.

Out Byte Rate Number of bytes per second going out of this route.

Out Msg Rate Number of messages per second going out of this route.

TIBCO Administrator EMS Plug-in Reference

Page 50: Tib Admin Ems Usr

40 | Chapter 1 EMS Plug-in Reference

New, Edit or View PaneWhen you click a route name, a detail pane window for that route allows you to view additional information. You can click an Edit button and make changes if you are authorized to do so. Be sure to click Save for the changes to take effect.

Out Total Bytes Total size of messages, in bytes, going out of this route.

Out Total Msgs Number of messages going out of this route.

Parameter Description

Parameter Description

General

Name Name of the route.

URL URL of the other JMS server with which this server has a routing relationship.

Zone Name The route belongs to the routing zone with this name. When absent, the default value is default_mhop_zone (this default yields backward compatibility with configurations from releases earlier than 4.0).

You can set this parameter when creating a route, but you cannot subsequently change it.

Zone Type The zone type is either 1hop or mhop. When omitted, the default value is mhop.

You can set this parameter when creating a route, but you cannot subsequently change it.

Configured

SSL Parameters

SSL Password Private key or password for private keys.

When passwords are set, the password is obfuscated in the configuration file.

Click set to set the password.

TIBCO Administrator EMS Plug-in Reference

Page 51: Tib Admin Ems Usr

Routes Parameters | 41

SSL Identity The server’s digital certificate in PEM, DER, or PKCS#12 format. You can copy the digital certificate into the specification for this parameter, or you can specify the path to a file that contains the certificate in one of the supported formats.

SSL Issuer Certificate chain member for the server. The server reads the certificates in the chain in the order they are presented in this parameter.

The same certificate can appear in multiple places in the certificate chain.

The certificates must be in PEM, DER, PKCS#7, or PKCS#12 format.

SSL Private Key The server’s private key. If it is included in the digital certificate in ssl_identity, then this parameter is not needed.

This parameter supports private keys in the following formats: PEM, DER, PKCS#12.

You can specify the actual key in this parameter, or you can specify a path to a file that contains the key.

SSL Trusted List of trusted certificates. This sets which Certificate Authority certificates should be trusted as issuers of the client certificates.

The same certificate can appear in multiple places in the certificate chain.

The certificates must be in PEM, DER, or PKCS#7 format. You can either provide the actual certificates, or you can specify a path to a file containing the certificate chain.

SSL Verify Host When checked, specifies whether the server should verify the other server’s certificate. By default, this parameter is enabled, signifying the server should verify the other server’s certificate.

When this parameter is not checked, the server establishes secure communication with the other server, but does not verify the server’s identity.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 52: Tib Admin Ems Usr

42 | Chapter 1 EMS Plug-in Reference

SSL Verify Hostname

When checked, specifies whether the server should verify the name in the CN field of the other server’s certificate. By default, this parameter is enabled, signifying the server should verify the name of the connected host or the name specified in the ssl_expected_hostname parameter against the value in the server’s certificate. If the names do not match, the connection is rejected.

When this parameter is not checked, the server establishes secure communication with the other server, but does not verify the server’s name.

SSL Expected Hostname

Specifies the name the server is expected to have in the CN field of the server’s certificate. If this parameter is not set, the expected name is the hostname of the server.

This parameter is used when the ssl_verify_hostname parameter is set to enabled.

SSL Ciphers Specifies the cipher suites used by the server; each suite in the list is separated by a colon (:). This parameter can use the OpenSSL name for cipher suites or the longer, more descriptive names.

SSL Entropy Gathering Daemon

The path for the installed entropy gathering daemon (EGD), if one is installed. This daemon is used to generate random numbers for the TIBCO Enterprise Message Service server.

Monitoring

Connection Id Unique connection ID. Each connection is assigned a unique, numeric ID that can be used to delete the connection.

Connected A check mark indicates the route is connected.

Stalled A check mark indicates the route is stalled.

Inbound Byte Rate

Number of bytes per second coming into this route.

Inbound Message Rate

Number of messages per second coming into this route.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 53: Tib Admin Ems Usr

Routes Parameters | 43

Inbound Total Size

Total size of messages, in bytes, coming into this route.

Inbound Total Messages

Number of messages coming into this route.

Outbound Byte Rate

Number of bytes per second going out of this route.

Outbound Message Rate

Number of messages per second going out of this route.

Outbound Total Size

Total size of messages, in bytes, going out of this route.

Outbound Total Messages

Number of messages going out of this route.

Parameter Description

TIBCO Administrator EMS Plug-in Reference

Page 54: Tib Admin Ems Usr

44 | Chapter 1 EMS Plug-in Reference

Bridges Parameters

The Bridges pane allows you to view information about bridges.

• To add a new bridge, click the New button.

• To delete a bridge, select the check box next to it and click the Delete button.

Click Search to limit the display if a large number of names are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

The following information is displayed:

New PaneYou can create a new destination bridge for an EMS server by providing values for the following field and clicking the Create button.

Parameter Description

Source Name of the destination being bridged from.

Source Type Type of destination (topic or queue) being bridged from.

Target Name of the destination being bridged to.

Target Type Type of destination (topic or queue) being bridged to.

Selector Message selector defined for the bridge.

Parameter Description

Source Type and Name

Select the type of destination (topic or queue) being bridged from. Click Pick Source to display a list of topics or queues to choose from.

Target Type and Name

Select the type of destination (topic or queue) being bridged to. Click Pick Target to display a list of topics or queues to choose from.

Selector Message selector for the bridge.

TIBCO Administrator EMS Plug-in Reference

Page 55: Tib Admin Ems Usr

Transports Parameters | 45

Transports Parameters

The Transports pane allows you to view information about transports.

Click Search to limit the display if a large number of transports are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

The following information is displayed:

Parameter Description

Name Name of the transport.

Type Type of the transport.

Queue Delivery Mode

Delivery mode for messages imported from this transport to a queue.

Topic Delivery Mode

Delivery mode for messages imported from this transport to a topic.

Export Headers Indicates whether or not JMS header information is included in messages exported on this transport.

Export Properties Indicates whether or not the JMS message properties are included in messages exported on this transport.

TIBCO Administrator EMS Plug-in Reference

Page 56: Tib Admin Ems Usr

46 | Chapter 1 EMS Plug-in Reference

Transactions Parameters

The Transactions pane allows you to view information about XA transactions associated with this server.

• To commit a transaction, select the check box next to it and click the Commit button.

• To roll back a transaction, select it and click the Roll Back button.

Click Search to limit the display if a large number of transactions are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

The following information is displayed:

Parameter Description

Data Transaction data.

State Transaction state, which can be one of the following:

• 'A' — active

• 'E' — ended

• 'R' — rollback only

• 'P' —prepared

Format ID Format ID of the transaction.

Global Transaction ID Length

Global transaction ID for this transaction.

Branch Qualifier Length

Branch qualifier of the transaction.

TIBCO Administrator EMS Plug-in Reference

Page 57: Tib Admin Ems Usr

Users and Groups Parameters | 47

Users and Groups Parameters

The Users and Groups pane allows you to create users and groups and assign access privileges for resources used by the TIBCO Enterprise Message Service (EMS) server.

• You can use the users and roles currently defined in the TIBCO Administrator User Management module as users and groups for the TIBCO Enterprise Message Service server, by clicking the Synchronize button. This will export the current TIBCO Administrator users, their passwords and roles to the EMS server. TIBCO Administrator roles are created as groups in the EMS server.

• To create users and groups explicitly for the EMS server, click New User or New Group. To edit a user or group, click the user or group name. User and group names cannot be changed.

• The External column indicates whether the user or group is defined in a directory that is not part of TIBCO Enterprise Message Service, such as an LDAP directory. See the TIBCO Enterprise Message Service User’s Guide for more information.

• You can assign protection permissions that allow you to group users into administrative domains so that administrators can only perform actions within their domain. An administrator can only perform administrative operations on a user that has the same protection permission as the user. There are four protection permissions (protect 1, protect 2, protect 3, and protect 4) that allow you to create four groups of administrators. Protection permissions do not apply to the admin user or users in the $admin group — these users can perform any action on any user regardless of protection permissions. See the TIBCO Enterprise Message Service User’s Guide for more information.

If you choose Synchronize, users and groups defined in TIBCO Administrator are exported to the EMS server. If a user or group in the EMS server has the same name as a user or group in TIBCO Administrator, the user or group name in the EMS server is overwritten. The EMS $admin group and admin user are not changed.

If TIBCO Administrator is integrated with an LDAP directory server synchronization is not recommended. An LDAP directory server does not allow passwords to be exported, and as a result passwords would not be exported on synchronization. See Synchronizing User Information With TIBCO Administrator (below) for more information.

TIBCO Administrator EMS Plug-in Reference

Page 58: Tib Admin Ems Usr

48 | Chapter 1 EMS Plug-in Reference

Click Search to limit the display if a large number of names are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

Synchronizing User Information With TIBCO AdministratorIf you wish to use the Users and Roles currently defined in the TIBCO Administrator User Management module as users and groups, click the Synchronize button.

The synchronization results depend on whether users and groups are defined in the domain repository or whether TIBCO Administrator integrates with an LDAP directory server:

• Domain repository—If a domain repository is used, both users and their passwords become known to JMS after synchronization.

• LDAP directory server—If your domain is integrated with an LDAP directory server and you synchronize, passwords do not become available.

If you wish to integrate with an LDAP directory server, set up your TIBCO Enterprise Message Service server configuration file to use LDAP. In that case, users and groups will then become available from the Edit Permissions panels of topics and queues.

Creating Users and Setting PermissionsTo add a user to TIBCO Enterprise Message Service explicitly, follow these steps. Upon creation, new users do not have any access privileges or roles. You can set access privileges for the user by setting Permissions in the appropriate object pages.

1. Click the New User button.

2. Supply the user name.

3. Optionally enter a description.

4. Set the password by clicking set and enter the password (twice).

TIBCO Administrator EMS Plug-in Reference

Page 59: Tib Admin Ems Usr

Users and Groups Parameters | 49

5. Click OK.

6. Assign permissions for the user by clicking the arrow next to each permission and selecting the access level. You can quickly assign a user all permissions by clicking Grant in the All box. Similarly, you can grant only view permissions by selecting Grant in the View All box. Note that the permission setting change only after you click the Create button.

7. Click the Create button to create and save the user and return to the previous screen.

All spaces before and after the name are removed. Spaces inside the name are retained.

Adding GroupsTo add a group to TIBCO Enterprise Message Service, follow these steps:

1. Click the Add Group button.

2. Supply the group name and an optional description.

3. Click the Create button to create and save the group and return to the previous screen. You must click Create to create the group.

Adding a User or Group to a GroupTo assign a user (or group) to a group, follow these steps:

1. Click the group name to add to.

2. Click Edit.

There are no limitations on the characters used for the username or password with the exception that

— the username and password currently cannot contain double-byte characters

— the password cannot start with the character # and cannot contain the characters / (forward slash) ; (semicolon), & (ampersand) or = (equal sign).

If you do not specify a password, that user can log in with a blank password field unless you’re using LDAP for users and groups.

You must click Create to create the user. If you select a different console in the left panel and have not clicked the Create button, that user is not created.

TIBCO Administrator EMS Plug-in Reference

Page 60: Tib Admin Ems Usr

50 | Chapter 1 EMS Plug-in Reference

3. In the dialog that appears, under Members (at the bottom of the dialog), click the Add button.

4. Select the group or user(s) to add.

5. Click Save (twice).

6. Click Done.

TIBCO Administrator EMS Plug-in Reference

Page 61: Tib Admin Ems Usr

JNDI Bindings Parameters | 51

JNDI Bindings Parameters

The JNDI Bindings pane lists the corresponding resource and resource type for each defined JNDI name. You can click the resource for more information about it.

Click Search to limit the display if a large number of JNDI names are defined. You can search based on data that appears in any of the columns. The * wildcard character can be used to represent zero or more characters.

TIBCO Administrator EMS Plug-in Reference

Page 62: Tib Admin Ems Usr

52 | Chapter 1 EMS Plug-in Reference

TIBCO Administrator EMS Plug-in Reference

Page 63: Tib Admin Ems Usr

TIBCO Software Inc. End User License Agreement | 53

TIBCO Software Inc. End User License AgreementREAD THIS END USER LICENSE AGREEMENT CAREFULLY. BY DOWNLOADING OR INSTALLING THE SOFTWARE, YOU AGREE TO BE BOUND BY THIS AGREEMENT. IF YOU DO NOT AGREE TO THESE TERMS, DO NOT DOWNLOAD OR INSTALL THE SOFTWARE AND RETURN IT TO THE VENDOR FROM WHICH IT WAS PURCHASED.

Upon your acceptance as indicated above, the following shall govern your use of the Software except to the extent all or any portion of the Software (a) is subject to a separate written agreement, or (b) is provided by a third party under the terms set forth in an Addenda at the end of this Agreement, in which case the terms of such addenda shall control over inconsistent terms with regard to such portion(s).

License Grant. The Software is the property of TIBCO or its licensors and is protected by copyright and other laws. While TIBCO continues to own the Software, TIBCO hereby grants to Customer a limited, non-transferable, non-exclusive, license to use the Number of Units set forth in the Ordering Document, in machine-readable, object code form and solely for Customer's internal business use.

Restrictions. Customer agrees not to (a) make more copies than the Number of Units plus a reasonable number of backups; (b) provide access to the Software to anyone other than employees, contractors, or consultants under written contract with Customer agreeing to be bound by terms at least as protective of TIBCO as those in this End User License Agreement ("Authorized Users"); (c) sublicense, transfer, assign, distribute to any third party, pledge, lease, rent, or commercially share the Software or any of Customer's rights under this Agreement (for the purposes of the foregoing a change in control of Customer is deemed to be an assignment); (d) use the Software for purposes of providing a service bureau, including, without limitation, providing third-party hosting, or third-party application integration or application service provider-type services, or any similar services; (e) use the Software in connection with ultrahazardous activities, or any activity for which failure of the Software might result in death or serious bodily injury to Customer or a third party; or (f) directly or indirectly, in whole or in part, modify, translate, reverse engineer, decrypt, decompile, disassemble, make error corrections to, create derivative works based on, or otherwise attempt to discover the source code or underlying ideas or algorithms of the Software.

Beta and Evaluation Licenses. Notwithstanding the foregoing, if the Software is being provided for demonstration, beta testing, or evaluation purposes, then Customer agrees (a) to use the Software solely for such purposes, (b) that the Software will not be used or deployed in a production or development environment, and (c) that such use shall automatically terminate upon the earlier of thirty days from the date Customer receives the right to install the Software, or Customer's receipt of notice of termination from TIBCO.

Technical Support. Provided Customer has paid applicable support fees (not included with Software fees unless separately listed), TIBCO shall provide support for generally available Software ("Maintenance") on an annual basis commencing on the Purchase Date. Thereafter Maintenance will be automatically renewed for successive one (1) year terms at the then current rates. Customer shall designate at TIBCO's support website https://support.tibco.com/eSupport/newuser.html, the number of authorized contacts as permitted by TIBCO based on the level of Maintenance purchased (contacts are changeable upon 48-hours prior written notice to TIBCO). Each contact may contact TIBCO for problem resolution during TIBCO's published support hours corresponding to the level of Maintenance purchased.

Upon notice from a contact of a Software problem which can be reproduced at a TIBCO Maintenance facility, TIBCO shall use reasonable efforts to correct or circumvent the problem according to its published maintenance objectives. TIBCO reserves the right to make changes only to the most currently available version. TIBCO will use reasonable efforts to support the previously released version of the Software for a maximum of six months.

Maintenance Fees for lapsed Maintenance or the changing of the level of Maintenance shall be mutually agreed upon between Customer and TIBCO. Upgrades, patches, enhancements, bug fixes, new versions and/or new releases of the Software provided from time to time under Maintenance shall be used only as replacements to existing copies, and shall not be deemed to increase the Number of Units, and use thereof shall be governed by the terms of this Agreement, except for the first paragraph of the Limited Warranty and any right of return or refund.

Services. Customer may request additional services ("Services") either in an Ordering Document, or by a separate mutually executed work order, statement of work or other work-request document incorporating the term of this End User License Agreement (each, a "Work Order"). Unless otherwise expressly agreed to in a Work Order, all Services and any work product therefrom shall be (a) performed on a time and materials basis, plus meals, lodging, travel, and other expenses reasonably incurred in connection therewith, (b) deemed accepted upon delivery, and (c) exclusively owned by TIBCO (except for Confidential Information of Customer), including all right, title and intellectual property or other right or interest therein. Each Work Order is intended to constitute an independent and distinct agreement of the parties, notwithstanding that each shall be construed to incorporate all applicable provisions of this End User License Agreement. Fees for Services shall be due and payable in United States dollars net 30 from the date of TIBCO's invoice.

Limited Warranty. If Customer obtained the Software directly from TIBCO, then TIBCO warrants that for a period of thirty (30) days from the Purchase Date: (i) the media on which the Software is furnished will be free of defects in materials and workmanship under normal use; and (ii) the Software will substantially conform to its Documentation. This limited warranty extends only to the original Customer hereunder. Customer's sole and exclusive remedy and the entire liability of TIBCO and its licensors under this limited warranty will be, at TIBCO's option, repair, replacement, or refund of the Software and applicable Maintenance fees, in which event this End User License Agreement shall terminate upon refund thereof.

This warranty does not apply to any Software which (a) is licensed for beta, evaluation, testing or demonstration purposes for which TIBCO does not receive a license fee, (b) has been altered or modified, except by TIBCO, (c) has not been installed, operated, repaired, or maintained in accordance with instructions supplied by TIBCO, (d) has been subjected to abnormal physical or electrical stress, misuse, negligence, or accident, or (e) is used in violation of any other term of this End User License Agreement. Customer agrees to pay TIBCO for any Maintenance or Services provided by TIBCO related to a breach of the foregoing on a time, materials, travel, lodging and other reasonable expenses basis. If Customer obtained the Software from a TIBCO reseller or distributor, the terms of any warranty shall be as provided by such reseller or distributor, and TIBCO provides Customer no warranty with respect to such Software.

EXCEPT AS SPECIFIED IN THIS LIMITED WARRANTY, THE SOFTWARE, MAINTENANCE AND SERVICES ARE PROVIDED "AS

TIBCO Administrator EMS Plug-in Reference

Page 64: Tib Admin Ems Usr

54 | TIBCO Software Inc. End User License Agreement

IS", ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS, AND WARRANTIES INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTY OR CONDITION OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, SATISFACTORY QUALITY OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE, ARE HEREBY EXCLUDED TO THE EXTENT ALLOWED BY APPLICABLE LAW. CERTAIN THIRD PARTY SOFTWARE MAY BE PROVIDED TO CUSTOMER ALONG WITH CERTAIN TIBCO SOFTWARE AS AN ACCOMMODATION TO CUSTOMER. THIS THIRD PARTY SOFTWARE IS PROVIDED "AS IS". CUSTOMER MAY CHOOSE NOT TO USE THIRD PARTY SOFTWARE PROVIDED AS AN ACCOMMODATION BY TIBCO. NO WARRANTY IS MADE REGARDING THE RESULTS OF ANY SOFTWARE, MAINTENANCE OR SERVICES OR THAT THE SOFTWARE WILL OPERATE WITHOUT ERRORS, PROBLEMS OR INTERRUPTIONS, OR THAT ERRORS OR BUGS IN THE SOFTWARE WILL BE CORRECTED, OR THAT THE SOFTWARE'S FUNCTIONALITY, MAINTENANCE OR SERVICES WILL MEET CUSTOMER'S REQUIREMENTS. NO TIBCO DEALER, DISTRIBUTOR, AGENT OR EMPLOYEE IS AUTHORIZED TO MAKE ANY MODIFICATIONS, EXTENSIONS OR ADDITIONS TO THIS WARRANTY.

Indemnity. If Customer obtained the Software from TIBCO directly, then TIBCO agrees at its own expense to defend or, at its option, to settle, any claim or action brought against Customer to the extent it is based on a claim that the unmodified Software infringes any patent issued by the United States, Canada, Australia, Japan, or any member of the European Union, or any copyright, or any trade secret of a third party; and TIBCO will indemnify and hold Customer harmless from and against any damages, costs and fees reasonably incurred (including reasonable attorneys' fees) that are attributable to such claim or action and which are assessed against Customer in a final judgment; provided that TIBCO is promptly notified in writing of such claim, TIBCO has the exclusive right to control such defense and/or settlement, and Customer shall provide reasonable assistance (at TIBCO's expense) in the defense thereof. In no event shall Customer settle any claim, action or proceeding without TIBCO's prior written approval. In the event of any such claim, litigation or threat thereof, TIBCO, at its sole option and expense, shall (a) procure for Customer the right to continue to use the Software or (b) replace or modify the Software with functionally equivalent software. If such settlement or modification is not commercially reasonable (in the reasonable opinion of TIBCO), TIBCO may cancel this End User License Agreement upon sixty days prior written notice to Customer, and refund to Customer the unamortized portion of the license fees paid to TIBCO by Customer based on a five-year straight-line depreciation. This Section states the entire liability of TIBCO with respect to the infringement of any intellectual property rights, and Customer hereby expressly waives any other liabilities or obligations of TIBCO with respect thereto. The foregoing indemnity shall not apply to the extent any infringement could have been avoided by use of the then-current release.

Limitation of Liability. EXCEPT AS PROVIDED UNDER INDEMNITY OR RESULTING FROM A BREACH OF CONFIDENTIALITY (THE "EXCLUDED MATTERS"), IN NO EVENT WILL EITHER PARTY OR TIBCO'S LICENSORS BE LIABLE FOR ANY LOST DATA, LOST REVENUE, LOST PROFITS, DAMAGE TO REPUTATION, BUSINESS INTERRUPTION, OR ANY OTHER INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL, PUNITIVE, EXEMPLARY OR ANY SIMILAR TYPE DAMAGES ARISING OUT OF THIS AGREEMENT, THE USE OR THE INABILITY TO USE THE SOFTWARE, OR THE PROVISION OF ANY MAINTENANCE OR SERVICES, EVEN IF A PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. EXCEPT FOR THE EXCLUDED MATTERS, IN NO EVENT SHALL A PARTY BE LIABLE TO THE

OTHER, WHETHER IN CONTRACT, TORT (INCLUDING ACTIVE OR PASSIVE NEGLIGENCE), BREACH OF WARRANTY, CLAIMS BY THIRD PARTIES OR OTHERWISE, EXCEED THE PRICE PAID BY CUSTOMER UNDER THE APPLICABLE ORDERING DOCUMENT.

THE FOREGOING LIMITATIONS SHALL APPLY EVEN IF THE ABOVE-STATED REMEDY OR LIMITED WARRANTY FAILS OF ITS ESSENTIAL PURPOSE. BECAUSE SOME STATES OR JURISDICTIONS DO NOT ALLOW LIMITATION OR EXCLUSION OF CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE LIMITATION MAY NOT APPLY TO CUSTOMER.

Confidentiality. "Confidential Information" means the terms of this End User License Agreement; all information marked by the disclosing party as proprietary or confidential; any provided software, related documentation or related performance test results derived by Customer; and any methods, concepts or processes utilized in provided software or related documentation. Confidential Information shall remain the sole property of the disclosing party and shall not be disclosed to any non-Authorized User of either TIBCO or Customer without the prior written consent of the disclosing party. If Confidential Information is communicated orally, such communication shall be confirmed as "Confidential" in writing within thirty days of such disclosure. The parties agree to protect the Confidential Information of the other in the same manner it protects the confidentiality of similar information and data of its own (and at all times exercising at least a reasonable degree of care). Except with respect to the Software, items will not be deemed Confidential Information if (i) available to the public other than by a breach of an agreement with TIBCO, (ii) rightfully received from a third party not in breach of any obligation of confidentiality, (iii) independently developed by one party without use of the Confidential Information of the other; (iv) known to the recipient at the time of disclosure (other than under a separate confidentiality obligation); or (v) produced in compliance with applicable law or court order, provided the other party is given reasonable notice of the same. Both parties agree to indemnify the other for any damages the other may sustain resulting from their unauthorized use and/or disclosure of the other's Confidential Information. Such damages shall include reasonable expenses incurred in seeking both legal and equitable remedies. To the extent required by law, at Customer's request, TIBCO shall provide Customer with the interface information needed to achieve interoperability between the Software and another independently created program, on payment of TIBCO's applicable fee. Customer agrees to observe obligations of confidentiality with respect to such information.

Export. Software, including technical data, is subject to U.S. export control laws, including the U.S. Export Administration Act and its associated regulations, and may be subject to export or import regulations in other countries. Customer agrees to comply strictly with all such regulations and agrees to obtain all necessary licenses to export, re-export, or import Software.

Government Use. If the Customer is an agency, department, or other entity of the United States Government ("Government"), the use, duplication, reproduction, release, modification, disclosure or transfer of the Software, or any related documentation of any kind, including technical data or manuals, is restricted in accordance with Federal Acquisition Regulation ("FAR") 12.212 for civilian agencies and Defense Federal Acquisition Regulation Supplement ("DFARS") 227.7202 for military agencies. The Software is commercial computer software and commercial computer software documentation. Use of the Software and related documentation by the Government is further restricted in accordance with the terms of this Agreement, and any modification thereto.

TIBCO Administrator EMS Plug-in Reference

Page 65: Tib Admin Ems Usr

TIBCO Software Inc. End User License Agreement | 55

Orders. An Ordering Document shall be deemed accepted only by issuance of a TIBCO invoice and solely for purposes of administrative convenience. None of the terms of the Ordering Document (other than the Software product name, Number of Units, level of Maintenance, description of Services, and fees due in connection therewith) shall apply for any reason or purpose whatsoever, regardless of any statement on any Ordering Document to the contrary, unless countersigned by an officer of TIBCO. This Agreement constitutes the entire agreement between the parties with respect to the use of the Software, Maintenance and Services, and supersedes all proposals, oral or written, and all other representations, statements, negotiations and undertakings relating to the subject matter hereof. All orders of Software, Maintenance or Services by Customer to TIBCO shall be deemed to occur with or without reference to, under the terms of this End User License Agreement, unless expressly superseded by a signed written agreement between the parties. Software shall be delivered electronically, and such delivery shall be deemed complete when the Software is made available for download by Customer.

Term and Termination. Maintenance or Services may be terminated: (a) by either party upon a default of the other, such default remaining uncured for fifteen days from written notice from the non-defaulting party; (b) upon the filing for bankruptcy or insolvency of the other party, (c) by either party upon prior written notice at least ninety (90) days prior to the end of any annual Maintenance term; or (d) by Customer (for Services), upon ten days prior written notice. Termination of Maintenance or Services shall not terminate this End User License Agreement. Customer may terminate this End User License Agreement in its entirety at any time by destroying all copies of the Software. Upon termination of this End User License Agreement in its entirety, for any reason, Customer must cease using and return or destroy all copies of the Software. Customer's obligation to pay accrued charges and any fees due as of the date of termination, as well as the sections entitled "Confidentiality", "Limited Warranty" and "Limitation of Liability" shall survive any such termination.

Authority. You hereby represent and warrant that you have full power and authority to accept the terms of this End User License Agreement on behalf of Customer, and that Customer agrees to be bound by this End User License Agreement.

General. Fees on the Ordering Document (all to be paid on the latter of thirty days from Invoice by TIBCO or the date set forth in the Ordering Document) do not include sales, use, withholding, value-added or similar taxes, and Customer agrees to pay all sales, use, value-added, goods and services, consumption, withholding, excise and any other similar taxes or government charges, exclusive of TIBCO's income tax. Customer agree to pay all reasonable costs incurred (including reasonable attorneys' fees) in collecting past due amounts. Except as set forth in the Section entitled "Limited Warranty" all fees paid under or in connection with this End User License Agreement are non-refundable and no right of set-off exists. All payments of fees due shall be made in U.S. dollars, net 30 from Purchase Date, or, for any other amounts coming due hereafter, net 30 from TIBCO's invoice. A service charge of one and one-half percent per month will be applied to all invoices that are not paid on time. No delay in the performance of any obligation by either party, excepting all obligations to make payment, shall constitute a breach of this End User License Agreement to the extent caused by force majeure. Customer hereby grants TIBCO and its independent auditors the right to audit Customer's compliance with this End User License Agreement. If any portion of this End User License Agreement is found to be void or unenforceable, the remaining provisions shall remain in full force and effect. This End User License Agreement shall be governed by and construed in accordance with the laws of the State of California, United States of America, as if performed wholly within the state and without giving effect to the principles of conflict of

law. The United Nations Convention on Contracts for the International Sale of Goods is excluded from application hereto. If any portion hereof is found to be void or unenforceable, the remaining provisions of this Agreement shall remain in full force and effect.

Definitions. In connection with this End User License Agreement the following capitalized terms shall have the following meaning: "Connection" means for TIBCO SmartSockets and TIBCO SmartMQ, any network protocol link established with such Software (directly or indirectly) to any other entity, including but not limited to software, firmware or hardware; "Connected Processor" means a Processor that produces information or messages consumed by the relevant Software (excluding Processors on devices such as routers, switches, proxies, HTTP or application servers configured to substantially pass-through information or messages to TIBCO Software); "Customer" means the original purchaser or licensee of the Software and any permitted successors and assigns; "Developer" means a Named User of a TIBCO Software product for use only in Non-Production; "Documentation" means text material that accompanies the TIBCO Software on delivery; "Enterprise" means an unlimited Number of Units of the TIBCO Software set forth in an Ordering Document, deployed by Customer for a period of one (1) year (unless otherwise set forth in an Ordering Document) from the Effective Date (the "Enterprise Term"), at which time, the Number of Units then deployed in Production and Non-Production use by Customer becomes fixed and Customer may not thereafter deploy additional Units. During the Enterprise Term, Customer's right to deploy an unlimited Number of Units does not extend to any entity which acquires, is acquired by, merged into, or otherwise combined with Customer. Customer hereby agrees to provide TIBCO, within sixty (60) days after the end of the Enterprise Term, with written notice of the Number of Units deployed at the end of the Enterprise Term by License Type, Platform and Unit; "License Type" means the environment in which the TIBCO Software may be used (including without limitation, Production, Non-Production); "MSU" means Millions of Service Units per hour, based on the then current MSU rating established by IBM for IBM and IBM compatible hardware which is used for software pricing (not necessarily a direct indication of relative processor capacity) as set forth in IBM's generally available Large System Performance Reference; "Named User" means an identifiable individual, not necessarily named at the time of a license grant, designated by Customer to access the TIBCO Software, regardless of whether or not the individual is actively using the TIBCO Software at any given time; "Non-Production" means a non-operational environment into which the TIBCO Software may be installed, which is not processing live data, which is not running any operations of the Customer and which has not been deployed to permit any users to access live data. Non-Production environments include development, cold back-up, high availability, hot standby, and test environments; "Number of Units" means the cumulative number of copies of TIBCO Software licensed for use by type of Unit as set forth in this Agreement, or in an Ordering Document, and including, if applicable, as reported by Licensee upon expiration of a Project or Enterprise Term; "Ordering Document" means any purchase order or similar document or agreement requesting Software, Maintenance or Services; "Platform" means the operating system set forth in an Ordering Document; "Processor" means a central processing unit ("CPU") on which the TIBCO Software is licensed to run and which for the purposes of counting Processors on multicore chips, the number of Processors is the number of CPUs times the number of cores multiplied by .75.; "Processor Source Locked" means the number of connections to a single database made possible by (or licensed for) the relevant TIBCO Software regardless of how many Processors are used by the system or environment which is accessing the database; "Production" means an operational environment into which the licensed TIBCO Software has been installed, which is processing live data and which has been deployed so that the intended users of the

TIBCO Administrator EMS Plug-in Reference

Page 66: Tib Admin Ems Usr

56 | TIBCO Software Inc. End User License Agreement

environment are able to access the live data; "Project" means an unlimited Number of Units for the License Type listed in this Agreement, to be deployed by Customer solely in connection with the undertaking described under an Ordering Document for a period of one (1) year (unless otherwise set forth in this Agreement) from the Effective Date (the "Project Term"), at which time, the Number of Units then deployed in Production and Non-Production use by Customer becomes fixed and Customer may not thereafter deploy additional Units. During the Project Term, Customer's right to deploy an unlimited Number of Units does not extend to any entity which acquires, is acquired by, merged into, or otherwise combined with Customer. Customer hereby agrees to provide TIBCO, within sixty (60) days after the end of the Project Term, with written notice of the Number of Units deployed at the end of the Project Term by Unit and License Type. "Purchase Date" means the date of the Ordering Document is accepted by TIBCO; "Server Instance" means a computer with 1 CPUs (unless otherwise specified in the Agreement) performing common services for multiple other machines; "Software" means the most current generally available object code version (as of the Purchase Date) of the software products listed in an Ordering Document (except as provided for beta or evaluation licenses), in whole and in part, including its Documentation; "Third Party Software" means third-party software identified by its company and/or product name, the provision of which by TIBCO is made solely as an accommodation and in lieu of Customer purchasing a license to Third Party Software directly from the third party vendor; "Trading Partner" means an entity or individual with which the Licensee engages in electronic commerce by means of TIBCO Software in accordance with this Agreement; "Unit" means a license restriction describing the manner in which a copy (or multiple copies) of the TIBCO Software may be deployed (including, without limitation, Processor, Named User, Connected Processor, and Processor Source Locked) and is the mechanism used to determine the Number of Units licensed pursuant to an Ordering Document.

Special Product Provisions. TIBCO BusinessPartner: Customer may sublicense to third parties ("Partners") up to the total Number of Copies of TIBCO BusinessPartner, provided that for every such sublicense, the Number of Copies Customer is licensed to use shall be reduced by the same number, and provided further that prior to delivery of TIBCO BusinessPartner to a Partner, such Partner agrees in writing (a) to be bound by terms and conditions at least as protective of TIBCO as the terms of this Agreement, (b) that TIBCO BusinessPartner be used solely to communicate with Customer's implementation of TIBCO BusinessConnect, and (c) for such Partner to direct all technical support and Maintenance questions directly to Customer. Customer agrees to keep records of the Partners to which it distributes TIBCO BusinessPartner, and to provide TIBCO the names thereof (with an address and contact name) within sixty days of the end of each quarter. Embedded/Bundled Products. Some TIBCO Software embeds or bundles other TIBCO Software (e.g., TIBCO InConcert bundles TIBCO Rendezvous). Use of such embedded or bundled TIBCO Software is solely to enable the functionality of the TIBCO Software licensed on the Cover Page, and may not be used or accessed by any other TIBCO Software, or for any other purpose. Open Source Software: If Customer uses Open Source software in conjunction with the TIBCO Software, Customer must ensure that its use does not: (i) create, or purport to create, obligations of use with respect to the TIBCO Software; or (ii) grant, or purport to grant, to any third party any rights to or immunities under TIBCO's intellectual property or proprietary rights in the TIBCO Software. You also may not combine the TIBCO Software with programs licensed under the GNU General Public License ("GPL") in any manner that could cause, or could be interpreted or asserted to cause, the TIBCO Software or any modifications thereto to become subject to the terms of the GPL.

Version 5.4, 6/10

TIBCO Administrator EMS Plug-in Reference