Tib Admin Ems Usr
Tib Admin Ems Usr
Tib Admin Ems Usr
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
TIBCO Administrator Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
TIBCO Runtime Agent Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
TIBCO Enterprise Message Service Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
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
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.
• In large code samples, to indicate the parts of the sample that are of
particular interest.
• In command syntax, to indicate the default value.
Key Key name separated by a plus sign indicate keys pressed simultaneously. For
combinations example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the
other. For example: Esc, Ctrl+Q.
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 In command syntax, indicates the default parameter for a command.
font
For example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]
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}
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.
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
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.
Security Dialog
The 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.
Server Parameters
Main Pane
This pane displays the following information about the server instance:
Parameter Description
Server Name Name of this TIBCO Enterprise Message Service server.
Parameter Description
Inbound Current number of messages received per second by this
Message Rate server.
Outbound Byte Current number of bytes sent per second by this server.
Rate
Log File Name Name of log file in which events are logged.
Log File Recommended maximum log file size before log file is
Maximum Size rotated.
Parameter Description
General
Parameter Description
Maximum Maximum memory the server can use for messages. This
Message parameter allows you to limit the amount of memory used
Memory 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 To lessen the overhead costs associated with malloc and
Block Size free, the server pre-allocates pools of storage for
messages. These parameters determine the behavior of
Message Pool
these pools. Performance varies depending on operating
Block Size
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
Message When this parameter is selected and the maximum
Swapping 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.
Parameter Description
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.
Parameter Description
Security
Server Password Click set... to change the password used to connect to the
TIBCO Enterprise Message Service server.
Statistics
Rate Interval Set the interval over which statistics for routes,
(ms) destinations, producers, and consumers are averaged.
Setting this parameter to zero disables the average
calculation.
Parameter Description
Server Rate Set the interval over which overall server statistics are
Interval 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.
Parameter Description
Default Select to set the trace options to the default set. This
includes:
• INFO
• WARNING
• ACL
• LIMITS
• ROUTE
• ADMIN
• RVADV
• CONNET_ERROR
• CONFIG
• MSG
Route Debug Select to print a message for each message that is sent over
a route.
Parameter Description
SSL Debug Select to print messages that trace the establishment of
SSL connections.
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 Display
The following information is displayed in the main display. Click the queue name
for more information, or to make changes to the queue.
Parameter Description
Name Name of a queue. Click this name to view additional
information about the queue and to modify the queue.
Parameter Description
Pending Msg Total size of pending messages for this queue.
Size
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
Properties
Parameter Description
Temporary A check mark indicates the queue is temporary.
Parameter Description
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.
Parameter Description
Sender Name Specifies that messages sent to this destination must
Enforced 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
Exclusive Defines how the server delivers messages to queue
(Inherited) 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
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.
Parameter Description
Max Size Queues can specify the maxbytes property in the form:
maxbytes=NNNNN where NNNN is the number of bytes.
Flow Control Max Specify the target maximum storage for pending messages
Size on the destination.
Msg Trace Select the message trace level to use. Either, None, Basic or
Detail.
JNDI Name Set of names through which this queue is available from
Bindings its connection factory. Click Bind to add a JNDI name or
Unbind to remove the selected JNDI name.
Parameter Description
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
Parameter Description
Inbound Byte Number of bytes per second arriving for this queue.
Rate
Inbound Total Total number of bytes that arrived since this queue was
Size started.
Outbound Byte Number of bytes per second being sent by this queue.
Rate
Parameter Description
Producers and Consumers
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 Display
The 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.
In Byte Rate Number of bytes per second arriving for this topic.
Parameter Description
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
Properties
Parameter Description
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.
Parameter Description
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.
Parameter Description
Sender Name Specifies that messages sent to this destination must
Enforced 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.
Flow Control Max Specify the target maximum storage for pending
Size messages on the destination.
Msg Trace Select the message trace level to use. Either, None, Basic
or Detail.
Parameter Description
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.
JNDI Name Set of names through which this topic is available from its
Bindings 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
Parameter Description
Durable Count Current number of durable subscribers for this topic.
Inbound Byte Number of bytes per second arriving for this topic.
Rate
Inbound Total Total number of bytes that arrived since this topic was
Size started.
Inbound Total Total number of messages that arrived since this topic was
Messages started.
Outbound Byte Number of bytes per second being sent by this topic.
Rate
Parameter Description
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.
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 Display
The 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.
Pending Msg Pending message size limit for the durable subscriber.
Size
User Name Name of the user of this durable subscriber. If the durable
subscriber is currently offline, the value in this column is
offline.
Parameter Description
General
Topic Name Select the topic for which you wish to create a durable
from the pop-up.
Statistics
Main Display
The next table lists connection factory information shown in the main display:
Property Description
JNDI Name List of names that this factory is bound to in the default
JNDI.
Parameter Description
General
Parameter Description
Client ID The client ID associated with connections created by this
factory.
Connect Attempt Sets the number of times that this connection object can
Count attempt to establish a connection to the server.
Reconnect Sets the number of times that this connection object can
Attempt Count attempt to reconnect to the server after a network
disconnect.
JNDI Name Allows you to view and edit the JNDI name bindings. You
Bindings can create multiple JNDI name bindings for the same
topic or queue.
SSL Parameters
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
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 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 Specifies whether the server should verify the name in the
Name 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
SSL Expected Specifies the name the server is expected to have in the
Host Name 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 The path for the installed entropy gathering daemon
Gathering (EGD), if one is installed. This daemon is used to generate
Daemon random numbers for the TIBCO Enterprise Message
Service server.
Connections Parameters
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 Display
The following information is displayed in the main display.
Parameter Description
ID Unique connection ID. Each connection is assigned a
unique, numeric ID that can be used to delete the
connection.
The Producers and Consumers pane allows you to view information about
producers and consumers associated with this server.
Main Display
The 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.
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.
Destination Details
When 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.
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 Display
The 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.
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.
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.
Parameter Description
Out Total Bytes Total size of messages, in bytes, going out of this route.
Parameter Description
General
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
Parameter Description
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 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
SSL Verify When checked, specifies whether the server should verify
Hostname 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 Specifies the name the server is expected to have in the
Hostname 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 The path for the installed entropy gathering daemon
Gathering (EGD), if one is installed. This daemon is used to generate
Daemon random numbers for the TIBCO Enterprise Message
Service server.
Monitoring
Inbound Byte Number of bytes per second coming into this route.
Rate
Parameter Description
Inbound Total Total size of messages, in bytes, coming into this route.
Size
Outbound Byte Number of bytes per second going out of this route.
Rate
Outbound Total Total size of messages, in bytes, going out of this route.
Size
Bridges Parameters
Parameter Description
Source Name of the destination being bridged from.
New Pane
You 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 Type and Select the type of destination (topic or queue) being
Name bridged from. Click Pick Source to display a list of topics
or queues to choose from.
Target Type and Select the type of destination (topic or queue) being
Name bridged to. Click Pick Target to display a list of topics or
queues to choose from.
Transports Parameters
Parameter Description
Name Name of the transport.
Queue Delivery Delivery mode for messages imported from this transport
Mode to a queue.
Topic Delivery Delivery mode for messages imported from this transport
Mode to a topic.
Export Properties Indicates whether or not the JMS message properties are
included in messages exported on this transport.
Transactions Parameters
Parameter Description
Data Transaction data.
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.
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.
5. Click OK.
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.
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.
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.
All spaces before and after the name are removed. Spaces inside the name are
retained.
Adding Groups
To 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.
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.
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.
Limitation of Liability. EXCEPT AS PROVIDED UNDER Government Use. If the Customer is an agency, department, or other
INDEMNITY OR RESULTING FROM A BREACH OF entity of the United States Government ("Government"), the use,
CONFIDENTIALITY (THE "EXCLUDED MATTERS"), IN NO EVENT duplication, reproduction, release, modification, disclosure or transfer
WILL EITHER PARTY OR TIBCO'S LICENSORS BE LIABLE FOR of the Software, or any related documentation of any kind, including
ANY LOST DATA, LOST REVENUE, LOST PROFITS, DAMAGE TO technical data or manuals, is restricted in accordance with Federal
REPUTATION, BUSINESS INTERRUPTION, OR ANY OTHER Acquisition Regulation ("FAR") 12.212 for civilian agencies and
INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL, PUNITIVE, Defense Federal Acquisition Regulation Supplement ("DFARS")
EXEMPLARY OR ANY SIMILAR TYPE DAMAGES ARISING OUT OF 227.7202 for military agencies. The Software is commercial computer
THIS AGREEMENT, THE USE OR THE INABILITY TO USE THE software and commercial computer software documentation. Use of
SOFTWARE, OR THE PROVISION OF ANY MAINTENANCE OR the Software and related documentation by the Government is further
SERVICES, EVEN IF A PARTY HAS BEEN ADVISED OF THE restricted in accordance with the terms of this Agreement, and any
POSSIBILITY OF SUCH DAMAGES. EXCEPT FOR THE EXCLUDED modification thereto.
MATTERS, IN NO EVENT SHALL A PARTY BE LIABLE TO THE