Tib Amx Administration

TIBCO ActiveMatrix Service Bus
Administration
Software Release 3.3.0
September 2013
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED
OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED
ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED
SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR
ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT,
OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT
WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS
DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR
CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF
THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR
USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and treaties.
No part of this document may be reproduced in any form without the written authorization of TIBCO Software
Inc.
TIBCO, Two-Second Advantage, TIBCO ActiveMatrix, and TIBCO Enterprise Message Service are either registered
trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition (J2EE),
and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation in the
U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their respective
owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL
OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME
TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC
OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES
ARE PERIODICALLYADDED 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 (c) 2005-2013 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
TIBCO ActiveMatrix Service Bus Administration
TOC | 5
Contents
Preface................................................................................................13
TIBCO Product Documentation..............................................................................................14
Other TIBCO Product Documentation....................................................................................15
Typographical Conventions....................................................................................................16
Connecting with TIBCO Resources........................................................................................19
Chapter 1
Introduction....................................................................21
Design....................................................................................................................................22
Runtime Environment.............................................................................................................23
Logical View of the Enterprise ....................................................................................23
Physical View of the Enterprise ..................................................................................24
Administration.........................................................................................................................26
Governance.................................................................................................................27
Chapter 2 Administrator Interfaces................................................29

Web Interface.........................................................................................................................30
Logging in to the Web Interface...................................................................................30
List View......................................................................................................................30
Graphical View.............................................................................................................32
Object States...............................................................................................................34
Command-Line Interface........................................................................................................40
Invoking the Command-Line Interface.........................................................................40
Build Files....................................................................................................................41
AMXAdminTask...........................................................................................................44
Actions.........................................................................................................................48
Data Files....................................................................................................................48
Objects........................................................................................................................49
Supported Objects.......................................................................................................50
Object Formats............................................................................................................51
Object Navigation........................................................................................................52
Inter-Object Relationships...........................................................................................53
Property File Reference...............................................................................................53
Chapter 3 Administrator Server Management..............................55

Administration Support for Older Hosts and Nodes...............................................................57
Creating an Administrator Server...........................................................................................58
Starting and Stopping an Administrator Server......................................................................59
6 | TOC
Administrator Configuration Reference..................................................................................60

Plug-Ins..................................................................................................................................61
Plug-Ins Reference......................................................................................................61
Notification Server..................................................................................................................62
Editing the Notification Server Configuration...............................................................62
Forcing a Reconnection...............................................................................................63
Chapter 4
Environments.................................................................65
Creating an Environment........................................................................................................67
CLI...............................................................................................................................67
Environment General Reference............................................................................................68
Environment Configuration Reference...................................................................................69
Messaging Bus.......................................................................................................................71
Configuring an Environment's Messaging Bus............................................................71
Messaging Bus Reference..........................................................................................72
Chapter 5 Hosts...............................................................................75
Host Processes......................................................................................................................76
Creating a TIBCO Host Instance............................................................................................77
Assigning a Host to An Environment......................................................................................78
CLI...............................................................................................................................78
Registering a TIBCO Host Instance as a Windows Service...................................................79
Starting a TIBCO Host Instance.............................................................................................80
Stopping a TIBCO Host Instance...........................................................................................81
Enabling Secure Communication between a Host and an Administrator Server...................82
Unregistering Hosts................................................................................................................83
GUI..............................................................................................................................83
CLI...............................................................................................................................83
Binding Hosts to an Administrator Server..............................................................................84
Discover Hosts Reference ..........................................................................................84
Register Host Reference.............................................................................................85
Diagnostics.............................................................................................................................86
Accessing and Using Diagnostics Commands............................................................86
Retrieving Log Files for Hosts and Nodes from Administrator.....................................87
References.............................................................................................................................88
Hosts Reference..........................................................................................................88
Host General Reference..............................................................................................88
Host Configuration Reference.....................................................................................89
Host Substitution Variables Reference........................................................................90
Host Resource Instances Reference...........................................................................90
Chapter 6 Nodes..............................................................................93
Node Processes.....................................................................................................................95
TOC | 7
Developer Node......................................................................................................................96
Navigating to a Nodes List.....................................................................................................97
Creating a Node.....................................................................................................................98
GUI..............................................................................................................................98
CLI...............................................................................................................................99
Editing a Node......................................................................................................................100
GUI............................................................................................................................100
CLI.............................................................................................................................100
Updating the Port Number for a Node.......................................................................100
Updating the JVM Configuration for a Node..............................................................101
Enabling and Disabling the Java Security Manager..................................................102
Enabling and Disabling Debuggers...........................................................................102
Installing or Syncing Nodes..................................................................................................104
GUI............................................................................................................................104
CLI.............................................................................................................................105
Uninstalling Nodes...............................................................................................................106
GUI............................................................................................................................106
CLI.............................................................................................................................106
Starting Nodes.....................................................................................................................107
GUI............................................................................................................................107
CLI.............................................................................................................................107
Manually Restarting Nodes..................................................................................................108
Stopping Nodes....................................................................................................................109
GUI............................................................................................................................109
CLI.............................................................................................................................109
Deleting Nodes.....................................................................................................................110
GUI............................................................................................................................110
CLI.............................................................................................................................110
Capturing Thread Dump for a Node from Administrator.......................................................111
References...........................................................................................................................112
Node General Reference...........................................................................................112
Node Configuration Reference..................................................................................112
Node Substitution Variables Reference.....................................................................115
Node Resource Instances Reference........................................................................116
Transaction Recovery Configuration.....................................................................................117
Configuration Properties for HOWL Log Files...........................................................118
Deleting HOWL Logs ................................................................................................118
Chapter 7 Applications..................................................................119
Creating an Application........................................................................................................122
GUI............................................................................................................................122
CLI.............................................................................................................................124
Distributing an Application....................................................................................................125
GUI............................................................................................................................125
8 | TOC
CLI.............................................................................................................................125
Application Dependencies....................................................................................................126
Deploying Applications.........................................................................................................127
GUI............................................................................................................................127
CLI.............................................................................................................................128
Undeploying Applications.....................................................................................................129
GUI............................................................................................................................129
CLI.............................................................................................................................130
Starting Applications............................................................................................................131
GUI............................................................................................................................131
CLI.............................................................................................................................131
Stopping Applications...........................................................................................................132
GUI............................................................................................................................132
CLI.............................................................................................................................132
Deleting Applications............................................................................................................134
GUI............................................................................................................................134
CLI.............................................................................................................................134
Editing an Application...........................................................................................................136
GUI............................................................................................................................136
Upgrading an Application..........................................................................................136
Upgrading an Application across Nodes...................................................................138
Displaying an Application's Dependencies...........................................................................139
Displaying Application Versions............................................................................................140
Displaying an Application's Components.............................................................................141
Displaying an Application's Bindings....................................................................................142
References...........................................................................................................................143
Applications Reference..............................................................................................143
Application General Reference..................................................................................143
Application Configuration Reference.........................................................................145
Application Substitution Variables Reference............................................................146
Application Distribution Reference.............................................................................147
Application Folders...............................................................................................................148
Creating a Folder.......................................................................................................148
Renaming a Folder....................................................................................................149
Deleting a Folder.......................................................................................................149
Moving an Application to a Folder.............................................................................150
Services and References.....................................................................................................151
Displaying the Bindings for a Service or a Reference ..............................................151
Adding a Binding to a Service...................................................................................151
Configuring a Binding for a Reference.......................................................................152
Promoting a Service to the Environment...................................................................152
Promoting a Reference to the Environment...............................................................153
References................................................................................................................153
Bindings.....................................................................................................................155
Wire to Binding Reference.........................................................................................180
TOC | 9
Properties.............................................................................................................................181
Setting a Property Value............................................................................................181
Editable Properties Reference...................................................................................183
Non-Editable and Policy Set Properties Reference...................................................183
Chapter 8 Resource Templates.....................................................185

Resource Templates With Scope..........................................................................................186
Creating a Resource Template.............................................................................................189
GUI............................................................................................................................189
CLI.............................................................................................................................190
Editing a Resource Template................................................................................................192
CLI.............................................................................................................................192
Incremental Editing of a Resource Template........................................................................194
Renaming a Resource Template..........................................................................................195
Changing the Scope of a Resource Template......................................................................196
CLI.............................................................................................................................197
Deleting Resource Templates...............................................................................................198
CLI.............................................................................................................................198
Creating an Obfuscated Password.......................................................................................199
Configuring Mutual Authentication.......................................................................................200
Configuring Third-Party JDBC Drivers..................................................................................201
Adding an Updated JDBC Driver .........................................................................................202
Configuring Third-Party JMS Drivers....................................................................................203
Configuring the Read Response Timeout for an LDAP Connection.....................................204
Keystores..............................................................................................................................205
Creating a Keystore Containing a User Name and Password..............................................206
References...........................................................................................................................208
Hibernate...................................................................................................................208
HTTP Client...............................................................................................................210
HTTP Connector........................................................................................................214
JDBC.........................................................................................................................217
JMS Resource Templates..........................................................................................221
LDAP Connection......................................................................................................228
SMTP.........................................................................................................................230
Teneo.........................................................................................................................231
Thread Pool...............................................................................................................234
Security Resource Templates....................................................................................235
Chapter 9 Resource Instances.....................................................255

Creating Resource Instances on Nodes...............................................................................256
GUI............................................................................................................................256
CLI.............................................................................................................................258
Installing Resource Instances on Nodes..............................................................................259
10 | TOC
GUI............................................................................................................................259
CLI.............................................................................................................................261
Uninstalling Resource Instances from Nodes......................................................................263
GUI............................................................................................................................263
CLI.............................................................................................................................264
Deleting Resource Instances from Nodes............................................................................265
GUI............................................................................................................................265
CLI.............................................................................................................................266
Resource Instances Reference............................................................................................267
Chapter 10 Substitution Variables................................................269

Creating a Substitution Variable...........................................................................................272
GUI............................................................................................................................272
CLI.............................................................................................................................272
Chapter 11 Software Management...............................................275

Features...............................................................................................................................276
Adding Features to the Enterprise.............................................................................276
Adding a Feature to a Node......................................................................................277
Adding Third-Party Libraries to Nodes.......................................................................278
Setting Node Features...............................................................................................278
Removing Features from a Node...............................................................................279
Deleting Features from the Enterprise.......................................................................280
Feature Reference.....................................................................................................280
Features Reference...................................................................................................281
Application Templates...........................................................................................................283
Adding Application Templates to the Enterprise........................................................283
Deleting Application Templates..................................................................................284
Application Template Reference................................................................................284
Versions................................................................................................................................285
Distributed Application Archives...........................................................................................286
Uploading a Distributed Application Archive..............................................................286
Distributed Application Archive Reference................................................................287
Chapter 12 Governance.................................................................289
Dashboards..........................................................................................................................290
Displaying the Dashboards........................................................................................290
Filter Criteria Gadget.................................................................................................290
Setting Dashboard Preferences................................................................................291
Drilling Down into Objects.........................................................................................292
Dashboard Controls...................................................................................................292
Users, Groups, and Permissions..........................................................................................293
Users.........................................................................................................................293
TOC | 11
Superusers................................................................................................................294
Groups.......................................................................................................................296
Permissions...............................................................................................................300
Log Viewer............................................................................................................................308
Running Searches.....................................................................................................308
Search Builder...........................................................................................................309
Log Table...................................................................................................................315
Deleting Log Entries..................................................................................................316
Monitoring.............................................................................................................................318
Monitoring Service.....................................................................................................318
Disabling the Monitoring Service...............................................................................318
Configuring a Fault Tolerant Monitoring Service........................................................319
Updating the Messaging Configuration ....................................................................320
Metrics Reference.....................................................................................................321
Chapter 13 Logging.......................................................................329
Log Services........................................................................................................................331
Editing Log Service Properties..................................................................................331
Log Service Property Reference...............................................................................331
Logging Appenders..............................................................................................................333
Creating a Logging Appender....................................................................................333
Logging Appender Reference....................................................................................335
Log Entry Enrichment................................................................................................336
Logging Configurations........................................................................................................339
Navigating to a Logging Configurations List..............................................................339
Creating a Logging Configuration for an Application ................................................340
Creating a Logging Configuration for a Host or a Node ............................................340
Applying a Logging Configuration..............................................................................341
Logging Configuration Reference..............................................................................342
Payload Services..................................................................................................................344
Payload Service Properties Reference......................................................................344
Creating Additional Log and Payload Services....................................................................345
Chapter 14 Secure Communication Channels............................347

Trust Stores..........................................................................................................................350
Creating a Trust Store Keystore.................................................................................350
Configuring a Trust Store...........................................................................................350
Enabling Secure Communication Channels Using Command-Line Scripts.........................352
HTTP Connector .......................................................................................................352
External Database ....................................................................................................352
Database Authentication Realm ...............................................................................353
LDAP Authentication Realm .....................................................................................353
Installing Unlimited Jurisdiction Files....................................................................................354
12 | TOC
TIBCO Credential Service....................................................................................................355
Chapter 15 Network Configuration...............................................357

IPv6 Support........................................................................................................................358
Port Usage...........................................................................................................................360
Chapter 16 UDDI Servers..............................................................361

Registering an SSL-Enabled UDDI Server...........................................................................362
Registering a UDDI Server...................................................................................................363
GUI............................................................................................................................363
CLI.............................................................................................................................363
Setting the Default UDDI Server..........................................................................................365
Configuring SSL Communication ........................................................................................366
Publishing Services in a UDDI Server..................................................................................367
References...........................................................................................................................368
UDDI Server Reference.............................................................................................368
Application UDDI Publication Reference...................................................................369
Chapter 17
NodeUtil......................................................................371
Invoking the NodeUtil Utility..................................................................................................372

NodeUtil Commands............................................................................................................373
Appendix A Troubleshooting........................................................377
Preface
TIBCO ActiveMatrix Service Bus is a scalable and extensible platform for developing, deploying, and
managing applications that conform to a service-oriented architecture.
14 | Preface
TIBCO Product Documentation

This section lists documentation resources you may find useful.
The following documents form the TIBCO ActiveMatrix Service Bus documentation set:
Concepts: Read this manual before reading any other manual in the documentation set. This manual
describes terminology and concepts of the platform. The other manuals in the documentation set assume
you are familiar with the information in this manual.
Development Tutorials: Read this manual for a step-by-step introduction to the process of creating, packaging,
and running composites in TIBCO Business Studio.
Composite Development: Read this manual to learn how to develop and package composites.
Mediation Component Development : Read this manual to learn how to configure and implement Mediation
components.
Mediation API Reference : Read this manual to learn how to develop custom Mediation tasks.
Administration Tutorial: Read this manual for a step-by-step introduction to the process of creating and
starting the runtime version of the product, starting TIBCO ActiveMatrix servers, and deploying
applications to the runtime.
Administration: Read this manual to learn how to manage the runtime and deploy and manage applications.
Hawk ActiveMatrix Plug-in Users Guide: Read this manual to learn about the Hawk plug-in and its optional
configurations.
Installation and Configuration: Read this manual to learn how to install and configure the software.
Release Notes: Read this manual for a list of new and changed features, steps for migrating from a previous
release, and lists of known issues and closed issues for the release.
The documentation for the following features is installed separately:
TIBCO ActiveMatrix Binding Type for EJB
TIBCO ActiveMatrix Binding Type for Adapters
TIBCO ActiveMatrix Implementation Type for TIBCO Adapters
TIBCO ActiveMatrix Implementation Type for Microsoft CLR
TIBCO ActiveMatrix Binding Type for REST
Preface | 15
Other TIBCO Product Documentation

You may find it useful to read the documentation for the following TIBCO products:
TIBCO Enterprise Message Service
16 | Preface
Typographical Conventions
Table 1: General Typographical Conventions
Convention
TIBCO_HOME
ENV_NAME
Use
TIBCO products are installed into an installation environment. A product installed into
an installation environment does not access components in other installation environments.
Incompatible products and multiple instances of the same product must be installed into
different installation environments. An installation environment consists of the following
properties:
Name - Identifies the installation environment. The name is appended to the name of
Windows services created by the installer and is a component of the path to the product
shortcut in the Windows Start > All Programs menu. This name is referenced in
documentation as ENV_NAME .
Path - The folder into which the product is installed. This folder is referenced in
documentation as TIBCO_HOME .
CONFIG_HOME
The folder that stores configuration data generated by TIBCO products. Configuration
data can include sample scripts, session data, configured binaries, logs, and so on. This
folder is referenced in documentation as CONFIG_HOME.
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.
Code example:
public class HelloWorldImpl extends AbstractHelloWorldImpl
{
...
public HelloResponseDocument sayHello(HelloRequestDocument
firstName)
{
...
System.out.println("--> Generating Java Hello Component
Response...");
String name =
firstName.getHelloRequest()==null||firstName.getHelloRequest().
equals("")?"Friend":firstName.getHelloRequest();
HelloResponseDocument resp =
HelloResponseDocument.Factory.newInstance();
resp.setHelloResponse("Hi " + name + "! " + "This is the Java
component.\n");
System.out.println("--> Java Hello Component Response: \n\t\t" +
resp.getHelloResponse());
...
}
}
CONFIG_HOME/admin/enterpriseName/samples/remote_props.properties
Output example:
C:\Program Files\tibco\amx-3\studio\3.6\eclipse>amx_eclipse_ant.exe
-buildfile "C:/helloworld1/build.xml" -data "C:/hws"
Buildfile: C:/helloworld1/build.xml
createApplicationDAA:
[sds.createDAA] Waited for 47ms for workspace refreshes after building
features.
all:
BUILD SUCCESSFUL
BUILD SUCCESSFUL
Total time: 2 minutes 18 seconds
Preface | 17
Convention
Use
bold code font
Bold code font is used in the following ways:

In procedures, to indicate what a user types. For example: Type admin.
In large code samples, to indicate the parts of the sample that are of particular interest.
In command syntax, to indicate the default parameter for a command. For example,
if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]
italic font
Italic font is used in the following ways:

To indicate a document title. For example: See TIBCO BusinessWorks Concepts.
To define new terms. For example: A keystore is a database of keys and certificates.
To indicate a variable in a command or code syntax that you must replace. For example:
MyCommand pathname.
Key
combinations
Key name separated by a plus sign indicate keys pressed simultaneously. For example:
Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the other.
For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for example,
an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to apply the
information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example, data loss
or corruption if certain steps are taken or not taken.
Table 2: Syntax Typographical Conventions

Convention
Use
[]
An optional item in command 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 param1
{}
| param2 | param3
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 the
pair param1 and param2, or the pair 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}
18 | Preface
Convention
Use
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}
Preface | 19
Connecting with TIBCO Resources

How to Join TIBCOmmunity
TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to
share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs,
and access to a variety of resources. To register, go to http://www.tibcommunity.com.
How to Access TIBCO Documentation
After you join TIBCOmmunity, you can access the documentation here: http://docs.tibco.com.
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, contact TIBCO Support as follows:
For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this
site:
http://www.tibco.com/services/support
If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a username and password. If you do not have a username, you can request one.
Chapter
1
Introduction
The TIBCO ActiveMatrix platform has three functional areas design, runtime, and administration that address
all phases of the distributed application life cycle.
This guide provides the information that you may need to administer TIBCO ActiveMatrix.
Topics
Design
Runtime Environment
Administration
22 | Introduction
Design
TIBCO ActiveMatrix design activities are performed in TIBCO Business Studio, an extension of the Eclipse
SDK Workbench. In TIBCO Business Studio, analysts, architects, and developers, design, implement, configure,
test, and package TIBCO ActiveMatrix applications.
Introduction | 23
Runtime Environment
TIBCO ActiveMatrix employs a runtime environment consisting of hosts, nodes, and application fragments.
A host runs TIBCO ActiveMatrix platform services, manages the life cycle of nodes, and maintains software
features and resources shared between nodes. Nodes run application fragments.
Hosts
A host is the runtime object that serves as the point of contact between nodes and Administrator. Hosts
perform operations such as software distribution, node life cycling, and application deployment. It is not
necessary for a host to be running to perform administrative operations. Administrator queues operations
and processes them when the host and the nodes it manages are available.
The host that manages the SystemNode node on which the Administrator server runs is named SystemHost
Nodes
A node is the runtime environment for TIBCO ActiveMatrix applications. Nodes exist in an environment
and are managed by hosts. When managed by a TIBCO Host instance, a node runs in its own OS process
and JVM. You can configure a host with multiple nodes. Nodes act as sandboxes for applications.
The node on which the Administrator server runs is named SystemNode.
Application Fragments
Application fragments are components or bindings of an application that are distributed and deployed
to nodes. A fragment can be distributed to many nodes, and a single node can run many fragments. To
increase throughput for a component or binding you can deploy multiple copies of the fragment to multiple
nodes.
Logical View of the Enterprise

The following figure shows the logical view of an enterprise consisting of two user-defined environments.
Each environment consists on several nodes running applications. The enterprise consists of one Administrator
server.
The hosts though a part of the enterprise do not participate in the environment.
24 | Introduction
Figure 1: Logical View
Physical View of the Enterprise

An enterprise consists of multiple machines. On each machine, one or more TIBCO host processes manage
one or more nodes, on which the different applications are running. The Administrator server, which runs
on a separate TIBCO Host process, manages the other TIBCO hosts remotely.
The following figure represents the physical view of the enterprise shown in Figure 1: Logical View on page
24.
Introduction | 25
Figure 2: Physical View
26 | Introduction
Administration
TIBCO ActiveMatrix Administrator allows you to to create, configure, monitor, and manage objects in the
TIBCO ActiveMatrix runtime. TIBCO ActiveMatrix Administrator is a web application that provides a browser
interface and a command-line scripting interface. The command-line interface is a set of Ant tasks that execute
via an automated script.
Administrator Components
TIBCO ActiveMatrix Administrator bundles the following components:
Administrator back-end server - supports the browser web interface and command-line scripting interface.
TIBCO Credential service - provides a built-in Certificate Authority for security configurations that use
SSL.
Monitoring Service - collates data from the regular broadcast of statistics and performance metrics from
remote applications and services deployed in TIBCO ActiveMatrix. This component enables you to view
aggregated and summarized metrics in the browser interface.
Log Service - collects and persists log event messages from an entire TIBCO ActiveMatrix installation to
a central database, allowing you to query the logs in powerful ways from the browser interface.
Payload Service - manages large payloads associated with log events.
Servers
The Administrator server interacts with the following servers:
One or more Enterprise Message Service servers:
Notification Server - propagates monitoring data such as the runtime states of various entities from the
rest of TIBCO ActiveMatrix to Administrator.
Messaging Bus - propagates messages between applications and also between components in an application.
You can partition and segregate business data traffic to multiple Enterprise Message Service Servers using
multiple environments.
You can combine the two Enterprise Message Service servers into a single one or have separate servers
for your configuration and bandwidth requirements.
AllEnterprise Message Service servers must be dedicated to one enterprise and cannot be shared across
multiple enterprises.
LDAP - (optional) integrates the user accounts for the Administrator with your corporate LDAP server.
If not integrating with an LDAP server, you can still create and manage accounts using the Administrator's
database.
Database - (optional) maintains the Administrator server configuration, statistical information about
services, and log events. If you do not have an external database server, Administrator can use HSQLDB,
a built-in lightweight database.
HSQLDB is suitable for a development environment but use of an HSQLDB database in a production
environment is not supported. If you use an HSQLDB database, Administrator replication and
concurrent user access to the Administrator server is not supported.
Enterprise
In the TIBCO ActiveMatrix platform the term enterprise has meaning in two different contexts: runtime and
administrative.
Introduction | 27
In the runtime, enterprise refers to the collection of runtime objects that share the Enterprise Message Service
server that functions as the notification server. The enterprise is identified by a name specified when you
create an Administrator server.
In Administrator, enterprise refers to the top-level administration object. An enterprise contains environments,
hosts, and objects shared between all the environments in an enterprise.
Within an enterprise, all host, nodes, and the Administrator server connect to the Notification Server.
Environment
An environment is a logical grouping of applications and nodes. An Administrator server can have multiple
environments. For example, you can define environments distinguished by product life cycle function such
as development and production, by geographical area, or by business unit.
Administrator Tasks Overview
The following tasks can be performed using the browser interface:
Upload, configure, and deploy applications.
Plan and configure high-availability requirements for your applications.
Manage the resources available for your applications, such as registering new hosts, creating nodes,
managing shared resources.
Plan and configure the security requirements.
Ensure that the deployed services are running and executing within the expected parameters.
Create and manage user accounts.
Most of the tasks listed above can be performed using the command-line interface as well.
Governance
Dashboards that allow monitoring, access control, and the log viewer support governance in the TIBCO
ActiveMatrix environment. In addition, you can secure all communications channels with SSL.
Dashboard
Dashboards display runtime object performance statistics. They allow you to monitor the overall health
and performance of infrastructure objects, applications, and resources.
See Dashboards on page 290.
Access Control
Authorization for all runtime objects is provided by the Administrator Server. See Users, Groups, and
Permissions on page 293.
Log Viewer
The Log Viewer allows you to search the log entries stored by a log service. The log service stores the logs
sent from a JMSAppender.
See Log Viewer on page 308.
SSL
See Secure Communication Channels on page 347.
Chapter
2
Administrator Interfaces
TIBCO ActiveMatrix Administrator provides two interfaces for interacting with Administrator: web and
command-line.
Web Interface
The web interface provides access to all Administrator functionality through a browser.
Command-Line Interface
The command-line interface provides a set of Ant tasks to execute most Administrator functions. You use the
command-line interface for repetitive application of standard actions on large numbers of objects.
Sample command-line scripts are provided in CONFIG_HOME/admin/enterpriseName/samples.
The web interface is asynchronous in nature and allows you to perform other actions while one is in progress.
The command-line interface, on the other hand, is synchronous. Any action invoked by a command-line
script waits till the action is complete before proceeding to execute the next action.
Topics
Web Interface
30 | Administrator Interfaces
Web Interface
The Administrator web interface provides access to all TIBCO ActiveMatrix Administrator functions. The
web interface displays TIBCO ActiveMatrix objects in two views: list and graphical.
Figure 3: TIBCO ActiveMatrix Administrator
Logging in to the Web Interface

You can log in to the Web interface from a Web browser. You must have login credentials to log in.
Procedure
1. Open a browser and navigate to the URL http://hostname:port/amxadministrator.
hostname and port are the connection properties you specified when you created the Administrator server.
The default URL is http://localhost:8120/amxadministrator.
2. Enter the credentials you specified when you created the Administrator server.
The Administrator login page displays.
Results
You are logged into the web interface and can perform any operations for which you have permission for
the duration of a session. If you do not perform any actions for the session timeout value (default 30 minutes)
set when you created the Administrator server, the session times out and you are automatically logged out.
The session timeout value is set when creating the Administrator server using TIBCO Configuration Tool. .
After successfully logging into the web interface, the Welcome Page displays. You can use the task links
provided on the Welcome Page or use the menu structure.
You can access the Welcome Page anytime by selecting Dashboards > Welcome Page.
List View
In the list view, collections of managed objects are displayed using a master-detail paradigm. The master
portion is a list that displays the collection. The master portion also offers action buttons that apply to the
selected object in the list. The bottom pane displays the properties of a selected object.
Displaying the List View
In the list view, collections of managed objects are displayed. You can display the List View from the Enterprise
Graphical View toolbar.
Infrastructure > Enterprise Graphical View
Administrator Interfaces | 31
Click List View

in the Enterprise Graphical View toolbar.
Select a menu option in the Administrator toolbar.
List View Interactions
The list view gives access to flat lists and tree lists. You interact with the two list types in different ways.
Flat Lists
The following figure displays a typical flat list which is displayed as a table.
If there are no objects, the list is empty. If there are objects, an item is not selected when the page is opened:
You must select an item in the list to display the details of the object. If an item is selected in a table, the details
for that item are displayed in the Details area.
A flat list has the following interactions:
Click on a row to select it.
Click the refresh icon to refresh the list. You may have to manually refresh the list periodically, especially
when invoking an action and are waiting to see the results of your action on the items in the list.
You can click column headings to sort by that column. Each click toggles between ascending and descending
sort.
Some columns appear as hyperlinks. Click the hyperlinks to view additional information.
Some a flat lists provide a filter. Select a value from the drop-down list to view items that match the chosen
type.
Tree Lists
A tree list displays a hierarchy of items, such as components of an application or appenders for a logging
configuration.
A tree list has the following interactions:
By default, each level is always in alphabetical order (ascending A-Z).

The top level entry is the first entry in the tree table.
Expand and collapse icons are displayed for all parent and child levels except the last level in the list.
Graphical View
The graphical view displays Administrator objects in a graphical canvas. The graphical canvas can display
a logical or physical view of the objects. The logical view displays the enterprise from the perspective of the
logical administrative entities maintained by Administrator: environments and applications.
Microsoft Silverlight is required to view the graphical view and the monitoring dashboards. Refer to
the readme file for the supported versions.
At a higher level, the graphical view displays a wide view of your enterprise. You can zoom in on a particular
object to view more details. Using the graphical view, you can visualize associations between objects in your
enterprise.
The physical view displays the enterprise from the perspective of the physical processes managed by
Administrator: hosts and nodes.
Displaying the Graphical View

You can display the graphical view from the Infrastructure menu or from the toolbar.
About this task
Choose one of the following options to display the graphical view:
Choose Infrastructure > Enterprise Graphical View
Click
in the toolbar of an object list.
Graphical View Interactions
The graphical view allows you to interact with the logical view or the physical view of your enterprise using
sliders, icons, and menus.
The graphical view supports the following interactions:
Choose between Logical and Physical View from the drop-down list located at the left hand side of the
display.
Use the slider located on the right side of the display to zoom in and out of the current view.
Use the Refresh button to update the data for the objects being displayed.
Use breadcrumbs along the top center to navigate from drilled into objects back up to a higher level view.
The mouse wheel zooms in and out centered on the cursor's location.
The large black gray squares with arrows, located towards the bottom of the screen, scroll in the direction
of the arrow and appear when some object is out of view.
Click the
button to hide the browser controls and to display over the entire screen. Press the ESC key
to exit the full screen mode.
Click
to drill into the selected object.
The indicators at the top of object boxes indicate the status of the object:
- running
- unknown
- stopped
Re-size the boxes to display detailed information.

In the logical view, use the Application Template tab located at the bottom of the screen to drag applications
templates to environments to create applications.
In the physical view, use the Resource Templates tab located at the bottom of the screen to drag resource
templates to a node to create a resource instance or a host to create a resource instance on each node in
the host.
Use the services (rendered in green) and references (rendered in pink) in the logical view to wire together
applications or environments.
The Wire option from the object menu allows you to pick targets from a list.
The FreeWire option from the object menu allows you to drag and drop.
Menus
When you select an object, a menu of actions that can be performed on the object becomes available. The
menu options depend on the selected object.
Wiring Using the Graphical View
You can use the services (rendered in green) and references (rendered in pink) in the logical view to wire
together applications or environments.
Procedure
1. Drill down into an application until the services and references are visible.
2. Click the reference.
3. Access the FreeWire option.
If wiring a reference to a service, click the FreeWire option and hold down the mouse button for a few
seconds till the wire is visible.
If wiring a service to a reference, double click the FreeWire option.

The wiring aid tool box appears. The following figure shows an example of a tool box displayed when
wiring a service to a reference.
4. Wire the components.

Option
Description
Wiring a reference to a
service
When wiring a reference to a service, guide the wire across the screen. On
reaching a suitable target service, the color of the wire changes to blue and
the service is expanded to display its bindings. Choose a binding.
Wiring a service to a
reference
1. When wiring a service to a reference, the service expands to display its

bindings.
2. Choose a binding.
The wire is enabled.
3. Guide the wire across the screen. On reaching a suitable target reference,
the color of the wire changes to blue. Release the mouse button when
over the desired reference.
The wire is created. The wiring aid tool box displays the updated information for a few seconds before it
disappears.
What to do next
To delete a wiring, select the wire and press the delete button on your keyboard.
Object States
In the Administrator web interface, all runtime objects and applications have properties that reflect their
state:
The objects managed through Administrator fall into two groups -- physical and logical.
Hosts, nodes, resource instances, components, and bindings, represent physical entities in the runtime.
Environments, applications, resource templates, users, groups, and permissions, are logical entities
employed for various management functions.
All runtime objects except for hosts are created in Administrator, and then instantiated in the runtime. Hosts
exist in the runtime first and their representation in Administrator is established through a registration
process.
The following object properties reflect object state:
Synchronization
Runtime State
Action History
Although applications do not exist in the runtime, the application's components and bindings have a runtime
manifestation. An application's state properties are a roll-up summary of the state of its components and
bindings.
Runtime State
Hosts and Nodes are the runtime processes that Administrator interacts with. They have a state that is
displayed in Administrator under the Runtime State column.
The runtime state typically changes when you invoke an action in Administrator. For example, a node goes
into a Running state shortly after you execute the Start action on it. The runtime state might also change due
to events that occur outside of Administrator. Powering down a machine stops nodes, booting a machine
starts them. If you end the node process, its state changes to Not Running.
As the runtime state changes dynamically, Administrator tracks state changes in real time through notification
messages it receives from the notification server. Refresh the Administrator UI periodically to display the
updated status of the objects.
Applications also have a runtime state. The Administrator displays the state of an application by aggregating
and summarizing the state based on all its components, including the bindings, that are distributed on multiple
nodes. For example, if an application fails to start, the runtime state displays Start Failed. If some application
components are running and some are explicitly stopped, the runtime state shows Partially Running.
When a runtime action has completed for some components, the runtime state shows Partially runtime action.
For example, when you undeploy an application you might see Partially Undeployed.
Runtime States
Applications, features, hosts, nodes, and resource instances support different runtime states.
Table 3: Runtime States
Object
Application
Runtime States
Not Deployed - before an application is deployed.

Deployed - after the first time the application is deployed.
Partially Undeployed - while an application is being undeployed.
Partially Running - the application is deployed to more than one node and not all the
nodes are running.
Starting
Start Failed - click the Action History link in the Administrator to get more information.
Running
Stopped - after the application has been started and stopped.
Stopping
Partially Stopped - the application's components and bindings are in different states.
Uninstalling
Partially Uninstalled - not all the components and bindings of the application have been
uninstalled.
Waiting for Dependencies - either a resource instance or application that this application
depends upon is not running. Once all dependencies are running, the components which
are waiting will automatically be started.
Preparing for Undeploy - the application is waiting for process instances and work items
to be completed.
This is a normal state when undeploying an application and there are process
instances or work items that are open. The application can remain in this state for
a very long time, since completing the open work items involves manual
Object
Runtime States
intervention. When the work items are completed, the application will be
automatically undeployed.
Interrupted Preparing for Undeploy - indicates the application that was preparing for
undeploy was either stopped, or its dependency taken away.
An application may depend on other application processes. If any of the dependent
applications are stopped or undeployed, it takes away a dependency for the main
application. In such a situation, the main application will go into a state of
Interrupted Preparing for Undeploy and will no longer progress work or
process instances. To recover from this state, you can either start the application
or bring back the dependencies by starting the processes or deploying the
dependant applications.
Partially Ready for Undeploy - some components have completed processing and have
been marked as ready for undeploy, but other components in the application have yet
to complete processing.
Unknown
Lost contact - when a host has lost contact with the Administrator server.
The runtime state is a roll-up value for all the application's components and bindings.
Partial states mean that some of an application's components and bindings are in a
different state than others.
Feature
Marked for Install - after a feature has been added to a node and before the change has
been applied to runtime.
Marked for Uninstall - after a feature is removed and before the change is applied to
runtime.
Installed - after a feature has been applied to runtime.
Host
Node
Not Installed - after a node has been created and before is has been installed
Not Running - after a node has been installed or when it was detected that the node
ended without being stopped by the host. This applies when the process is detected as
stopped.
Stopping - Stopping a node is expected to be a quick activity. If the node is stuck at
Stopping for more than a few minutes, checking the logs may indicate the problem.
Stopped - the node was explicitly stopped. This is a normal and expected condition.
Starting - Starting a node is expected to be a quick activity. If the node is stuck at Starting
for more than a few minutes, checking the logs may indicate the problem.
Initializing
Initializing Failed - click the Action History link to get more information.
Initialized
Lost Contact - when the host has lost contact with the Administrator server.
Starting
Starting Failed - click the Action History link to get more information.
Running
Stopping
Stopped - when the host is explicitly stopped and has completed the shutdown process.
Unknown
Object
Runtime States
Start Failed - The host was not able to start the node process. Possible causes are that the
node_classpath.tra file contains errors, the JRE libraries are not found, or the OS is
unable spawn additional processes. After this state ,the node is disabled and must be
manually enabled.
Running
Lost contact - When a host has lost contact with the Administrator server.
Resource
Instance
Not Installed - after a resource instance has been added to a node and before it has been
installed
Running - after a resource instance has been installed and the node on which it has been
installed is Running
Uninstalled - either the resource instance is uninstalled or the node on which the resource
instance is installed is Not Running
Stopped - when a host has lost contact with the Administrator server.
If the Runtime State column of applications is Lost Contact or Unknown, the connection to the Enterprise
Message Service server acting as the notification server and Messaging Bus has been lost.
After you upgrade an Administrator server, the runtime state of applications running on a node
managed by a TIBCO Host instance that has not been upgraded is Partially Running.
Action History
Action history displays information about actions performed on objects such as a node, host, or an application
using ActiveMatrix Administration UI or the CLI.
Start, Stop, Install, Uninstall, Deploy, Undeploy are actions.
You can view the Action history in the Administrator web interface.
Action history does not record actions performed outside of the Administrator such as a TIBCO host
restart.
Action history of an application displays the outcome of completed tasks and actions of the application's
components and bindings .
The runtime status column of a host, node, and application displays the current status of an object.
The following scenarios explain how action history is helpful:
An application is redeployed without clearing the previous version of a feature. If the resolve mode for
the redeploy action was not used, the node assumes the earlier version of the feature is needed. In this
case, the action history displays Deploy with Start Failed and Runtime State displays Running. Click
the Action History link and open the last action. Few successful actions and one failed action, Cleanup
Features node name failed, displays.
Let us say, Application A is successfully deployed in Node A and uses an HTTP resource instance A. Another
instance HTTP resource instance B from the same resource template is created in Node B in the same machine.
Action history will display Install Failed when instance B is installed. However, the instance status
displays Installed (Start Failed). Stop and Restart the host. If instance B starts first, it will display
Installed and instance A will display Installed (Start Failed). However, action history will not
change as no action was initiated from the Administrator. The application Action History will display
Successful, and the Application State will display Start Failed.
Let us say, Application A is successfully deployed in Node A and uses an HTTP resource instance A. Another
instance HTTP resource instance B from the same resource template is created in Node B in the same machine.
Start instance B from the Administrator. Since instance B is not running, the start will fail and Action History
will display Start Failed. Now, remove instance B and restart the node with the application. The
Application State will display Running. The Action History will continue to display Start Failed since
no action was initiated from the Administrator.
Outstanding Actions
Actions affect either TIBCO host or nodes, so the TIBCO host and node must be running to execute the actions.
For example, if a machine is down, actions targeted to objects running on that machine will fail. However,
Administrator supports an offline mode for many actions. This means that actions in Administrator are
queued up while runtime objects are offline and executed when they comes back online.
While a target runtime object is offline (either not running or unreachable) queued actions in Administrator
wait their turn for execution. For example, if a host is offline, actions performed against the host will remain
queued, and will execute as soon as the host comes back online.
An application distributed to several runtime nodes may be deployed while some nodes are online and some
are offline. Administrator will split the deployment action into multiple tasks, some of which are executed
right away and others put on a queue for future execution when their target node comes online.
An action is complete when all its tasks, including those placed on the queue, are done executing. For the
offline case, an action may take a very long time to complete. Even in the online case, certain asynchronous
actions may take a long time to complete.
Action History Reference
Action history information is available for pending tasks and actions. You can also view the outcome of
recently completed tasks and actions.
Table 4: Pending Tasks and Actions
Column
Description
Action
The type of the action.
Task ID
Dynamically allocated identifiers used to correlate task dependencies.
Description
A description of the action.
Node or
The node or application to which the action is applied.
Application
Dependency
The task IDs on which the action depends.
Start Time
The time at which the action was started.
Table 5: Outcome of Recently Completed Tasks and Actions

Column
Description
Result
The outcome of the action: Success or Failure.
Action
The type of the action.
Node or
The node or application to which the action is applied.
Application
Detail
Details of the result in case the outcome of the action is an error.
End Time
The time at which the action completed.
Time Taken (s)
The time taken, in seconds, to complete the action.
Show Only Failed
Show only those tasks that have failed.

This button toggles between Show Only Failed and Show All.
Column
Description
Print Error
Shows detailed information for the error.
Synchronization
The Synchronization property indicates whether the runtime has the latest configuration for an object. An
object is shown as Out of Sync when the runtime is not running the latest configuration and otherwise is
shown as In sync.
For example, if you modify a port number of a node after its installation, the runtime would have the older
port number, and node will show as Out of sync. To sync the runtime node with the latest configuration, you
must execute one or more actions.
Only the properties that change the behavior of an object at runtime are tracked using the synchronization
flag. For example, modifying an object's permissions does not make the object go out of sync because
permissions are used only by Administrator and are not sent to the runtime.
Administrator displays only whether an object is in sync or not. Hover over the Out of Sync text to see the
change that caused it to have a different configuration than what is in the runtime. For example if you
distribute the application to a second node the hover text will say Distribution Config. If more than one type
of change is causing the object to be out of sync, all of them will be displayed separated by semicolons. You
may need to refresh the master list to observe a change to the synchronization state or reason. Clicking the
Out of Sync text opens a dialog box Synchronization Details that provides more information about the changes.
The Administrator command-line interface (CLI) provides access to most TIBCO ActiveMatrix Administrator
functions that change the state of Administrator objects.
You can perform the following actions using the CLI:
Add, edit, and delete objects
Install and uninstall
Start and stop objects
Set properties and substitution variables
Distribute application components to nodes
You can use the CLI for repetitive application of standard actions on large numbers of objects.
The CLI is based on the Ant open source build tool and is implemented in an Ant task named AMXAdminTask.
You specify the Ant task in a build target within an Ant build file. Each instance of AMXAdminTask in the
build file specifies an action to be performed on one or more objects specified in a data file.
The CLI invokes web services exposed by the Administrator server. You specify the Administrator server
location and user credentials in a property file.
Sample Build, Data, and Property Files
Sample build and data files for many of the objects supported by the command-line interface are provided
in CONFIG_HOME/admin/enterpriseName/samples. A sample property file is provided in
CONFIG_HOME/admin/enterpriseName/samples/remote_props.properties, where enterpriseName is the name
specified for the Administrator enterprise when you created the Administrator server. Before using this
sample file, replace the host portion of the adminURL property with the address of your TIBCO ActiveMatrix
Administrator server and the username and password properties with the credentials of a user that has been
granted the permissions required to execute the actions in the script.
Invoking the Command-Line Interface

To invoke the command-line interface, you first install and set up Ant. You can then run Ant.
Before you begin
1. Download Ant from http://ant.apache.org and install as directed in the Ant documentation.
2. Increase the JVM permgen size:
Windows - Add set ANT_OPTS=-Xmx1024m -XX:MaxPermSize=256m -XX:PermSize=128m to
%USERPROFILE%\antrc_pre.bat
UNIX - Add
export ANT_OPTS="-Xmx1024m -XX:MaxPermSize=256m -XX:PermSize=128m
~/.antrc
3. Confirm the value of ANT_OPTS before executing CLI scripts from the command prompt.
Procedure
1. Add the Ant executable to your path.
2. Run ant -f build.xml, where build is the name of the build configuration file.
Results
The output states the results of each action specified in the default target in the build file.
to
Build Files
The Ant build file for the command-line interface must contain the import, project, target, and
AMXAdminTask elements.
import Element
The import element identifies the task definition file, which defines the path to the libraries required by
AMXAdminTask.
Set the file attribute to CONFIG_HOME/admin/amxadmin/samples/admin-scripts-base.xml . For
example:
<import file="C:/Documents and
Settings/AMX-User/ApplicationData/amx-3/data/admin/amxadmin/samples/admin-scripts-base.xml"/>
project Element
The project element declares the default build target for the build.xml file. taskdef and target are
subelements of the project. The optional default attribute allows you to specify a default target. You can
choose any target from the build file to be the default target.
<project default="target">
<taskdef ... />
<target name="target" ... />
</project>
target Element
The target element specifies the actions performed for an execution of the command line interface via the
AMXAdminTask subelement. In a target you can provide a depends attribute containing a list of targets.
Each target will be run in order until one fails or the list completes.
<target name="target">
<AMXAdminTask ... />
</target>
Example Build File

The following build file defines targets to upload a distributed application archive, create an application,
map an application to a node, create a resource template, create a resource instance and install it in a node,
and deploy an application.
<project default="all">
<dirname property="admin.samples.directory"
file="CONFIG_HOME/admin/enterpriseName/samples"/>

<import file="${admin.samples.directory}/admin-scripts-base.xml"/>

<property name="dataFile" value="userProvided dataFile"/>

<property name="remote-properties.file"
value="${admin.samples.directory}/remote_props.properties"/>

<target name="all"
depends="upload.daa, create.app, edit.properties, wire.application, distribute.app,
deploy.app, start.app"
description="Default target group, execute following targets: upload.daa, create.app,
edit.properties, wire.application, distribute.app, deploy.app, start.app"/>

<target name="upload.daa" description="Uploading Application">
<AMXAdminTask
action="add"
objectSelector="DAA"
remote="true"
propsFile="${remote-properties.file}"
dataFile="${dataFile}"
overwrite="false" merge="true" createIfNotExists="true"
force="false" failOnError="false" />
</target>

<target name="create.app" description="Creating Application">
<AMXAdminTask remote="true" propsFile="${remote-properties.file}"
action="add" dataFile="${basedir}/jv.phonebook.soa.deployment-config.xml"
objectSelector="Environment//Application"
overwrite="false" merge="true"
createIfNotExists="true" force="false" failOnError="true" />
</target>

<target name="edit.properties" description="Editing Properties">

action="add" dataFile="${dataFile}"
objectSelector="ResourceTemplate" overwrite="false" merge="true"

action="add" dataFile="${dataFile}"
objectSelector="Environment/Node/ResourceInstance"

action="install" dataFile="${dataFile}"

action="edit" dataFile="${dataFile}"
objectSelector="Environment//Application/Property |
Environment//Application//PromotedService//Binding/Property |
Environment//Application//PromotedReference//Binding/Property"
</target>

<target name="wire.application" description="Wiring Application">
action="set" dataFile="${dataFile}"
objectSelector="//PromotedReference/Wire"
</target>
<target name="distribute.app" description="Distributing Application">
<AMXAdminTask
action="set"
objectSelector="Environment//Application//Component/Node |
Environment//Application//PromotedService//Binding/Node |
Environment//Application//PromotedReference//Binding/Node"
remote="true"
overwrite="false"
merge="true"
createIfNotExists="true"
force="false"
failOnError="false"/>
</target>

<target name="deploy.app" description="Deploying Application">
action="deploy" dataFile="${dataFile}"
createIfNotExists="true" force="false" failOnError="true"
/>
</target>
<target name="start.app" description="Starting Application">
action="start" dataFile="${dataFile}"
</target>
</project>
<project default="all">
<dirname property="admin.samples.directory"
file="CONFIG_HOME/admin/enterpriseName/samples"/>

<import file="${admin.samples.directory}/admin-scripts-base.xml"/>

<property name="dataFile" value="userProvided dataFile"/>

<property name="remote-properties.file"
value="${admin.samples.directory}/remote_props.properties"/>
<target name="all" depends="upload.daa, create.app, map.app.to.node, create.rt,
create.ri, install.ri, deploy.app"/>
<target name="upload.daa">
<AMXAdminTask
action="add"
dataFile="dateMgr_data.xml"
objectSelector="DAA"
failOnError="true"/>
</target>
<target name="create.app">
<AMXAdminTask
remote="true"
action="add"
</target>
<target name="map.app.to.node">
<AMXAdminTask
remote="true"
action="set"
objectSelector="Environment//Application/Node"
</target>
<target name="create.rt">
<AMXAdminTask
remote="true"
action="add"
objectSelector="ResourceTemplate"
</target>
<target name="create.ri">
<AMXAdminTask
remote="true"
action="add"
</target>
<target name="install.ri">
<AMXAdminTask
remote="true"
action="install"
</target>
<target name="deploy.app">
<AMXAdminTask
remote="true"
action="deploy"
</target>
</project>
AMXAdminTask
AMXAdminTask specifies an action, data and property files, the objects on which the action is performed,
and various behavioral attributes.
<AMXAdminTask
action="action"
dataFile="path to data file"
propsFile="path to properties file"
[createIfNotExists = "{true|false}"]
[failOnError="{true|false}"]
[force="{true|false}"]
[merge="{true|false}"]
[objectSelector="XPath expression"]
[options="nostart|immediate|terminate|resolve|auto-resolve|stable|handle-dependencies"]
[overwrite="{true|false}"]
[timeout="timeout value"/>
Parameters
Attribute
action
Type
String
Req?
Yes
Description
The action to be performed on the objects in the data file. The
action is case insensitive.
Unless objectSelector is specified, the action is applied
to every object in the data file.
The order in which the action is applied to the objects is
either breadth first or depth first. The method used is
determined by the action.
Breadth first - add, edit, install, start, stop
Depth first - delete, uninstall
Attribute
Type
Req?
Description
Some actions are not performed against certain object
formats.
For the most part, add and edit are applied only to objects
specified in full format. Objects not in this format are
skipped.
createIfNotExists
Boolean
No
Applicable to the edit action.

If an object is to be edited but doesnt yet exist and this flag is
true, then the object is added.
If this flag is false and the object to be edited doesn't exist, an
error is reported.
Default: true.
String
Yes
The path to the XML file containing the object data.
failOnError
Boolean
No
Causes the Ant task to fail when an unrecoverable error is

reported. The option stops processing of targets in the depends
list or specified on the command line.
force
Boolean
No
Forces an action even if the object has dependent objects or is

not in the appropriate state. Applies to the following actions
and objects:
delete - Node, Application, Environment, ResourceTemplate,
ResourceInstance
undeploy - Application
stop - Application, Component, Binding
uninstall - Node, ResourceInstance
dataFile
For example:
A node must be in the uninstalled state before it can be
deleted and it must be stopped before it can be uninstalled.
If any problems occur moving the node to one of these states,
and force is true, the node is deleted even if it is not in the
uninstalled state or uninstalled even if it is not stopped.
An application must be in the undeployed state before it
can be deleted and it must be stopped before it can be
undeployed. If any problems occur moving the application
to one of these states, and force is true, the application is
deleted even if it is not in the undeployed state.
You should exercise extreme caution when using this
option as it may leave your system in a non-working
state.
Default: false.
merge
Boolean
No
Applicable to the add action, and only if the overwrite flag was
used and is true.
If an object to be added already exists and
If merge is true and overwrite is true, then the existing
object is overwritten by merging with the new object. That
is, the old object's data is updated with the new object's data.
Attribute
Type
Req?
Description
If merge is false but overwrite is true, then the existing
object is deleted and replaced by the new object. The old
object's children and access control lists, if any, are lost in
the process.
Default: true.
objectSelector
String
No
Specifies the set of objects to be processed by an XPath

expression. For information on the XPath language, see
http://www.w3.org/TR/xpath. If this attribute is not specified:
All of the objects in the data file are processed.
The heuristic used to determine the order in which the
objects are processed depends on the action option.
options
String
No
The following actions have additional options:

deploy - nostart prevents applications from being started
after deployment.
stop - immediate allows applications, components, bindings,
and nodes to perform a quick cleanup and then stop.
terminate applies only to nodes and causes the node
process to be killed without any cleanup.
install, add, remove, deploy, undeploy - resolve causes
nodes to be restarted when a node is installed, a feature is
added or removed from a node, or an application is
deployed or undeployed from a node.
auto-resolve applies to the resource instance. It causes the
node to be re-started only if needed.

is an option available when installing resource
instances. Prevents the nodes from restarting. In this mode
what you deploy should not affect any other running code
in the runtime.
stable
handle-dependenciesre-installs
all dependant resource

instances and restart applications that use these resource
instances.
overwrite
Boolean
No.
Applicable to the add action. If an object to be added already

exists and the overwrite is true, then the existing object is
overwritten.
There are two ways in which an object can be overwritten: it
can be merged, or created from scratch. The strategy used is
determined by the merge option.
Default: true.
propsFile
skipIfNotExists
String
Yes
The path to the properties file containing the Administrator

server location and user-specific information data.
Boolean
No
Used when deleting an object.

When set to true, no attempt is made to delete the object if it
does not exist.
Attribute
Type
Req?
Description
When set to false, an error is reported if the object to be deleted
does not exist.
Default: false.
timeout
Integer
No
Length of time in seconds that a target will wait for an action

to complete before reporting an error. If a timeout occurs and
failOnError is true, the Ant task will fail. If a timeout occurs
and failOnError is false, the script will report an error but the
script will continue to process targets.
This option applies only to the following asynchronous actions
and objects:
deploy, undeploy - Application, Plug-in
install and uninstall - Node, ResourceInstance
start - Node
Default: 0, which means the task will never time out. You should
not change the default unless you are creating large amounts
of data and leaving the script run unattended or have a
requirement that node startup satisfies a timing constraint.
create
Assume you have an environment env1 in the database. Your data file has environment env1 and a node
node1. If you specify the edit action and
createIfNotExists = false. env1 already exists, so its data is edited to match env1 in the data file. node1
doesnt exist, so is not updated.
createIfNotExists = true. env1 already exists, so its data is edited to match env1 in the data file. node1doesnt
exist, so it is added to env1.
force
Assume you have an environment env1 and node node1 in both the database and the data file. node1 is in
the Started state. If you do a delete and
force = false. node1 is in the Started state. There are two possible outcomes:
The stop and uninstall are successful. node1 and env1 are deleted.
The stop or uninstall fails. node1 is not in the uninstalled state so it cannot be deleted. The delete does
not complete.
force = true. node1 is in the Started state. There are two possible outcomes:
The stop and uninstall are successful. node1 is deleted. env1 is deleted.
The stop or uninstall fails. node1 is not in the uninstalled state but is forcefully deleted. env1 is deleted.
objectSelector
objectSelector="//*"
Process all objects.
objectSelector="//Node"
Process all nodes.
objectSelector=/Environment[@name=env1]/Node[@name=node1]"
Process node1 in environment env1.
overwrite and merge

Assume you have environment env1 and node2 in the database. If you specify the add action with a data file
that contains env1 and node1:
overwrite = false (merge is then ignored). Nothing happens to env1. node1 is added.
overwrite = true and merge = false. env1 is deleted and replaced with the env1 in the data file and node2
is deleted. node1 doesnt exist yet and is added.
overwrite = true and merge = true. The existing env1 is updated with data from the env1 in the data file.
Nothing happens to node2 and node1 is added.
Actions
The actions that can be performed with the command-line interface affect either the objects contained in the
database or the objects executing in the TIBCO ActiveMatrix runtime.
Database Actions
Database actions modify the objects contained in the Administrator database:
add - Add an object or an association between objects, such as between an application and a node.
edit - Edit an object.
delete - Delete an object or an association between objects. When you delete an object, the entire tree rooted
at the object is deleted starting at the leaves.
set - Set the value of a substitution variable, map an application, component or binding to a node, set a
property of a binding. This action deletes any existing entries that aren't present in the new set and adds
any entries in the new set that weren't in the database.
upgrade - Upgrade an existing application.
promote - Make a service or reference available at the environment level for cross-environmental wiring.
demote - Make a service or reference unavailable at the environment.
resetPassword - Reset a user password.
Runtime Actions
Runtime actions modify the state of the objects contained in the TIBCO ActiveMatrix runtime:
install - Install node on a host or a resource instance on a node.
uninstall - Uninstall a node from a host or a resource instance from a node.
deploy - Deploy a component or binding to a node, a logging configuration for a host, node, application,
or component, a plug-in to the Administrator server. Also undeploys components and bindings from
nodes they are no longer mapped to.
undeploy - Undeploy an application or plug-in.
start - Start a node, application, component, or binding.
stop - Stop a node, application, component, or binding.
Data Files
The data file is an XML file that specifies attributes of the objects that are operated on by AMXAdminTask.
A data file has the following structure.
<amxdata_base:Enterprise
xmlns:amxdata="http://tibco.com/amxadministrator/command/line/types"
xmlns:amxdata_base="http://tibco.com/amxadministrator/command/line/types_base"
xmlns:amxdata_reference="http://tibco.com/amxadministrator/command/line/types_reference"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://tibco.com/amxadministrator/command/line/types
../schemas/amxdata.xsd
http://tibco.com/amxadministrator/command/line/types_base ../schemas/amxdata_base.xsd
http://tibco.com/amxadministrator/command/line/types_reference
../schemas/amxdata_reference.xsd">
Objects
</amxdata_base:Enterprise>
Example Data File

The following data file defines a node named admin01-node and an application named JavaDateManagerSoa
in an environment named hw, a resource instance named datemgrConnector on the node, a mapping of the
application to the node, an application template named JavaDateManagerSoa, a resource template named
DateMgrConnectorTemplate, and a distributed application archive.
xsi:schemaLocation="http://tibco.com/amxadministrator/command/line/types
../schemas/amxdata.xsd
http://tibco.com/amxadministrator/command/line/types_base ../schemas/amxdata_base.xsd
http://tibco.com/amxadministrator/command/line/types_reference
../schemas/amxdata_reference.xsd">
<Environment xsi:type="amxdata:Environment" name="hw" >
<Node xsi:type="amxdata_base:Node_base" name="admin01-node">
<ResourceInstance xsi:type="amxdata:ResourceInstance" name="datemgrConnector"
resourceTemplateName="DateMgrConnectorTemplate"/>
</Node>
<Application xsi:type="amxdata:Application" name="datemanager" importBindings="true">
<Node name="admin01-node" environmentName="hw"/>
<ApplicationTemplate xsi:type="amxdata_reference:ApplicationTemplate_reference"
name="JavaDateManagerSoa"/>
</Application>
</Environment>
<ResourceTemplate xsi:type="amxdata:HttpConnectorResourceTemplate"
name="DateMgrConnectorTemplate"
host="localhost"
port="9870"/>
<DAA xsi:type="amxdata:DAA" location="JavaDateManagerSoa.daa"
importResourceTemplates="false"/DAA>
Objects
You specify the objects on which the command-line interface operates in an XML data file. TIBCO ActiveMatrix
Administrator provides XSD schemas for the data files that capture all of the ID attributes, description
attributes, parent-child relationships, and associative relationships of objects.
Every object is described in an XML element. The attributes of that object (both ID and descriptive) are
attributes of the XML element, and the relationships this object has with other objects are subelements of the
XML element. In these schemas, every Administrator object can be specified in three types of formats: base,
full, and reference.
Object Schemas
The object schemas are located in TIBCO_HOME/administrator/version/schemas and are named:
Full format definitions.

amxdata_base.xsd Base format definitions.
amxdata_reference.xsd Reference format definitions.
amxdata_detailed.xsd Currently this schema is empty. It is reserved for use in the future.
amxdata.xsd
Supported Objects
The command-line interface supports a set of objects that represent the components of an ActiveMatrix
environment. Each object has a set of attributes that describe the object.
The objects supported by the command-line interface are: Appender, AppenderRef, Application, AppTemplate,
Binding, Component, DAA, Enterprise, Environment, Feature, Host, LogAppender, Logger, LogicalNode,
MessagingBus, Node, Plugin, PromotedReference, PromotedService, Property, Reference, ResourceInstance,
YYYResourceTemplate (where YYY is Hibernate, Teneo, Smtp, Jdbc, HttpClient, LdapQuery, HttpConnector),
Service, SVar, User, Wire).
Each object has a set of attributes that describe that object. Some of these attributes, such as the name of the
object, can be used to uniquely identify a particular object assuming the location of the object in the data
hierarchy is known. Such identifying attributes are ID attributes. The rest of the attributes are description
attributes. The following table summarizes the actions and the objects that support those actions.
Certain objects do not explicitly support actions. Enterprise, the top-level container object, does not
support any actions. Other objects, such as AppenderRef, LogicalNode, PromotedReference, and
PromotedService are subelements of objects that support actions.
Table 6: Actions and Objects
Object
Add Edit Delete Set
Appender
Application
AppTemplate
Binding
Component
DAA
Environment
Feature
Host
Logger
MessagingBus
Node
Plugin
Property
Reference
ResourceInstance
ResourceTemplate
Service
SVar
User
Start or Install or
Stop
Uninstall
Deploy Undeploy Promote Demote
Object
Add Edit Delete Set
Start or Install or
Stop
Uninstall
Deploy Undeploy Promote Demote
Wire
Object Formats
Objects in the data XML file of a CLI script can be specified in three formats: base, full, and reference.
Base Format
Base format uniquely identifies the object. Base format is defined in the schema amxdata_base.xsd. The base
format is a convenience so that you do not have to give all the descriptive attributes of an object to work with
it. Base format:
Captures the ID attributes of an object as XML attributes
Captures the parent-child relationships of an object as XML elements
Doesnt capture any parent information about the object as that information is derived from the XML
structure
You use the base format to:
Delete an object
Perform a runtime action on an object
Add a child to an object
Perform an action on a child of an object
Full Format
Full format is derived from the base format and includes all the base format information plus additional
attributes that describe the objects. Full format in defined in the schema amxdata.xsd. Full format:
Is derived from base format

Captures the ID and description attributes of an object as XML attributes
Captures the parent-child and associative relationships of an object as XML elements
Doesnt capture any parent information about the object as that information is derived from the XML
structure
You use full format:

Whenever the base format can be used
To add or edit an object
Reference Format
Reference format is used for making associations between two objects. Reference format is defined in the
schema amxdata_reference.xsd. Reference format:
Captures the ID attributes of an object as XML attributes
Objects not residing directly under the Enterprise object have parent information because it cannot be
derived from the XML structure
You use reference format:
When associating that object to another object
Object Navigation
For each object type and action, you can supply XPath navigation expressions to the objectSelector option
of AMXAdmin task.
You specify objects under Enterprise with the simple XPath expression ObjectType, where ObjectType can be
Environment, Host, Feature, ResourceTemplate, DAA, Plugin, User, Group, and LogAppender.
Table 7: Object Navigation
Object Type
Action
Application
add, edit, delete, Environment/Application

deploy, undeploy,
start, stop
Binding
add, delete, start,

stop
Component
add, edit, delete, Environment/Application/Component

deploy, start, stop
Logger
set, add, delete,

Host/Logger
deploy, deployLog Node/Logger
Environment/Application/Logger
Environment/Application/Component/Logger
Node (life cycle

operations)
add, delete, install, Environment/Node

uninstall, deploy
Node (distribution
operations)
set, add, delete
Property
set
Environment/Application/Property
Environment/Application/PromotedService/Binding/Property
Environment/Application/PromotedReference/Binding/Property
ResourceAdapter
add, delete
Host/ResourceAdapter
ResourceInstance
add, delete, install, Environment/Node/ResourceInstance

uninstall
SVar
set
XPath Expression
Environment/Application/PromotedService/Binding
Environment/Application/PromotedReference/Binding
Environment/Application/Component/Node
Environment/Application/PromotedService/Binding/Node
Environment/Application/PromotedReference/Binding/Node
Environment/Application/LogicalNode/Node
Enterprise
Environment
Host
Environment/Node
Environment/Application/SVar
Environment/AppFragment/SVar
Inter-Object Relationships
Objects have parent-child or associative relationships with other objects.
In a parent-child relationship, such as that between an environment and a node or application, one object is
contained in its parent object. The relationship is expressed in the nested structure of the object definition.
For example, the Enterprise object is the parent of Environment, Host, ResourceTemplate, DAA, and
LogAppender. When a parent object is deleted, its children are deleted.
An associative relationship expresses an interaction between objects that does not involve ownership. An
example is the relationship between an application and an application template. To express associative
relationships you use a reference type when you identify the reference to one object by another object. For
example:
<Application xsi:type="amxdata:Application"
name="datemanager"
importBindings="true">
<ApplicationTemplate
xsi:type="amxdata_reference:ApplicationTemplate_reference"
name="JavaDateManagerSoa"/>
</Application>
Property File Reference

Property files contain Administrator server location and user-specific information used when running the
command-line interface.
Property
Type
Description
adminURL
URL
URL of the Administrator server.
username
String
Name of the Administrator user executing the task. The

user must have the permissions required to execute the
actions in the script.
password
String
Password of the Administrator user executing the task.
httpConnectionTimeout (s) Integer
Length of time to wait for the connection to the

Administrator server to establish.
httpAuthType
Type of authentication to use to secure communication

between the Administrator CLI and the remote
Administrator server:
basic - Use basic authentication. The username and
password credentials are sent in each request. Before
transmission, the user name is appended with a colon
and concatenated with the password. The resulting
string is encoded with the Base64 algorithm.
form - Use form-based authentication. After the
username and password credentials are validated by
the Administrator server, the server creates a session
identified by a unique key that is passed between the
client and server on each subsequent HTTP request.
This approach is more secure because authentication
credentials are only sent during the initial handshake
and not with every request.
String
Default: basic.
Property
Type
Description
javax.net.ssl.trustStore
String
Trust store properties used by the Administrator CLI to

connect to the Administrator server when the external
HTTP connector is enabled with SSL. The property values
are used to create the trust store file in the location
specified by the javax.net.ssl.trustStore property.
javax.net.ssl.trustStoreType String
javax.net.ssl.trustStorePassword Obfuscated
password
admin.cli.ssl.keystorelocation String
admin.cli.ssl.keystorepassword Obfuscated
password
admin.cli.ssl.keystoretype
String
admin.cli.ssl.keyalias
String
admin.cli.ssl.keypassword Obfuscated
password
Keystore properties are used by the Administrator CLI

to connect to the TIBCO Host instance when it is enabled
with JMX over SSL. The property values are used to create
the keystore file in the location specified by the
admin.cli.ssl.keystorelocation property.
Chapter
3
Administrator Server Management
Administrator servers maintain the configuration and runtime data of a TIBCO ActiveMatrix system. An
Administrator server gathers management data from nodes, interacts with the Administrator web and command-line
UIs, interacts with an authentication realm to authenticate users, interacts with hosts to manage nodes, and stores
and retrieves configuration and runtime data from the persistent store. Administrator server runs on the node
SystemNode, which is managed by the host SystemHost.
Administrator servers interact with other servers:
Database - maintains Administrator server configuration, performance, log, and payload data
Authentication realm - maintains user data
Notification - propagates status messages between Administrator server, hosts, and nodes
Messaging Bus - propagates messages between applications
UDDI server - (optional) maintains published service data
The communication channels between Administrator servers and other servers can be secured with SSL. For
information on SSL support, see the installation manual for your product.
The default ports used by these servers, their clients, and the mechanism for configuring the ports is listed in Table
8: Default Ports on page 55.
Table 8: Default Ports
Process
Default
Port
Client
Configuration Mechanism
SystemHost
6051
Administrator server
TIBCO Configuration Tool
Standalone host
6001
Administrator server
SystemNode
6021
SystemHost
DevNode
6031
SystemHost
HTTP connector
8120
Administrator UI and CLI
HTTPS connector
8120
Payload service
8787
Internal use only
Log service
8789
Service clients
Credential Server
6041
Hosts, nodes, and Administrator server TIBCO Configuration Tool

Configuration Tool
Enterprise Message
Service server
7222 or
7243
TIBCO Host Instances
Administrator Server
Enterprise Message Service

configuration file.
56 | Administrator Server Management
Process
Default
Port
Client
Notification Server
Administrator servers, nodes, hosts,

monitoring service
Messaging Bus
Applications:
Monitoring service
Logging service
Implementation and binding types
Product
User-defined
Configuration Mechanism
Authentication Realms
An authentication realm is the mechanism for storing information about Administrator users and groups. You select
and configure the authentication realm when you create the Administrator server. For details, see the installation
manual for your product.
DDL Script Generator
The DDL Script Generator is used to generate database specific DDL scripts that are based on user commands and
configuration. For more information see the installation manual for your product.
Topics
Administration Support for Older Hosts and Nodes

Creating an Administrator Server
Starting and Stopping an Administrator Server
Administrator Configuration Reference
Plug-Ins
Notification Server
Administrator Server Management | 57
Administration Support for Older Hosts and Nodes

The ActiveMatrix Administration server supports hosts and nodes of some older versions of the ActiveMatrix
software.
ActiveMatrix Service Grid may support many solutions in a production environment. Upgrading to a newer
version of the ActiveMatrix product may bring with it unique challenges. For that reason, some enterprises
may be reluctant to upgrade their entire set of applications to the new version at once. Some businesses may
choose to upgrade gradually, some may plan it in phases, and some may not upgrade their applications at
all.
To address the multiple business needs, TIBCO ActiveMatrix version 3.3.0 Administrator introduces the
ability to manage ActiveMatrix hosts, nodes, and applications running versions 3.1.5 and higher. This allows
businesses to install the latest ActiveMatrix software and continue to use and manage the existing ActiveMatrix
environments. Limited monitoring support for select versions earlier than 3.1.5 is available.
Figure 4: Managing older versions of hosts and nodes

The ActiveMatrix 3.3.0 Administrator can deploy applications to nodes running older versions of the
ActiveMatrix software. For example, you decide to upgrade your ActiveMatrix Administrator software
version 3.1.5 to ActiveMatrix version 3.3.0 and still want to continue to keep your nodes and applications
from the older version. The new Administrator makes this scenario possible and can manage both the
ActiveMatrix 3.1.5 and ActiveMatrix 3.3.0 environments seamlessly. The auto-provisioning feature filters
available nodes and product software for the target environments based on the respective TIBCO ActiveMatrix
software version. The Administrator UI will display the ActiveMatrix software version of every host and
node.
Bear in mind that node creation requires a specific version of the ActiveMatrix software available. For example,
if you want to create a node for a host running 3.1.5 HF6, then that version of the ActiveMatrix platform
software must be installed in the tibco.home used by the Administrator.
Creating an Administrator Server

You create an Administrator server with the Create TIBCO ActiveMatrix Administrator Server wizard in
TIBCO Configuration Tool.
Procedure
1. Start TIBCO Configuration Tool.
You can start the tool at the end of installation, or invoke the took separately.
2. Run the Create TIBCO ActiveMatrix Administrator Server wizard.
See the Installation and Configuration manual for your product for details.
Results
When the Administrator server is created, the following are created and are visible:
SystemNode - the node that runs the Administrator.
SystemEnvironment - the environment that contains SystemNode and applications that represent some
components of Administrator.
SystemHost - the host process that manages SystemNode.
Do not delete, undeploy, or uninstall from SystemEnvironment, SystemNode, or SystemHost.
For information on editing server configurations refer to the installation manual for your product.
For information on replicating an Administrator server, see the Installation and Configuration manual
for your product.
Starting and Stopping an Administrator Server

You start and stop an Administrator server by starting and stopping the SystemHost TIBCO Host instance.
The process differs for Windows and Linux systems.
Before you begin
You must start other servers before starting Administrator server:
The Enterprise Messaging Service server that is the notification server
The database server if you are using an external Administrator database
About this task
You start and stop an Administrator server by starting and stopping the SystemHost TIBCO Host instance.
SystemHost in turn starts SystemNode, the node on which the Administrator server runs.
Starting the SystemHost TIBCO Host Instance
Windows
If you created a Windows desktop shortcut, double-click the shortcut.
If SystemHost is registered as a Windows service:
1. Open the Windows Services application.
2. Click TIBCO ActiveMatrix Admin-enterpriseName-adminServerName.
3. Click Start.
Run CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\host\bin\tibcohost.exe.
UNIX Run CONFIG_HOME/tibcohost/Admin-enterpriseName-adminServerName/host/bin/tibcohost.
Certain caveats apply to specific UNIX versions:
AIX
tibcohost may fail to start with the error:
Failed to exec process : Arg list too long : ./tibcohost
To resolve, log on as root and run chdev
-l sys0 -a ncargs=40.
Linux
Disable SELinux with the command sudo
echo 0 > /selinux/enforce before running tibcohost.
The tibcohost process is started and the node processes managed by SystemHost, including
tibamx_SystemNode, are started.
Stopping the SystemHost TIBCO Host Instance
Windows
3. Click Stop.
Run CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\host\bin\tibcohost.exe
stop -wait true.
UNIX Run CONFIG_HOME/
stop -wait true.
tibcohost/Admin-enterpriseName-adminServerName/host/bin/tibcohost
If you perform the stop from the command-line using the -wait option, the command completes and you
are returned to the command prompt only after all the nodes are stopped.
Administrator Configuration Reference

You can configure the transport configuration and the session timeout for the Administrator server.
Transport Configuration
Property
Required? Editable? Accepts

Svars?
Description
Notification Server
Enterprise
Name
(Read-only). A name that defines a communication group

for notification messages sent between Administrator
server and the hosts that are bound to the server.
EMS Server
URL
The URL for the Enterprise Message Service server that

handles notification messages.
Default: tcp://localhost:7222.
Username
The Enterprise Message Service server user.
Password
The Enterprise Message Service server user's password.

(Administrator only) For superusers, passwords display
encrypted. For non-superusers, the password doesn't
display even if it was set when it was created. If you have
permission to edit the password, you can specify a new
value and save. If you edit other fields, the old value for
the password field is retained. If you want to set an empty
value as password, click the link Set Blank Password.
Recovery
Timeout(ms)
Length of time to wait between attempts to reconnect to

the Enterprise Message Service server.
Default: 15000.
Recovery
Attempt
Delay(ms)
The length of time to wait before sending out a status

notification. The runtime will wait a random interval from
0 to the specified number of milliseconds before sending
messages. A value of 0 disables this feature.
Default: 500.
Enable SSL
Enable SSL connections. When checked, the SSL properties

display.
Default: Unchecked.
SSL Client
Provider
The name of an SSL Client Provider.
Length of time before an Administrator GUI login session

times out due to inactivity.
General
Session
Timeout
Plug-Ins
Administrator server is an extensible web application. You can add new functionality to Administrator server
by uploading and deploying a plug-in that contains the new features.
You can click Admin Configuration > Plug-ins for a list of the available plug-ins.
Plug-Ins Reference
When you display the list of available plugins, you see the name, version, modification information, and
whether the plug-in is deployed or undeployed.
GUI
CLI
Editable? Required? Accepts Description
Property Element
SVars?
or
Attribute
Name
name
The name of the plug-in.
Version
N/A
The version of the plug-in.
Modified
By
N/A
The Administrator user that last modified the plug-in.
Modified
On
N/A
The date that the plug-in was modified.
State
N/A
The state of the plug-in: Deployed or Undeployed.
Notification Server
The notification server is an Enterprise Messaging Service server that performs two essential system functions
within the TIBCO ActiveMatrix platform. It delivers status messages sent by hosts and nodes to the
Administrator server.
Hosts and nodes send status messages for the following types of state changes:
Starting
Stopping
Running
Start failed
Status messages are not stored persistently.
The Administrator server also stores all the tasks with no outstanding dependencies associated with an action
on persistent queues in the notification server. For example, the following screen lists some of the pending
tasks for a deploy action:
The tasks are stored persistently so that if the node stops while the tasks are being processed, the action can
be completed after the node restarts.
Editing the Notification Server Configuration

You can edit the Notification Server configuration from the Admin Configuration interface. After you save
the configuration, the settings are updated in the Administrator server and are pushed to all hosts bound to
the server and all nodes managed by the server.
About this task
Follow these steps to update the configuration for the notification server.
Procedure
1. Select Admin Configuration > Admin Server .
2. Edit the properties in the Notification Server area.
3. Click Save.
Forcing a Reconnection
You perform this task if the Administrator server loses the connection to the Administrator server that serves
as the notification server. When this happens the Action History column reports In Progress.
Procedure
1. Select Admin Configuration > Admin Server .
2. Click Reconnect to EMS Server.
Chapter
4
Environments
An environment is a logical grouping of applications and nodes. An Administrator server can have multiple
environments. For example, you can define environments distinguished by product life cycle function such as
development and production, by geographical area, or by business unit.
Environments provide a way to isolate one group of applications and nodes from another. This is useful for security,
optimizing network traffic (each environment has its own Enterprise Message Service server for service bus
communication) and visual organization in the Administrator UI. Hosts can also be isolated and associated with
one or more environments.
Environments contain the following types of objects:
Applications The services and references defined by an application can be promoted to the application's
environment. Services and references promoted to the environment level can be wired to each other. The
following figure illustrates a service and reference exposed by a component, promoted to the composite level,
promoted again to the environment level, and wired between the promoted reference and service.
Figure 5: Cross Environment Wires

Nodes Nodes are runtime sandboxes that run application logic. Node names must be unique within an
environment and within a host.
Messaging Bus configuration
66 | Environments
Administrator Environment
The environment containing the node on which the Administrator server runs, SystemNode, is named
SystemEnvironment.
Development Environment
When you create an Administrator server you have the option to create a development environment and node. By
default, the environment is named DevEnvironment and the node is named DevNode.
Topics
Creating an Environment
Environment General Reference
Environment Configuration Reference
Messaging Bus
Environments | 67
Creating an Environment
You can create an environment with the New Environment wizard in the Administrator UI.
Procedure
1. Select Infrastructure > Environments.
2. Click New.
The New Environment wizard displays.
3. In the Name field, type a name for the environment.
4. Optionally provide description and contact information.
5. Check the Enable Security Validations checkbox to enable security validations.
When checked, Administrator does not allow the following actions:
Saving an environment's Messaging Bus configuration that is not SSL-enabled.
Creating a node on a host that is not secured with SSL over JMX.
Installing a node if the environment's Messaging Bus configuration is not SSL-enabled.
Deploying an application that uses a resource instance that is not SSL-enabled. Resource instances that
are referenced by the application's resource instances must also be SSL-enabled. All composite,
component, and binding properties are validated.
6. Check the checkbox for Enable Auto-Provisioning to automatically deploy applications providing
implementation or binding types to the target nodes when deploying user applications that require these
applications.
7. Click Next .
The Messaging Bus screen displays.
8. Specify the Messaging Bus details.
9. Click Finish to create the environment or Cancel to exit the wizard.
CLI
Procedure
1. In the AMXAdminTask element, type the action attribute to add and the objectSelector attribute to
Environment.
<AMXAdminTask action="add" objectSelector="Environment"/>
2. In the AMXAdminTask element, type the action attribute to set and the objectSelector attribute to
Environment/MessagingBus.
<AMXAdminTask action="set" objectSelector="Environment/MessagingBus"/>
3. Invoke the command-line interface on the build file.
68 | Environments
Environment General Reference

Enterprise properties include name, description, and contact information. You can also specify whether
auto-provisioning should be enabled.
<Node xsi:type="amxdata:Node"
Property
attributeList</Node>

SVars?
Description
Name
The name of the node. The name must start with a letter
and can contain letters, digits, dot, dash, and underscore.
Description
Short description of the node.
Modified By
RO
RO
The user that last modified the node.
Modified
On
RO
RO
The date that the node was modified.
Contact
Contact information.
Auto-
When enabled, applications providing implementation or

binding types are automatically deployed to the target nodes
when deploying user applications that require these
applications.
Indicate whether the environment is secure.
Provisioning
Secure
Environments | 69
Environment Configuration Reference

Environment configuration includes configuration of the nodes, configuration of the Enterprise Messaging
Server service, and Assigned Hosts.
Table 9: Nodes
Column
Description
Name
The name of the node. The name must be unique within the environment.
Host
The host the node is associated with.
Node State
The actual state of the node as reported by the runtime.

Not Running - after a node has been installed or when it was detected that the
node ended without being stopped by the host. This applies when the process is
detected as stopped.
Stopping - Stopping a node is expected to be a quick activity. If the node is stuck
at Stopping for more than a few minutes, checking the logs may indicate the
problem.
Starting - Starting a node is expected to be a quick activity. If the node is stuck at
Starting for more than a few minutes, checking the logs may indicate the problem.
Start Failed - The host was not able to start the node process. Possible causes are
that the node_classpath.tra file contains errors, the JRE libraries are not found,
or the OS is unable spawn additional processes. After this state ,the node is
disabled and must be manually enabled.
Running
The node.tra file has the property
to
alert when EMS server in unresponsive. However, the setting does not provide
an alert for closing connections and sessions.
java.property.com.tibco.tibjms.connect.attempt.timeout=3000
Version
ActiveMatrix node version.
Synchronization
Status
Indicates whether the node runtime matches the node's configuration in the
Administrator database.
Action History
The outcome of the last action performed with the intent of affecting the runtime
state.
Table 10: Assigned Host

Column
Name
Version
State
Description
Name of host instance.
ActiveMatrix host version.
State of the host:
Initializing
70 | Environments
Column
Description
Machine
Initializing_Failed
Initialized
Lost_Contact - when the host has lost contact with the Administrator server.
Starting
Starting_Failed
Running
Stopping
Unknown
Name of the machine on which the host is running.
Messaging server configuration reference.
Environments | 71
Messaging Bus
An environment's Messaging Bus is the communications backbone that mediates message exchange between
service consumers and providers. When a consumer makes a service request, it is the responsibility of
Messaging Bus to locate providers that offer the service and deliver the message to a provider.
Messaging Bus enables service virtualization. With service virtualization, a reference does not need to know
about the binding details of the service with which it is communicating. It only needs to know the name of
the service. Service virtualization allows applications within an environment to communicate without requiring
the applications' promoted services and references to have bindings.
Configuring an Environment's Messaging Bus

You can configure an environment's messaging Bus from the GUI or by using the CLI.
About this task
The following configurations are possible:
SSL is disabled in the EMS server.
Both SSL and non-SSL connections are enabled in the EMS server.
Only SSL connections are enabled in the SMS server.
GUI
Before you begin
Make sure you stop all applications in the environment before configuring the Messaging Bus properties.
Restart the node after configuring the Messaging Bus properties.
Procedure
1.
2.
3.
4.
5.
6.
Click Infrastructure > Environments.

Click an environment.
Click the Configuration tab.
Click the Messaging Bus link.
Configure properties according to Messaging Bus Reference on page 72.
Click Save.
CLI
Procedure
1. In the data file, specify a MessagingBus element in full format.
2. In the AMXAdminTask element, set the action attribute to add and the objectSelector attribute to
Environment/MessagingBus.
72 | Environments
Messaging Bus Reference

The below reference table provides information required to confiture the Messaging Bus while creating an
ActiveMatrix environment.
If you check Enable SSL checkbox then, a SSL server URL is mandatory. The non-SSL EMS Server
URL is optional.
Property
EMS
Server
URL

SVars?
Y
Description
Enterprise Message Service server location or locations. Can
be a comma-separated list of URLs for fault tolerance and
reconnection. If a comma-separated list is specified, the
Enterprise Message Service server must be configured for
fault-tolerant mode.
Default: tcp://localhost:7222
Login
Credentials
Username
Password
Indicate how the credentials required to authenticate to a

server are provided:
Username + Password - Provide inline username and
password credentials. When selected, the Username and
Password fields are activated.
Identity Provider - Provide username and password
credentials encapsulated in an identity provider resource.
When selected, the Identity Provider field is activated.
The username used to authenticate connections to the server.
The user's password used to authenticate connections to
the server.
value and save. If you edit other fields, the old value for the
password field is retained. If you want to set an empty value
as password, click the link Set Blank Password.
Identity
Provider
The name of the Identity Provider resource instance used

to authenticate the user.
Connection
Pool Size
Maximum number of connections used for sending or

receiving messages. Although messaging can work with
just one connection, the multiple connections allow parallel
message processing.
Default: 12.
Outbound
Session
Pool Size
Maximum number of sessions available to send messages

to the server.
Default: 24.
Environments | 73
Property

SVars?
Reconnect
Attempt
Count
Description
Number of times a node attempts to establish a connection
to the server before an error is returned.
Default : 600.
Modify the default reconnect attempt values to suit
your environment. If the messaging bus fails to
connect with the messaging server, restart the node
manually.
Reconnect
Attempt
Delay (ms)
Time interval between successive attempts to reconnect to

the server.
Default : 500.
For example, multiply the Reconnect Attempt Delay
(ms) with the Reconnect Attempt Count. Default is
300000 ms. The messaging bus attempts to reconnect
to the messaging server for the specified time and
then stops reconnect attempts.
EMS
Server SSL
URL
The SSL URL of the Enterprise Message Service server.
SSL Client
Provider
The name of an SSL Client Provider.
SSL
Property

SVars?
Description
Enable
SSL

display.
Default: Unchecked.
SSL Client N
Provider
The name of an SSL Client Provider on page 249 resource.
Configure N
SSL
(Not applicable to some resource templates) Invokes a

wizard to import certificates from an SSL-enabled server,
optionally create an SSL Client Provider resource, and
configure the trust store of the newly created or an existing
SSL Client Provider with the imported certificates. When
you complete the wizard, the SSL Client Provider field is
filled in.
Chapter
5
Hosts
Within the enterprise, hosts are used to manage nodes. A host can contain nodes from more than one environment.
Hosts are responsible for deploying applications and for other administrative tasks. Each host has a software
repository that contains the application templates, features, and resource adapters available to the nodes managed
by that host.
Hosts have types, but the only type currently supported is TIBCO Host.
A host is bound to a single Administrator server at a time. Hosts can contain nodes from multiple environments
within one Administrator server.
ActiveMatrix enables isolation of hosts so that enterprises can separate different groups and services. The features
are given below:
A host can be part of any number of environments.
If the host association is changed from All Environments to Specific Environments, support for nodes already
running on the host continues.
Node creation on the isolated host is limited to users in the associated environment or group of environments.
Host not associated with an environment is hidden.
It is not possible to remove a host from an environment if nodes for that environment are running on the host.
The host that manages the SystemNode node on which the Administrator server runs is named SystemHost.
Topics
Host Processes
Creating a TIBCO Host Instance
Assigning a Host to An Environment
Registering a TIBCO Host Instance as a Windows Service
Starting a TIBCO Host Instance
Stopping a TIBCO Host Instance
Enabling Secure Communication between a Host and an Administrator Server
Unregistering Hosts
Binding Hosts to an Administrator Server
Diagnostics
References
76 | Hosts
Host Processes
The path to the TIBCO Host instance process is different for the SystemHost TIBCO Host instances and for
other TIBCO Host instances.
The name of a TIBCO Host instance process is tibcohost. The path to the executable is:
SystemHost TIBCO Host instance CONFIG_HOME/tibcohost/Admin-enterpriseName-adminServerName/host/bin/tibcohost
enterpriseName is the name specified for the enterprise when you created the Administrator server.
If you use the default values for enterpriseName and adminServerName, amxadmin and instanceOne, the path
to the executable is CONFIG_HOME/tibcohost/Admin-amxadmin-instanceOne/host/bin/tibcohost.
Other TIBCO Host instances - CONFIG_HOME/tibcohost/instanceName/host/bin/tibcohost.
Hosts | 77
Creating a TIBCO Host Instance

You create a TIBCO Host Instance by running TIBCO Configuration Tool.
Procedure
1. Start TIBCO Configuration Tool.
2. Run the Create TIBCO Host Instance V3.3 wizard.
For details, see the Installation and Configuration manual for your product.
78 | Hosts
Assigning a Host to An Environment

You can assign a host to all environments or to specific environments.
Procedure
1.
2.
3.
4.
Select Infrastructure > Hosts .

Select a Host.
Click the Environments tab.
Choose whether to assign the host to all environments or to specific environments.
Option
Description
All Environments
1. Click Host Assigned to All Environments.

2. Click Save.
Specific Environments
1. Click Host Assigned to Specific Environments.

2. Select an environment from the Available Environment box and use
the arrow to move it to Assigned to Environments box.
Repeat the above step to select more environments.
3. Click Save.
CLI
Procedure
1. In the AMXAdminTask element, type the action attribute to add, and the objectSelector attribute to
Environment/Host.
<AMXAdminTask action="add" objectSelector="Environment/Host"/>
Hosts | 79
Registering a TIBCO Host Instance as a Windows Service

You can register SystemHost as a Windows service when you create it using TIBCO Configuration Tool. You
can also register SystemHost after it has been created.
Procedure
1. Copy TIBCO_HOME\tools\wrapper\pwrap.exe to
CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\host\bin.
2. Back up tibcohost.exe and rename pwrap.exe to tibcohost.exe.

Before renaming, make sure the tibcohost process is stopped.
3. Run tibcohost.exe --install.
The service TIBCO ActiveMatrix Admin-enterpriseName-adminServerName is added to the Windows Services
application.
4. Delete the renamed tibcohost.exe , and retain the backed up tibcohost.exe.
5. Start tibcohost using Windows Services.
80 | Hosts

You first start the SystemHost TIBCO Host instance and can then start other TIBCO host instances. The
process for starting a TIBCO Host instance is different on Windows and on Linux.
About this task
A TIBCO Host instance must be able to connect to the notification server on the configured port (by default,
7222). If this port is blocked by a firewall (the default on Windows systems), the instance will not start.
Starting the SystemHost TIBCO Host Instance
Windows
3. Click Start.
Run CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\host\bin\tibcohost.exe.
UNIX Run CONFIG_HOME/tibcohost/Admin-enterpriseName-adminServerName/host/bin/tibcohost.
Certain caveats apply to specific UNIX versions:
AIX
tibcohost may fail to start with the error:
Failed to exec process : Arg list too long : ./tibcohost
To resolve, log on as root and run chdev
-l sys0 -a ncargs=40.
Linux
Disable SELinux with the command sudo
echo 0 > /selinux/enforce before running tibcohost.
The tibcohost process is started and the node processes managed by SystemHost, including
tibamx_SystemNode, are started.
Windows
If the instance is registered as a Windows service:
2. Click TIBCO ActiveMatrix hostName.
3. Click Start.
Run CONFIG_HOME\tibcohost\instanceName\host\bin\tibcohost.exe.
UNIX Run CONFIG_HOME/tibcohost/instanceName/host/bin/tibcohost.
The tibcohost process is started and the node processes managed by the TIBCO Host instance are started.
Hosts | 81

You usually stop all TIBCO Host instances before you stop the SystemHost TIBCO Host instance.
Windows
If the instance is registered as a Windows service:
2. Click TIBCO ActiveMatrix hostName.
3. Click Stop.
Run CONFIG_HOME\tibcohost\instanceName\host\bin\tibcohost.exe
UNIX Run CONFIG_HOME/tibcohost/instanceName/host/bin/tibcohost
stop -wait true
stop -wait true.
The node processes managed by the TIBCO Host instance are stopped and the tibcohost process is stopped.
Stopping the SystemHost TIBCO Host Instance
Windows
3. Click Stop.
Run CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\host\bin\tibcohost.exe
stop -wait true.
UNIX Run CONFIG_HOME/
stop -wait true.
tibcohost/Admin-enterpriseName-adminServerName/host/bin/tibcohost
If you perform the stop from the command-line using the -wait option, the command completes and you
are returned to the command prompt only after all the nodes are stopped.
82 | Hosts
Enabling Secure Communication between a Host and an

You can enable secure communication over SSL from the Administrator UI.
Procedure
1.
2.
3.
4.
5.
6.
Select Infrastructure > Hosts .

Click a host.
Click the Security link.
Check the Enable Secure Management Communication checkbox.
Click Save.
Communication between the host and Administrator server is secured using SSL with a certificate obtained
from the TIBCO Credential Server.
Once enabled, the secure communication between the host and Administrator server cannot be disabled.
Hosts | 83
Unregistering Hosts
When you unregister a host you remove it from being managed by the Administrator server and destroy any
nodes that the host manages. You can unregister hosts from the GUI or by using the CLI.
About this task
GUI
Procedure
1. Select Infrastructure > Hosts .
2. Choose an unregister option.
Option
Procedure
Unregister
1. Click Unregister or select Unregister > Unregister . If no nodes are installed

on the host, the host is unregistered and deleted from the Administrator database.
If nodes are installed on the host, the operation fails.
Force Unregister
1. Select Unregister > Force unregister . Nodes are force uninstalled from the
host and the host, nodes, and application components deployed on the nodes
are deleted from the Administrator database. It's usually a good idea to first use
Unregister. If you decide to proceed with removing that data, use Force
Unregister.
CLI
Procedure
1. In the data file, specify a Host element in base format (the default).
<Host name="SecondHost" />
2. In the build file, set the action attribute of the AMXAdminTask element to delete and the objectSelector
attribute to Host.
<AMXAdminTask action="delete" objectSelector="Host"/>
3. To perform a force uninstall, specify the -force option.

<AMXAdminTask action="delete" objectSelector="Host" force="true"/>
84 | Hosts
Binding Hosts to an Administrator Server

When you bind a host to an Administrator server, the host and all the nodes the host manages are managed
by the server.
Before you begin
When the host is created, it must be configured to use the same Enterprise Message Service notification server
and enterprise name as the Administrator server to which it will be bound.
About this task
If you create a TIBCO Host instance, you cannot use that instance with an older version of the
Procedure
1. Select Infrastructure > Hosts .
The Hosts screen displays.
2. Choose whether to discover hosts or register a known host.
Option
Description
Discover
1. Click Discover.
2. Click Start Discovery.
3. In the Discovered Hosts list, check the checkboxes next to each host to bind and
type a name in the Name column.
4. From Assign to Environment drop-down list, select an environment or All.
5. Click Bind.
Register
1. Click Register.
2. In the Name field, type a name for the host.
3. In the Management URL field, change the machine and port to the machine and
port of the host to bind.
4. To enable secure communication between the host and Administrator server, check
the Secure checkbox.
If a host is bound to another Administrator server, the bind fails. Otherwise, the host binds to the
3. If the host is bound to another server you can take control of it by checking the Force Bind checkbox and
clicking Bind.
First run with Force Bind unchecked to see if the host is already bound. That way you can investigate if
this is really a host you should be binding to. If you determine that it you can take control of the host from
another Administrator server, only then should you use the force option.
With the Force Bind checked, even if the host is already bound, the bind does not throw an error. Instead
the host severs its connection with the existing Administrator server, and bind to this Administrator server.
Discover Hosts Reference

When want to bind hosts to an Administrator server, you can use a Discover operation to see hosts that can
bind to a server.
Select Infrastructure > Hosts > Discover to discover hosts to bind to the Administrator server.
Hosts | 85
Column
Description
Discovery Timeout(s)
The time, in seconds, after which the discovery process stops.
Name
The name of the host. The name must be unique on the

Management URL
The JMX URL used to communicate to the host.
Version
Secure
Indicate whether to communicate with the host using a secure

channel.
Assign to Environments
Assign a host to an environment.
Register Host Reference

Select Infrastructure > Hosts > Register to register the host.
Field
Description
Name
The name of the host. The name must be unique on the Administrator server.
Description
Optional description.
Host Type
The type of the host: TIBCO Host.
Management URL
The JMX URL used to communicate to the host. Stored in the file
CONFIG_HOME\tibcohost\instanceName\data_3.2.x\host\
configuration\jmxendpoints.properties.
Force Bind
Indicate whether to remove an existing binding between the host and another
Administrator server and create a new binding between the host and this
Secure
Indicate whether to communicate with the host using a secure channel.
86 | Hosts
Diagnostics
The TIBCO ActiveMatrix diagnostic tools help extract various types of information from a host or node in
order to optimize performance and troubleshoot issues quickly. Diagnostic tools are available from the
Administrator UI, and as TIBCO host shell commands.
All diagnostic commands require the host to be running. Some node-related commands also require the node
to be running. Using the diagnostics tool you can:
View status of application components when runtime and action histories do not match.
Verify if any connection pools are not released when applications are slow.
View memory usage of a host or node.
Get information about an applications and its components.
Get information about one or more application components.
Accessing and Using Diagnostics Commands

You can access the diagnostics commands using the TIBCO host shell command.
Procedure
1. View the list of diagnostics commands by entering the following in the command window:
CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\host\bin\tibcohost.exe help.
Under the Diagnostics Commands heading, the following commands are available:
describeApplications
describeComponents
describeDeployedResourcePools
getLogFiles
getMemoryUsage
getThreadDump
2. To view the description and arguments for each of the above command, enter the following command:
CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\host\bin\tibcohost.exe help
command
The following example shows how to retrieve memory usage for a node.
Example
Memory Usage
The following examples show how to retrieve memory usage for a node. If a node name is not specified, the
command displays host memory usage.
C:\AMX\tibcohost\Admin-amxadmin-instanceOne\host\bin\tibcohost.exe getMemoryUsage -nodeName
DevNode
Invoking getMemoryUsage
-nodeName DevNode
Heap memory usage for node "DevNode" follows:
Initial size: 128MB
Maximum size: 494.9MB
Committed size: 162.6MB
Non-heap memory usage for node "DevNode" follows:
Initial size: 23.2MB
Maximum size: 240MB
Committed size: 77.6MB
Amount used: 77.4MB
Hosts | 87
Retrieving Log Files for Hosts and Nodes from Administrator

You can retrieve log files for a host or a node using the diagnostics tool from the Administrator.
Procedure
1.
2.
3.
4.
Select Infrastructure > Hosts or Nodes.

Select a host or a node.
Click the Diagnostics tab.
Choose one of the following options:
All Log Files
Log files for the past days, or the past hours
5. Click Download Logs.

You can Open or Save the log files.
88 | Hosts
References
The topics in this section provide detailed references to elements in the User Interface and CLI.
Hosts Reference
Information about a host includes its name, type, state, machine name, and action history.
Select Infrastructure > Hosts to find the state of the host.
Column
Name
Version
Host State
Machine
Action History
Description
Name of host instance.
State of the host:
Initializing
Initializing_Failed - click the Action History link to get more information.
Initialized
Lost_Contact - when the host has lost contact with the Administrator server.
Starting
Starting_Failed - click the Action History link to get more information.
Running
Stopping
Unknown
Name of the machine on which the host is running.
Outcome of the last action performed with the intent of affecting the runtime state.
Host General Reference

You can view information about hosts including the runtime state, action history, modification information,
and more in the Administrator UI.
Select Infrastructure > Hosts for a list of hosts. Click on a host to view details.
GUI Property

SVar?
Description
Version
Runtime State
RO
RO
The state of the host.
Action History
RO
RO
The status of the last runtime action performed on

the host.
Description
Optional description.
Contact
Modified On
RO
RO
The date that the host was modified.
Hosts | 89
GUI Property

SVar?
Description
Modified By
RO
RO
The user that last modified the host.
Management URL Y
The JMX URL used to communicate the status of

nodes managed by the host and send life cycle
commands such as start and stop to the nodes.
Operating System RO
RO
The operating system on the machine on which the

host is running.
Machine Name
RO
The name of the machine on which the host is

running.
RO
Host Configuration Reference

You can view a host's logging configuration and security configuration from the Administrator UI.
Select Infrastructure > Hosts to view the list of available hosts. Select a host and navigate to the Configuration
tab to access the Logging Configurations and Security settings .
Logging Configurations
Table 11: Logging Configuration: Basic and Advanced Mode
Property

SVars?
Description
Logger Name
The name of the logging configuration. The logging

configuration name must be the name of a logger in
the source code or the name of the package in which
the source code is contained.
Log Level
All events of a level equal to or lower than the specified

level are logged. For the Info level, Info, Warn, Error
and Fatal events are logged. One of:
TRACE All events.
DEBUG Fine-grained informational events used
for debugging an application.
INFO Coarse-grained informational messages that
highlight the progress of the application.
WARN Potentially harmful events.
ERROR Errors that allow the application to
continue running.
FATAL Errors that cause the application to fail.
OFF Blocks passing messages to a parent
Additivity
One of:
true Log messages are passed to the parent logging
configuration.
false Log messages are not passed to the parent
logging configuration.
Appender
The destination to which log events are appended.
(FileAppender,
JmsAppender)
90 | Hosts
Security
Check the Enable Secure Management Communication checkbox to secure the communication between the
host and the Administrator server using certificates obtained from the TIBCO Credential Server.
Host Substitution Variables Reference

A small set of substitution variables is defined for a host. You can add or delete substitution variables from
the Administrator UI.
Use the Add button to add variables for use in properties or logging configurations or the Delete button to
remove variables so they can be resolved at another level, such as the environment.
Table 12: Substitution Variables
Property
Required? Editable?
Description
Substitution
Variable Name
Name of the substitution variable.
Type
Type of the substitution variable. One of

String
Integer
Boolean
Password
Default: String.
Description
Description of the substitution variable.
Local Value
Local value or the substitution variable.
Host Resource Instances Reference

You can view host resource instance information such as the instance name, template name, instance state,
node, and instance state in the Administrator UI.
Column
Description
Instance Name
Name of the resource instance.
Type
Type of resource template.
Scope
The scope of the resource template. It could be global, environment, or application.
Template Name
Name of the resource template from which the instance was created.
Instance State
State of the resource instance.

Not Installed - after a resource instance has been added to a node and before it has
been installed
Running - after a resource instance has been installed and the node on which it has
been installed is Running
Uninstalled - either the resource instance is uninstalled or the node on which the
resource instance is installed is Not Running
Synchronized
Indicates whether the resource instance runtime matches the host's configuration in the
Node Name
Node where the resource instance is installed.
Hosts | 91
Column
Description
Action History
Outcome of the last action performed with the intent of affecting the runtime state.
Chapter
6
Nodes
A node is the runtime environment for applications. Nodes exist in an environment and are managed by hosts.
When managed by a host, a node runs in its own OS process and JVM. You can configure a host with multiple
nodes. Nodes act as sandboxes for applications.
The reasons to use multiple nodes include:
Increase throughput.
Run different versions of software and limit the set of affected application fragments when updating software
versions.
Allow applications to use different resource instance configurations of the same name.
Enable fault tolerance.
Implement various security policies by limiting access to certain nodes and resources.
The reasons to share a node include:
Share resource instances between applications such as thread pools and database connection pools.
Communication between components in a node avoids serialization overheads.
Reduced overall memory utilization.
Application fragments are components or bindings of an application that are distributed and deployed to nodes.
A fragment can be distributed to many nodes, and a single node can run many fragments. To increase throughput
for a component or binding you can deploy multiple copies of the fragment to multiple nodes.
A node has a set of product and features shared by resource instances and application fragments running on the
node. You can upgrade or downgrade the features to match the feature versions to those available in the software
repository.
The node on which the Administrator server runs is named SystemNode.
The following figure depicts a configuration of environments, hosts, and nodes that shows the flexibility achieved
with a multi-node setup. The two environments are assigned to groups of users that have responsibility for a
specific phase of the application life cycle: Development and Production. Isolation between the groups is achieved
by creating two nodes on each host and assigning them to different environments. Nodes A and B are located on
Host 1 and nodes C and D are located on Host 2. Nodes A and C are managed by the Development environment
and nodes B and D are managed by the Production environment. In addition, access to a JDBC resource is restricted
to the nodes in the Production environment.
94 | Nodes
Figure 6: Multiple Node Scenario
Topics
Node Processes
Developer Node
Navigating to a Nodes List
Creating a Node
Editing a Node
Installing or Syncing Nodes
Uninstalling Nodes
Starting Nodes
Manually Restarting Nodes
Stopping Nodes
Deleting Nodes
Capturing Thread Dump for a Node from Administrator
References
Transaction Recovery Configuration
Nodes | 95
Node Processes
A node process is named tibamx_nodeName, where nodeName is the name of the node. The executable is at
different location for nodes managed by the SystemHost TIBCO Host instance and nodes managed by other
TIBCO Host instances.
The location of the process executable is:
Nodes managed by the SystemHost TIBCO Host instance CONFIG_HOME\tibcohost\INSTANCE_NAME\data_3.2.X\nodes\nodeName
enterpriseName is the name specified for the Administrator enterprise when you created the Administrator
server
adminServerName is the name specified for the Administrator server.
If you use the default values for enterpriseName and adminServerName, amxadmin and instanceOne, the path
to the executable is CONFIG_HOME\tibcohost\INSTANCE_NAME\data_3.2.X\nodes\nodeName.
Nodes managed by other TIBCO Host instances CONFIG_HOME\tibcohost\INSTANCE_NAME\data_3.2.X\nodes\nodeName
96 | Nodes
Developer Node
When you create an Administrator server you have the option to create a developer node. The default name
of the node is DevNode. The names of any additional hosts that you create must be unique on the host and
also within the environment.
Nodes | 97
Navigating to a Nodes List

You can navigate to a nodes list from the environment, from the host, or from the nodes display.
Procedure
Choose a starting point and follow the relevant procedure:
Starting Point
Procedure
Node
1. Select Infrastructure > Nodes.

2. Select an environment from the Environment drop-down list.
Environment
1.
2.
3.
4.
Select Infrastructure > Environment.

In the Environments list, click an environment.
Click the Nodes link.
Host
1.
2.
3.
4.
Select Infrastructure > Host .

In the Hosts list, click a host.
Click the General tab.
Expand the host and environment nodes.
98 | Nodes
Creating a Node
You can create a node from the GUI or by using the CLI.
GUI
About this task
You create a node in an environment and associate it with a host within the environment.
Procedure
1. Choose a starting point and follow the appropriate procedure.
Starting Point
Procedure
Environments
1. Select Infrastructure > Environments.

2. Select an environment and click the Configuration tab and click Nodes.
3. Click the Add button.
Hosts
1. Select Infrastructure > Hosts.

2. Select an environment and click the Configuration tab and click Nodes.
3. Click the Add button.
Nodes

2. Click the New button.
The New Node dialog displays.

2. In the Name field, type a name.
3. If you have not started from a host, choose a host.
Select a host from the Host drop-down list.
Only hosts associated with the environment are visible. If there are unavailable hosts, they can
be viewed by clicking the Unavailable hosts link.
Click add host.
The Add Host dialog overlays the New Host dialog allowing you to bind to a host.
4. Optionally add one or more of the features available to the Administrator server.
In most cases you can skip this step since Administrator will automatically add features to a node
when required -- for example, deploying an application or installing a resource instance. In rare
cases, you may have to add features to a node explicitly if the features is from the shared library.
The explicit addition of features to a node can be done during and after node creation, and during
installation of application or application running.
5. Click Save.
The node is added to the Nodes list with a Runtime State of Not installed.
Nodes | 99
CLI
Procedure
1. In the data file, specify a Node element in full format.
<Node xsi:type="amxdata:Node" name="DevNode" hostName="SystemHost"
contact="TIBCO" portNumber="5006">
</Node>
Environment/Node.
<AMXAdminTask action="add" objectSelector="Environment/Node" />
100 | Nodes
Editing a Node
You can edit a node from the GUI or by using the CLI.
GUI
Procedure
1. Navigate to a nodes list.
2. Select a node.
The node details display in the General tab.
3. Edit the contact, description, and the startup mode.
4. Click the Configuration, Substitution Variables, Resource Instances tabs for other editable information.
5. Click Save.
CLI
Procedure
1. In a data file, specify a Node element in full format using the new attribute values.
2. In the AMXAdminTask element set the action attribute to edit and the objectSelector attribute to
Environment/Node[@name='nodeName'], where nodeName is the name of the node to edit.
Updating the Port Number for a Node

You can update the port number for a node from the GUI or by using the CLI.
GUI
Procedure
1. Starting Point
Procedure
Nodes
1.
2.
3.
4.
Hosts
1. Select Infrastructure > Host

2. Select a node from the Nodes list.
3. Click the General tab.
Starting Point
Procedure
Nodes
1.
2.
3.
4.
Hosts
1. Select Infrastructure > Host
Select Infrastructure > Nodes.

Select an environment from the Environment drop down list.
Select a node from the Nodes list.

Select an environment from the Environment drop down list.
Select a node from the Nodes list.
Nodes | 101
Starting Point
Procedure
2. Select a node from the Nodes list.
2. Update the port number.

3. Click Save.
4. The updates take effect when the node is next started. If the node is out of sync, click Install or Sync. If
the node was running, restart the node.
CLI
About this task
The port number used by the node can be updated using the Administrator CLI using the files node_data.xml
and node_build.xml located in TIBCO_HOME/administrator/version/samples .
Procedure
1. Edit node_data.xml and update the Node element.
2. Edit node_build.xml and update the objectSelector attribute to Environment/Node[@name='nodeName'],
where nodeName is the name of the node.
3. Run ant -f node_build.xml update.
The port number is updated. Using the Administrator GUI, navigate to a nodes list to see the updated
port number. The Action History of the node changes to Change node management port Successful.
Updating the JVM Configuration for a Node

You can update the Java Virtual Machine (JVM configuration for a node from the Administrator UI. A restart
of the node is required as part of the process.
Procedure
2. Select a node.
The node details display in the General tab.
3. Click the Configuration tab.
4. Click the JVM Configuration link.
The JVM arguments are displayed.
5. Modify the JVM arguments and click Save.
See Node Configuration Reference on page 112 for more information.
6. Click Install or Sync.
7. Restart the node.
102 | Nodes
Enabling and Disabling the Java Security Manager

A Java security manager is available for a node, but is disabled by default. You can enable and disable the
security manager by editing the node's .tra file.
About this task
A Java security manager prevents code from calling System.exit. When a security manager is enabled, the
node process by accidentally or by calling System.exit. However, a security manager may lead to a
performance degradation if code is written to perform most system API calls in a privileged block according
to Java best practices for security. Therefore, although a security manager is available for a node, by default
the security manager is disabled. You can set a node configuration property to enable the security manager
in scenarios where the safety measure is more important than the performance or for diagnostic purposes.
Enabling
Add the property amx.securitymanager.enabled=true to the .tra file of the node.
Restart the node.
Disabling
Reset the value of the amx.securitymanager.enabled property to false in the .tra file of the node.
Restart the node.
The .tra file of the node is located in the folder
CONFIG_HOME/tibcohost/Admin-enterpriseName-adminServerName/data_3.2.x/nodes/nodeName/bin.
Enabling and Disabling Debuggers

Debuggers are used to debug remotely deployed applications by attaching to a running application. Before
debugging a remotely deployed application, you must enable debuggers on the nodes on which the application
is deployed.
Enabling Debuggers
About this task
Debuggers should not be enabled in production systems as a rogue process could attach to a debugger
and halt the node.
Enabling a debugger will increase the time it takes to receive responses to requests sent to applications
running on the node.
Procedure
1.
2.
3.
4.
5.
Navigate to a nodes list.

Click a node.
Click the Debuggers link.
Click the next to a debugger type.
The debugger properties display.
6. If the port property is not set:
a) In the row for the Debug Port, click the Property Value column, and type a port value that is not
currently used on the node's host.
b) Click in another column. The Save button is enabled.
c) Click Save.
The Synchronization column changes to Out of Sync.
Nodes | 103
7. Click a debugger and click Enable.

Debugger Type
Result
Java
The State column changes to Enabled.
Platform
An application com.tibco.amf.debugger.daa.NodeName is created if one

does not exist and the application is deployed on the node and started. The
State changes to Enabling and then Enabled.
8. If you have enabled a Java debugger, restart the node.

Disabling Debuggers
Procedure
1.
2.
3.
4.
Navigate to a nodes list.

Click a node.
Select a debugger and click Disable.
The debugger is disabled.
If you disable the platform debugger, the application com.tibco.amf.debugger.daa.NodeName that was
created when you enabled the debugger is deleted.
104 | Nodes
Installing or Syncing Nodes

You can install or sync a node from the GUI or by using the CLI.
Before you begin
Clicking the Install or Sync button either installs the node or syncs the node by applying the latest
configuration changes.
About this task
The install or sync action performs any of the following actions:
Creates the node on the host. This action is skipped if the node is installed or running.
Applies updated configuration changes.
Installs features.
Update the port number.
Update the JVM values
Enables or disables debuggers.
Installs the platform applications and associated resource instances.
To complete the installation process, the node must be started.
GUI
Procedure
2. In the Nodes list, click one or more nodes.
3. Choose an install option.
Install Option
Effect
Install or Sync or
Install or Sync Install/ Sync
If the Runtime State is Not Installed, the node runtime files are
created in the file system, the Runtime State changes to Not
Running and the Action History is Platform Install will resume
after node start.
If the Runtime State is Not Running or Running, there is no
change.
Install or Sync Install with Resolve
Applies changes to the node's configuration to the runtime and

Using the Resolve mode will cause the causes all applications deployed on the node to use the latest
node to restart (and by extension all
versions of the features on which they depend.
components and bindings on the node).
Install or Sync Resolve only
Causes all applications deployed on the node to use the latest

versions of the features on which they depend.
4. If the Action History is Platform Install waiting for node start, click Start.
The Runtime State changes to Running and the Action History changes to In Progress and then to Start
Successful.
Nodes | 105
CLI
Procedure
1. In the data file, specify an Environment and one or more Node definitions in base format. You can also
use a data file previously used to create the nodes in which the nodes are specified in full format.
<Environment name="DevEnvironment"
<Node name="node1"/>
</Environment>
2. In the build file, set the action attribute of the AMXAdminTask element to install and the objectSelector
attribute to Environment/Node.
<AMXAdminTask action="install" objectSelector="Environment/Node" />
106 | Nodes
Uninstalling Nodes
You can uninstall a node from the GUI or by using the CLI. If the nodes are not stopped, you can use the
Force Uninstall option.
GUI
Procedure
1. Infrastructure > Nodes
3. Choose an uninstall option.
Option
Procedure
Uninstall
1. Click Uninstall or select Uninstall

Uninstall.
The nodes must be stopped and no application fragments can
2. Uninstalls the nodes.
be distributed to the nodes.
Force Uninstall
1. Select Uninstall Force Uninstall.
Terminates the nodes, deletes application components, and

uninstalls the nodes. Components running on the nodes are
not notified before the nodes are stopped.
CLI
Procedure
</Environment>
</Environment>
3. In the build file, set the action attribute of the AMXAdminTask element to uninstall and the
objectSelector attribute to Environment/Node. To perform a force uninstall, specify the force="true"
attribute.
<AMXAdminTask action="uninstall" objectSelector="Environment/Node" />
Nodes | 107
Starting Nodes
You can start nodes using the Administrator GUI or CLI. If the Administrator server is not running, you can
start the nodes by starting the TIBCO Host instance that manages the nodes.
GUI
Procedure
3. Click the Start button.
The Node State of the node changes to Starting.
4. Click the Refresh button until the Runtime State changes to Running.
CLI
Procedure
</Environment>
</Environment>
3. In the build file, set the action attribute of the AMXAdminTask element to start and the objectSelector
attribute to Environment/Node.
<AMXAdminTask action="start" objectSelector="Environment/Node" />
108 | Nodes
Manually Restarting Nodes

You can manually restart a node using the Administrator GUI. Before you can restart the node, you must
address the issue that prevented the node from starting.
Procedure
2. In the Nodes list, select the node that failed to start.
3. In the Details panel, choose Disabled from the Startup Mode drop-down list and click Save.
Synchronization status changes to Out of Sync. Startup Mode status changes to Disabled.
4. Click the Install or Sync button.
Synchronization status changes to In Sync. Startup Mode status remains as Disabled. Action History
status changes to In Progress.
5. In the Details panel, select Automatic or Manual from the Startup Mode drop-down list and click Save.
Synchronization status changes to Out of Sync. Startup Mode status changes to Automatic or Manual.
6. In the Nodes panel above click the Install or Sync button.
Synchronization status changes to In Sync.
7. Click the Start icon.
The node is started.
It may take few seconds before the Start
clicking the Refresh button.
Successful
status appears in Action History. Try
Nodes | 109
Stopping Nodes
You can stop a node using the Administrator GUI or CLI. If the Administrator server is not running, you can
stop the node by stopping the TIBCO Host instance that manages the node.
GUI
Procedure
2. Click one or more nodes.
3. Choose a stop option.
Option
Description
Stop or Stop Stop
Stops the nodes. Components running on the node are notified and allowed
to finish work. The components may take a few minutes to an hour to stop.
Stop Stop immediately
Stops the nodes. Components running on the node are notified and allowed
to perform clean up operations such as closing connections. The components
typically take a few seconds to stop.
Stop Terminate node

process
Stops the nodes. Supported only for nodes running on a host of type TIBCO
Host. Components running on the node are not notified before the node
is stopped.
CLI
Procedure
</Environment>
2. In the build file, set the action attribute of the AMXAdminTask element to stop, the options attribute to
nothing, immediate, or terminate, and the objectSelector attribute to Environment/Node.
<AMXAdminTask action="stop" objectSelector="Environment/Node" />
110 | Nodes
Deleting Nodes
You can delete a node from the GUI or by using the CLI
GUI
Procedure
3. Choose a delete option.
Option
Delete
Procedure
Deletes the nodes from the database.
The node must be uninstalled and no

application components can be
distributed to the node.
1. Click Delete or Delete Delete.
Force Delete
1. Click Delete Force Delete
Terminates and uninstalls the nodes, deletes components, and

deletes the nodes from the database. Components running on the
nodes are not notified before the nodes are stopped.
This option is enabled only if you have the necessary permissions.
See Setting Enterprise Permissions on page 301 for more
information.
You should exercise extreme caution when using this
option as it may leave your system in a non-working state.
CLI
Procedure
1. from conref_source/t_first_step_for_cli_tasks
</Environment>
attribute to Environment/Node. To perform a force delete, specify the force="true" attribute.
<AMXAdminTask action="delete" objectSelector="Environment/Node" />
Nodes | 111
Capturing Thread Dump for a Node from Administrator

You can view the thread dump of a node from Administrator.
Procedure
1.
2.
3.
4.

Select a node.
Click the Diagnostics tab.
Click Capture Thread Dump.
A new window with the thread dump of the node displays.
Related Topics
Retrieving Log Files for Hosts and Nodes from Administrator on page 87
You can retrieve log files for a host or a node using the diagnostics tool from the Administrator.
Diagnostics on page 86
The TIBCO ActiveMatrix diagnostic tools help extract various types of information from a host or
node in order to optimize performance and troubleshoot issues quickly. Diagnostic tools are available
from the Administrator UI, and as TIBCO host shell commands.
112 | Nodes
References
Node General Reference

You can view a node's general information, including its name, host it's running on, port number, and more
from the Administrator GUI.
<Node xsi:type="amxdata:Node"
Property
attributeList</Node>

SVars?
Description
Name
The name of the node. The name must start with a letter
and can contain letters, digits, dot, dash, and underscore.
Contact
Modified
By
RO
RO
The user that last modified the node.
Modified
On
RO
RO
The date that the node was modified.
The name of the host associated with the node.
Host
Also used to identify the owner of the node.

Port
Number
The port of the node on which it receives life cycle

management messages from the host. The number
assigned to a new port is two more than the largest
number currently assigned to any port on the host.
Used only when host is of type TIBCO Host.
Default: 26842.
Startup
Mode
The startup mode of the node:

Automatic - The node starts when the TIBCO Host
instance that manages the node is started.
Manual - The node starts when an Administrator start
action is applied to the node.
Disabled - The node cannot be started.
Version
Version of the node.
Description
Short description of the node.
Node Configuration Reference

Features
Column
Description
Name
The name of the feature.
Type
The type of the feature.
Nodes | 113
Column
Description
Version
The version of the feature.
Status
The status of the feature:

Installed
Marked for Install
Marked for Uninstall
Property

SVars?
Description
Logger Name

Log Level

TRACE All events.
continue running.
Additivity
One of:
configuration.
Appender
(FileAppender,
JmsAppender)
Debuggers
Property
Required? Editable?
Accepts
SVars?
Description
Type
The type of the debugger:

Java Debugger - supports debugging Java and
Spring component implementations. Implemented
by changing properties on the Java VM in which
the node runs. Requires restarting the node enable.
114 | Nodes
Property
Required? Editable?
Accepts
SVars?
Description
Platform Debugger - supports debugging composite
applications. Implemented as a composite
application that runs on the node.
State
The state of the debugger:

Marked for Enable - displayed by a Java Debugger
when you set the value of the Debug Port property.
Enabling
Enabled
Disabled
Synchronization Y
Indicates whether the node runtime matches the node

version in the Administrator database.
Property
Name
The name of the property to configure:

Java - Debug Port
Platform - TCP Port
Property Value Y
The property value.
JVM Configuration
This link is displayed only if the node is associated with a TIBCO host.
Property

SVars?
Max Heap N
Size (MB)
Java
Thread
Stack Size
(KB)
Description
The maximum size of the heap for the JVM. If Max Heap
Size is specified -Xmx Max Heap Size m is appended to
the JVM argument string.
The size of the Java thread stack. If a Java thread stack size
is specified the string -Xss Java Thread Stack Size k
is appended to the JVM argument string.
Enable
JVM
Security
Manager
When enabled, code running on the node cannot shut down

the node process by accidentally or purposefully calling
System.exit.
General
Args
General arguments to pass to the JVM.
Properties N
Properties to pass to the JVM. For each property, name is

required but value is optional. For a property with a value
the string -Dname=value is appended to the JVM argument
string. For a property without a value the string -Dname is
appended to the JVM argument string.
JVM
RO
Argument
String
RO
The argument string passed to the JVM. It is generated from

the other properties.
Nodes | 115
Tuning
A node supports resource instances as JCA resource adapters. Resource adapters can dispatch runnable jobs
to the JCA work manager which internally uses a JCA thread pool to execute the jobs. There is one JCA thread
pool per node and all resource adapters use same thread pool to dispatch their jobs. Currently only the JMS
resource adapter is using this thread pool for its job execution.
Property

SVars?
Core Pool N
Size
Description
When a new task is submitted and fewer than Core Pool
Size threads are running, a new thread is created to handle
the request, even if other threads are idle. If there are greater
than Core Pool Size but fewer than Max Pool Size threads
running, a new thread is created only if no threads are idle.
Must be greater than or equal to zero.
Default: 2. Two threads are used to service one request: one
for receiving the request and one for receiving the response.
Max Pool
Size
The maximum number of threads in the pool. Must be

greater than zero and greater than or equal to Core Pool
Size.
Default: 250.
Keep
Alive
Time (s)
The amount of time an idle thread remains in the pool before

being reclaimed if the number of threads in pool is more
than Core Pool Size.
Default: 60 s.
Node Substitution Variables Reference

You can Add and Delete node substitution variables from the Administrator GUI.
Property
Required? Editable?
Description
Substitution
Variable Name
Type

String
Integer
Boolean
Password
Default: String.
Description
Local Value
116 | Nodes
Node Resource Instances Reference

You can view node resource instance information in the Administrator GUI. The information includes the
instance name, and state, the resource template, and whether the resource instance matches the nodes's
configuration.
Column
Description
Instance Name
The name of the resource instance.
Type
The type of the resource instance.
Template Name
The name of the resource template from which the instance was created.
Instance State
The state of the resource instance.

been installed
Synchronized
Indicates whether the resource instance runtime matches the node's configuration in
the Administrator database.
Node Name
The node where the resource instance is installed.
Action History
The outcome of the last action performed with the intent of affecting the runtime state.
Nodes | 117
Transaction Recovery Configuration

XA enabled shared resources (SRs) participate in global transactions. Global transactions are transactions
that are coordinated by the transaction manager (TM) within a node. In the event of a crash of the node, the
shared resources can update themselves to the decided state of the global transaction when they recover.
Nodes bundle the Geronimo transaction manager which is configured to use a HOWL's transaction logger
to record the state of transactions, that is, the names of the XA SRs involved in each transaction, whether they
are prepared/committed, and also the overall decision to commit/rollback the transaction.
The Geronimo TM requires a persistent TM ID (unchanged over restarts) in order to be able to identify the
transactions it initiated in the HOWL logs. If this ID is lost, the TM will not be able to correctly resolve the
undecided transactions of recovering XA resources. Since it has this persistent TM ID, there also needs to be
a persistent transaction count, in order to have consistently unique transaction IDs (made by coupling the
two). The ID and the count are stored in the folder
CONFIG_HOME/tibcohost/hostName/nodes/nodename/work/GeronimoTMID in the files tmid.bin and
xidcount.txt.
Outbound XA SRs (for example, JDBC-XA, JMS) are recovered when a node is restarted and the SRs are
initialized. Recovery code will automatically create a connection to the actual resource and recover it. Inbound
XA SRs are recovered when the node restarts when the application initializes the transport endpoints with
the resource adapter. Recovery code will automatically create a connection to the actual resource and recover
it.
Transaction recovery will not work under the following circumstances:
HOWL logs are deleted
The TM ID file is deleted
(Outbound SRs) If, when a node restarts, the SR has been undeployed/removed.
(Outbound SRs) The SR has been deployed without authentication credentials (that is, the authentication
credentials are to be supplied at runtime). Recovery code will not be able to create a connection because
it won't have the credentials.
Recovery does not work without a restart. For example, if the transaction manager loses connection with
an XA SR at some point during transaction commitment, the transaction branch of the XA SR may remain
in prepared state and not be recovered until the TIBCO Host instance is restarted. node restart.
For information on configuring the log files, see Configuration Properties for HOWL Log Files on page 118
Transaction Recovery Issues
Oracle database - If this error is seen in the logs, the database user does not have sufficient privileges to
perform recovery :
17 Nov 2009 17:48:06,312 [TxRecoveryThread: java:V13_NewJDBCResource1] [ERROR]
RecoveryController - Recovery error
javax.transaction.xa.XAException
at oracle.jdbc.xa.OracleXAResource.recover(OracleXAResource.java:703)
at com.tibco.amf.sharedresource.runtime.tibcohost.jdbcxa.WrappedXAResource.recover
(WrappedXAResource.java:122)
at org.apache.geronimo.transaction.manager.WrapperNamedXAResource.recover
(WrapperNamedXAResource.java:74)
at org.apache.geronimo.transaction.manager.RecoveryImpl.recoverResourceManager
(RecoveryImpl.java:98)
at org.apache.geronimo.transaction.manager.TransactionManagerImpl.recoverResourceManager
(TransactionManagerImpl.java:352)
at org.apache.geronimo.connector.outbound.AbstractConnectionManager.doRecovery
(AbstractConnectionManager.java:70)
at
com.tibco.amf.resources.tibcohost.geronimo.transaction.ResourceRecoverer.recoverUsingMCF
(ResourceRecoverer.java:112)
at com.tibco.amf.resources.tibcohost.geronimo.transaction.ResourceRecoverer.run
(ResourceRecoverer.java:98)
at java.lang.Thread.run(Thread.java:662)
118 | Nodes
The correct privileges are described by Oracle documentation as follows: The recover method requires
SELECT privilege on DBA_PENDING_TRANSACTIONS and EXECUTE privilege on SYS.DBMS_XA in
Oracle database server. For database versions prior to Oracle Database 11g Release 1 (11.1), where an Oracle
patch including a fix for bug 5945463 is not available or it is infeasible to apply the patch for the particular
application scenario, the recover method further requires EXECUTE privilege on SYS.DBMS_SYSTEM in
Oracle database. To grant the privileges, execute following SQL statements as the "sys" user:
GRANT SELECT ON sys.dba_pending_transactions TO
GRANT EXECUTE ON sys.dbms_xa TO user
user
Configuration Properties for HOWL Log Files

Configuration properties for HOWL log files include the file location and maximum size, and the number of
log files.
Property
Description
amf.node.txlogdir
The full path to the location of the log file.

Default value:
CONFIG_HOME/tibcohost/Admin-enterpriseName-serverName/data_3.2._x/nodes/
nodeName/work/HowlLogs
amf.node.txlogsize
The maximum size of the log file, in KB. The minimum value that can be specified
is 20.
Default value: 10240
amf.node.txlognum
The number of log files. The minimum value that can be specified is 2.
Default value: 5
If the properties amf.node.txlogsize and amf.node.txlognum are not specified, the default values are
used.
At startup a file howl.properties is created in the logs directory. This file contains the values of the
amf.node.txlogsize and amf.node.txlognum properties that the log was configured with. This file
should not be modified.
If you attempt to start a node using values other than those specified in the howl.properties file, the
node is started using the using values specified in the howl.properties file. Additionally a warning
message is written to the log file recommending that you should first archive and the delete the log files
before attempting to change the configuration. See Deleting HOWL Logs on page 118 for more information.
Deleting HOWL Logs

Before you begin
Verify that there are no active transactions.
Procedure
1.
2.
3.
4.
5.
Stop the applications that are generating transactions.

Stop the nodes where those applications were running .
Make sure there are no active transactions. Use the howlLogReader command of the nodeutil utility..
Delete all the HOWL log files for the node.
Add the property amf.node.txlogsize to the node. See Updating the JVM Configuration for a Node on
page 101 for more information.
6. Restart the nodes and the applications.
Chapter
7
Applications
TIBCO ActiveMatrix SOA applications assume different forms in different phases of the application life cycle. The
cycle consists of a design phase, an administration phase, and a runtime phase.
In the design phase a TIBCO ActiveMatrix SOA application consists of one or more composites. Each application
has a root composite. A composite contains components, services, references, and properties. The components,
services, and references depend on custom features and resources. Services, references, and properties promoted
to the root composite comprise the public interface of the application.
The output of the design phase is a distributed application archive (DAA). A DAA contains features and an
application template, which consists of the root composite and a set of related configuration files:
Nested composites
Resource templates
WSDL files and
Substitution variable files
In the administration phase, you create an application by instantiating an application template. The product installer
adds product application templates to Administrator. When you upload a DAA file to Administrator, Administrator
extracts the application template and (optionally) the features and resource templates.
The following figure illustrates the application artifacts across the application life cycle.
120 | Applications
Figure 7: Application Life Cycle

The following actions can be performed using the Administrator:
Configure the application by setting properties, logging configurations, and substitution variables
Add bindings to services
Promote services and references to the environment
Wire services and references to services and references in other applications or environments
Specify a distribution of the application to the runtime infrastructure
Explicitly distribute application fragments-components and bindings-to one or more nodes
Specify that an application should be distributed to the same nodes as another application
When you deploy the application, Administrator applies the distribution and the configuration. Features are
automatically distributed with components, but resource instances required by the application must be manually
installed into nodes before deployment. Life cycle operations on the application are translated into life cycle
operations on the application fragments. You can also start and stop application fragments.
Topics
Creating an Application
Distributing an Application
Application Dependencies
Deploying Applications
Undeploying Applications
Starting Applications
Stopping Applications
Deleting Applications
Editing an Application
Applications | 121
Displaying an Application's Dependencies

Displaying Application Versions
Displaying an Application's Components
Displaying an Application's Bindings
References
Application Folders
Services and References
Properties
122 | Applications
Creating an Application
You create an application from the GUI or the CLI. You can specify the application's distribution, configure
properties, substitution variables, features, wire services and references, and create bindings.
GUI
About this task
The New Application wizard allows you to create an application.
Procedure
1. In the Applications tab, click New New Application.
The New Application wizard displays.
2. Create an application from a DAA or EAR file or an application template.
DAA or EAR file
1. Click the Browse button.
2. Navigate to a folder containing a DAA and double-click the DAA file.
Application template
1. Select one of the displayed application template. Optionally type a string in the Search text box and
click
to jump to a template containing the string.
3. Specify values for the following fields:

Application Name - accept the default name or type an application name.
Application names cannot contain the characters \, /, :, *, ?, ", <, >,|, whitespace, %, #, &, (, ), or comma
and they cannot be the same as the node name.
Environment Name - from the drop-down list select an environment in which to create the application.
Application Folder - accept the default location or click Select... to choose a folder for the application.
Description - provide an optional description for the application.
Click Next.
4. If you uploaded a DAA and if the DAA contains features, chose which features you want to import. Check
the checkboxes for the features you want to import.
The feature is not re-imported if it exists in Administrator.
Click Next.
5. Choose the nodes where you want to deploy the application by checking the checkbox for that node.
The number of applications deployed on each node are displayed. This helps in distributing your
applications across the available nodes.
If you have multiple nodes running you can choose to deploy the application to more than one node by
checking the checkbox for Advanced to fine tune the distribution.
Select nodes for an item - choose items from the composite tree on the left and drag to nodes on the
right. Double-click the items to distribute it to all the nodes.
Components or bindings in logical nodes will not appear in the item lists as they can not be distributed
separately from the logical node.
Applications | 123
Distribution is cumulative. So if a component is explicitly distributed to node A and the application is

distributed to node B, then the component will be distributed to both nodes A and B during deployment.
Click the link to see all the nodes to which it is distributed.
Select items for a node - choose a node from the list on the left and drop on items on the right.
Double-click a node to distribute all items to the selected node.
Click the link under a node name to see all the fragments of the application distributed to the node.
Click the Clear distribution for the selected items button to delete the distribution.
Click Next.
6. Configure the promoted references.
If the references have been configured at design time, the references with the wiring is displayed.
To delete a wired binding, hover over the binding and click X.
To edit a wired binding, hover over the binding and click Edit.
The Edit Binding dialog displays. Edit the configuration information and click Save.
If the references have not been configured at design time, choose one of the following options:
To add a binding, click Add a binding.
The Add Binding dialog displays. Edit the configuration information and click Save.
To wire to a target service, click Wire to a target service.
The Target Service dialog displays. Choose a listed service and click Save.
Click Next.
7. If your application refers to resource templates, choose which resource templates you want to import.
To import the resource template check the checkbox for that resource template and click Next.
8. If your application contains configured properties, specify values for them.
Expand the tree for Owner to view and edit the displayed properties. When you click on a cell in the
Property Value column, a picker icon appears that allows you to select existing resource instances of the
correct type.
Click Next.
9. If your application contains substitution variables, assign values for them.
In the Local Value column, edit application and application fragment substitution variable values. When
you click on a cell in the value column, a picker icon appears that allows you to select existing resource
instances of the correct type.
Click Add to create additional substitution variables.
Click Next.
10. You can now make changes to your configuration, deploy the application, or save the setup information.
Back - navigate to any previous screen in the wizard.
Deploy - deploys the newly created application.
Save and Exit - saves the setup information and exits the wizard.
The application is added to Applications list. You must manually specify the application's distribution
in the Distribution tab below the Applications list and manually configure any properties, bindings
or substitution variables.
Cancel - does not create the application. Any DAA uploaded or resource templates imported in previous
steps will remain.
124 | Applications
CLI
Before you begin
The application template and environment must already exist in the enterprise.
Procedure
1. In the data file, specify an Application element in full format.
Distribution
Data Object
Manual
<Environment xsi:type="amxdata:Environment" name="EnvName" >

<Application xsi:type="amxdata:Application" name="AppName">
name="AppTemplateName" version="1.0.0.201005040925" />
</Application>
</Environment>
Product
Application

<Application xsi:type="amxdata:Application" name="AppName">
name="AppTemplateName" version="1.0.0.201005040925"/>
<TargetApplication xsi:type="amxdata_reference:Application_reference"
name="TargetApp" />
</Application>
</Environment>
Specify the target application when creating the application or it will default to
manual distribution.
The target application cannot be changed at a later time
2. In the build file set the action attribute of the AMXAdminTask element to add and the objectSelector
attribute to Environment/Application.
<AMXAdminTask action="add" objectSelector="Environment/Application" />
Applications | 125
Distributing an Application
About this task
Applies only to applications created with a Manual distribution mode. An application must be distributed
before it can be deployed. You can change the distribution at any time and apply the change by re-deploying
the application.
The allowable nodes are those in the same environment as the application.
GUI
Procedure
1. Click Applications button.
2. In the Applications list, click an application.
3. Click the Distribution tab.
4.
Select a node from the Available Nodes list and click
5. Click Save.
CLI
Procedure
1. In the data file, specify Application and Node elements in base or full format. You can distribute the entire
application to a set of nodes using what is described. However, you can also distribute pieces of an
application to one or more nodes. These can be components, promoted service bindings, promoted reference
bindings or logical nodes. For components, they can be either composite type components or runtime
components.
<Application xsi:type="amxdata:Application" name="testApp">
<Node name="node1" environmentName="DevEnvironment" />
</Application>
2. In the build file, set the action attribute of the AMXAdminTask element to add and the objectSelector
attribute to */Application.
<AMXAdminTask action="add" objectSelector="*/Application" />
126 | Applications
Application Dependencies
Interdependency is the natural consequence of a model in which applications are constructed from
interconnected services. In TIBCO ActiveMatrix, interdependency manifests at several levels. Within an
application, component references depend on services provided by other components. At the application
level, promoted references depend on promoted services provided by other applications. Service dependencies
can be satisfied even if the interdependent components and applications are deployed to different nodes.
In TIBCO ActiveMatrix, applications have other types of dependencies besides service dependencies.
Components are dependent on the custom features that contain the component implementations. Applications
can depend on product applications that extend the functionality of the TIBCO ActiveMatrix platform. In
addition, applications can also depend on extensions to product applications provided by user-supplied
applications. That is, application A can depend on application P, a product application and application E, a
user-supplied extension application. Applications can have properties that depend on resource instances.
Dependencies affect the life cycles of interdependent applications. For example, when an application A is
dependent on application B, all life cycle operations performed on application B affect the availability of
services provided by application A. If application B is stopped, application A cannot service its clients even
if it continues to run.
Service, feature, application, and resource dependencies are tracked and managed within Administrator.
When you perform life cycle operations (create, delete, deploy, stop, and start) on an application or node,
Administrator examines the application's dependencies and performs actions to ensure that the dependencies
are satisfied. The specific actions depend on the types of the dependency:
Service - When you start or stop an application or node, Administrator ensures that applications providing
required services are started before and stopped after the dependent application is started or stopped.
Feature - When you deploy an application, Administrator automatically installs required features on any
nodes to which the application's components are distributed. If a required feature is not packaged with
the application you must upload it before you deploy the application.
Application - When you perform any life cycle operations, Administrator evaluates dependencies before
invoking the operation. Administrator notifies you which dependencies and other applications are affected
by the operation and allows you to specify how to resolve the dependencies.
Resource instance - When you deploy an application, Administrator reports a deployment failure for each
node lacking a required resource instance. You must install any required resource instances before you
deploy the application.
Applications | 127
Deploying Applications
You can deploy an application from the GUI for from the CLI. The GUI allows you to deploy with or without
starting the application. You can also select other deploy options.
About this task
ActiveMatrix components and bindings depend on functionality provided by ActiveMatrix product
applications. The ActiveMatrix platform product application installed on every node supports components
and SOAP and JMS bindings. Before deploying an application containing any other type of component or
binding on a node, an instance of the product application template that supports that component or binding
is automatically deployed on that node. For Mediation components, the product application name is TIBCO
ActiveMatrix Mediation Implementation Type Application and the product application template name is
TIBCO ActiveMatrix Mediation Implementation Type Application Template. For all other component and
binding types, see the documentation for the component and binding type for whether a product application
is needed and for the name of the required product application template.
The required driver must be provisioned using TCT before deploying the application.
GUI
Procedure
1. Click the Applications button.
2. In the Applications list, click one or more applications.
3. Choose a deploy option.
Option
Procedure
Deploy Deploy with Start 1.
Dependencies on target
product applications are
checked.
2.
Do one of the following:

Click Deploy.
Select Deploy Deploy with Start.
If the applications depend on undeployed target product applications,

the Deployment Application Dependencies dialog displays.
3. Check the checkboxes next to the target applications to deploy.
Deploy without Start

Dependencies on target
product applications are
checked.
More Deploy Options
1. Select Deploy Deploy without Start

2. If the applications depend on undeployed target product applications,
the Deployment Application Dependencies dialog displays.
3. Check the checkboxes next to the target applications to deploy.
1. Select Deploy More deploy options
2. Check the checkboxes for one or more of the following options
Start Applications - Dependencies on target applications are checked.
Resolve Mode - Dependencies on target product applications are
checked.
Deploys the selected applications on the nodes, restarts the nodes, and
causes all applications deployed on the nodes to use the latest versions
of the features on which they depend. Use this operation to deploy an
application with a new version of an existing feature, to force
applications that reference the existing feature to use the new version,
128 | Applications
Option
Procedure
or if after clicking Deploy you get an error that says that because the
node is running in stable mode, it cannot accept the deployment of
the application.
Force Deploy - Dependencies on target product applications are not
checked and validation errors ignored. May result in broken
applications and should be used with caution.
3. Click Deploy to deploy the application or Cancel to cancel the
deployment.
Results
The applications are deployed and if auto-provisioning is enabled, those applications that provide
implementation or binding types to the applications being deployed are also automatically deployed to the
target nodes.
CLI
Procedure
1. In the data file, specify Environment and Application elements in base format. Drivers required for the
application resource instances can be specified inside the <Application> element in the data.xml file.
<Environment xsi:type="amxdata:Environment" name="envName" >
<Application xsi:type="amxdata:Application" name="test.app1" contact="TIBCO
description="Test application with imported resource template which requires a driver feature"
importResourceTemplates="true" resourceTemplatesScope="Application">
Inc."
<Node name="${dev.node.name}" environmentName="${dev.envt.name}"/>

xsi:type="amxdata_reference:ApplicationTemplate_reference" name="AppTemplate"/>

<Driver resourceTemplateName="OracleResourceTemplate"
driverFeatureName="com.tibco.tpcl.gen.oracle.jdbc.feature" driverFeatureVersion="11.2.100.001"/>
</Application>
</Environment>
2. In the build file, set the action attribute of the AMXAdminTask element set to deploy and the
objectSelector attribute to Environment/Application. To deploy without starting the application,
specify the options attribute and set the value to nostart.
<target name="deploy.app">
<AMXAdminTask
remote="true"
propsFile="${instance.properties.file}"
action="deploy"
dataFile="${basedir}/cli_data.xml"
overwrite="true"
merge="true"
force="false"
failOnError="true"
options="auto-resolve-driver"/>
</target>

The application is deployed and started.
If the application is a dependent application and its target application has been deployed, the application
is deployed and started. If the target application is not deployed, the deployment will fail.
If an application is a target application, it and all its dependent applications are deployed and started.
Applications | 129
Undeploying Applications
You can undeploy an application from the GUI or by using the CLI. When you undeploy an application, the
system queues the request and applies it to components as they become available. During undeployment,
dependencies are taken into account to allow processing to clean up before removing components and
bindings.
GUI
Procedure
3. Choose an undeploy option.
Option
Procedure
Undeploy
Dependencies on
target product
applications are
checked.
1. Do one of the following:

Click Undeploy.
Select Undeploy Undeploy
If the application has multiple versions deployed, a dialog will
display all the versions. Select the version to undeploy.
2. If any of the selected applications has dependencies, the Application
Dependencies to Undeploy dialog displays with target applications.
3. Check the checkboxes next to the target applications to undeploy.
4. Click Undeploy. The selected target applications are undeployed. The length
of time this action takes to complete depends on how long it takes for the
target applications to complete their processing. It may take up to several days
or longer.
Force Undeploy
Dependencies on
target product
applications are not
checked.
More undeploy
options
1. Select Undeploy Force undeploy

If the application has multiple versions deployed, a dialog will display
all the versions. Select the version to Force undeploy.
2. Click Undeploy. Components in the selected applications are allowed to
perform clean up operations. In rare cases, a component may hang while
performing its cleanup. When that happens a node that becomes unusable
might need to be restarted. If a component stores information in a database
or file, that data may remain after a force undeploy and must be cleaned up
manually.
1. Select Undeploy More undeploy options
2. Check the checkboxes for one or more of the following options:
Resolve Mode - Dependencies on target product applications are checked.
If any of the selected applications has dependencies, the Application
Dependencies to Undeploy dialog displays with target applications. The
applications are deleted from the node and the runtime state changes to
Not deployed. The nodes where the applications are undeployed are
restarted to load software updates.
130 | Applications
Option
Procedure
Force Undeploy - Dependencies on target product applications are not
checked.
Components in the selected applications are allowed to perform clean up
operations. In rare cases, a component may hang while performing its
cleanup. When that happens a node that becomes unusable might need to
be restarted. If a component stores information in a database or file, that
data may remain after a force undeploy and must be cleaned up manually.
3. Click Undeploy to undeploy the application or Cancel to cancel the
undeployment process.
CLI
Procedure
Inc."

</Application>
</Environment>
2. In the build file, set the action attribute of the AMXAdminTask element to undeploy and the objectSelector
attribute to Environment/Application. To perform a force undeploy, specify the -force option.
<AMXAdminTask action="undeploy" objectSelector="Environment/Application" [-force] />
Applications | 131
Starting Applications
You can start applications from the GUI or by using the CLI. If the application starts successfully, the runtime
state changes to Running.
GUI
Procedure
3. Click the Start button.
If there are target applications, the Application Dependencies to Start dialog displays.
4. Check the checkboxes next to the target applications to start.
5. Click Start.
The target applications are started and the selected applications are started after the target applications
are running. The Runtime State of the selected applications changes to Starting.
6. Click the Refresh button until the Runtime State changes to Running.
Results
The selected applications and target applications are started.
CLI
Procedure
1.
Inc."

</Application>
</Environment>
3. In the build file set the action attribute of the AMXAdminTask element to start and the objectSelector
<AMXAdminTask action="start" objectSelector="Environment/Application" />

Results
The selected applications and target applications are started.
132 | Applications
Stopping Applications
You can stop applications from the Administrator GUI or by using the CLI. If you are using the GUI, you
can choose the Stop Immediately options to have the application exit right away without cleanup.
GUI
Procedure
3. Choose a stop option.
Option
Procedure
Stop
Allows applications to complete processing before
shutting down.

Click Stop.
Select Stop Stop
Dependencies on target product applications are

checked.
2. If there are target applications, the Application

Dependencies to Stop dialog displays.
3.
Check the checkboxes next to the target
Applications may take anywhere from a few seconds
applications to stop.
to an hour to stop.
4. Click Stop.
Components with dependencies will be
stopped only after the components they depend
upon have stopped.
Stop immediately
1. Select Stop Stop immediately
Applications may take a few seconds to stop.

Applications are allowed to perform cleanup
operations but not complete their current processing.
Applications are not stopped in dependency order.
The selected applications and target applications are stopped.
CLI
Procedure
Inc."

Applications | 133
</Application>
</Environment>
2. In the build file, set the action attribute of the AMXAdminTask element to stop, the options attribute to
immediate and the objectSelector attribute to Environment/Application.
<AMXAdminTask action="stop" objectSelector="Environment/Application" />

Results
The selected applications and target applications are stopped.
134 | Applications
Deleting Applications
You can delete applications from the Administrator GUI or by using the CLI. If you are using the Administrator
GUI, you have a Force Delete option that deletes the application regardless of its state.
GUI
Procedure
3. Choose a delete option.
Option
Delete
Deletes the application if the application is not deployed
and no order application depends on it.
Description
Click Delete.
Delete Delete.
2. If there are target applications, the
Application Dependencies to Delete dialog
displays.
3. Check the checkboxes next to the target
applications to delete.
4. Click Delete.
Force Delete
1. Select Delete Force Delete.
Deletes the application regardless of its state.

This option is enabled only if you have the necessary
permissions. See Setting Enterprise Permissions on page
301 for more information.
Exercise extreme caution when using this option
as it might leave your system in a non-working
state.
The selected applications and target applications are deleted.
CLI
Procedure
Inc."

Applications | 135
</Application>
</Environment>
attribute to Environment/Application. To perform a force delete, add the -force option.
<AMXAdminTask action="delete" objectSelector="Environment/Application" [-force] />
136 | Applications
Editing an Application
GUI
Procedure
1. Click Applications.
2. Select an application from the displayed list.
The application details display.
3. Edit the properties according to Application General Reference on page 143.
4. Click the Configuration, Properties, Substitution Variables, Resource Instances, Status tabs for other
editable information.
5. Click Save.
Upgrading an Application
You upgrade an application from the GUI or the CLI.
Before you begin
The application template version to which the application is upgraded must exist in the Administrator
software repository or you must upload a DAA containing the new template.
GUI
Procedure
1. Click Applications and click an application from the list. .
2. If the new template does not exist in the repository, in the General tab click Upload DAA or EAR to upload
a DAA containing a new version of the application.
The Upload DAA or EAR dialog displays.
3. Click Browse to navigate to a DAA file.
a) Navigate to a directory containing the DAA file.
b) Click the DAA file.
c) Click Open.
The DAA is validated.
4. If the DAA is not uploaded click the More details link to see the errors.
5. After you have resolved any errors, select the features to import and click Save.
A dialog box displays the effects of updating the application template to the new version.
6. Choose an action based on whether you want to continue the process of upgrading the application.
Save - Continues the process of upgrading the application.
Cancel - Does not upload the new version of the application template.
Click Print Preview to print the displayed information.
7. Click Deploy.
The application will be upgraded on all the nodes where it was deployed.
For information on selecting nodes to deploy the upgraded application, see Upgrading an Application
across Nodes on page 138.
Applications | 137
While upgrading an application, resource templates will be imported at the same scope where the
resource templates were first imported during initial application creation. Moreover, an existing
resource template will not be overwritten. Only new resource templates will be created at the
specified scope.
CLI
Procedure
1. In the data file, specify an application element in full format.
Distribution
Data Object
Manual

<Application xsi:type="amxdata:Application" name="AppName"
importResourceTemplates="true">
name="AppTemplateName" version="1.0.0.201005040925" />
</Application>
</Environment>
Product
Application

<Application xsi:type="amxdata:Application" name="AppName"
importResourceTemplates="true">
name="AppTemplateName" version="1.0.0.201005040925"/>
<TargetApplication xsi:type="amxdata_reference:Application_reference"
name="TargetApp" />
</Application>
</Environment>
Specify the target application when creating the application or it will default to manual
distribution.
The target application cannot be changed at a later time
If you set the property importResourceTemplates="true" then resource templates will be imported. If
the property is not set, or set to importResourceTemplates="false", then resource templates will not
be imported.
You can also import specific resource templates by using
<ImportResourceTemplateName>RT_Name</ImportResourceTemplateNames>
2. In the build file set the action attribute of the AMXAdminTask element to upgrade and the objectSelector
attribute to Environment/Application. In the build file set the action attribute of the AMXAdminTask
element to deploy and the objectSelector attribute to Environment/Application.
<AMXAdminTask action="upgrade" objectSelector="Environment/Application" />
Results
The application is upgraded.
When upgrading an application, the upgrade process waits for the previous version of the application to be
first undeployed. In cases where you do not want this selective polling where the upgrade process waits for
the previous version to undeploy, use the disableSelectivePolling option.
138 | Applications
Upgrading an Application across Nodes

When an application has been deployed on more than one node and the application is created with a Manual
distribution mode, the Rolling Upgrade tab is enabled. Use this tab to selectively upgrade the application on
the available nodes.
About this task
If all nodes run the current version of the application, the Rolling Upgrade tab is not editable and displays
the version of the application template in use.
Procedure
1. Click Applications and select an application from the list.
2. If the new template does not exist in the repository, in the General tab click Upload DAA or EAR to upload
a DAA containing a new version of the application.
3. Click Browse and select a DAA file.
The DAA file is validated.
4. If the DAA is not uploaded click the More details link to see the errors.
5. After you have resolved any errors, select the features to import and click Save.
A dialog box displays the effects of updating the application template to the new version.
6. Choose an action based on whether you want to continue the process of upgrading the application.
Save - Continues the process of upgrading the application.
Cancel - Does not upload the new version of the application template.
Click Print Preview to print the displayed information.
7. Click the Rolling Upgrade tab.
The nodes to which this application is deployed are listed.
8. Check the checkboxes for the nodes on which you want to upgrade the application.
The application is upgraded on the selected nodes.
Applications | 139
Displaying an Application's Dependencies

You can display the applications and the resource instances on which an application depends in the
Administrator GUI.
Procedure
2. Click an application.
3. Click next to Depends On.
The list of applications and the resource instances that the selected application depend on displays.
4. Click on an application or a resource instance to view additional details.
140 | Applications
Displaying Application Versions

You can display an application's version, including the runtime status, in the Administrator GUI.
Procedure
3. In the Status tab, click Application Versions.
The application versions and runtime state will display.
Applications | 141
Displaying an Application's Components

You can display an application's component, including the component status, in the Administrator GUI.
Procedure
3. In the Status tab, click Component Status.
The applications's components display.
142 | Applications
Displaying an Application's Bindings

You can display an application's bindings from its Status tab.
Procedure
3. In the Status tab, click Binding Status.
The application's bindings display.
Applications | 143
References
Applications Reference
You can view the application name, state, last deployment date, and other attributes in the Administrator
GUI.
Column
Description
Name
The name of an application. By default, the Applications list contains the

platform application amx.platform-app. This application contains the default
binding type implementations, platform services, and data binding converters.
The platform application is dependent on the TIBCO ActiveMatrix Platform
feature. Administrator automatically provisions this feature when
amx.platform-app is deployed.
Application State
The runtime state of the application. The application state is a roll up of the
state of its constituent components and bindings.
For details, see Runtime States on page 35
Last Deployed On
The date that the application was last deployed.
Synchronization
Indicates whether the runtime has the latest configuration for the application.
Action History
The outcome of the last action performed with the intent of affecting the runtime
state.
The action history does not reflect the component state of ActiveMatrix
Implementation Type for TIBCO Adapters .
Application General Reference

The General tab displays the application's logical nodes, components, and promoted services and references
in a hierarchical list. The information displayed on the right matches the object selected from the hierarchical
list.
Details
Property
Required? Editable?
Description
Name
Y (if the
The name of the application.
application is
undeployed)
Contact
A contact information for the owner of the application.
Description
Description of the application.
Modified By
RO
RO
The Administrator user that last modified the application.
Modified On
RO
RO
The date and time that the application was last modified.
Last Deployed
By
RO
RO
The Administrator user that last deployed the application.
144 | Applications
Property
Required? Editable?
Description
Last Deployed
On
RO
RO
The date and time that the application was last deployed.
Application
Template Name
The name of the application template from which the

application was created.
Application
Template
Version
The version of the application template from which the

application was created.
Application
Template ID
Unique application template identifier.
Distribution
Policy
Determines how the application's fragments are distributed

to nodes. One of:
Product Application - The fragments are distributed to
the nodes based upon the locations where components of
a specified product application are deployed.
Manual - The fragments are distributed to the nodes that
you specify.
Environment - The fragments are distributed to every
node in an environment. Currently only the platform
application uses this policy.
Product
Application
Displays only if the Distribution Policy is set to Product

Application. The product application with which the
application must be deployed.
When specifying an application template to use for

creating an application using CLI, the ID must be used
rather than the name.
Binding Status
Shows the status of bindings on a particular node.
Column
Description
Binding Path
Identifies the binding with the name and the path of nested components for the component
with which the binding is associated. The type of binding (direction, service or reference,
and whether the binding is intermediate) is indicated by the value in parenthesis. Values
are often too long to be completely visible. Hovering over the name shows a tooltip that
displays the full name.
Node Name
The node on which the binding is running. If the binding is distributed to multiple nodes,
there will be a row in the table for each node. The binding path will be the same, but the
node name differentiates them.
Binding State
The state of the binding.
Action History
The outcome of the last action on the binding instance.
Applications | 145
Component Status
Column
Description
Component Path The set of nested composites containing the component separated by forward slashes
followed by the component name, an underscore, and the component version.
Node Name
The node on which an instance of the component is running.

If the component is distributed to multiple nodes, then each node will have its own row
with the component path being duplicated.
Component
State
The state of the component.
Action History
The outcome of the last action.
Application Configuration Reference

Wires
To wire a reference to a service
1. Click a reference.
Dots are now visible on the services and references.
2. Click the dot on the reference and continue to press and hold the left mouse button.
3. Move the mouse to a service
4. Release the mouse button.
The reference is now wired to the service.
Field
Description
Add Binding
Click this button to add a binding for a reference. Configure properties according to
Manual Binding Reference on page 153.
Edit Binding
Click this button to edit properties for a binding.
Delete Binding
Click this button to delete the binding added to a reference.
Switch to
Binding
Click this button to replace a wire with a manual banding.
Logging Configuration
You can either use the node's logging configuration or create a new logging configuration.
To create a new logging configuration
1. Uncheck the checkbox for Use node's logging configuration
2. Refer Creating a Logging Configuration for a Host or a Node on page 340 for information on creating a
Property

SVars?
Description
Logger Name

146 | Applications
Property

SVars?
Description
Log Level

TRACE All events.
continue running.
Additivity
One of:
configuration.
Appender
(FileAppender,
JmsAppender)
Application Substitution Variables Reference

The Substitution Variables tab displays the application's components, promoted services and references, and
bindings in a hierarchical list. The information displayed on the right hand side matches the object selected
from the hierarchical list.
Property
Required? Editable?
Description
Substitution
Variable Name
Type

String
Integer
Boolean
Password
Default: String.
Description
Local Value
Applications | 147
Use the Application Fragment Substitution Variables link to configure different values for this application
on different nodes.
Property
Required?
Editable?
Description
Substitution
Variable
Name
The name of the substitution variable.
Node Name
The node on which the value for this substitution variable is

defined.
This property is available only on the Application Fragment
Substitution Variables link.
Type
The type of the substitution variable. One of

String
Integer
Boolean
Password
Default: String.
Description
Local Value
The local value or the substitution variable.
Application Distribution Reference

The Distribution tab allows you to view the nodes for deployed applications. For current applications, you
can edit the distribution.
To edit the distribution, select the Current Configuration option in the View drop-down list.
The Distribution tab displays the application's logical nodes, components, and promoted services and
references in a hierarchical list. The top-level component is the root composite. You can expand it to display
nested components and composites. Expand promoted services to display their bindings.
148 | Applications
Application Folders
Application folders allow to you organize your applications.
When you create an application you can optionally choose a folder in which to store the application. If you
do not choose a folder, the application is stored in the root folder. Permissions assigned to a folder are inherited
by all applications contained within the folder.
Each environment contains a System folder. This folder contains TIBCO product applications. Do not create
user applications in this folder.
Creating a Folder
You can create an application folder from the GUI or by using the CLI.
GUI
Procedure
1. Click New > New Application Folder .
The New Folder dialog displays.
2. Type a folder name and an optional description, and click Save. Folder names should be unique within
an environment.
The application folder is created at the same level as the System folder.
3. To create the folder at another level
a) Select the folder where in the tree view of the folder names select the folder and click New.
b) Type a folder name and an optional description, and click Save.
The folder is created at the selected
CLI
Procedure
1. In the data file, specify an ApplicationFolder element in full format.
<Environment xsi:type="amxdata:Environment" name="MyEnvironment" description="My
environment">
<ApplicationFolder xsi:type="amxdata:ApplicationFolder" name="FolderA"
description="description for FolderA">
...
</ApplicationFolder>
...
attribute to Environment/ApplicationFolder.
<AMXAdminTask action="add" objectSelector="Environment/ApplicationFolder" />
Applications | 149
Renaming a Folder
You can rename a folder from the GUI or by using the CLI.
GUI
Procedure
1.
2.
3.
4.
Click Applications.
Select an environment from the Environment drop-down list.
In Applications list, select an application folder.
Edit the Folder Name and, optionally, the Description and click Save.
CLI
Procedure
environment">
<ApplicationFolder xsi:type="amxdata:ApplicationFolder" name="MyApp"
newName="MyAppNew">
...
...
2. In the build file set the action attribute of the AMXAdminTask element to rename and the objectSelector
<AMXAdminTask action="rename" objectSelector="Environment/ApplicationFolder" />
Deleting a Folder
You can delete a folder from the GUI or by using the CLI. When you delete a folder, any subfolders and
undeployed applications are deleted. If the folder contains any deployed application, the folder is not deleted.
GUI
Procedure
1.
2.
3.
4.
Click Applications.
In Applications list, select an application folder and click Delete.
Click OK.
Results
CLI
Procedure
environment">
<ApplicationFolder xsi:type="amxdata:ApplicationFolder" name="MyFolder">
...
150 | Applications
...
2. In the build file set the action attribute of the AMXAdminTask element to delete and the objectSelector
<AMXAdminTask action="delete" objectSelector="Environment/ApplicationFolder" />
Moving an Application to a Folder

You can move a an application to a folder from the GUI or by using the CLI.
GUI
Procedure
1.
2.
3.
4.
Click Applications.
In Applications list, select an application folder and click Move .
Select the folder where you want to move the application and click Save.
The application is added to the specified folder.
CLI
Procedure
environment">
<ApplicationFolder xsi:type="amxdata:ApplicationFolder" name="MyApp">
<TargetFolder path="/folderOne/"/>
...
...
<AMXAdminTask action="move" objectSelector="Environment/ApplicationFolder" />
Applications | 151
Services and References

Applications interact via services and references. A service is a set of operations and the messages required
by the operations. A reference identifies the service consumed by a component or composite. Applications
offer services and invoke references to other services.
An application's services and references are promoted from the services and references of the components
it contains.
Component services can be consumed by other components within the composite or promoted as composite
services for use by consumers outside the composite. A composite service has an interface and one or more
bindings.
Component references consume services provided by other components in the same composite or services
provided outside the composite. A composite reference has an interface and one binding.
Displaying the Bindings for a Service or a Reference

You can display the bindings for a service or reference from an application's Configuration tab.
Procedure
1. Click Applications and select an application.
The View drop-down list displays Currently Configured.
3. Expand the application node and click a service or a reference.
The bindings display in the right pane.
4. Click next to a binding to display the nodes on which a binding is deployed.
The following figure shows the bindings for a service.
Adding a Binding to a Service

You can add a binding to a service from the application's Configuration tab.
Procedure
The Applications list displays.
152 | Applications
3. Expand the application node and select a service.

4. Click the Bindings tab.
5. Click New Binding and specify the binding information.
a) In the Name field, type a name for the binding.
b) In the Type drop-down list, select a binding type.
The property sheets dialog displays the binding specific properties which may be across multiple tabs.
c) Edit the binding properties.
d) Click Save.
6. Click the plus ( ) next to a binding to display the nodes on which the binding is deployed.
A row displays with the node to which the binding is mapped. The Runtime State is Not Deployed.
7. Optionally add nodes on which to deploy the binding.
a) Click the Add to Nodes button.
b) In the Node Name column of the new row, click and select a node on which to deploy the binding.
c) Click Save.
The binding is added to the node with state Not Deployed.
8. Click Deploy to add the binding to the runtime.
The Action History of the application changes to In Progress (Deploy with Start).
9. Click Save.
Configuring a Binding for a Reference

You can configure a binding for a reference from the reference's Configuration tab. You can select a Manual
Binding or a Wire to Binding.
Procedure
1.
2.
3.
4.
Click Applications.
Expand the application node and select a reference.
Click the Bindings link.
The binding details display.
5. To configure the binding, select one of the following options
Manual Binding - click the Edit link to manually create a service binding and to wire to that binding.
The Edit Bindings dialog displays. Configure properties according to Manual Binding Reference on
page 153.
Wire to Binding - click the Edit link to wire the reference to an existing service.
The Target Service dialog displays. Configure properties according to Wire to Binding Reference on
page 180.
None - select this option If the reference has no binding.
6. Click Save.
Promoting a Service to the Environment

You can promote a service to the environment. Only deployed services can be promoted to the environment.
About this task
Services that are promoted can be wired from references at the application level in the same environment or
from references promoted to other environments.
Applications | 153
Procedure
1.
2.
3.
4.
Click Applications.
Click an application.
Expand the application node and select a service.
In the pane on the right, click New.
A row is added to the Environment Promoted Service Name table.
5. Type a name for the environment level service. Click Save.
A single service can be promoted to multiple names at the environment level.
Promoting a Reference to the Environment

You can prompt a reference to the environment. Once a reference is promoted to an environment, the
responsibility for configuring that reference is delegated to the environment level and any wiring must be
done at the environment level.
Procedure
1.
2.
3.
4.
Click Applications.
Expand the application node and select a reference.
In the pane on the right, click New.
A row is added to the Environment Promoted Reference Name table.
5. Type a name for the environment level reference. Click Save.
References
Reference Details Reference
Property

SVars?
Description
Source Component
Name
RO
RO
Name of the source component.
Source Component
Reference Name
RO
RO
Name of the source component reference.
Interface
RO
RO
MEP
RO
RO
Promoted to
Environment as
Wired by
Implementation
RO
RO
This indicates message exchange pattern.
Indicates whether the interface is dynamic.
Manual Binding Reference

When you configure a binding for a reference, you are prompted for information about the binding.
Field
Required?
Editable?
Description
Name
Name of the binding.

154 | Applications
Field
Required?
Editable?
Description
Type
Type of binding. Default is SOAP binding.
Transport Type
Type of transport supported by the binding.

HTTP or JMS.
SOAP Version
Version of the SOAP specification. 1.1 or 1.2
HTTP Client
Configuration
Enable WS-Addressing
Indicate whether to enable WS-Addressing

headers. When checked, the Connector Name
field displays.
Connector Name
A HTTP Connector on page 214 to which

responses are sent resource instance.
Endpoint URI
HTTP
The HTTP Client resource template represents
an outgoing HTTP connection.
The endpoint URI.

This field is populated from the SOAP Address
element of the WSDL port associated with the
SOAP-HTTP reference binding. This value can
be edited by typing the new value or by using
the Substitution Variables picker to select a
substitution variable that points to a valid
endpoint URI value.
JMS
Binding Specification
Binding specification supported: TIBCO or W3C

SOAP-JMS.
Default: TIBCO.
JMS - Inbound
Acknowledge Mode
Acknoledgement mode for incoming messages.

Set to Auto, meaning that the message is
automatically acknowledged when it is received.
Reply Destination
A JMS Destination on page 224.
JMS Connection Factory
A JMS Connection Factory on page 221 resource

instance.
JMS Destination
A JMS Destination on page 224.
JMS-Outbound
Only queues are supported for

SOAP/JMS. Topics are not supported.
Delivery Mode
The delivery mode of messages:

Persistent Messages are stored and
forwarded.
Applications | 155
Field
Required?
Editable?
Description
Non-Persistent Messages are not stored and
may be lost due to failure.
Default: Persistent.
Message Priority
The priority of the message. Priority is a value

from 0-9. Higher numbers signify a higher
priority (that is, 9 is a higher priority than 8).
Default: 0.
Message Expiration
The length of time a message can remain active.

0 means that the message does not expire.
Default: 0.
Correlation Scheme
Scheme which identifies the correlation scheme

used when sending reply messages.
MessageID to CorrelationID (default)
Message ID of the request message is copied
to the Correlation ID of the response
message.
CorrelationID to CorrelationID
Correlation ID of the request message is
copied to the Correlation ID of the response
message.
Bindings
A binding specifies how communication happens between a reference and a service. A service binding describes
the mechanism a client uses to access a service. A reference binding describes the access mechanism a reference
uses to invoke a service. References can have at most one binding.
TIBCO ActiveMatrix supports the following binding types:
Virtualization
REST
SOAP
JMS
EJB
Adapters
Virtualization bindings connect services and references to the Messaging Bus. Virtualization bindings are
automatically created for every composite service and every wired component service and reference. At
design-time, Virtualization bindings of component services and references are implicit; their properties cannot
be viewed.
There are two types of Virtualization bindings: internal and external. An internal binding is associated with
a component service or reference. An external binding is associated with a service or reference promoted to
the root composite. Administrators can create or modify wires connected to external bindings and can monitor,
start, and stop external bindings.
SOAP, EJB, Adapters, and JMS bindings are explicitly created by architects and developers only on promoted
services and references.
156 | Applications
TIBCO Business Studio and TIBCO ActiveMatrix Administrator provide the option to choose between
TIBCO's SOAP/JMS and W3C SOAP/JMS on SOAP binding type and a target service while adding
a binding to a service.
Figure 8: Bindings on page 156 illustrates the different types of bindings. In the figure, bindings are indicated
by a icon. The promoted service HelloWorldPT has a SOAP and external Virtualization binding. The
components have internal Virtualization bindings. The promoted reference DateManagerPT has a SOAP
binding. In addition, any time a service or reference has a binding of type other than Virtualization, a pair
of proxy (Virtualization) bindings are created to connect the service or reference to the component to which
the service or reference service is wired.
Figure 8: Bindings
SOAP Bindings
SOAP bindings serve as a gateway for inbound and outbound SOAP messages. SOAP bindings expose
endpoints that accept requests from SOAP consumers and allow composites to invoke external SOAP providers.
SOAP bindings support the following features:
SOAP 1.1 and SOAP 1.2 specifications.
Encoding: Document-literal and RPC-literal
Message exchange patterns: one-way, request-response, and fault
Changing of endpoint URI for SOAP-HTTP reference from Administrator UI and command-line interface.
HTTP and JMS transport
SOAP headers
WS-Addressing on page 162
WS-Reliable Messaging on page 166
If you change the order of operations in the WSDL interface of a service or reference you must recreate
all SOAP bindings associated with the service or reference.
Applications | 157
Starting and Stopping Bindings

You can start and stop bindings from the application's General tab.
Procedure
1.
2.
3.
4.
Click Applications.
In the View drop-down list, select Currently Deployed. Choose an object and follow the appropriate
procedure:
Object
Procedure
Application
1. Click an application
in the tree-list.
2. In the Status tab, click Binding Status tab.
3. In the table, click a row containing a binding path and node name.
Binding
1. Expand the application tree.

2. Click a binding .
3. In the table on the right, click a node on which to start or stop the binding.
5. Click Start or Stop.

Generating a WSDL File for a SOAP Service Binding Instance
You can generate a WSDL file for a SOAP Service binding instance from the application or the service.
Procedure
3. Choose one of the following starting points:
Starting Point
Procedure
Application
1. In the Status tab, click the Binding Status.

2. In the table, select a row and click Generate WSDL.
Service
1.
2.
3.
4.
Display a service's bindings.

Expand a SOAP binding.
Click a row containing a node on which the binding is deployed.
Click the Generate WSDL button.
What to do next
When the WSDL is generated, a machine name 0.0.0.0 is embedded in the SOAP address element. For
example,<soap:address location="http://0.0.0.0:9091/helloWorldPT/"/>.
The machine name should be updated before using the WSDL.
158 | Applications
Changing Endpoint URI For SOAP-HTTP Reference

An endpoint URI is the URL of an external service that is accessed by a business service. Support is available
for changing the endpoint URI for SOAP-HTTP reference from the Administrator UI and using command-line
interface.
Procedure
3. Select the application node.
The bindings display in the right pane.
4. Select the SOAP service binding and click Edit.
Edit Binding window is displayed.
5. Edit the value of Endpoint URI field and click Save.
CLI
You can change the Endpoint URI for SOAP-HTTP reference binding using the command-line interface.
Procedure
Specify the Endpoint URI n the section of the binding under of the CLI_Data.xml.
<PromotedReference xsi:type="amxdata_base:Reference_base" name"refName"
<Binding xsi:type="amxdata_binding:SoapRefBinding" name="SoapRefBinding" description="desc"
style="DOCUMENT" encoding="LITERAL">
<HttpTransportDetails xsi:type="amxdata_binding:HttpTransportDetailsForReference"
endpointURI="/endpoint_uri_edited/"
</Binding>
</PromotedReference>
SOAP Binding Reference

You can specify the endpoint, SOAP defaults, service transport, and reference transport for the binding node.
You can specify the SOAP general configuration for the operation node, and the part list for the input or
output message node.
Binding Node
Table 17: Binding - Service
Field
Required? Editable?
Description
Name
The name of the binding.
Default: SOAPService_Bindingn, where n is an integer.

Type
The type of the binding.
Table 18: SOAP Default Configuration

Field
Required? Editable?
Description
Description N
A description of the binding.
SOAP
Version
The version of the SOAP specification: 1.1 or 1.2.
Default: 1.1.
Applications | 159
Field
Required? Editable?
Description
Style
The SOAP binding style: Document or RPC.
Default: Document.
Encoding
The encoding type for the body of the SOAP input and output
messages. Set to Literal.
Target
N
NameSpace
The target namespace for a concrete WSDL file for the service.
Table 19: Service Transport Configuration

Field
Required? Editable?
Description
Substitution variables are not supported for the following fields.
HTTP
Transport
Type
Endpoint URI Y
Type of transport supported by the binding. HTTP or JMS.

The endpoint URI.
This field is populated from the SOAP Address element of the
WSDL port associated with the SOAP-HTTP reference binding.
Connector
Name
The name of the HTTP connector resource instance that provides

incoming transport services.
Session
Inactivity
Timeout (s)
The length of time before an invocation of the endpoint times out.

Default: 60.
JMS
Transport
Type
Message
Type
Type of transport supported by the binding. HTTP or JMS.

The type of the message content: Text or Bytes.
Default: Text.
Binding
Y
Specification
Binding specification supported: TIBCO SOAP/JMS or W3C

SOAP/JMS.
Default: TIBCO SOAP/JMS.
JMS - Inbound Configuration

Acknowledge Y
Mode
The acknowledgment mode for incoming messages. Set to Auto,

meaning that the message is automatically acknowledged when it
is received.
JMS
Connection
Factory
A JMS Connection Factory on page 221 resource instance.
160 | Applications
Field
Required? Editable?
Description
JMS
Destination
A JMS Destination on page 224 resource instance.
Only queues are supported for SOAP/JMS. Topics are not

supported.
JMS - Outbound Configuration

JMS
Connection
Factory
A JMS Connection Factory on page 221 resource instance.
Delivery
Mode

Persistent Messages are stored and forwarded.
Non-Persistent Messages are not stored and may be lost due to
failure.
Message
Priority
The priority of the message. Priority is a value from 0-9. Higher

numbers signify a higher priority (that is, 9 is a higher priority than
8).
Default: 4.
Message
Expiration
The length of time a message can remain active. 0 means that the
message does not expire.
Default: 0.
Correlation
Scheme
Scheme which identifies the correlation scheme used when sending

reply messages.
MessageID to CorrelationID (default) Message ID of the
request message is copied to the Correlation ID of the response
message.
CorrelationID to CorrelationID Correlation ID of the request
message is copied to the Correlation ID of the response message.
Infer from Request If CorrelationID is present in incoming
Request Message, CorrelationID of incoming Request Message
is copied to CorrelationID of outgoing Response Message. If
CorrelationID is absent in incoming Request Message,
MessageID of incoming Request Message (which is always
present) is copied to CorrelationID of outgoing Response
Message.
Table 20: Reference Transport Configuration

Field
Required? Editable?
Description
Transport
Type
The type of transport supported by the binding: HTTP or JMS.
Y (while
adding the
binding)
N (while
editing the
binding)
Applications | 161
Field
Required? Editable?
Description
SOAP
Version
N (display N
only field
while
editing)
The version of the SOAP specification: 1.1 or 1.2.

Default: 1.1.
HTTP
Substitution variables are supported only for Endpoint URI Filespec.
HTTP Client Y
Configuration
Endpoint
URI
Enable
N
WS-Addressing
The HTTP Client on page 210 resource template represents an

outgoing HTTP connection.
The endpoint URI. This field is populated from the SOAP Address
element of the WSDL port associated with the SOAP-HTTP
reference binding. This value can be edited by typing the new value
or by using the Substitution Variables picker to select a substitution
variable that points to a valid endpoint URI value.
Indicate whether to enable WS-Addressing headers. When checked,
the Connector Name field displays.
Default: Unchecked.
Connector
Name
The name of the connector to which responses should be sent.

Default: None.
JMS
Binding
Y
Specification
Binding specification supported: TIBCO SOAP/JMS or W3C

SOAP/JMS.
Default: TIBCO SOAP/JMS.
JMS - Inbound Configuration

Acknowledge Y
Mode
The acknowledgment mode for incoming messages. Set to Auto,

meaning that the message is automatically acknowledged when it
is received.
Reply
Destination
A JMS destination configuration.

supported.
JMS - Outbound Configuration

JMS
Connection
Factory
A JMS Connection Factory creates an outbound connection to a

JMS server.
JMS
Destination
A JMS destination.
supported.
162 | Applications
Field
Required? Editable?
Description
Delivery
Mode

Persistent Messages are stored and forwarded.
Non-Persistent Messages are not stored and may be lost due to
failure.
Message
Priority
The priority of the message. Priority is a value from 0-9. Higher

numbers signify a higher priority (that is, 9 is a higher priority than
8).
Default: 4.
Message
Expiration
The length of time a message can remain active. 0 means that the
message does not expire.
Default: 0.
Correlation
Scheme
Scheme which identifies the correlation scheme used when sending

reply messages.
MessageID to CorrelationID (default) Message ID of the
request message is copied to the Correlation ID of the response
message.
CorrelationID to CorrelationID Correlation ID of the request
message is copied to the Correlation ID of the response message.
Service Operation Configuration

Field
Required? Editable?
Description
Style
The SOAP binding style: Document or RPC.
Default: Document.
Encoding
The encoding type for the body of the SOAP input and output
messages. Set to Literal.
The following displays only when you expand the Operation node and click on INPUT/OUTPUT:
Table 21: Part List in the Input/Output Message Node
Field
Description
Part Name
The name of the message part.
Part Type
The type of the message part: Body or Header.
WS-Addressing
You can use WS-Addressing to specify message destinations and other information that is not part of the
SOAP protocol.
The SOAP protocol does not provide a standard way to specify message destination, where to return a
response, or how to report an error. Traditionally these details have usually been handled by the transport
layer. For example, when a SOAP request is sent over HTTP, the URI of the HTTP request determines the
message's destination. The message response is packaged in the HTTP response and received by the client
over the HTTP connection. When a SOAP request message is sent asynchronously through JMS, a destination
Applications | 163
for responses might be specified in the JMS message headers, incorporated into the message body, or left up
to the service implementation.
The WS-Addressing specifications provide a uniform method for incorporating delivery, reply-to, and fault
handler addressing information into a SOAP envelope. WS-Addressing defines two constructs that convey
such addressing information: endpoint references and message addressing properties.
Endpoint References
An endpoint reference conveys the information needed to identify a Web service endpoint, but are also used
to provide addresses for individual messages sent to and from Web services. An endpoint reference contains
an address (a URI), reference parameters, and metadata.
For details on endpoint references, refer to the WS-Addressing Core Specification. For information on
WS-Addressing, see Composite Development.
Schema
The schema of an endpoint reference is described in Web Services Addressing 1.0 - Core: Endpoint Reference
XML Infoset Representation.
URIs
The only required element of an endpoint reference is the address; the other elements are optional. Thus, the
simplest endpoint reference is a URI:
<wsa:Address>
http://localhost:9090/axis2/services/billing_service
</wsa:Address>
The supported URI formats are listed in the following table:

Table 22: Supported URI Formats
Binding Type
URI Format
Virtualization
urn:amx:environmentName/applicationName#service(serviceName) where serviceName is

the name of the target service, applicationName is the name of the application that
contains the target service, and environmentName. is the name of the ActiveMatrix
environment that contains the application.
SOAP/HTTP
scheme://hostname:port/filespec/
SOAP/JMS
jms:queue:queueName, where queueName is the name of the JMS queue to which

messages are sent.
Reference Parameters
A reference parameter is associated with an endpoint to facilitate a particular interaction. The binding of
reference parameters to messages depends upon the protocol binding used to interact with the endpoint.
Web Services Addressing 1.0 - SOAP Binding describes the default binding for the SOAP protocol.
Metadata
Endpoint reference metadata describes the behavior, policies, and capabilities of the endpoint. Metadata may
be included in an endpoint reference to facilitate easier processing by a user of an endpoint reference, or
because the metadata was dynamically generated.
Example
<wsa:EndpointReference
xmlns:wsa="http://www.w3.org/2005/08/addressing"
xmlns:wsaw="http://www.w3.org/2006/02/addressing/wsdl"
xmlns:fabrikam="http://example.com/fabrikam"
xmlns:wsdli="http://www.w3.org/2006/01/wsdl-instance"
wsdli:wsdlLocation="http://example.com/fabrikam
http://example.com/fabrikam/fabrikam.wsdl">
164 | Applications
<wsa:Address>http://example.com/fabrikam/acct</wsa:Address>
<wsa:Metadata>
<wsaw:InterfaceName>fabrikam:Inventory</wsaw:InterfaceName>
</wsa:Metadata>
<wsa:ReferenceParameters>
<fabrikam:CustomerKey>123456789</fabrikam:CustomerKey>
<fabrikam:ShoppingCart>ABCDEFG</fabrikam:ShoppingCart>
</wsa:ReferenceParameters>
</wsa:EndpointReference>
Message Addressing Properties

Message addressing properties allow uniform addressing of messages independent of underlying transport.
These properties convey end-to-end message characteristics including addressing for source and destination
endpoints as well as message identity.
Most of the properties are optional; the only required property is the action property. The value of the
[action] property should be an IRI identifying an input, output, or fault message within a WSDL interface or
port type. An action may be explicitly or implicitly associated with the corresponding WSDL definition. See
Configuring the Action Property. If present, the request is delivered to the IRI specified in the To element.
The action IRI indicates the action to be taken. In an HTTP request, these would be the same IRI. In a non-HTTP
request, the To IRI may differ from the action IRI.
Message Addressing Properties
The message addressing properties augment a message with the properties listed in Message Addressing
Properties.
Message Addressing Elements
The syntax of the message addressing elements is described in Message Addressing Elements.
Example
<soapenv:Envelope xmlns:soapenv='http://www.w3.org/2003/05/soap-envelope'>
<soapenv:Header xmlns:wsa='http://www.w3.org/2005/08/addressing'>
<wsa:To>http://localhost:9090/axis2/services/order_service</wsa:To>
<wsa:Action>http://tibco.com/addr/order</wsa:Action>
<wsa:ReplyTo>
<wsa:Address>http://localhost:9090/axis2/services/billing_service</wsa:Address>
</wsa:ReplyTo>
<wsa:FaultTo>
<wsa:Address>http://localhost:9090/axis2/services/reorder_service</wsa:Address>
</wsa:FaultTo>
<wsa:MessageID>a4dfb94a-593b-1dc1-36d2-000000000000</wsa:MessageID>
</soapenv:Header>
<soapenv:Body>
</soapenv:Body>
</soapenv:Envelope>
Validation and Fault Handling

Most WS-Addressing elements are optional. If these elements are omitted, the SOAP binding does not return
a fault message. To enable validation, enable the endpoint for WS-Addressing.
The faults defined in this section are generated if the condition stated in the preamble in each subsection is
met. They are sent to the [fault endpoint], if present and valid. Otherwise they are sent to the [reply endpoint]
if present. If neither is present faults may be sent to the [source endpoint].
The [action] property designates WS-Addressing fault messages. This URI is also used as default Action
value for WSDL fault messages: http://schemas.xmlsoap.org/ws/2004/08/addressing/fault
The definitions of faults use the following properties:
Property
Description
[Code]
The fault code.
[Subcode] or
[Subsubcode]
The fault subcode.
[Details]
The detail element. If absent, no detail element is defined for the fault.
Applications | 165
SOAP Binding Flags

The handling of WS-Addressing headers depends on the state of the Enable WS-Addressing SOAP binding
flag. When checked, the WS-Addressing headers are validated. If unchecked, the request URI determines the
service name and the soapAction transport header determines the operation. The following sections describe
the behavior of the SOAP binding when incoming requests are missing WS-Addressing header elements.
/wsa:Action
Missing /wsa:Action The SOAP container returns a fault message with the details:
<ProblemAction xmlns="http://www.w3.org/2005/08/addressing">
<Action>NULL</Action>
</ProblemAction>
If this header is set but is invalid, the SOAP binding returns a fault message with the details:
<Action>invalidAction</Action>
</ProblemAction>
/wsa:To
Missing /wsa:To
The value of the [destination] property is set to http://www.w3c.org/2005/08/addressing/anonymous.
Missing Both /wsa:Action and /wsa:To
The SOAP binding returns a fault message with the details:
<Action>NULL</Action>
</ProblemAction>
/wsa:ReplyTo
Missing /wsa:ReplyTo
The [address] property of the [reply endpoint] is set to
http://www.w3c.org/2005/08/addressing/anonymous. If this element is missing or invalid, the SOAP
container synchronously returns a response message to the client with WS-Addressing header populated.
Missing /wsa:ReplyTo/Addressing
If /wsa:ReplyTo element is present, but is missing the required address subelement, the SOAP container
returns a fault message with subcode=InvalidAddressingHeader and subsubcode=MissingAddressInEPR.
The [action] property is set to http://www.w3.org./2005/08/addressing/soap/fault.
/wsa:FaultTo
Missing /wsa:FaultTo
If the reply is a fault message the [reply endpoint] property is used.
Missing Both /wsa:FaultTo and /wsa:ReplyTo
The response is sent back to the client directly. The [action] property is set to
http://www.w3.org./2005/08/addressing/soap/fault.
Missing /wsa:FaultTo/Addressing
If the /wsa:FaultTo element is present, but is missing the required Address subelement, the SOAP container
returns a fault message with subcode InvalidAddressingHeader and subsubcode=MissingAddressInEPR.
The [action] property is set to http://www.w3.org./2005/08/addressing/soap/fault.
Missing /wsa:MessageID
The SOAP container returns a fault message with subcode=MessageAddressingHeaderRequired.
166 | Applications
Configuring the Action Property

WS-Addressing defines two mechanisms to associate a value of the [action] property with input, output, and
fault elements within a WSDL description: explicit association and default association.
Explicit Association
In an explicit association, the [action] property value is set from the value of the Action elements specified
for the input, output, and fault messages or the value of the soapAction attribute set in the transport header.
<?xml version="1.0" encoding="utf-8"?>
<definitions targetNamespace="someuri">
<portType name="Hello_PortType">
<operation name="sayHello">
<input message="SayHelloRequest" wsam:Action="http://tibco.com/HelloService/Request"/>
<output message="SayHelloResponse"
wsam:Action="http://tibco.com/HelloService/Response"/>
</operation>
</portType>
Input message [action] = "http://tibco.com/HelloService/Request"
Output message [action] = "http://tibco.com/HelloService/Response"
Default Association
If neither the Action elements or soapAction attribute is specified, the [action] property value is constructed
as follows:
Input and output messages
targetnamespace/porttypename/messagename
Fault message
targetnamespace/porttypename/operationname/Fault/messagename
<?xml version="1.0" encoding="utf-8"?>
<definitions targetNamespace="http://tibco.com/defaulting ">
<portType name="Hello_PortType">
<operation name="sayHello">
<input message="SayHelloRequest"/>
<output message="SayHelloResponse" />
<fault message="InvalidMessage" name="InvalidRequest"/>
</operation>
</portType>
Input message [action] =
"http://tibco.com/defaulting/ Hello_PortType/SayHelloRequest"
Output message [action] =
"http://tibco.com/defaulting/ Hello_PortType/SayHelloResponse"
Fault message [action] =
"http://tibco.com/defaulting/Hello_PortType/ sayHello/Fault/InvalidRequest"
WS-Reliable Messaging
The OASIS Web Services Reliable Messaging 1.1 Specification describes a protocol that allows reliable message
transfer in the presence of software component, system, or network failures. The specification describes the
protocol in a transport-independent manner so it can be implemented using different network technologies.
To support interoperable Web services, a SOAP binding is defined within the specification.
The participants in reliable messaging are application source (AS), application destination (AD), reliable
message source (RMS), and reliable message destination (RMD), as shown in the following illustration.
Applications | 167
Figure 9: WS-RM Participants

An AS wants to reliably send messages to an AD over an unreliable infrastructure. To accomplish this it uses
a reliable message source (RMS) and a reliable message destination (RMD). The AS sends a message to the
RMS. The RMS uses the WS-Reliable Messaging (WS-RM) protocol to transmit the message to the RMD. The
RMD delivers the message to the AD. If the RMS cannot transmit the message to the RMD for some reason,
raises an exception or otherwise indicates to the AS that the message was not transmitted. The AS and RMS
can be implemented within the same process space or they be separate components. Similarly, the AD and
RMD can exist within the same process space or be separate components.
Delivery Guarantees
WS-Reliable Messaging defines the following delivery guarantees:
At Least Once Each message is delivered to the AD at least once. If a message cannot be delivered, an
error must be raised by the RMS, RMD or both. Messages may be delivered to the consumer more than
once (that is, the consumer may get duplicate messages).
At Most Once Each message is delivered to the AD at most once. Messages may not be delivered to the
AD, but the AD never gets duplicate messages.
Exactly Once Each message is delivered to the AD exactly once. If a message cannot be delivered, an error
must be raised by the RMS, RMD, or both. The AD never gets duplicate messages.
In Order Messages are delivered from the RMD to the AD in the order that they are sent from the AS to
the RMS. This guarantee can be combined with any of the other guarantees.
TIBCO ActiveMatrix supports Exactly Once delivery guarantee.
Composition with WS-Addressing
When the WS-RM protocol is composed with the WS-Addressing specification, the following rules prescribe
the constraints on the value of the wsa:Action header:
When an endpoint generates a message that carries an RM protocol element in the body of a SOAP
envelope, that endpoint must include in that envelope a wsa:Action SOAP header block whose value is
an IRI that is a concatenation of the WS-RM namespace URI, followed by a "/", followed by the value of
the local name of the child element of the SOAP body. For example, for a Sequence creation request
message, the value of the wsa:Action IRI would be
http://docs.oasis-open.org/ws-rx/wsrm/200702/CreateSequence.
When an endpoint generates an acknowledgement message that has no element content in the SOAP
body, then the value of the wsa:Action IRI must be
http://docs.oasis-open.org/ws-rx/wsrm/200702/SequenceAcknowledgement.
When an endpoint generates an acknowledgement request that has no element content in the SOAP body,
then the value of the wsa:Action IRI must be
http://docs.oasis-open.org/ws-rx/wsrm/200702/AckRequested.
When an endpoint generates an RM fault, the value of the wsa:Action IRI must be
http://docs.oasis-open.org/ws-rx/wsrm/200702/fault.
168 | Applications
Reliable Messaging Elements

Figure 9: WS-RM Participants on page 167 shows the four participants in a reliable messaging scenario. Reliable
Messaging Elements illustrates how the participants are mapped to composite elements. This section describes
how to enable reliable messaging in the participating elements.
Figure 10: Reliable Messaging Participants

As shown in the figure, the Application Source role is performed by Component 1 and a SOAP reference.
Reliable messaging commences when Component 1 initiates a reliable conversation.
In order for the SOAP reference to participate in reliable messaging you must enable WS-Reliable Messaging
for the reference. When reliable messaging is enabled, the SOAP reference communicates with a Reliable
Message Source implemented by the platform.
The Application Destination role is performed by a SOAP service, which like the reference, must be enabled
for WS-Reliable Messaging and Component 2. The SOAP service communicates with a Reliable Message
Destination implemented by the platform.
Because WS-Reliable Messaging requires WS-Addressing, you must also enable WS-Addressing on both the
SOAP reference and service.
JMS Bindings
JMS bindings integrate JMS applications with TIBCO ActiveMatrix. The JMS bindings convert JMS messages
to TIBCO ActiveMatrix messages and vice versa.
Java Message Service (JMS) is a Java specification for messaging between applications. JMS is based on the
creation and delivery of messages. The creator of the message is known as the publisher and the receiver of
the message is known as the subscriber. A JMS server acts as an intermediary for the message and manages
its delivery to the correct destination.
Configuration Overview
JMS bindings enable you to establish request and response message communication with a JMS server. In
other words, adding a JMS binding enables a particular application to receive JMS messages or to send
messages to the JMS server (JMS destination).
For an application to receive messages, for example, it must subscribe to a JMS server on a destination, which
is defined by the JMS Connection Factory Configuration, JMS Destination Configuration, and JNDI Connection
resource instances.
For the application to send messages, configuration details must be provided for the runtime library through
the JMS Connection Factory, JMS Destination, and JNDI Connection resource instances.
Applications | 169
The following figure illustrates an example of the request and response message communication sequence
of a service and of a reference within a TIBCO ActiveMatrix component.
Figure 11: Service and Reference Request and Reply Communication

The communication sequence for the service, which corresponds to the numbers shown in the figure, is:
1. The service gets a message from the destination specified by the request destination.
2. The message is processed and sent to the component implementation.
3. If a response is received from the component implementation, and an incoming message was configured
for a JMSReplyTo destination--either a temporary one or one specified as a service outbound
destination--then the output goes to that destination.
4. The destination receives the message.
The communication sequence for the reference, which corresponds to the numbers shown in the figure, is:
1. A message is sent by the reference to a destination specified by the outbound destination.
2. Once the message goes to the destination, there is another application listening to that message.
3. The application gets the message and puts a response to JMSReplyTo specified on the incoming
message--either a temporary one or one specified as a request destination.
4. The reference listens for responses on that destination and then receives one (4).
Use Cases
TIBCO ActiveMatrix supports the following JMS use cases and corresponding MEPs:
Service binding - You can create a service referencing port types of a component hosted inside TIBCO
ActiveMatrix. The component hosted inside TIBCO ActiveMatrix dictates the WSDL file and provides
services.
TIBCO ActiveMatrix subscriber communicating with a JMS publisher - In-Only
TIBCO ActiveMatrix server communicating with a JMS requestor - In-Out
Reference binding- You can create a reference for endpoints in an existing JMS application. The JMS
application dictates the WSDL file and provides services.
TIBCO ActiveMatrix publisher communicating with a JMS subscriber - In-Only
TIBCO ActiveMatrix client communicating with a JMS responder - In-Out
170 | Applications
JMS Binding Reference

JMS Bindings include properties. You can configure most properties, and several properties accept substitution
variables.
Binding Node
Property
Editable?
Accepts
Svar?
Description
Name
Name of JMS Binding.
Description
Description of JMS Binding.
Connection
Factory
The name of a JMS Connection Factory on page 221resource

instance.
Required for MEP:
In-Out (Service, Reference)
In-Only (Service, Reference)
Table 23: Configuration for JMS Binding Request Communication

Property
Editable?
Destination Type Y
Accepts
Svar?
Description
The Type of JMS destination, Queue, Topic, or JNDI. For

Direct Destinations, use Queue or Topic. For JNDI Resource
template, use JMS Destination Resource template.
Required for MEP:
Destination
This property is only applicable for JNDI

Destination Type.
The name of a JMS Destination in case of JMS Destination
resource template.
Required for MEP:
Queue Name
Topic Name
Name of the Queue if Destination Type is selected as

Queue.
Name of the Topic if Destination Type is selected as Topic.
Table 24: Configuration for Reply JMS message, applicable for In-Out MEP
Property
Editable?
Destination Type Y
Accepts
Svar?
N
Description
The Type of JMS destination, Queue, Topic or JNDI. For

direct destinations use Queue or Topic. For JNDI resource
template, use JMS Destination Resource template.
Applications | 171
Property
Editable?
Accepts
Svar?
Description
By default destination type is 'Same as Request Message'.
The 'Same as Request Message' option indicates that
the Reply Message Destination Type is same as the
Request Message Destination Type. In CLI script,
there is no such option. You must select Queue,
Topic, or JNDI.
Required MEP:
Destination
This property is only applicable for JNDI

Destination Type.
The name of a JMS Destination in case of JMS Destination
resource template. If not specified, temporary destination
name derived from value of JMSReplyTo JMS header will
be used.
Queue Name
Name of the Queue if Destination Type is selected as

Queue.
Topic Name
Name of the Topic if Destination Type is selected as Topic.
In case of In-Out MEP even when Reply Message is configured, priority well be given to JMSReplyTo
JMS Message header and reply will be sent on the destination represented by the JMSReplyTo header
value. Clients must not set this header field when fixed reply destination is used.
Table 25: Advanced Settings for JMS Binding

Property
Editable?
Accepts
Svar?
Description
Reply Message
NOTE: If Request or Reply message destination type is set to Queue or Topic and JMS Provider does not
support dynamic queue or topic creation or the user of provider does not have create permissions, create
a queue or topic before deploying the application.
Connection
Factory
Name of the JMS Connection Factory resource template.

By default Connection Factory is 'Same as Request Message'.
The 'Same as Request Message' option indicates that
the Reply Message Connection Factory is same as
the Request Message Connection Factory. In CLI
script, there is no such option.
Required MEP:
172 | Applications
Property
Editable?
Accepts
Svar?
Correlation
Scheme
Description
Scheme which identifies the correlation scheme used when

sending reply messages.
Required if the reply destination is set. The correlation
schemes are:
RequestCorrelIDtoCorrelID - Correlation ID of the
request message is copied to the Correlation ID of the
response message.
RequestMsgIDtoCorrelID - Message ID of the request
message is copied to the Correlation ID of the response
message.
For receiving proper reply messages by the JMS Binding on
Promoted Reference in case of In-Out MEP, to pick the
message from Request Destination, client must set the
JMSCorrelationID header field on the JMS Message
according to the Correlation Scheme.
Default: RequestCorrelIDtoCorrelID
RequestMsgIDtoCorrelID correlation scheme is not
supported for Topic set as static reply destination.
Operation Selection
Type
Applicable only in case of multiple operations.

Operation selection scheme in case of multiple operations.
SCA and Custom are supported. In case of Custom scheme
other properties (JMS Property Name and Error Action) are
not editable but Message Selector configuration on each
operation is mandatory. See "Operation Node" for more
details.
JMS Property
Name

Name of the JMS property to be used for operation selection
in case of multiple operation and "SCA" operation selection
type. Default property name is "scaOperationName".
Error Action

Action to trigger in case when operation selection from
multiple operation fails.
Discard Message - This is a default Error Action. When
selected, runtime will discard the message when
operation selection fails.
Send Message To Operation - By selecting this action,
user can inform runtime to send the message to a
Applications | 173
Property
Editable?
Accepts
Svar?
Description
particular configured operation when operation selection
fails.
Send Message To Error Queue - By selecting this action,
user can inform runtime to send the message to a
configured error queue when operation selection fails.
Retain Message in Service Destination - By selecting this
action, user can inform runtime to retain the message in
the service request destination configured in Request
Message section.
Operation Name Y
Error Queue
Name
Displayed when "Send Message to Error Queue" error action

is selected. Error queue to send the JMS message in case of
operation selection fails and "Send Message to Error Queue"
error action is configured.
JMS Property name used to send the fault as a value. Default

property name is "faultName".
Displayed when "Send Message to Operation" error action

is selected. Operation name to send the message in case of
operation selection fails and "Send Message to Operation"
is configured.
Fault Selection
JMS Property
Name
Interface Settings
Property
Editable? Accepts
Svar?
Description
Operation Selection
Message Selector
A JMS message selector allows a client to specify, by

message header and properties, the messages its interested
in. Message selector on Interface Settings is configurable
when Error Action in Operation Selection is other than
"Retain Message in Service Destination" and Operation
Selection Type is "SCA".
Request Message
Message Type
Message type used for request messages. One of:

XML Text - A text message carrying XML payload that
confirms to specified schema.
Bytes - Binary data
Text - A text message carrying a payload of type
xsd:string.
XML Bytes - XML content sent as bytes. (JMS resource
instances treat this type as bytes but JMS bindings expect
content in XML.)
174 | Applications
Property
Editable? Accepts
Svar?
Description
Default: XML Text.
Durable
Subscription
Configurable only in JMS Binding on Promoted Service.

Specifies a durable subscription. You must specify a name
in the Durable Subscription field which gets registered with
the JMS application as the durable subscription name.
Applicable only if Request Message Destination type
is Topic.
Subscription Name Y

The subscription name registered with the JMS application
for durable subscriptions. This field is only available when
the Durable Subscription field is checked.
Applicable only if Request Message Destination type
is Topic.
Delivery Mode
Configurable only in JMS Binding on Promoted Reference.

The delivery mode of the message. One of the following:
Persistent - Messages are stored and forwarded
Non-Persistent - Messages are not stored and could be
lost due to failures in transmission.
TIBCO Enterprise Message Service Reliable - The
consumer never sends the provider a receipt
confirmation or access denial and the provider does not
wait for it. Reliable mode decreases the volume of
message traffic, enabling higher message rates.
Default: Non-Persistent.
Message Priority

Priority of the message. You can set the priority to a value
from 0-9.
Message
Expiration

The time in milliseconds for which request message is
retained by JMS Provider.
Operation Timeout Y

The period that the JMS binding waits for the response to
arrive.
Default: If the MEP is In-Out, the defaults are 6000 ms at
the port type and operation levels. If other values
(non-default values) are specified, these values take effect,
with the value at the operation level given precedence.
Applications | 175
Property
Editable? Accepts
Svar?
Description
Operation Timeout is applicable for a Reference only.
For a Service, add a thread policy on a component
service and set timeout on the thread policy.
Reply Message
Message Type
Message type used for reply messages. One of:

XML-Text - A text message carrying XML payload that
Bytes - Binary data
xsd:string.
xmlBytes - XML content sent as bytes. (JMS resource
content in XML.)
Default: XML-Text.
Delivery Mode

Message Priority

from 0-9.
Message
Expiration

The time in milliseconds for which reply message are
Fault Message:
This section is visible only in JMS Binding on Promoted Service and if operation has defined faults. It is
applicable only for In-Out-Fault MEP.
Override Reply
Message
Configuration from Reply Message is INHERITED by

default. To "Override Reply Message" configuration in
Interface Settings for Fault Message select "Override Reply
Message".
Message Type

XML-Text - A text message carrying XML payload that
Bytes - Binary data
176 | Applications
Property
Editable? Accepts
Svar?
Description
xsd:string.
xmlBytes - XML content sent as bytes. (JMS resource
content in XML.)
Default: XML-Text.
Delivery Mode

Message Priority
Message
Expiration

from 0-9.
The time in milliseconds for which reply message is retained
by JMS Provider.
Operation Node
Property
Editable?
Accepts Svar? Description
Operation Settings
Name
Operation name.
Description
Notes for operation name.
Operation Selection
Message Selector Y
A JMS message selector allows a client to specify, by

message header, the messages its interested in. Message
Selector is displayed only when Operation Selection Type
is "Custom" or Operation Selection Error Action is "Retain
Message in Service Destination" and is used as a operation
selector for the selected operation.
Request Message
Override
Y
Request Message
Override INHERITED Request Message configuration

from Interface Settings for this operation only. If selected
Message Type can be overridden.
Applications | 177
Property
Editable?
Message Type
Message type used for request messages. One of:

Bytes - Binary data
xsd:string.
instances treat this type as bytes but JMS bindings
expect content in XML.)
Default: XML Text.
Durable
Subscription
Subscription
Name
Delivery Mode
Specifies a durable subscription. You must specify a name

in the Durable Subscription field which gets registered
with the JMS application as the durable subscription name.
Durable subscription is displayed only when Request
Message Destination Type is "Topic" and Operation
Selection Type is "Custom" or Operation Selection Error
Action is "Retain Message in Service Destination".
The subscription name registered with the JMS application
for durable subscriptions. This field is only available when
the Durable field is checked and Request Message
Destination Type is "Topic" and Operation Selection Type
is "Custom" or Operation Selection Error Action is "Retain
Message in Service Destination".
Non-Persistent - Messages are not stored and could
be lost due to failures in transmission.
confirmation or access denial and the provider does
not wait for it. Reliable mode decreases the volume of
Message Priority Y

from 0-9.
Message
Expiration

Operation
Timeout
178 | Applications
Property
Editable?

The period that the JMS binding waits for the response to
arrive.
Default: If the MEP is In-Out, the defaults are 6000 ms at
the port type and operation levels. If other values
(non-default values) are specified, these values take effect,
with the value at the operation level given precedence.
Operation Timeout is applicable for a Reference
only. For a Service, add a thread policy on a
component service and set timeout on the thread
policy.
Reply Message
Override Reply
Message
Override INHERITED Reply Message configuration from

Interface Settings for this operation only.
Message Type

Bytes - Binary data
xsd:string.
Default: XML Text.
Delivery Mode

Message Priority Y

from 0-9.
Message
Expiration
Fault Message

Applications | 179
Property
Editable?
This section is visible only if faults are configured.
Override Fault
Message
Fault Name
Message Type
Override INHERITED fault message configuration from

Interface Settings.
Name of the fault.
Bytes - Binary data
xsd:string.
Default: XML Text.
Delivery Mode

Message Priority Y

from 0-9.
Message Expiry Y

Context Parameter Mapping

The following table shows the context parameter mapping to JMS header parameters or JMS application
properties. JMS Header parameters or JMS application properties on JMS message from Request Message
can be mapped to a context parameter and vice versa. Context parameters are defined in the General section
of the Promoted Service or Promoted Reference. All the parameters defined in Context Parameters are available
to Context Parameter Mapping in JMS Binding.
Property
Description
Context Parameter
Name of the context parameter.
Direction
Direction of the flow of parameter.

INPUT: JMS Header parameter or JMS Application property is mapped to a Context
Parameter.
180 | Applications
Property
Description
OUTPUT: Context parameter is mapped to a JMS Header parameter or JMS
Application property.
Header Source
Source of the header parameter.

JMS_HEADER: When JMS_HEADER is used, a JMS Header parameter name to
map to a context parameter can be selected from Header Name.
JMS_APPLICATION_PROPERTIES: Customer JMS Application property name is
used for Context Parameter mapping.
Header Name
Shows JMS Header parameter names when JMS_Header is selected. Allows custom
property value to be set when JMS_APPLICATION_PROPERTIES is set.
JMS Binding supports only Context Parameters of 'Type' Basic.
Wire to Binding Reference

Field
Read-only? Description
Show only
Valid
When selected, only those services that are valid for the reference are displayed.
Application
Name
Name of the application.
Service
Name
Name of the target service.
Service
Binding
The type of service binding.
Remarks
Description for the target service.
Applications | 181
Properties
A property is an externally visible data value. Properties enable object behavior to be configured at deployment
time.
A property has a type, which may be either simple or complex. Implementations, components, composites,
bindings, logging configurations and appenders, and resource templates can have properties. Implementation,
component, and composite properties are defined in TIBCO Business Studio. Binding, logging configuration
and logging appender, and resource template properties are defined by the TIBCO ActiveMatrix platform.
Properties can have explicit values or may be bound to substitution variables, which can be set at deployment
time in various scopes. Depending on the object possessing the property, the property value can be bound
at design time, deployment time, or both:
At design time you can provide default values and indicate whether a composite or component property
value must be set at deployment time.
Some properties can be bound to substitution variables.
At design time, a composite property value can be set to a constant or bound to a substitution variable. Either
type of binding can be overridden at administration time. However, only the properties of the root composite
of an application or those on bindings associated with application level services and references can be
overridden. If there are nested composites (component of type composite) then their property values cannot
be changed by an Administrator.
A composite property is specific to an application. Often the same property may be defined in more than one
application. For business reasons or ease of use an Administrator may want to define the value only once
and have it be used by more than one composite property. This is achieved by binding the composite property
to a substitution variable, which can be defined at the enterprise, host, environment, node, application, and
application fragment levels. The following figure shows a property named Greeting bound to a substitution
variable named Greeting.
A component may be deployed to more than one node and you may want to have different values passed
for a component property in every node. In such cases you would set the component property to a substitution
variable, and set the substitution variable to different values on each node.
Setting a Property Value

You can set a property value in the GUI or by using the CLI. You can set a property value to a constant, a
substitution variable, or the name of a resource instance available on the node on which an application is
deployed.
About this task
To bind a property value to a substitution variable, you can set the value to %%variableName%%,
wherevariableName is the name of the substitution variable.
GUI
Procedure
1. Select the node where the application is deployed.
182 | Applications
3. Click the Properties tab and click the Editable Properties link.
4. Click the plus ( ) next to a property owner.
The owner's properties and their associated values display.
5. Click a property row in the Value column.
The value is enabled for input.
6. Specify a value according to the property type.
Property Type Procedure
Simple
Type a value or substitution variable string.
Resource
Instance
You can specify a resource instance in several different ways.

Type a value or substitution variable string.
Select an existing resource instance.
1. Click the icon. The Lookup Resource Instance dialog displays.
a. In the Hosts column, choose a node.
b. In the Instances column, choose a resource instance.
c. Click Save.
Create a new resource template.
1. Click the new link. The Add Resource Template dialog displays.
2. Complete the dialog and click Save. The property value is filled in with the
name of the resource template.
When you create and install a resource instance of a referencing resource
template, a resource instance with the same name as the referenced
resource template is instantiated and installed on the same node. For
example, if you create and install an SSL Client Provider resource
instance, the Keystore Provider it references will be created and installed.
7. Click Save.
The property value is updated in the database.
8. Click Refresh.
The value in the Synchronization column changes to Out of Sync.
9. Click Deploy.
The property value is updated in the runtime and the Synchronization column changes to In Sync.
CLI
Procedure
1. In the data file specify a Property definition in full format. Nest the Property element under an
Application element.
<Property xsi:type="amxdata:Property" name="propertyName" value="propertyValue"/>
2. In the build file set the action attribute of the AMXAdminTask element to edit and the objectSelector
attribute to //Application/Property.
<AMXAdminTask action="edit" objectSelector="//Application/Property"/>
Applications | 183
Editable Properties Reference

You can access the editable properties for an application by selecting the application, navigating to the
Properties tab, and clicking the Editable Properties link.
Field
Owner
Name of the application or binding.
Owner Type Y
Property
Name
Name of the property.
Property
Type
Type of the property. Either string or a resource template type.
Property
Value
Value of the property.
Non-Editable and Policy Set Properties Reference

You can access the non-editable and policy set properties for an application by selecting the application,
navigating to the Properties tab, and clicking the Non-editable Properties or Policy Set Properties link.
Field
Owner
Name of the application or binding.
Owner Type Y
Property
Name
Property
Type
Type of the property. Either string or a resource template type.
Property
Value
Value of the property.
Chapter
8
Resource Templates
A resource template specifies configuration details for resources.
One resource template can be used to configure many resource instances. Resource instances allow sharing of
resources such as connection pools. They also eliminate the need to provide such details in services, component
implementations, and references. Instead, you specify a property of the type of required resource in the service,
component, or reference. While configuring an application for deployment, the property of a resource instance in
the node is mapped to the application.
Resource templates are defined at the enterprise, environment, or application level. A resource template defined
at enterprise level is available to all environments and applications in the enterprise; a resource template defined
at an environment level is available only to applications in that environment; a resource template defined at an
application level is available only to that application.
You can create resource templates in two ways:
Manually using the command-line and web interfaces.
Automatically when you import the resource templates while creating an application.
In either case you must have enterprise permission to create a resource template.
Topics
Resource Templates With Scope

Creating a Resource Template
Editing a Resource Template
Incremental Editing of a Resource Template
Renaming a Resource Template
Changing the Scope of a Resource Template
Deleting Resource Templates
Creating an Obfuscated Password
Configuring Mutual Authentication
Configuring Third-Party JDBC Drivers
Adding an Updated JDBC Driver
Configuring Third-Party JMS Drivers
Configuring the Read Response Timeout for an LDAP Connection
Keystores
Creating a Keystore Containing a User Name and Password
References
186 | Resource Templates
Resource Templates With Scope

The scope of resource templates can be defined at enterprise level, environment level, and application level.
The following levels of scope are available:
Global or enterprise (default) - available to all environments and applications in the enterprise.
Environment - available only to applications in a specific environment.
Application - available only to a specific application running on a node or multiple nodes.
The scope of a resource template is specified at the time of creating it. Later it is possible to change the scope.
The following are conditions when changing scope:
You can specify multiple target elements for a resource template while changing the scope. When multiple
target scopes are specified, a resource template in each target scope is created. For example, the resource
template with global scope can be scoped to multiple environments or applications.
If a resource template has a resource instance linked to it, then changing the scope makes a copy than
move the resource template itself. For example, if JDBC_RT has its scope as global and a JDBC_RI linked to
it, changing the scope of JDBC_RT will make a copy of it for the environment or application than move it
to the new scope and remove it from enterprise.
The image below provides an example of how resource templates are scoped at application, environment,
and global levels.
Resource Templates | 187
Life Cycle of Application Scope Resource Template

When you scope a resource template to an application, the application owns the resource template and the
life cycle of the associated resource instances. When you deploy an application:
Resource instances using the resource templates with scope to the application are installed.
Resource instances are created in the appropriate nodes as needed.
A validation process verifies the application property that needs a resource instance matches the resource
template name in the application scope. If the match is found the resource instance is automatically created
and installed when the application is deployed.
When you undeploy the application all the resource instances using the resource templates with scope defined
to the application are uninstalled.
When an application is deleted, all resource templates with scope to the application and the associated
resource instances are deleted. This allows creation of an application once and deployment multiple times
without conflict.
Uniqueness
Resource templates names are unique in a specified scope. Two resource templates with the same name
cannot exist in the same scope irrespective of the resource template type.
When a scope is deleted, all resource templates contained in the scope are deleted.
When an application is deleted, all resource templates scoped for the application are deleted.
Before deleting the resource templates, all resource instances created from the resource templates are
un-installed (only relevant for force) and deleted.
Two applications whose property containing same resource instance name and containing the corresponding
resource template configuration cannot coexist on the same node. However, they can both have properties
referring to the same JNDI name as long as only one of them provides the application level resource
template. For example, consider:
Two applications containing a resource template configuration each with same name.
When the application is created, the corresponding resource template is created with in its application
scope.
When deploying the application, this requires two resource instances to be installed with same name,
but it cannot because resource instances with same name cannot coexist on the same node.
Resource Dependency and Auto Creation of Resource Instances
Resource templates can depend on other resources defined in its scope or its parents scope. It cannot
depend on its child scope for the purpose of auto creation. However, if dependencies are explicitly created,
a resource instance can depend on a resource at a child scope. For example, consider that an HTTP_Client
resource template exists in the System Environment which depends on a SSL_Client_Provider in the
Enterprise. When HTTP resource instance is created and installed on a node:
1. It looks for the dependency resource instance (SSL_Client_Provider) on the node
2. If no resource instance exists, Administrator checks whether an SSL_Client_Provider resource template
with the same name exist in the System Environment scope. If the resource template is available at the
environment scope, Administrator creates a resource instance using the resource template.
3. If the resource template does not exist in the environment scope , Administrator checks in the Enterprise
and creates a resource instance if the resource template is available.
However, if the SSL_Client_Provider resource instance with the same name already exists in the specified
node, the HTTP_Client will depend on it irrespective of its scope.
Permissions
Users need permission to create resource templates and change the scope. For example, a user with permission
to an environment can create a resource template to be shared across applications in the environment and
not globally at enterprise level.
Resource templates with global or environment scope have view, edit, and owner permissions that are
set individually for each resource templates.
For global or environment scope, users with Create Resource Template permission can create resource
templates at that scope level.
Resource templates with application scope do not have individual permissions. Users who are granted
Manage Resource Template permission for the application can create, edit, view, and delete resource
templates with application scope.
Other Conditions
Resource Templates from one scope are not visible to other scope of the same level. Resource Templates
created in SystemEnvironment are not visible to DevEnvironment and thus are not used for auto creation
of resource instances nor do they show up in pickers.
Resource templates cannot be deleted if a resource instances exists for it.
Resource instances cannot be uninstalled when other resource instances depend on it.
Resource instances with the same name cannot coexist in the same node.
When an application is undeployed, all resource instances using resource templates scoped to that
application are uninstalled.
When an application is deployed, all Resource Templates scoped to that application are:
1. Checked against the application's properties to see where they are needed.
2. If specific nodes are identified this way, then Resource Instances with the same name are created and
installed on each of those nodes.
3. If no properties in the application reference the resource templates, then resource instances are
automatically created and installed on every node to which the application is mapped.
If a Resource Instance with the required JNDI name already exists on a node where the above rules would
cause auto-creation to happen, then deployment validation fails. If redeployment results in the application
being removed from a node, all Resource Instances on that node using Resource Templates scoped to the
application are uninstalled and deleted.
Creating a Resource Template

You can create a resource template from the GUI or by using the CLI.
GUI
Procedure
1. Navigate to a resource templates list. Choose a starting point.
Starting Point
Procedure
Shared Objects
1. Click Shared Objects > Resource Templates.

2. Click New.
Hosts
1. Click Infrastructure > Hosts > hostName > Resource Instances.

2. Click New.
You can use the Type and Scope to filter the list of resource templates.
3. In the New Resource Instances window click new resource template.
Nodes
1. Click Infrastructure > Nodes > nodeName > Resource Instances.

2. Click New.
3. In the New Resource Instances window click new resource template.
Application
1. Click Application > appName > Resource Templates.

2. Click Resource Template link.
3. Click New.
Resource template created from the Application tab will have a scope to the
application
Dashboard
1. Select Dashboards > Welcome Page.

2. Click New Resource Template
2. In the Add Resource Template dialog, select a resource type from the Type drop-down list.
The dialog redraws with type-specific fields.
Ensure there is no resource template with the same name at the specified scope level.
3. Use the slide bar to select a scope for the resource template.
When the slide bar is above Global, the resource template is created at global level to share across
environments and applications.
When the slide bar is above Environment the resource template is created for a selected environment.
When the slide bar is above Application, the resource template is created for a selected application.
Select an environment to filter the list of applications in an environment.
4. Edit the template configuration fields.

The name of the resource template must not contain the colon (:) or ampersand (&) characters.
Ensure there is no resource template with the same name at the specified scope level.
5. Click Save.
CLI
Procedure
You can either manually specify the scope of a resource template or import while creating an application.
Manual
In the data file, specify the type of the resource template in the xsi:type attribute. The resource
templates can be nested under Enterprise, or Environment, or Application to create them in the
corresponding scope:
<ResourceTemplate xsi:type="amxdata:JdbcResourceTemplate"
...
</ResourceTemplate>
name="appJDBC1"
<Environment xsi:type="amxdata:Environment" name="DevEnvironment" >

...
<ResourceTemplate xsi:type="amxdata:JdbcResourceTemplate" name="appJDBC1"
...
</ResourceTemplate>
<Application xsi:type="amxdata:Application" name="nestedTestApp"
resourceTemplatesScope="Application">
...
...
</ResourceTemplate>
</Application>
</Environment>
In the AMXAdminTask element, set the action attribute to add and the objectSelector attribute to
ResourceTemplate or Environment/ResoureceTemplate or
Environment/Applicaiton/ResoureceTemplate:
<AMXAdminTask action="add"
objectSelector="ResourceTemplate|Environment/ResourceTemplate|Environment/
Application/ResourceTemplate"/>
See AMX AdminTask for more information.

Import
When you create an application, it can import the resource templates from the DAA file.
Set the attribute ImportResourceTemplateNames="true"to import all resource templates from the
application template.
To import select resource templates from the application template, specify each resource template
separately in <ImportResourceTemplateName>
You can specify a scope to the resource template in resourceTemplatesScope. If no scope is
mentioned, default scope is global.
<Application xsi:type="amxdata:Application" name="app" importResourceTemplates="true"
resourceTemplatesScope="Global/Environment/Application">
<ApplicationTemplate xsi:type="amxdata_reference:ApplicationTemplate_reference"
name="appTemplate"/>
<ImportResourceTemplateName>Httpclient_RT</ImportResourceTemplateNames>
<ImportResourceTemplateName>JDBC_RT</ImportResourceTemplateNames>
</Application>
In the AMXAdminTask element, set the action attribute to add and the objectSelector attribute to
ResourceTemplate|Environment/ResourceTemplate|Environment/Application/ResourceTemplate
Editing a Resource Template

You can edit a resource template from the resource templates list in the GUI.
Procedure
1. Select Shared Objects > Resource Templates.
2. Select a resource template from the list.
3. Click the General and edit the configuration fields are required.
Some resource templates have properties that accept passwords. Passwords can be specified as clear or
obfuscated text.
4. Click an action button. The action performed by a button applies only to the tab being edited.
Option
Action
Save
Save changes to the database.
Revert
Discard changes and revert to the last saved state.
Restore Default
Restore default values for fields that have a default. If a field does not
have a default, the value stays as is.
The Save and Revert buttons are disabled.

5. If there are resource instances that depend on the modified resource template and if there are applications
that use those resource instances, the Apply Changes in Resource Template to Runtime dialog displays.
a) Select the resource instances that you want to reinstall. These are resource instances created from this
resource template or other resource templates that depend on the modified resource template.
b) Select the applications that you want to restart.
c) Select the nodes where you want the resource instances reinstalled and the applications restarted.
6. Click Save.
CLI
You can edit a resource template using the command-line utility.
Procedure
1. In the data file, specify the type of the resource template in the xsi:type attribute.
<ResourceTemplate
xsi:type="amxdata:JdbcResourceTemplate"
name="JdbcResource"
description="This is a new Jdbc Resource"
maxConnections="10">
<Direct
xsi:type="amxdata:Direct"
dbUrl="jdbc:hsqldb:hsql://localhost:1234/jdbcRtDb"
jdbcDriver="org.hsqldb.jdbcDriver"
isTransactional="false"
loginTimeOut="60000"/>
<InlineCredentials username="a" password="a"/>
</ResourceTemplate>
2. In the AMXAdminTask element, set the action attribute to edit and the objectSelector attribute
ResourceTemplate|Environment/ResourceTemplate|Environment/Application/ResourceTemplate/>.
<AMXAdminTask action="edit"
Application/ResourceTemplate">
Incremental Editing of a Resource Template

Incremental editing allows you to selectively edit only those properties that you want to change in a resource
template using command-line interface.
Procedure
<ResourceTemplate
name="JdbcResource">
<Direct
dbUrl="jdbc:hsqldb:hsql://localhost:1234/jdbcRtDb"/>
</ResourceTemplate>
2. In the AMXAdminTask element set the action attribute to edit, and the objectSelector to
ResourceTemplate|Environment/ResourceTemplate|Environment/Application/ResourceTemplate.
The ant target will have action as edit and one more xml attribute called incrementalEdit and
set it to true. This new attribute incrementalEdit will make this edit call as incremental edit.
<AMXAdminTask action="edit"
Application/ResourceTemplate">
incrementalEdit="true"
Renaming a Resource Template

A resource template can be renamed using command-line interface.
Procedure
1. In the data file use the attribute newName to rename a resource template.
<ResourceTemplate
name="JdbcResource"
newName="JdbcResource-New">
<Direct
dbUrl="dummy"
jdbcDriver="dummy"/>
</ResourceTemplate>
2. In the AMXAdminTask element, set the action attribute to rename and the objectSelector attribute
<AMXAdminTask action="rename"
Changing the Scope of a Resource Template

You can change the scope of a resource template using the Administration GUI. For more information, see
Resource Template With Scope.
About this task
The scope of a resource template can be changed even if:
a resource instances exists.
there is a hidden dependency such as inline credentials.
resource instances on nodes are not related to the target scope.
For more information, see Resource Template With Scope.
Procedure
2. Select a resource template from the list.
3. Click the Change Scope.
Change Scope from Resource Templates window displays.
4. Select Global, Environment, or Application.
For a resource template with Global scope, you can change the scope to Environment or Application.
For a resource template with Environment scope, you can change the scope to Global or Application.
For a resource template with Application scope, you can change the scope to Global or Environment.
Based on the selection, options are displayed in the Available window.

5. Select and use the arrow to move your selection to the Selected window.
6. Click Save.
CLI
You can change the scope of a resource template using the command-line utility. You can specify multiple
TargetScope elements for a resource template.
Procedure
1. If changing scope from global to environment, specify environment.
<TargetScope xsi:type="amxdata_base:Scope" type="Environment" envName="ENVIRONMENT_NAME"/>
If changing scope from global to application, specify both environment and application.
<TargetScope xsi:type="amxdata_base:Scope" type="Application" envName="ENVIRONMENT_NAME"
appName="APPLICATION_NAME"/>
If changing scope from environment or application to global, specify global.

<TargetScope xsi:type="amxdata_base:Scope" type="global"/>
The following example shows, the jdbc_rt resource template's scope is changed from environment to
application App1:
<ResourceTemplate
name="jdbc_rt"
description="Environment jdbc"
maxConnections="8888">
<TargetScope xsi:type="amxdata_base:Scope" type="Application"
envName="DevEnvironment" appName="App1"/>
<Direct
dbUrl="jdbc:hsqldb:hsql://localhost:1234/jdbcRtDb"
jdbcDriver="org.hsqldb.jdbcDriver"
isTransactional="false"
loginTimeOut="2"/>
<InlineCredentials username="envJdbc" password="envJdbc"/>
</ResourceTemplate>
</Environment>
2. In the AMXAdminTask element, set the action attribute to changeScope and the objectSelector attribute
to ResourceTemplate|Environment/ResourceTemplate|Environment/Application/ResourceTemplate.
<AMXAdminTask action="rename"
Deleting Resource Templates

You can delete a resource template from the resource list in the GUI. If resource instances created from the
template exist, you cannot delete the template.
Procedure
1. Select Shared Objects > Resource Templates .
2. Select one or more resource templates from the list.
3. Click Delete.
If resource instances created from the template exist an error dialog is displayed. Otherwise, the templates
are deleted from the database.
CLI
You can delete a resource template using the command-line utility.
Procedure
<ResourceTemplate xsi:type="amxdata:JdbcResourceTemplate"
...
</ResourceTemplate>
name="appJDBC1"

...
...
</ResourceTemplate>
<Application xsi:type="amxdata:Application" name="nestedTestApp"
resourceTemplatesScope="Application">
...
...
</ResourceTemplate>
</Application>
</Environment>
2. In the AMXAdminTask element, set the action attribute to delete and the objectSelector attribute
<AMXAdminTask action="delete"
Creating an Obfuscated Password

You create an obfuscated password from the command line. Obfuscation enables you to hide username and
password from other users on the system.
Procedure
Run the command: ant
-f
CONFIG_HOME/admin/enterpriseName/samples/obfuscate_build.xml
-Dpassword=yourpassword
Example
C:\>ant -f C:\amx3data\admin\amxadmin\samples\obfuscate_build.xml -Dpassword=mypw
Buildfile: C:\amx3data\admin\amxadmin\samples\obfuscate_build.xml -Dpassword=mypw
encrypt:
[AMXObfuscateTask] INFO - Initializing JSSE's crypto provider class com.sun.net
.ssl.internal.ssl.Provider in default mode
[AMXObfuscateTask] Obfuscated value:[#!EotHYBCR6OhxS0l7VK0GqnyKeSAp0DVd]
BUILD SUCCESSFUL
Total time: 3 seconds
Configuring Mutual Authentication

You can configure mutual authentication between an HTTP Client resource and an HTTP server.
Procedure
1. Create a trust store keystore following the instructions in Creating a Trust Store Keystore on page 350 with
the public root certificate of the HTTP server. You do not need the private key of the HTTP server.
2. Create a trust store Keystore Provider resource template.
a) Click the Browse button, select the keystore you created in 1 on page 200, and click Open.
b) In the Type drop-down list, select JKS.
c) In the Password field, type the keystore password.
d) Save the Keystore Provider resource template.
3. Create a keystore file that has the certificate containing the private key for the client. You can use the
keytool utility to create such a keystore and import the client-side certificate. You can combine the two
keystores if you choose to maintain a single keystore file that stores the client identity certificate as well
as trusted certificates.
4. Create an identity Keystore Provider resource template.
a) Click the Browse button, select the keystore you created in 3 on page 200, and click Open.
b) In the Type drop-down list, select JKS.
c) In the Password field, type the keystore password.
d) Save the Keystore Provider resource template.
5. Create an SSL Client Provider resource template.
a) Configure the Keystore Provider as Trust Store field with the trust store Keystore Provider resource
template you created.
b) Check the Enable Mutual Authentication checkbox.
c) Configure the Keystore Provider Having Identity field with a Keystore Provider resource template
that you created.
d) Save the SSL Client Provider resource template.
6. Configure the HTTP Client resource template to reference the SSL Client Provider resource template.
7. Install the HTTP Client resource on a node.
The HTTP Client, SSL Client Provider, and Keystore Provider resource instances referenced by the HTTP
Client resource instance are installed on the node.
Configuring Third-Party JDBC Drivers

Before you deploy an application that uses a third-party JDBC server, you must package and install the client
library on each node on which the application will run.
Procedure
1. Configure the third-party JDBC client driver as described in the installation manual for your product.
A feature named "TIBCO enabled JDBC client for vendor" is added to the Administrator server software
repository.
2. Add the feature to the nodes on which the JDBC resource instances are installed.
Adding an Updated JDBC Driver

When a JDBC driver configured using TIBCO Configuration Tool has an update, the updated driver has to
be added to Administrator.
Procedure
1.
2.
3.
4.
5.
6.
Create a feature for the driver. See Component Development for information.
Put a file at a special location in the feature's path with the driver name and version
Add the feature to the node. See Adding a Feature to a Node on page 277.
Delete the resource instances that use this driver and re-create resource templates.
Remove the old driver from all these nodes. See Removing Features from a Node on page 279.
Reinstall all the resource instances created in step 4. While reinstalling the resource instances you will
be prompted to choose the driver feature.
Add the feature for the new driver. See Adding a Feature to a Node on page 277. Reinstall all the
resource instances created in In Software Management, enable the new driver feature on all of the
nodes and then Reinstall all of the RIs.
Results
The updated JDBC driver is now available for use in Administrator.
Configuring Third-Party JMS Drivers

Before you deploy an application that uses a third-party JMS server, the JMS client library must be packaged
and installed on each node on which the application will run.
Procedure
1. Configure the third-party JMS client driver as described in the installation manual for your product.
A feature named "TIBCO enabled JMS client for vendor" is added to the Administrator server software
repository.
2. Add the feature to the nodes on which the JMS resource instances are installed.
Reference Table
Configuring the Read Response Timeout for an LDAP Connection

Users can configure the read response timeout for an LDAP Connection resource by setting the framework
property in node.xml.
Before you begin
Stop the host and node before making the following changes.
Procedure
1. Add the following changes to <user-framework-props> section of
<CONFIG_HOME>\tibcohost\<instance_name>\data_3.2.x\nodes\<node_name>\configuration\node.xml.
<kv-pair value="80000"
name="com.tibco.amf.sr.ldap.readResponseTimeout.java:LDAPConnection"/>
In the above property, replace LDAPConnection with the name of the resource.
2. Restart the host and node.
The new values take effect.
3. Reinstall the LDAP Connection resource.
Keystores
If you set up your environment for SSL, you have to set up a keystore. As part of the process, you configure
a keystore provider.
SSL uses keys and certificates when it establishes the secure connection. A keystore is a database of keys and
certificates. A keystore password is required to access or modify the keystore.
Access to keystores is provided by a Keystore Provider resource instance. Keystores can be stored internally
in Administrator or externally.
Keystore Entries
A keystore has two types of entries:
Private key - holds a cryptographic private key, which is optionally stored in a protected format to prevent
unauthorized access. The private key is accompanied by a certificate chain for the corresponding public
key. Private keys and certificate chains are used by a given entity for self-authentication.
Trusted certificate - contains a single public key certificate. It is called a trusted certificate because the
keystore owner trusts that the public key in the certificate belongs to the identity identified by the subject
(owner) of the certificate. This type of entry can be used to authenticate other parties.
Certificates of trusted entities are typically imported into a keystore as trusted certificates.
Keystore Entries and Aliases
Each entry in a keystore is identified by an alias. In the case of private keys and their associated certificate
chains, these aliases distinguish among the different ways in which the entity may authenticate itself. For
example, the entity may authenticate itself using different certificate authorities, or using different public
key algorithms. An alias might be named after the role in which the keystore owner uses the associated key,
or might identify the purpose of the key.
Keystore Passwords and Private Key Passwords
The private keys in a keystore are encrypted with a keystore password, which should be several words long.
You can also protect each private key with its individual password, which may or may not be the same as
the keystore password.
If a password is lost, the associated keys cannot be recovered.
Creating a Keystore Containing a User Name and Password

You can create a keystore that contains a username and password by editing data and build files and running
an Ant script.
Procedure
1. Go to the CONFIG_HOME/admin/enterpriseName/samples/ directory.
2. Open the keystore_data.xml data file and edit the following attributes of the CredentialEntry element:
Attribute
Description
alias
Alias identifying the keystore entry
protectionParam
Password that protects the keystore entry
username
Username
secret
Password
3. Open the keystore_build.xml build file and edit the following attributes of the AMXKeyStoreTask
element in the addCredential target:
Attribute
Description
adminKeyStorelocation
The name of the file to contain the keystore.
adminKeyStorePassword
The password protecting the keystore.
4. Run ant
-f keystore_build.xml addCredential.
Example
<?xml version="1.0" encoding="UTF-8"?>
xsi:schemaLocation="http://tibco.com/amxadministrator/command/line/types_base
../schemas/amxdata_base.xsd http://tibco.com/amxadministrator/command/line/types
../schemas/amxdata.xsd">
<AMXKeyStore xsi:type="amxdata:AMXKeyStore">
<CredentialEntry alias="myDatabase" protectionParam="databaseKeyAliasPassword"
username="scott" secret="tiger" />
<CredentialEntry alias="myLDAP" protectionParam="ldapKeyAliasPassword"
username="cn=Manager,dc=example,dc=com" secret="password" />
</AMXKeyStore>
<target name="addCredential">
<AMXKeyStoreTask
dataFile="keystore_data.xml"
adminKeyStorelocation = "my_keystore.jceks"
adminKeyStorePassword = "password"
action="add"/>
</target>
>ant -f keystore_build.xml addCredential
Buildfile: C:\amx330data\admin\amxadmin\samples\keystore_build.xml
addCredential:
[AMXKeyStoreTask] INFO - Keystore file
C:\amx330data\admin\amxadmin\samples\my_keystore.jceks does not exist; creat
ing a new keystore file
[AMXKeyStoreTask] Adding entry for alias 'myDatabase'...
[AMXKeyStoreTask] Adding entry for alias 'myLDAP'...
[AMXKeyStoreTask] Saving to keystore file

C:\amx330data\admin\amxadmin\samples\my_keystore.jceks
BUILD SUCCESSFUL
Total time: 12 seconds
References
Hibernate
The Hibernate resource template represents a Hibernate resource. Used by component implementations to
access databases, the hibernate is a framework that supports storing Java objects in a relational database.
Hibernate solves object-relational impedance mismatch by replacing direct database access with high-level,
object-handling functions.
General
Property

SVars?
Description
Data
Source
The name of a JDBC resource that represents the connection

to the database.
Schema
N
Generation
Type
Indicate whether to create or validate the schema in the

database when the session factory is created:
Do Nothing - Indicate that only data is added, changed,
and deleted. If the schema does not already exist, the
application will experience errors when it runs.
Validate - Validate the schema.
Create - Create the schema every time the session factory
is created, deleting old schema and data if it exists.
Create Drop - Same as Create, but drops the schema at
the end of the session.
Update - Update the schema with the changes implied
by the Java objects being mapped to the database.
Default: Do Nothing.
Dialect
The class name of a Hibernate dialect that enables Hibernate

to generate SQL optimized for a particular relational
database. The supported dialects are:
org.hibernate.dialect
DB2390Dialect
DB2400Dialect
DB2Dialect
FirebirdDialect
FrontbaseDialect
HSQLDialect
InformixDialect
IngresDialect
InterbaseDialect
MckoiDialect
MySQLDialect
MySQLInnoDBDialect
MySQLMyISAMDialect
Oracle9Dialect
OracleDialect
Property

SVars?
Description
PointbaseDialect
PostgreSQLDialect
ProgressDialect
SAPDBDialect
SQLServerDialect
SybaseAnywhereDialect
SybaseDialect
com.tibco.amf.sharedresource.runtime.core.
hibernate.dialects
DB2Dialect
HSQLDialect
MySQL5Dialect
Oracle9Dialect
Oracle10GDialect
SQLServerDialect
Default: com.tibco.amf.sharedresource.runtime.core.
hibernate.dialects.HSQLDialect
Advanced
Property

SVars?
Description
Enable
SQL
Logging
Permit data collection in the SQL Server transaction log file.
Default: Unchecked.
Batch Size N
Enables JDBC batch processing.

Default: 5.
Share
Session
Factory
Indicate whether clients share the session factory or whether

a new factory is created for each client.
Default: Checked.
Property

SVars?
Properties N
Description
Hibernate configuration properties:
Format SQL Enabled
Default Schema
Default Catalog
Max Fetch Depth
Default Batch Fetch Size
Use Order Updates
Use Order Inserts
Use Generate Statistics
Use Identifier Rollback
Property

SVars?
Description
Use SQL Comments

Fetch Size
Batch Versioned Data
Batcher Factory Class
Use Scrollable Resultset
Use Stream For Binary
Use Get Generated Keys
Connection Isolation
Use Auto Commit
Connection Release Mode
Cache Provider Class
Use Minimal Puts
Use Query Cache
Use Second Level Cache
Query Cache Factory
Cache Region Prefix
Use Structured Entries
Transaction Factory Class
JTA Transaction JNDI Name
Flush Before Completion
Auto Close Session
Query Factory Class
Query Substitutions
Use Reflection Optimizer
Related Topics
JDBC on page 217
The JDBC resource template represents a JDBC connection that is used by component implementations
to access databases.
HTTP Client
The HTTP Client resource template represents an outgoing HTTP connection. HTTP clients are used by a
reference's SOAP binding.
General
Property

SVars?
Description
Machine
Name
The name of the host that accepts the incoming requests.

For machines that have only one network card, the default
value localhost specifies the current machine. For machines
that have more than one network card, this field specifies
the host name of the card that used to accept incoming
HTTP requests.
Default: localhost.
Property

SVars?
Description
Port
The port number on which to invoke outgoing HTTP

requests.
Default: 80.
Idle
Timeout
(s)
The length of time to wait before closing an inactive

connection. If more than zero, and data transmission has
not finished, a call to close the connection blocks the calling
program until the data is transmitted or until the specified
timeout occurs. If 0, a call to close the connection returns
without blocking the caller and an attempt is made to send
the data. Normally this transfer is successful, but it cannot
be guaranteed. This value should be changed only on the
advise of TIBCO Support.
Default: 0 s.
Socket
Timeout
(ms)
Defines the socket timeout (SO_TIMEOUT), which is the

timeout for waiting for data or a maximum period inactivity
between consecutive data packets. This should be changed
when connecting to very slow external services. A timeout
value of zero is interpreted as an infinite timeout.
Default: 0 ms.
Connection N
Timeout
(ms)
Determines the timeout until a connection is established.

This should be changed when connecting to very slow
external services. A timeout value of zero is interpreted as
an infinite timeout.
The timeout is influenced by operating system
specific behavior at the TCP socket layer. On
Windows 2008, Windows 7 and Windows XP the
timeout value configured in this field is not honored,
and instead it uses an internal timeout of around 21
seconds. Some versions of Linux, such as Ubuntu,
also do not honor this timeout.
Default: 0 ms.
SSL
Property

SVars?
Description
Enable
SSL

display.
Default: Unchecked.
SSL Client N
Provider
Configure N
SSL

Property

SVars?
Description
filled in.
Advanced Configuration
Property

SVars?
Description
Accept
Redirect
Indicates whether the HTTP method should

automatically follow HTTP redirects.
This option is used when client connection receives the

redirect responses from server like Moved Permanently,
Moved Temporarily, Temporary Redirect and so on.
Default: Unchecked.
Reuse
Address
When a TCP connection is closed, the connection might

remain in a timeout state for a period of time after the
connection is closed (typically known as the
TIME_WAIT state or 2MSL wait state).
For applications using a well-known socket address or
port, it might not be possible to bind a socket to the
required SocketAddress if there is a connection in the
timeout state involving the socket address or port.
Default: Unchecked.
Disable
Connection
Pooling
Indicate whether to use the single or multi-threaded

connection manager.
Default: Unchecked.
Suppress TCP N
Delay
Determines whether the Nagle algorithm is used.

The Nagle algorithm tries to conserve bandwidth by
minimizing the number of segments that are sent. When
applications wish to decrease network latency and
increase performance, they can disable Nagle's
algorithm by enabling Suppress TCP Delay.
Data will be sent earlier at the cost of an increase in
bandwidth consumption and the number of packets.
Default: Checked.
Stale Check
Determines whether the stale connection check is to be

used. Disabling the stale connection check can result
in slight performance improvement at the risk of getting
an I/O error when executing a request over a
connection that has been closed at the server side.
Default: Unchecked.
Property

SVars?
Description
Buffer Size
(B)
Socket buffer size in bytes.
A suggestion to the kernel from the application about

the size of the buffers to use for the data transferred
over the socket.
Default: -1. Allow the runtime to determine the buffer
size.
Connection N
Retrieval
Timeout (ms)
Local Socket
Address
Maximum
Total
Connections
The timeout, in milliseconds, until a connection is

established.
Default: 0.
Local host address to be used for creating the socket.

Default: None.
Controls the maximum number of simultaneous active

connection that this resource instance allows. The value
should be increased for application that creates a lot of
long-lived connections.
Default: 20.
Maximum
Total
Connections
per Host
Controls the maximum number of simultaneous active

connection to a same host that this resource instance
allows. This number cannot be greater than Maximum
Total Connections.
Default: 2.
HTTP Proxy
Property
Required? Editable? Accepts Description

SVars?
Configure Proxy N
Check the check box to configure the HTTP Proxy options

described in this table.
Default: Unchecked
Proxy Type
Type of proxy server. You can select HTTP or SOCKS V4

/ V5.
Default: HTTP
Proxy Host
Address of the proxy host.

Default: localhost
Proxy Port
Port of the proxy host.

Default: 8080
Property

SVars?
Configure
BASIC
authentication
Check the box to configure access to proxy server with a

username and password.
Default: Unchecked
When you check this check box, the fields for specifying
the username and password are enabled.
Default username: username
Default password: None
HTTP Connector
The HTTP Connector resource template represents an incoming HTTP connection. HTTP connectors are used
by a service's SOAP binding and also by the WebApp component.
General
Property

SVars?
Description
Machine
Name
The name of the machine that accepts the incoming requests.

For machines that have only one network card, the default
value, localhost, specifies the current machine. For machines
that have more than one network card, this field specifies
the host name of the card that will be used to accept
incoming HTTP requests.
If there is more than one network card on the machine, and

you specify 0.0.0.0 in this field, all network cards on the
machine will listen for incoming HTTP requests on the
specified port. Only one HTTP connector can be started on
each port. Therefore make certain that all HTTP connection
resources that use the same machine name specify different
port numbers.
Default: 0.0.0.0. Note that machine name signifies the
machine on which the node is running, not the machine on
which the Administrator server is running.
Port
The port number on which to listen for incoming requests.

Once you install an HTTP connector resource
instance the port is bound to the connector even if
there are no applications using the connector. You
should uninstall unused instances to conserve ports.
Default: 9895.
Accept
Queue
Size
The number of incoming requests that can be queued before

additional requests are rejected.
Default: 0, which indicates that the JVM should use the
default value for accept queue size. For Oracle JVM, the
default value is 50.
Property

SVars?
Description
Acceptor
Threads
The number of threads dedicated to processing incoming

connection requests. Ideally, you want to have enough
acceptor threads so that there is always one available when
a user needs one, but few enough so that they do not
provide too much of a burden on the system. The threads
are started when the HTTP Connector resource instance is
installed on a node.
An acceptor thread accepts the connection, then queues the

request to the worker thread pool and returns to process
the next connection request.
In general, the number of acceptor threads should be kept
low. A good rule of thumb is the number of acceptor threads
should not be greater than twice the number of processors.
Default: 1 and grey.
SSL
GUI
Property

SVars?
Description
Enable
SSL
Indicate that SSL connections should be enabled. When

checked, the SSL Certificate Source field is enabled.
Default: Unchecked.
SSL
N
Certificate
Source
The source of the SSL certificate:

TIBCO Credential Server
SSL Server Provider - when selected the SSL Provider
field is enabled.
SSL Server N
Provider
The name of an SSL Server Provider resource instance.
Advanced
GUI Property Required? Editable? Accepts
SVars?
Description
Header Buffer N
Size (B)
The size of the buffer available for the HTTP header.
Request
N
Buffer Size (B)
Response
N
Buffer Size (B)
Default: 4096.
Y
The size of the buffer available for the HTTP request.

Default: 8192.
The size of the buffer available for the HTTP response.

Default: 24576.
GUI Property Required? Editable? Accepts

SVars?
Description
Low
Resources
Max Idle
Time (ms)
The period that a connection is allowed to be idle when

there are more than (the number of) Low Resources
Connections.
Max Idle
Time (ms)
Default: -1. There is no timeout.

Y
The maximum idle time for a connection. The maximum

idle time is applied when:
Waiting for a new request to be received on a
connection
Reading the headers and the content of a request
Writing the headers and the content of a response
Default: 200000 ms.
Linger Time
(ms)
The time to delay before a socket resets. Before a socket

terminates a connection, it can linger, allowing unsent
data to be transmitted or it can reset, which means that
all unsent data will be lost.
Default: -1. There is no delay before resetting.
Use
N
Non-Blocking
IO Sockets
Indicate whether to use non-blocking or blocking IO. In

non-blocking IO, the thread will read whatever data is
available and return to perform other tasks. In blocking
IO, the thread will block on a read operation until all the
data is available.
Default: Checked.
Restriction: Due to a [bug] in the Oracle JVM version
1.6, non-blocking IO does not work when the Machine
Name field contains an IPv6 address or when the machine
name resolves only to an IPv6 address. If the machine
name resolves to a IPv4 and an IPv6 address, the IPv4
address will be used and non-blocking IO will work
correctly. Because of this limitation, you should either
use blocking IO or use IPv4 addresses for connectors
with non-blocking IO.
Use Direct
Buffers
Indicate whether to use direct buffers with non-blocking

IO. Some JVMs have memory management issues with
direct buffers.
Default: Checked.
Worker
Thread Pool
The name of a Thread Pool resource instance containing

the threads used to handle the HTTP request.
When unset, a thread pool with Max Pool Size set
to 250 is created.
Default: None.
By default all HTTP methods are enabled for HTTP connectors. To disable HTTP OPTIONS and PUT methods
for all connectors on a node or a specific connector, configure the following node JVM properties:
amf.node.disableHTTPOptions
amf.node.disableHTTPOptions.connectorName
amf.node.disableHTTPPut
amf.node.disableHTTPPut.connectorName
JDBC
The JDBC resource template represents a JDBC connection that is used by component implementations to
access databases.
General
Property
Required? Editable? Accept

SVars?
Connection Y
Type
Description
The type of the JDBC connection:
Direct The connection to the database is through a
vendor-specific driver. When selected, the Database
Driver and Database URL fields display.
XA The connection to the database is through a
vendor-specific data source. When selected, the Data
Source field displays. A component implementation that
uses a JDBC connection of connection type XA typically
executes within a global transaction and consequently
may not explicitly commit transactions. To ensure that
such implementations always behave correctly, the
TIBCO ActiveMatrix platform detects when such a
resource is used outside of a global transaction and
enables the JDBC autocommit feature, so that all
database access by the component is committed. Default
Login Timeout: 60000 ms (60s)
Default: Direct
Table 26: Direct

Property
Required? Editable?
Accepts Description
SVars?
Database
Driver
The name of the JDBC driver class. You can select from a
drop-down list of supported drivers or type the name of a custom
driver:
org.hsqldb.jdbcDriver
com.microsoft.sqlserver.jdbc.SQLServerDriver
com.mysql.jdbc.Driver
oracle.jdbc.OracleDriver
com.ibm.db2.jcc.DB2Driver
org.postgresql.Driver
Additional drivers available when using TIBCO Business Studio:
com.ibm.as400.access.AS400JDBCDriver
com.informix.jdbc.lfxDriver
ca.edbc.jdbc.EdbcDriver
When you select a driver, the Database URL field is populated
with a template for the URL of the driver.
Property
Required? Editable?
Accepts Description
SVars?
Default: org.hsqldb.jdbcDriver.
Database
URL
The URL to use to connect to the database. A template of the

URL is supplied for the driver you select in the Database Driver
field or you can type the name of a URL:
jdbc:hsqldb:hsql://localhost:<port#>/<db_instancename>
jdbc:sqlserver://<server
Name>:<portNumber>;databaseName=<dbname>;
jdbc:mysql://<localhost>:<port>/<DBName>
jdbc:oracle:thin:@<machine_name>:<port>:<instance_name>
jdbc:db2://<host>:<port default is 50000>/<database name>
jdbc:postgresql://<servername>:<portnumber>/<dbname>
Available when using TIBCO Business Studio:
jdbc:as400://server<server_ip>;libraries=<lib>
jdbc:informix-sqli://<host>:<port
>/<database>:informixserver=<server>
jdbc:edbc://<host>:<port>/<database>
You must supply the portions of the URL shown between angle
brackets and remove the angle brackets.
Default: jdbc:hsqldb:hsql://localhost:<port#>/<db_instance
name>.
Table 27: XA
Property

SVars?
Description
Data
Source
The fully-qualified name of the javax.sql.XADataSource

implementation class. The supported classes are:
com.ibm.db2.jcc.DB2XADataSource
com.mysql.jdbc.jdbc2.optional.MysqlXADataSource
oracle.jdbc.xa.client.OracleXADataSource
com.microsoft.sqlserver.jdbc.SQLServerXADataSource
org.postgresql.xa.PGXADataSource
Default: oracle.jdbc.xa.client.OracleXADataSource
Property

SVars?
Maximum N
Connections
Description
The maximum number of database connections to allocate.
The minimum value that can be specified is 0.
Default: 10.
Login
Timeout
(ms)
Time to wait for a successful database connection. If the

JDBC driver does not support connection timeouts, the
value of this field is ignored. Only JDBC drivers that support
Property

SVars?
Description
connection timeouts use this configuration field. Most JDBC
drivers support connection timeouts.
Default: 60000 (60 seconds).
Supports N
Transactions
Indicate whether the application demarcates transaction

boundaries. If unchecked, the application does not
demarcate transaction boundaries and all SQL statements
are autocommitted.
If checked, the application demarcates transaction
boundaries.
Default: Unchecked.
Login Credentials
Property

SVars?
Login
Y
Credentials
Description
Default: Identity Provider
Identity
Provider
Name of the Identity Provider resource used to authenticate

the user.
Username N
Username used to authenticate connections to the server.
Password N
User's password used to authenticate connections to the

server.
Advanced
GUI

SVars?
Host Type Properties
Properties to configure the connection between

the JDBC resource and a specific type of host.
GUI

SVars?
commitBeforeAutocommit Y
Indicates whether the driver requires a commit to

be performed before enabling auto-commit on a
connection. This should be (and is, by default) set
to false for compliant drivers to avoid extraneous
commits to the database.
Default: false.
exceptionSorterClass
The class used by the resource adapter to judge if

an exception is fatal to the connection. That is,
whether the connection pool should discard the
connection from the pool, since it is no longer
reusable. As the name implies, the default
SQLState08ExceptionsAreFatalSorter treats SQL
State 8 exceptions as fatal (connection errors). All
other exceptions do not result in any connection
pool action (but of course are passed up to the
application for it to react as it wishes). The class
must implement
org.tranql.connector.ExceptionSorter.
Default:
com.tibco.amf.sharedresource.runtime.tibcohost.jdbc.SQLState08ExceptionsAreFatalSorter.
POOL_MIN_SIZE
Minimum number of connections in the pool.

Default: 5.
POOL_BLOCKING_TIMEOUT Y
(ms)
The length of time a requestor will wait for a

connection when the pool is at maximum.
Default: 60000 ms.
POOL_IDLE_TIMEOUT Y
(min)
The length of time after which idle connections

are closed.
Default: 5 min.
preparedStatementCacheSize Y
The size of the cache containing prepared

statements. The size should correspond to the
number of JDBC statements you expect your
application to reuse.
Default: 0; that is, the cache is disabled.
Table 28: Direct

Property

SVars?
Connection N
Properties
Description
Properties to configure connections to a database driver.
The properties are vendor specific.
Table 29: XA
Property

SVars?
Connection N
Properties
Description
Properties to configure connections to a data source. The
properties are vendor specific.
JMS Resource Templates

JMS resource templates enable applications to access objects maintained in JMS servers.
The JMS resource templates are:
JNDI Connection Configuration - Provides a JNDI connection to look up a JMS server.
JMS Connection Factory - Used to create an outbound connection to a JMS server.
JMS Destination-Used for Request/Reply messages. Specifies destination objects, which represent virtual
channels (topics and queues) in JMS. When a message is sent, it is addressed to a destination, not to a
specific application. Any application that subscribes or registers an interest in that destination can receive
that message. Depending on the JMS messaging model used, the destination is called a topic or a queue.
In the publish-subscribe model, a message is published for many subscribers to a topic (destination). In
the point-to-point model, one message is sent to one potential receiver using a queue (destination).
JMS Destination Configuration - Specifies what topic or queue to listen to for request messages.
JMS Resource Template Relationships
The JMS resource templates are used in different combinations to accomplish the tasks involved in setting
up JMS enterprise messaging:
Identifying the JMS server to connect to
Establishing request communication
Establishing reply communication
Identifying the JMS server is accomplished through the JNDI Connection resource template. All the other
JMS resource templates contain a link for the JNDI Connection that assists them in determining which JMS
server to look up. Additionally, before the connection to the JNDI server is made, the JNDI might require
authentication. Authentication can take the form of a username and password, or supplying credential
information stored in a keystore using an identity provider. If the JNDI server is SSL-enabled, you provide
the required SSL configuration.
To establish request or reply communication, you need these resource templates: JMS Connection Factory,
JMS Destination, and JNDI Connection.
Only JMS Connection Factory resource template is needed, if direct destinations are used.
JMS Connection Factory

A JMS Connection Factory creates an outbound connection to a JMS server.
Property
Editable? Required? Accepts

SVars?
Connection Y
Factory
JNDI
Name
Description
JNDI name of the JMS Connection Factory that points to a
particular queue or topic.
Property

SVars?
JNDI
Y
Connection
Configuration
Description
The name of a JNDI Connection Configuration on page 225
resource.
Security
Property

SVars?
Enable
N
Authentication
Description
(Administrator UI only) Enable server
authentication. When checked, the authentication
properties: Login Credentials, Username, and
Password are displayed. The Enable Authentication
property is only available in the Administrator UI.
Default: Unchecked.
Login
Credentials
Indicate how the credentials required to

authenticate to a server are provided:
None
Username + Password - Provide inline
username and password credentials. When
selected, the Username and Password fields are
activated.
Identity Provider - Provide username and
password credentials encapsulated in an
identity provider resource. When selected, the
Identity Provider field is activated.
Default: None
Username
Username used to authenticate connections to the

server.
Password
User's password used to authenticate connections

to the server.
(Administrator only) For superusers, passwords
display encrypted. For non-superusers, the
password doesn't display even if it was set when
it was created. If you have permission to edit the
password, you can specify a new value and save.
If you edit other fields, the old value for the
password field is retained. If you want to set an
empty value as password, click the link Set Blank
Password.
Identity
Provider
Name of the Identity Provider resource used to

authenticate the user.
Enable SSL
Enable SSL connections. When checked, the SSL

properties display.
Default: Unchecked.
Property

SVars?
Description
SSL Client
Provider
The name of an SSL Client Provider on page 249

resource.
JMS Connection Factory Configuration

A JMS Connection Factory Configuration resource template creates a request connection to a JMS server to
enable request receipt of JMS messages.
Property

SVars?
Description
Connection Y
Factory
JNDI
Name
A JNDI name of a Connection Factory that points to a

particular queue or topic.
JNDI
Y
Connection
Configuration

resource.
Security
Property

SVars?
Enable
N
Authentication
Description
Default: Unchecked.
Login
Credentials

None
activated.
Default: None
Username

server.
Password

to the server.
Property

SVars?
Description
Password.
Identity
Provider

Enable SSL

properties display.
Default: Unchecked.
SSL Client
Provider

resource.
SSL Configuration
SSL communication works only for the EMS and WebSphere MQ JMS providers. The Connection
Factory Configuration used in the Connection Factory JNDI Name should be SSL enabled.
Property

SVars?
Description
Enable
SSL

display.
Default: Unchecked.
SSL Client N
Provider
Configure N
SSL

filled in.
JMS Destination
A JMS Destination resource template specifies destination objects, which represent virtual channels (topics
and queues) in JMS. It is used for Request/Reply messages.
When a message is sent, it is addressed to a destination, not to a specific application. Any application that
subscribes or registers an interest in that destination can receive that message. Depending on the JMS messaging
model used, the destination is called a topic or a queue. In the publish-subscribe model, a message is published
for many subscribers to a topic (destination). In the point-to-point model, one message is sent to one potential
receiver using a queue (destination).
Property

SVars?
Description
Destination Y
JNDI
Name
A JNDI name of a JMS destination that points to a particular

queue or topic.
JNDI
Y
Connection
Configuration
The name of a JNDI Connection Configuration.
JMS Destination Configuration

A JMS Destination Configuration resource template specifies what topic or queue to listen to for request
messages.
Property

SVars?
Description
Destination Y
JNDI
Name
A JNDI name of a JMS destination that points to a particular

queue or topic.
JNDI
Y
Connection
Configuration

resource.
JNDI Connection Configuration

A JNDI Connection Configuration resource template provides a JNDI connection to look up a JMS server.
General
Property

SVars?
Description
JNDI
Provider
The provider to use for JNDI lookup:

TIBCO EMS
Progress SonicMQ
IBM WebSphere MQ
Custom - Used for custom JNDI providers.
The Initial Context Factory field is populated based on the

JNDI provider selected. SSL lookup is only available for the
TIBCO EMS provider.
Default: TIBCO EMS.
Initial
Context
Factory
Initial context factory to be used for the JNDI lookup. The

value for Initial Context Factory is set based on the JNDI
provider selected:
TIBCO EMS com.tibco.tibjms.naming.TibjmsInitialContextFactory
value is populated
Progress SonicMQ - the
com.sonicsw.jndi.mfcontext.MFContextFactory
value is populated
Property

SVars?
Description
IBM WebSphere MQ com.sun.jndi.ldap.LdapCtxFactory for the JNDI
lookup in LDAP. Pair this value with the Naming
Provider URL: ldap://<ldap_url>.
com.sun.jndi.fscontext.RefFSContextFactory
for the JNDI lookup in a file system. Pair this value
with the Naming Provider URL: file:<url_
of_bindings_file>.
Custom provider - Specify the custom initial context
factory value.
Default:
com.tibco.tibjms.naming.TibjmsInitialContextFactory
Provider
URL
Provider URL of the JNDI server. The value for Naming

Provider URL is set based on the JNDI provider selected:
TIBCO EMS - tibjmsnaming://<host>:<port>
Progress SonicMQ - tcp://<host>:<port>
IBM WebSphere MQ ldap://<ldap_url> for the JNDI lookup in LDAP.
Example:
ldap://mymachine.tibco.com:2076/dc=tibco,dc=com.
Pair this value with the Initial Context Factory:
com.sun.jndi.ldap.LdapCtxFactory.
file:<url_ of_bindings_file> for the JNDI lookup in a file
system. Example: file:/D:/Program
Files/IBM/fileBinding. Pair this value with the Initial
Context Factory:
com.sun.jndi.fscontext.RefFSContextFactory.
Custom - specify the custom provider URL.
Default: tibjmsnaming://<host>:<port>.
The Naming Provider URL is validated using
recommendation of the "Uniform Resource Identifiers (URI):
Generic Syntax" [RFC2396] standard for the TIBCO EMS,
Progress SonicMQ and IBM WebSphere MQ JNDI provider.
Security
Property

SVars?
Enable
N
Authentication
Description
Default: Unchecked.
Property

SVars?
Description
Login
Credentials

None
activated.
Default: None
Username

server.
Password

to the server.
Password.
Identity
Provider

Enable SSL

properties display.
Default: Unchecked.
SSL Client
Provider

resource.
Advanced
A list of properties used for JNDI lookup.
Table 30: Application Properties
Property
Description
Name
Type
Type of the property. One of: string, boolean, byte, short, char, int, long, float, or double.
Value
Property value.
Default: Depends on value of 'Type'.
You can set a property value to a literal or a substitution variable.
LDAP Connection
An LDAP Connection resource template represents a connection to an LDAP server. Used by component
implementations to look up names in an LDAP directory server.
General
Property

SVars?
Connection Y
Factory
Description
The factory object that provides the starting point for
resolution of names within the LDAP server.
Default: com.sun.jndi.ldap.LdapCtxFactory.
Provider
URL
The URL that provides the host and port number on which
the LDAP server is listening for connections. It can also
include a Base DN, the DN of an entry in the directory.
The Base DN:
Identifies the LDAP entry that is the starting point of all
searches
Limits the searches to a subtree of the LDAP Server's
directory
If the Base DN is not specified, all searches begin at the root
DN.
Any unsafe characters in the URL must be represented by
a special sequence of characters called escaping. For
example, a space must be represented as %20. Thus, the DN
ou=Product Development must be encoded as
ou=Product%20Development.
Default: ldap://localhost:389.
Connection N
Timeout
(ms)
The time to wait for a response from the LDAP directory

server.
Default: 0.
Login Credentials
Property

SVars?
Login
Y
Credentials
Description
Property

SVars?
Description
Identity
Provider

the user.
Username N
Password N

server.
Advanced
Property

SVars?
Description
Pool Size
The preferred number of connections per connection identity

that should be maintained concurrently.
Default: 10.
Pool
N
Maximum
The maximum number of connections per connection

identity that can be maintained concurrently.
Default: 15.
Pool Initial N
The number of connections per connection identity to create

when initially creating a connection for the identity.
Default: 5.
Pool
Timeout
(ms)
Follow
Referrals
The length of time that an idle connection may remain in

the pool without being closed and removed from the pool.
Default: 300000.
Indicate whether an LDAP server should return a reference

(a referral) to another LDAP server which may contain
further information instead of returning a result.
Default: Unchecked.
SSL
Property Required? Editable? Accepts
SVars?
Description
Enable
SSL

display.
Default: Unchecked.
Property Required? Editable? Accepts

SVars?
Description
SSL Client N
Provider
SMTP
An SMTP resource template represents a connection to an SMTP server. Used by component implementations
to send and receive messages to and from an SMTP mail server.
General
Property

SVars?
Description
Machine
Name
The name of the host that accepts incoming requests.
Port
Default: localhost.
Y
The port number on which to listen for SMTP requests.

Default: 25.
Timeout
(ms)
The length of time to wait for a response from the server.

The timeout must be greater than 0. A timeout of zero is
interpreted as an infinite timeout.
Default: 0.
Login Credentials
Property

SVars?
Login
Y
Credentials
Description
Identity
Provider

the user.
Username N
Password N

server.
Property

SVars?
Description
SSL
Property

SVars?
Description
Enable
SSL

display.
Default: Unchecked.
SSL Client N
Provider
Teneo
A Teneo resource is used by component implementations to access databases. Teneo is a model-relational
mapping and runtime database persistence solution for the Eclipse Modeling Framework (EMF). Teneo
integrates EMF with Hibernate.
General
Property

SVars?
Description
Data
Source
The name of a JDBC resource that represents the connection

to the database.
Schema
N
Generation
Type
Indicate whether to create or validate the schema in the

database when the session factory is created:
Do Nothing - Indicate that only data is added, changed,
and deleted. If the schema does not already exist, the
application will experience errors when it runs.
Validate - Validate the schema.
Create - Create the schema every time the session factory
is created, deleting old schema and data if it exists.
Create Drop - Same as Create, but drops the schema at
the end of the session.
Update - Update the schema with the changes implied
by the Java objects being mapped to the database.
Default: Do Nothing.
Dialect
The class name of a Hibernate dialect that enables Hibernate

to generate SQL optimized for a particular relational
database. The supported dialects are:
org.hibernate.dialect
DB2390Dialect
DB2400Dialect
DB2Dialect
Property

SVars?
Description
FirebirdDialect
FrontbaseDialect
HSQLDialect
InformixDialect
IngresDialect
InterbaseDialect
MckoiDialect
MySQLDialect
MySQLInnoDBDialect
MySQLMyISAMDialect
Oracle9Dialect
OracleDialect
PointbaseDialect
PostgreSQLDialect
ProgressDialect
SAPDBDialect
SQLServerDialect
SybaseAnywhereDialect
SybaseDialect
com.tibco.amf.sharedresource.runtime.core.
hibernate.dialects
DB2Dialect
HSQLDialect
MySQL5Dialect
Oracle9Dialect
Oracle10GDialect
SQLServerDialect
Default: com.tibco.amf.sharedresource.runtime.core.
hibernate.dialects.HSQLDialect
Property

SVars?
Inheritance N
Mapping
Type
Description
Indicate how class hierarchies are mapped to tables.
SINGLE-TABLE The classes of one class hierarchy are
all mapped to one table.
JOINED Each subclass has its own table. To retrieve an
object from the database, the superclass and subclass
tables are joined. This also applies to subclasses of
subclasses.
Default: Single Table.
Advanced
Property

SVars?
Description
Enable
SQL
Logging
Permit data collection in the SQL Server transaction log file.
Default: Unchecked.
Batch Size N
Enables JDBC batch processing.

Default: 5.
Share
Session
Factory
Indicate whether clients share the session factory or whether

a new factory is created for each client.
Default: Checked.
Property

SVars?
Properties N
Description
Hibernate configuration properties:
Format SQL Enabled
Default Schema
Default Catalog
Max Fetch Depth
Default Batch Fetch Size
Use Order Updates
Use Order Inserts
Use Generate Statistics
Use Identifier Rollback
Use SQL Comments
Fetch Size
Batch Versioned Data
Batcher Factory Class
Use Scrollable Resultset
Use Stream For Binary
Use Get Generated Keys
Connection Isolation
Use Auto Commit
Connection Release Mode
Cache Provider Class
Use Minimal Puts
Use Query Cache
Use Second Level Cache
Query Cache Factory
Cache Region Prefix
Use Structured Entries
Transaction Factory Class
JTA Transaction JNDI Name
Flush Before Completion
Auto Close Session
Query Factory Class
Property

SVars?
Description
Query Substitutions
Use Reflection Optimizer
Thread Pool
A thread pool is a queue of threads available to run a queue of tasks. Thread pools are used to improve
performance when executing large numbers of asynchronous tasks by reducing per-task invocation overhead
and provide a means of bounding and managing the resources consumed when executing a collection of
tasks.
A thread pool is created with zero threads.
General
Property

SVars?
Core Pool N
Size
Description
When a new task is submitted and fewer than Core Pool
Size threads are running, a new thread is created to handle
the request, even if other threads are idle. If there are greater
than Core Pool Size but fewer than Max Pool Size threads
running, a new thread is created only if no threads are idle.
Must be greater than or equal to zero.
Default: 2. Two threads are used to service one request: one
for receiving the request and one for receiving the response.
Max Pool
Size
The maximum number of threads in the pool. Must be

greater than zero and greater than or equal to Core Pool
Size.
Default: 10.
Keep
Alive
Time
The amount of time an idle thread remains in the pool before

being reclaimed if the number of threads in pool is more
than Core Pool Size.
Default: 30 Milliseconds.
Autostart
Core
Threads
Indicate that Core Pool Size threads should be created and

started when the thread pool is created. Normally core
threads are created and started only when new tasks arrive.
Default: false.
Thread
Pool
Name
Prefix
Priority
A string prepended to the name of each thread.

Default: <pool-poolnumber-thread-threadnumber>
The default priority of the threads in the pool.

Default: 5.
Rejection
Policy
The policy applied when no thread is available to run a task:

Abort - The task is aborted and an exception is thrown.
Property

SVars?
Description
Blocking - The task is blocked until a thread from thread
pool picks up this task.
Caller Runs - The task is run in the calling thread.
Default: Blocking.
Daemon
Indicate whether the threads can be started as daemon or

user.
Default: Unchecked.
Security Resource Templates

Security features are provided by a set of resource templates that provide access to various types of security
providers: identity, trust, mutual identity, keystore, SSL client and server, and authentication.
Identity, keystore, trust, and mutual identity providers enable clients and servers to assert and establish
identity. SSL resource templates are used to enable SSL configurations for use in resource templates that
define connections to various types of servers. For example, the SSL configuration for an HTTP Client, is set
by an SSL Client Provider. The SSL Client Provider in turn references a Keystore Provider to establish the
identity of a trusted server. Authentication providers enable connections to authentication services. Some
resource templates types, for example authentication providers, are only available in Administrator.
Type
Resource Template
Identity
Identity Provider - The Identity Provider resource template provides access to a

username and password credential stored in a keystore.
Kerberos Identity Provider - The Kerberos Identity Provider resource template
provides access to an identity stored in a Kerberos authentication server.
Keystore Provider - The Keystore Provider resource template provides access to a
keystore.
Mutual Identity Provider - A Mutual Identity Provider resource template is an
identity provider that supplies an identity and serves as a trust store.
Trust Provider - Maintains the identity of a trusted resource.
SSL
SSL Client Provider - Maintains the credentials required by an SSL client.

SSL Server Provider - An SSL Server Provider resource template maintains the
credentials required by an SSL server.
Authentication
Kerberos Authentication - The Kerberos Authentication resource template represents

a Kerberos authentication service.
LDAP Authentication - The LDAP Authentication resource template represents
an LDAP server providing authentication services.
SiteMinder Authentication - The SiteMinder Authentication resource template
represents a SiteMinder authentication service.
WS-Security ASP - Enables a connection to Web Services Security authentication
services.
Identity Provider
The Identity Provider resource template provides access to a username and password credential stored in a
keystore.
General
Property

SVars?
Description
Keystore
Y
Provider to
Supply Identity
Name of a Keystore Provider resource that maintains

a keystore used to assert an identity.
Enable Access to N
Credential Store
Containing
Identity
(optional)
Enables access to an identity keystore. To establish SSL

connections, certain third-party systems such as
MySQL require access to a keystore file location. In
such situations Administrator provides a copy of
credentials in a keystore, which are then written to
disk and used by the third party as the SSL credential
store. To prevent Administrator from providing
credentials, uncheck the checkbox.
Default: Unchecked.
Key Alias to
Access Identity
Name of the alias used to access the identity.
Key Alias
Password
Password for the alias.

display encrypted. For non-superusers, the password
doesn't display even if it was set when it was created.
If you have permission to edit the password, you can
specify a new value and save. If you edit other fields,
the old value for the password field is retained. If you
want to set an empty value as password, click the link
Set Blank Password.
Kerberos Authentication
The Kerberos Authentication resource template represents a Kerberos authentication service.
SAML Options
SAML assertions are accessed from a security context and can be propagated between components to achieve
single sign-on
Property

SVars?
Validity of SAML
Tokens (s)
Signer of SAML
Tokens
The duration of the validity of the SAML tokens.

Default: 600 s.
The name of an Identity Provider on page 236 resource

that identifies the signer of the SAML tokens.
Configuration File
Property

SVars?
Kerberos Realm
The Kerberos realm.

Default: None.
Key Distribution
Center
Kerberos
Configuration File
Option
The Kerberos key distribution center.

Default: None.
The method for specifying the location of the Kerberos

configuration file. One of:
System Specific Default Location - Use the
system-specific default location.
Custom Configuration File - Use a custom
configuration file. Enables the Custom
Configuration File Name field.
Generated - Use a generated configuration file.
Enables the Generated Configuration File field
and all other fields whose values are used in
generating the configuration file.
Default: System Specific Default Location.
Custom
Configuration File
Name
Generated
Configuration File
Name
Default DNS
Domain
The fully-qualified path to the configuration file.

Default: None.
The fully-qualified path to which the generated

configuration file is saved.
Default: None.
The default DNS domain to which the Kerberos realm

belongs.
Default: None.
Addressless Tickets Y
Indicate that initial Kerberos ticket will be addressless.

Default: Checked.
Proxiable Tickets
Indicate that initial Kerberos ticket will be proxiable.

Default: Checked.
Forwardable Tickets Y
Indicate that initial Kerberos ticket will be

forwardable.
Default: Unchecked.
Clock Skew(s)
The maximum allowable amount of clock skew before

a Kerberos message is assumed to be invalid.
Default: 600.
Ticket Lifetime(h)
The lifetime for initial tickets.

Default: 24.
Property

SVars?
Renew Lifetime(h)
The renewable lifetime for initial tickets.

Default: None.
Client TGS
Encryption
The encryption types to use for the session key in the

ticket granting ticket.
Default: aes128-cts-hmac-sha1-96, aes128-cts,
des3-cbc-sha1.
Client Ticket
Encryption
The encryption types to use for the session key in the

ticket granting ticket.
des3-cbc-sha1.
Service Ticket
Encryption
The encryption types to use for the session key in

service tickets.
des3-cbc-sha1.
Lookup DNS for

KDC
Indicate whether DNS SRV records should be used

to locate the KDCs and other servers for a realm, if
the KDC is not the default realm.
Default: Checked.
Lookup DNS for

Realm
Indicate whether DNS TXT records should be used

to determine the Kerberos realm of a host if it is not
the default realm.
Default: Unchecked.
Advanced
Property

SVars?
Login Module Class Y
The class that implements authentication for users

using Kerberos authentication.
Default:
com.sun.security.auth.module.Krb5LoginModule
Refresh KRB5
Configuration
Indicate that you want the configuration to be

refreshed before the login authentication method is
invoked.
Default: Unchecked.
Renew TGT
Indicate that you want to renew ticket granting tickets.

If checked, the Use Ticket Cache checkbox is checked
and the Ticket Cache Name field is enabled.
Default: Unchecked.
Property

SVars?
Use Ticket Cache
Indicate that you want the ticket granting tickets to

be obtained from the ticket cache.
Default: Unchecked.
Ticket Cache Name Y
Use Key Tab
When Use Y
Ticket
Cache is
checked.
The name of the ticket cache that contains ticket

granting tickets.
Indicate that the principal's key should be obtained

from the keytab. When checked, the Keytab Filename
field is enabled. If Keytab Filename field is not set,
the keytab is obtained from the Kerberos configuration
file.
Default: None.
Default: Unchecked.
Key Tab Filename
Store Key
When Use Y
Key Tab is
checked
The file name of the keytab.
Indicate that the principal's key should be stored in

the subject's private credentials.
Default: None.
Default: Checked.
Principal Name
The name of the principal.

Default: None.
Kerberos Identity Provider

The Kerberos Identity Provider resource template provides access to an identity stored in a Kerberos
authentication server.
Property

SVars?
Kerberos
Authentication
Provider
Kerberos Service
Principal Name
Kerberos Client
Principal Name
The name of a Kerberos Authentication Provider

containing the identity.
Default: None.
The name of a Kerberos service principal.

Default: None.
The name of a Kerberos client principal. Specify this

information to gain access to the private key of the
client principal.
Default: None.
Kerberos Client
Y
Principal Password
The password of the Kerberos client principal. In

addition to the Kerberos Client Principal Name,
specify this information to gain access to the private
key of the client principal.
Property

SVars?
Default: None.
Kerberos Identity Provider must be set up before configuring WSS Authentication.
Keystore Provider
The Keystore Provider resource template provides access to a keystore.
General
Property

SVars?
Keystore Served
From
Location of the keystore:

Store the keystore in Administrator and serve it
from here
The keystore is hosted externally at URL
Administrator Upload Keystore

From
Path to the keystore to be uploaded into

Administrator. After the keystore is uploaded, a link
displays from which the keystore can be downloaded.
URL
Location of the external keystore.
Password
Password for the keystore.

Set Blank Password.
Provider
Name of the keystore provider:

SunJCE (JCEKS format)
SUN (JKS format)
IBMJCE (IBM JREs)
SunJSSE (PKCS12 format)
Default: Empty. The first matching provider
supporting the format will be chosen.
Type
Type of the keystore: JCEKS, JKS, PKCS12.

Default: JKS.
Refresh Interval (ms) Y
Refresh interval, greater than 0. If the keystore

provider is accessed after the refresh interval has
expired:
1. The keystore provider is refreshed from its backing
keystore.
Property

SVars?
2. The refresh timer is reset to zero.
3. Operations on the keystore provider are performed
on the refreshed copy.
Default: 3600000.
LDAP Authentication
The LDAP Authentication resource template represents an LDAP server providing authentication services.
LDAP authentication is done in one of the following ways:
Bind mode The bind mode authenticates (binds) each user's Disitinguished Name (DN) and password
to the LDAP server. In this case, you can use the DN Template field to so that users do not have to provide
their whole DN. For example, a DN Template of uid={0},OU=Department,DC=company,DC=com allows
users to type in only their uid and the RI will use the template to create the DN.
Search mode In the search mode, a connection binds as the administrative user. It then searches for the
given users and authenticates their found DNs and passwords with the LDAP server. In this case, you
need to provide the credentials of such an administrative user by checking Log in as Administrator.
General
Property

SVars?
Server URLs
A space-separated list of URLs for an LDAP server.

To achieve fault tolerance, you can specify URLs. For
example, ldap://server1.example.com:686
ldap://server2.example.com:1686.
Default: ldap://localhost:389.
User Attribute with N

User Name
The name of the LDAP attribute from which the user

display name can be obtained. Always specify an
Attribute Name even though this field is labeled
optional.
You must use an attribute that is part of the LDAP
schema. Otherwise, any attribute not defined by the
schema can result in an error.
Default: None
Search Entire
Subtree Starting at
Base DN
Determines whether the authentication should search

sub-branches of the LDAP directory. Always check
Yes.
Default: Checked
Log in as
Administrator
If you check "Log in as Administrator", you must

provide the DN of the administrative user to connect
to the LDAP server. If checked, the following fields
display:
User Search Base DN
Login Type with Username + Password option
shown
Property

SVars?
Username
Password
If unchecked, the User DN Template field displays.
Default: Unchecked
User DN Template
The template by which the User DN, used to bind to

the LDAP server, is generated. Because the full DN
is always supplied, the template should always
contain {0} which gets replaced with the actual
username.
Default: {0}
User Search Base

DN
User Search
Expression
Base distinguished name from which the search starts.

Example: ou=department, dc=company, dc=com.
The expression used for searching a user. An example

for this expression is (CN={0}). '{0}' is replaced by the
username being searched for. You can define any
complex filter like (&(cn={0})(objectClass=account)).
Default: &(objectClass=person)(uid={0})
Login Credentials
Method to identify the administrative user:

Username + Password - Activates the Username
and Password fields.
Identity Provider that Supplies Credentials Activates the Identity Provider field.
Keystore Provider to Supply Identity (deprecated)
- Activates the Keystore Provider fields.
Default: Username + Password
Username
Full Distinguished Name (DN) of an administrative

user in the LDAP server.
Password
Password for the user.
Identity Provider

instance.
Keystore Provider to Y
Supply Identity
The name of a Keystore Provider resource instance.
Key Alias to Access Y

Identity
Default: None
Y
Alias of the user's key entry in the keystore managed

by the keystore provider.
Default: None
Key Alias Password Y
The password protecting the key entry.

Default: None
Group Attributes
Property

SVars?
Group
N
Indication
Description
Specifies how a user's group memberships are found. Group
information is used by Administrator when a user, once
authenticated, performs other activities in the system.
Options:
Group has users A list of users that belong to the group.
User has groups A list of groups to which the user
belongs.
User DN has groupsThe DN with a list of groups to
which the user belongs.
No Group Info Group memberships are not handled.
If the selected value is User has groups or User DN has
groups, the Users Attribute with Group Names field
displays.
If the selected value is Group has users, the following fields
display:
Group Search Base DN
Group Search Expression
Group Attribute with User Names
Group Attribute with Group Name
Group Attribute with Subgroup Names
Group Search Scope Subtree
Default: No Group Info.
User
Attribute
with
Group
Names
Group
Search
Base DN
The name of the attribute in each user object that lists the
groups to which the user belongs.
Default: None.
Searches for groups beginning at this base distinguished

name (DN).
Default: None.
Group
Y
Search
Expression
Group
Y
Attribute
with User
Names
Group
Attribute
with
Group
Name
Search by matching this expression against potential groups.

Default: None.
The name of the attribute in the group object that contains

its users. For example, for OpenLDAP: uniqueMember, for
ActiveDirectory: member.
Default: None.

the name of the group. For example, for OpenLDAP: cn,
for ActiveDirectory:sAMAccountName.
Default: None.
Property

SVars?
Group
N
Attribute
with
Subgroup
Names
Group
Search
Scope
Subtree
Description
its subgroups. For example, for OpenLDAP: uniqueMember,
for ActiveDirectory: member.
Default: None.
Search the entire subtree starting at the base DN for groups

(default). Otherwise, search only the nodes one level below
the base DN.
Default: Checked.
SAML Options
single sign-on
Property

SVars?
Validity of SAML
Tokens (s)
Signer of SAML
Tokens

Default: 600 s.

Advanced
GUI Property

SVars?
Context Factory N
Description
The factory object that provides the starting point for
resolution of names within the LDAP server.
Default: com.sun.jndi.ldap.LdapCtxFactory.
Maximum
Connections
(disabled in
non-Admin
mode)
Security
N
Authentication
The maximum number of connections to keep active in

the pool. (Enabled only when Log in as Administrator
is selected in General tab)
Default: 10.
Value of Simple Authentication and Security Layer (SASL)

authentication protocol to use. Values are
implementation-dependent. Some possible values are
simple, none, md-5.
Default: Blank.
Search Timeout N
(ms)
The time to wait for a response from the LDAP directory

server.
Default: -1, which means to wait forever.
GUI Property

SVars?
Follow Referrals N
Description
Indicate whether the client should follow referrals
returned by the LDAP server.
Default: Unchecked.
User Attributes N
Extra
Optional list of user attributes to retrieve from the LDAP

directory during authentication.
Default: None.
SSL
Property

SVars?
Description
Enable
SSL

display.
Default: Unchecked.
SSL Client N
Provider
Configure N
SSL

filled in.
Mutual Identity Provider

A Mutual Identity Provider resource template is an identity provider that supplies an identity and serves as
a trust store.
General
Property

SVars?
Description
Keystore
Provider
as Trust
Store
The name of a Keystore Provider resource instance that

maintains a keystore that confirms an identity.
Enable
N
Access to
Trust Store
Enable access to a trust credential store.

In order to establish SSL connections certain third-party
systems, such as MySQL, require access to a keystore file
location. In such situations Administrator provides a copy
of the credentials in a keystore which are then written to
disk and used by the third party as the SSL credential store.
Default: Checked.
Property

SVars?
Description
Keystore Y
Provider
to Supply
Identity
Name of Keystore Provider resource that maintains a

keystore used to assert an identity.
Enable
N
Access to
Credential
Store
Providing
Identity

connections, certain third-party systems such as MySQL
require access to a keystore file location. In such situations
Administrator provides a copy of credentials in a keystore,
which are then written to disk and used by the third party
as the SSL credential store. To prevent Administrator from
providing credentials, uncheck the checkbox.
Default: Checked.
Key Alias
to Access
Identity

Default: None.
Key Alias Y
Password
to Access
Identity

Default: None.
SiteMinder Authentication
The SiteMinder Authentication resource template represents a SiteMinder authentication service.
General
You must install unlimited jurisdiction files on nodes that will run SiteMinder resource instances.
Property

SVars?
Agent Name
The name of the SiteMinder agent that enforces access

control policies provided by the Policy Server.
Default: None.
Client IP Address
The IP address of the machine on which the

SiteMinder agent is installed.
Default: None.
Property

SVars?
Protected Resource
Name
The name should match the corresponding value

specified in the policy set or it should be left blank.
In Policy Director deployments, the name should
match the corresponding value specified in the
Governance Control or it should be left blank.
Default: None.
SAML Options
single sign-on.
Property

SVars?
Validity of SAML
Tokens (s)
Enable Security
Token Attribute

Default: 600 s.
(Not Applicable to some resource templates)

Indicate whether an attribute that contains a security
token should be enabled.
In Policy Director deployments, this checkbox should
be checked.
Default: Unchecked.
Signer of SAML
Tokens

Configuration File
Property

SVars?
Host Configuration N
File Option
The method for specifying the location of the

SiteMinder configuration file.
System Specific Default Location - Use the
system-specific default location.
Custom File Location - Use a custom configuration
file. Enables the Custom Configuration File Name
field.
Generate - Use a generated configuration file.
Enables the Generated Configuration File field
and all other fields whose values are used in
generating the configuration file.
Default: System Specific Default Location.
Configuration File
Custom Location
The path to the configuration file.

Default: None.
Property

SVars?
Generated
Configuration File
Name
The path to which the generated configuration file is

saved.
Default: None.
Trusted Host Name Y
The name of the host.

Default: None.
Host Configuration Y
Object
Shared Secret
The host's configuration object name.

Default: None.
The host's shared secret.

Default: None.
Policy Server
The URLs of the SiteMinder Policy Server.

Default: None.
Shared Secret Time
The validity period for the shared secret.

Default: None.
Crypto Provider
The name of the crypo provider.

Default: None.
Request Timeout (s) Y
The request timeout.

Default: 60 s.
FIPS Mode
The FIPS mode for the crypto provider.

FIPS-Compatibility Mode - the environment uses
existing SiteMinder algorithms to encrypt sensitive
data.
FIPS-Migration Mode - the SiteMinder Policy
Server continues to use existing SiteMinder
encryption algorithms as you migrate the
environment to use only FIPS-compliant
algorithms.
FIPS-only Mode - the environment only uses
FIPS-compliant algorithms to encrypt sensitive
data.
Default: None.
When you configure a shared resource for SiteMinder configuration, ensure that you select Enable
SecurityToken Attribute on the SAML Options tab.
SSL Client Provider

The SSL Client Provider resource template maintains the credentials required by an SSL client.
General
Property

SVars?
Description
Keystore
Provider
as Trust
Store

Enable
N
Access to
Trust Store

Default: Checked.
Property

SVars?
Enable
N
Mutual
Authentication
Description
Indicate whether the client in the SSL connection will
authenticate to the server. When checked, the identity fields
are enabled.
Default: Unchecked.
Property

SVars?
Description
Identity Store
Provider

Enable Access to
Identity Provider

Default: Unchecked.
Key Alias Name

Default: None.

Property

SVars?
Description
Set Blank Password.
Advanced
Property

SVars?
Description
SSL
Security
Provider
Optional. The SSL security provider.
SSL
Protocol
The SSL protocol to use in the SSL connection:

SSLv3
TLSv1
Default: TLSv1.
SSL
Cipher
Class
The number of bits in the key used to encrypt data:

No Exportable Ciphers
At Least 128 Bit
More Than 128 Bit
At Least 256 Bit
FIPS Ciphers
All Ciphers
Explicit Ciphers
The greater the number of bits in the key (cipher strength),
the more possible key combinations and the longer it would
take to break the encryption.
Default: At Least 128 Bit.
Explicit
Cipher
List
Verify
N
Remote
Hostname
A list of ciphers. Enabled when SSL Cipher Class is set to

Explicit Ciphers. Use the JSSE format for ciphers names.
Default: None
Indicate whether the name on the server's certificate must

be verified against the server's hostname. If the server's
hostname is different than the name on the certificate, the
SSL connection will fail. The name on the certificate can be
verified against another name by specifying Expected
Remote Hostname. When checked, the Expected Remote
Hostname field is enabled.
Default: Unchecked.
Expected N
Remote
Hostname
Optional. The expected name of the remote host.

Default: None
SSL Server Provider

An SSL Server Provider resource template maintains the credentials required by an SSL server.
General
Property

SVars?
Description
Identity Store
Provider

Enable Access to
Identity Provider

Default: Unchecked.
Key Alias Name

Default: None.

Set Blank Password.
Property

SVars?
Enable Mutual N
Authentication
Description
Indicate whether mutual authentication is enabled. When
checked, the Make Client Authentication As, Keystore
Provider as Trust Store, and Enable Access to Trust Store
fields display.
Default: Unchecked.
Make Client
N
Authentication
As
Indicate whether it is optional or required for an SSL

client to authenticate to the SSL server.
Default: Optional.
Property

SVars?
Description
Keystore
Provider

Property

SVars?
Description
as Trust
Store
Enable
N
Access to
Trust Store

Default: Checked.
Advanced
Property

SVars?
Description
SSL
Security
Provider
Optional. The SSL security provider.
SSL
Protocol
The SSL protocol to use in the SSL connection:

SSLv3
TLSv1
Default: TLSv1.
SSL
Cipher
Class
The number of bits in the key used to encrypt data:

No Exportable Ciphers
At Least 128 Bit
More Than 128 Bit
At Least 256 Bit
FIPS Ciphers
All Ciphers
Explicit Ciphers
The greater the number of bits in the key (cipher strength),
the more possible key combinations and the longer it would
take to break the encryption.
Default: At Least 128 Bit.
Explicit
Cipher
List
Verify
N
Remote
Hostname
A list of ciphers. Enabled when SSL Cipher Class is set to

Explicit Ciphers. Use the JSSE format for ciphers names.
Default: None
Indicate whether the name on the server's certificate must

be verified against the server's hostname. If the server's
hostname is different than the name on the certificate, the
SSL connection will fail. The name on the certificate can be
verified against another name by specifying Expected
Remote Hostname. When checked, the Expected Remote
Hostname field is enabled.
Property

SVars?
Description
Default: Unchecked.
Expected N
Remote
Hostname
Optional. The expected name of the remote host.

Default: None
Trust Provider
The Trust Provider resource template maintains the identity of a trusted resource.
General
Property

SVars?
Description
Keystore
Provider
as Trust
Store

Enable
N
Access to
Trust Store

Default: Checked.
WSS Authentication
A WS-Security ASP resource template enables a connection to Web Services Security authentication services.
General
Property

SVars?
Security Token
Security Token is an online security credential that adds

an extra layer of identity protection.
X.509
X.509 is an ITU-T standard for a public key infrastructure

(PKI) and Privilege Management Infrastructure (PMI).
Default.
Kerberos
Kerberos is a secure method for authenticating a request

for a service in a computer network.
Enable
Signature
Verification
Indicate whether to verify the signatures. If checked,

activates the Trust Provider field.
Default: Unchecked.
Property

SVars?
Enable
Decryption
Indicate whether to enable decryption. If checked, activates

the Identity Provider field.
Default: Unchecked.
Identity
Provider
Name of the Identity Provider on page 236 resource that

provides the credential used to decrypt messages. Activated
if Enable Decryption is checked.
Trust Provider
Name of a Trust Provider on page 253 resource that

provides the credential use to verify a signature. Activated
if Enable Signature Verification is checked.
Mutual Identity Y
Provider
Name of a Mutual Identity Provider on page 245 resource.

Activated if Enable Decryption and Enable Signature
Verification are checked.
Username Authentication
Property

SVars?
Enable
N
Username
authentication
Authentication Y
Provider
Description
Indicate whether to verify the username. If checked,
activates the Authentication Provider field.
Default: Unchecked.
Name of an LDAP Authentication on page 241 resource that

provides authentication services.
Chapter
9
Resource Instances
A resource instance is a runtime object that represents a resource, such as an HTTP, JDBC, or LDAP connection.
A resource instance instantiates the configuration defined in a resource template and makes it available to services
running on a node.
Applications, components, bindings, logging appenders, and resource templates can have properties whose value
is the name of a resource. For example, an HTTP client resource template's SSL property configuration includes a
property whose value is the name of SSL Client Provider resource. Figure 12: TIBCO Business Studio Resource
Instance on page 255 and Figure 13: Administrator Resource Instance on page 255 show how to set a resource
property in TIBCO Business Studio and Administrator respectively.
Figure 12: TIBCO Business Studio Resource Instance
Figure 13: Administrator Resource Instance
Topics
Creating Resource Instances on Nodes

Installing Resource Instances on Nodes
Uninstalling Resource Instances from Nodes
Deleting Resource Instances from Nodes
Resource Instances Reference
256 | Resource Instances
Creating Resource Instances on Nodes

You can create a resource instance on a node from the host, from the node, from the resource template, or
from an Application using the Administrator GUI. You can also create a resource instance with the CLI.
About this task
The available nodes are the nodes managed by the selected host.
On TIBCO ActiveMatrix Service Bus and TIBCO ActiveMatrix Service Grid, the name of the resource
instance does not have to be the same as the name of the resource template from which it gets its
configuration though it is often a good idea to use the same name.
GUI
Procedure
Choose a starting point and follow the appropriate procedure.
Starting
Procedure
Point
Hosts

2. Select a host.
3. Click the Resource Instances tab. In the All Instances table, click New.
You can select a resource template type from the View drop-down list and click New
4. Select resource template type from the drop-down list.
If no resource templates exist, click new resource template link and follow the procedure
in Creating a Resource Template on page 189.
5. Use the check boxes under Scope to filter resource templates with specific scopes.
6. On TIBCO ActiveMatrix Service Bus and TIBCO ActiveMatrix Service Grid, accept the
default instance name or type a new one in the Instance Name field. The name must not
contain the characters : or &.
On TIBCO ActiveMatrix Policy Director, the name of the resource instance should be
the same as the resource template.
7. Select a node in the Available Nodes and move it to Selected Nodes using the arrow
buttons.
8. Choose one of the following options:
Save to add the resource instance to the selected nodes and continue adding resource
instances.
Save and Close to add the resource instance to the selected nodes and close the dialog.
Save and Install to install the resource instance to the selected nodes and close the
dialog.
9. If you did not install the resource instance in the previous step, the Install Resource
Instances dialog box displays. Select the resource instances to install and click Install.
Applications 1.
2.
3.
4.
Click Applications and select an application.

Click Resource Templates > Resource Instances.
Click New.
Select a resource template from the drop-down menu.
Resource Instances | 257
Starting
Point
Procedure
5. Select a node from the Available Nodes box and move to Selected Nodes box.
6. Type an instance name.
7. Save.
Nodes
1.
2.
3.
4.
5.

In the Nodes table, click a node.
Click the Resource Instances tab.
Select All Instances and click New.
Select a resource template type from the drop-down list.
If no resource templates exist, click new resource template link and follow the procedure
in Creating a Resource Template on page 189.
6. Use the check boxes under Scope to filter resource templates with specific scopes.
7. Accept the default instance name or type a new one in the Instance Name field. The
name must not contain the characters : or &.
8. Click Save to add the resource instance to the selected nodes and continue adding
resource instances or Save and Close to add to add the resource instance to the selected
nodes and close the dialog.
9. In the Install Resource Instances dialog box, select the resource instances to install and
click Install.
Resource
Templates

2. Click a resource template.
3. Click New Resource Instances.
Optionally, you can select a resource template and click the Resource Instances tab.
4. Accept the default instance name or type a new one in the Instance Name field. The
name must not contain the characters : or &.
5. Select a node in the Available Nodes and move it to Selected Nodes using the arrow
buttons.
Save to add the resource instance to the selected nodes and continue adding resource
instances.
Save and Close to add the resource instance to the selected nodes and close the dialog.
Save and Install to install the resource instance to the selected nodes and close the
dialog.
7. If you did not install the resource instance in the previous step, the Install Resource
Instances dialog box displays. Select the resource instances to install and click Install.
CLI
Before you begin
The resource template specified in the resourceTemplateName attribute must exist in the Administrator
database.
Procedure
1. In the data file, specify a ResourceInstance element in full format.
<ResourceInstance xsi:type="amxdata:ResourceInstance" name="resourceHttpClient"
resourceTemplateName="HttpclientRT" />
attribute to Environment/Node/ResourceInstance.
<AMXAdminTask action="add" objectSelector="Environment/Node/ResourceInstance"/>
Installing Resource Instances on Nodes

After you have created a resource instance, you can add it to one or more nodes from the GUI or by using
the CLI.
Before you begin
The resource instances must have already been added to the nodes.
GUI
Procedure
Starting Point
Procedure
Hosts

2. Select a host.
3. Click Resource Instances.
Applications
1. Click Application and select an application.

2. Click Resource Template> Resource Instances.
Nodes

2. Select a node.
3. Click the Resource Instances tab.
Resource Templates

You can filter resource templates using Type and Scope.
3. Click Resource Instances.
2. Select a resource instance.

3. Click arrow next to Install for an install option.
Install - installs the selected resources only if dependent resources can be autoinstalled or have been
previously installed.
Force Install - installs the selected resources and issues warnings if dependent resources are not
installed.
More install options - check the check boxes for the following options as applicable:
Install with force, bypassing validation checks.
Provision driver in resolve mode (restarts the node).
4. If the resource instance depends on a recently modified resource template, the Resource Instance Install
Impact Dialog dialog displays.
a) Select the resource instances that you want to reinstall. These are resource instances created from this
resource template or other resource templates that depend on the modified resource template.
b) Select the applications that you want to restart.
c) Select the nodes where you want the resource instances reinstalled and the applications restarted.
5. When using JDBC or JMS drivers, if you have configured multiple drivers that have the same class name
but different driver JAR file names, the Driver Selection Dialog displays. The following shows the dialog
box for a selecting a JDBC driver.
a) Select a version from the Driver drop-down list.

b) If the driver requires the use of a resolve mode, the checkbox for Use Resolve Mode (node will restart)
is checked by default.
c) Click OK.
Results
The resource instances are installed on the nodes with the Runtime State is either Stopped or Running
depending on the state of the node.
When a resource instance is installed and its resource template references another resource template,
Administrator automatically creates a resource instance of the same name as the referenced template and
install it. This is done recursively for several levels if needed.
Only those drivers installed using TIBCO Configuration Tool are detected and provisioned.
If the driver for a particular class is already installed on the node, the provisioning process is
skipped.
If using a driver not supported by TIBCO Configuratino Tool, choose the option to ignore the
missing driver in the Driver Selection Dialog.
CLI
Procedure
1. In the data file, specify a ResourceInstance element in base format.
<ResourceInstance xsi:type="amxdata:ResourceInstance_base"
name="resourceHttpClient" />
If installing either JDBC or JMS resource instances and if you have multiple drivers available, specify the
name and version of the driver using the driverFeaturename and driverFeatureVersion elements.
name="resourceJDBC_ORA" resourceTemplatename="ora"
driverFeatureName="com.tibco.tpcl.gen.oracle.jdbc.feature"
driverFeatureVersion="11.2.100.001" />
To store this driver version as the default driver in the resource template, use the setDriverAsDefault
option and set it to true. All resource instances created using this resource template will now use this
driver.
driverFeatureVersion="11.2.100.001"
setDriverAsDefault="true" />
2. In the build file, set the action attribute of the AMXAdminTask element to install and the objectSelector
attribute to Environment/Node/ResourceInstance. The options element is used to specify the provisioning
mode.
auto-resolve - the mode specified by the driver is used.
resolve - the resolve mode is used.
element not specified - the provisioning is done in the stable mode.
<AMXAdminTask action="install"
options="auto-resolve"/>
When installing a resource instance that refers to a JMS or JDBC resource instance, the resource instances
are installed but the drivers are not provisioned.
3. To re-install all dependant resource instances and restart applications that use these resource instances,
use the handle-dependencies option.
<AMXAdminTask action="install"
options="handle-dependencies"/>
Uninstalling Resource Instances from Nodes

You can install all resource instances or a selected resource instance from a node by using the GUI or the CLI.
GUI
Procedure
Starting Point
Procedure
Hosts

2. Select a host.
Applications

Nodes

2. Select a node.
Resource Templates


Option
Description
All Instances
1. In the Resource Instances view, click All Instances.

2. Click the rows containing the instances to uninstall.
3. Choose an uninstall option .
Uninstall - uninstalls the selected resources only if applications are not using it
and no other resources are using it.
Force Uninstall - uninstalls the selected resources and issues warnings if
applications or dependent resources are using it.
Instance
1. In the Resource Instances view, first expand the All Instances node and then the
node for the resource instance type.
2. Click a resource instance.
3.
Click one or more nodes in the Selected Nodes list and click
. The nodes move
to the Available Nodes list.
4. Click Update. The selected resource instances are uninstalled only if any applications
or other resources are not using it.
CLI
Procedure
name="resourceHttpClient" />
If installing either JDBC or JMS resource instances and if you have multiple drivers available, specify the
name and version of the driver using the driverFeaturename and driverFeatureVersion elements.
driverFeatureVersion="11.2.100.001" />
To store this driver version as the default driver in the resource template, use the setDriverAsDefault
option and set it to true. All resource instances created using this resource template will now use this
driver.
driverFeatureVersion="11.2.100.001"
setDriverAsDefault="true" />
2. In the build file, set the action attribute of the AMXAdminTask element to uninstall and the
objectSelector attribute to Environment/Node/ResourceInstance. To perform a force uninstall, specify
the -force option and set it to true.
<AMXAdminTask action="uninstall"
objectSelector="Environment/Node/ResourceInstance"/>
Deleting Resource Instances from Nodes

You can delete resource all resource instances or a selected instance from a not by using the GUI or the CLI.
A Force Delete option is available but not recommended.
GUI
Procedure
Starting Point
Procedure
Hosts

2. Select a host.
Applications

Nodes

2. Select a node.
Resource Templates


The list of resource instances display. The resource instances listed in the table on the left hand side are
grouped by the type of the resource instance.
3. Choose one of the following procedures:
Option
Description
All Instances
1. In the Resource Instances view, click All Instances.

2. Expand the rows for the listed resource instance type to see individual resource
instances.
3. Click the rows containing the instances to delete.
4. Choose a delete option .
Delete - deletes the selected resources only if the resources are uninstalled.
Force Delete - Force uninstalls the resource instance and then deletes it. This
option is enabled only if you have the necessary permissions. See Setting Enterprise
Permissions on page 301 for more information.
You should exercise extreme caution when using this option as it may
leave your system in a non-working state.
Instance
1. In the Resource Instances view, expand the All Instances node and click a resource
instance.
2. Click Remove Instance. Deletes the selected resource only if the resource is
uninstalled.
CLI
Procedure
<ResourceInstance xsi:type="amxdata:ResourceInstance_base" name="resourceHttpClient"
/>
attribute to Environment/Node/ResourceInstance. To perform a force delete, specify the -force option
and set it to true.
<AMXAdminTask action="delete" objectSelector="Environment/Node/ResourceInstance"/>
Resource Instances Reference

Resource Instance reference provides information about a resource instance and its state.
Column
Description
Type
The type of the resource instance.
Template Name
The name of the resource template from which the instance was created.
Instance Name
The name of the resource instance.
Scope
The scope of the resource template. For information, see Resource Template with Scope.
Instance State
The state of the resource instance.

been installed
Synchronized
Indicates whether the resource instance runtime matches the host's configuration in the
Node Name
The node where the instance is installed.
Action History
The outcome of the last action performed with the intent of affecting the runtime state.
Chapter
10
Substitution Variables
A substitution variable is a variable that you can reuse in resource, logging, and application configurations. Substitution
variables enable late binding of property values to values set at administration time. For example, you can create
an HTTP client resource template and bind its port property to a substitution variable that is set when the template
is instantiated. The types of substitution variables are:
String (default type)
Integer
Boolean
Password
You can create substitution variables at design time and during administration. At design time, instead of explicitly
setting property values, you can bind them to substitution variables. During administration, you set the substitution
variables values to values supported by the resources available on the node on which the components and bindings
are deployed.
A substitution variable is identified by a name. Names may not contain whitespace. When a property value is
bound to a substitution variable, the property value is a string containing the substitution variable name surrounded
by two pairs of percent signs.
Substitution Variable Scope
In Administrator, you can define and set enterprise, host, node, and environment substitution variables and can
set application and application fragment substitution variables.
Using Substitution Variables
Substitution variables can be used in:
Resource templates
Application properties - specifically, components and binding properties
Logging appenders
Substitution variables provide the ability to share common values, called generalization, or to introduce small
variations in the configuration based on the node or machine, called specialization.
The general workflow to use a substitution variable is as follows:
1. In the resource template, application, or logging appender, type %%svar-name%% in any editable field instead
of a fixed value such as 8080 for a port number. The svar-name is simply an identifier for the substitution variable
and the %% is a mandatory prefix and suffix in a substitution variable. You can use multiple substitution
variables as well as static text in a single value. For example, http://%%host-name%%/%%endpoint-uri%% can represent
http://hostname/uri format.
2. Define each substitution variable by assigning a type and value. For example, you can define substitution
variables host-name and endpoint-uri at the environment level of type String and with a value venus and
myservices/OrderService respectively. Do not use %% as prefix or suffix in the definitions. Also, do not use the
values themselves as substitution variables.
3. Design the resolution scheme for the substitution variables. If you are trying to generalize by sharing common
values across multiple objects, define substitution variables at a broader scope, such as enterprise or environment.
270 | Substitution Variables
If you are trying to specialize by introducing small variations in the configuration, define substitution variables
at a narrower scope such as application, node or host.
Example of Substitution Variable Usage
Let us say you created a HTTP Connector resource template and want to create two resource instances on two
nodes. When you create this configuration, you want the flexibility to run the two nodes on the same machine or
on two different machines. Entering a fixed port number such as 8080 in the HTTP Connector's port number field
will not create a port conflict if the nodes run on different machines, however, will result in port conflict when the
two nodes run on the same machine. To avoid a port conflict, use a substitution variable %%port%% in the port
number field. Then define the substitution variable with name port, type Integer, and value 8080 at the node level
for Node1, and also define the same substitution variable with a different port value, 8081 for Node2. Then, create
resource instances on the two nodes and install them. ActiveMatrix Administrator will use port 8080 for Node1 and
8081 for Node2 which will avoid a port conflict. Thus, you have introduced a small variation in your HTTP Connector
configuration at a node level.
A variation of the above case is that you can define the port substitution variable at the enterprise level with a value
of 8082. Let us say you now add a Node3 to the system, however, forgot to define the substitution variable to the
node level. Installing a resource instance on Node3 will succeed by using the port value 8082, which is treated as a
default (fallback) value when no substitution variable is found at the node level for Node3.
Substitution Variable Resolution
A substitution variable defined at the node level will get a higher precedence than the one defined at the enterprise
level. Enterprise level is the broadest scope at which you can define a substitution variable. A substitution variable
defined at a specific node level is narrow in scope and is not visible to other nodes.
ActiveMatrix Administrator uses a resolution process based on fixed rules to determine which substitution variables
should be considered to arrive at the final values to be replaced in a configuration property. The final value is sent
to the runtime instead of the substitution variable. The value that is chosen depends on the type of the object and
the scopes in which the substitution variables are defined.
The substitution variable resolution for each type is as follows:
Resource Templates
Substitution variables for resource templates are resolved when a resource instance from the resource template is
installed or re-installed on a node.
For resource templates scoped at global or environment level, the resolution order is:
1. Node SVars
2. Host SVars
3. Environment SVars
4. Enterprise SVars
For example, if a resource template using %%port%% substitution variable with a name port is defined at the node
level, then its value is used and others ignored. If the host does not define port, then environment SVars are scanned
for a match, and if there is no match, finally enterprise SVars are scanned. If no definitions are found, an error
indicates that the substitution variable %%port%% was not found.
For resource templates scoped at application level, the resolution order is:
1. Application Fragment SVars
2. Application SVars
3. Node SVars
4. Host SVars
6. Enterprise SVars
Application Properties
Substitution Variables | 271
Substitution variables for application properties are resolved when deploying an application. The resolution order
is the same as described for resource templates scoped at application level.
Logging Appenders
Substitution variables for logging appenders are resolved through logging configurations, that makes use of logging
appenders, for a node, host or application. The resolution occurs when the logging configuration is deployed.
When used in logging configuration for a node, the resolution order is:
1. Node SVars
2. Host SVars
4. Enterprise SVars
When used in logging configurations for a host, the resolution order is:
1. Host SVars
2. Enterprise SVars
When used in logging configuration for an application, the resolution order for a substitution variable is the same
as described for resource templates scoped at the application level.
Topics
Creating a Substitution Variable
272 | Substitution Variables
Creating a Substitution Variable

GUI
Procedure
1. Open a substitution variable screen.
Level
Commands
Enterprise
Shared Objects > Substitution Variables
Host
1. Infrastructure > Hosts

2. Choose a host.
3. Click Substitution Variables.
Environment
1. Infrastructure > Environments

2. Choose an environment.
Node

2. Choose a node.
Application
1. Applications .
2. Choose an application.
Application fragment
1.
2.
3.
4.
Applications .
Choose an application.
Click Substitution Variables.
Click Application Fragment Substitution Variables.
2. In the Substitution Variables table, click Add.

A row is added to the table.
3. In the Name column, type a name for the variable.
4. In the Type column, select the variable type from the drop-down list.
5. Optionally click the Description and Local Value columns and provide a description and value respectively.
6. Click Save.
CLI
Procedure
1. In the data file, specify a SVar element in base format. Nest the SVar element under a parent Enterprise,
Environment, Host, Node, Application, or AppFragment element.
<SVar xsi:type="amxdata_base:SubstitutionVariable" name="svarName"
type="String" value="svarValue"/>
Substitution Variables | 273
2. In the build file, set the action attribute of the AMXAdminTask element to set or add and the
objectSelector attribute to //SVar. The add action adds variables in the data file that don't exist in the
database and updates variables defined both data file and database. The set does the same as add and
deletes variables in the database not defined in the data file.
<AMXAdminTask action="add" objectSelector="//SVar"/>
Chapter
11
Software Management
Topics
Features
Application Templates
Versions
Distributed Application Archives
276 | Software Management
Features
System features are part of a TIBCO ActiveMatrix product or contain the drivers that are installed using
TIBCO Configuration Tool. Shared library features contain component implementations and libraries. When
you create a distributed application archive containing a composite, you can package the composite's required
features in the application archive or you can package the features as a standalone distributed application
archive.
When you upload a distributed application archive containing a composite in Administrator you can optionally
import the features contained in the archive into the Administrator software repository. When you deploy
an application, Administrator automatically distributes the features (and any features that it depends on) to
the host that manages the nodes on which the application is distributed and installs the features on those
nodes. You can also manually install features on the other nodes managed by that host.
Adding Features to the Enterprise

GUI
Procedure
Starting Point
Procedure
Software Management 1. Select Infrastructure > Software Management .
2. Click the Features or Application Templates tab.
3. Click Upload DAA or EAR.
a. Navigate to a directory containing the DAA file.
b. Click the DAA file.
c. Click Open.
4. Choose whether you want to import the listed features.
Applications
3. In the General tab, click the Upload DAA or EAR link next to the Template
Version field.
c. Click Open.
2. Click Save.
CLI
Procedure
1. In the data file, specify a DAA element in full format and set the importFeatures attribute to true.
<DAA xsi:type="amxdata:DAA" location="testApp.daa" importFeatures="true">
<importFeatureIdentifier>UseCase847Application:1.0.0.200907131735</importFeatureIdentifier>
</DAA>
Software Management | 277
2. In the build file, set the action attribute of the AMXAdminTask element, to add and the objectSelector
attribute to DAA.
<AMXAdminTask action="add" objectSelector="DAA"/>
Adding a Feature to a Node

After a feature has been added to the enterprise, you can add it to one or more nodes from the GUI or by
using the CLI.
Before you begin
The feature must have previously been added to the enterprise by being installed or uploaded through a
DAA file.
GUI
Procedure
1. Choose a starting point and follow the procedure.
Starting Point
Procedure
Nodes
1.
2.
3.
4.
5.
6.
7.
Software
Management
1. Select Infrastructure > Software Management.

2. Click the Features tab.
3. In the View By drop-down list, choose whether to display features or nodes as the
parent object.
Features Click one or more features and click Edit. The Edit Nodes for Feature
Version dialog displays.

In the Nodes list, click a node.
Click the Features link.
Click the Add link over the Features table. A new row is added to the table.
Select the feature type, name, and version from the drop-down lists in the respective
columns.
8. Click Save.
Click one or more nodes in the Available Nodes list and click
move to the Selected Nodes list.
. The nodes
Nodes Click one or more nodes and click Edit. The Edit Features for Node dialog
displays.
Click one or more features in the Available Features list and click
move to the Selected Features list.
. The features
4. Click Apply.
The feature is added to the node and the Runtime State changes to Marked for Install.
2. Apply the update.
Apply - Installs the selected features on the nodes. Applications deployed on the nodes will continue
to use the features that were available on the node when they were deployed.
Apply with Resolve- Installs the selected features on the nodes, restarts the nodes, and causes all
applications deployed on the nodes to use the latest versions of the features on which they depend.
Use this operation to install a new version of an existing feature, to force applications that reference
the existing feature to use the new version, or if after clicking Apply you get an error that says that
because the node is running in stable mode, it cannot accept the deployment of the feature.
Cancel
The Runtime State of the feature changes to Installed.
CLI
Procedure
1. In the data file, specify a Feature element nested in a Node element.
<Node xsi:type="amxdata:Node" name="node1"
<Feature xsi:type="amxdata_base:FeatureID" componentID="myFeature"
version="myFeatureVersion"/>
</Node>
2. In the AMXAdminTask element, set the action attribute to add and the objectSelector element to
Environment/Node/Feature.
<AMXAdminTask action="add" objectSelector="Environment/Node/Feature"/>
3. In the AMXAdminTask element, set the action attribute to reprovision and the objectSelector element
to Environment/Node. If the feature includes a resource instance that is dependant on drivers that must
be installed in the resolve mode, specify the options="resolve" attribute. Using the resolve option
restarts the node.
<AMXAdminTask action="reprovision" objectSelector="Environment/Node"/>
Adding Third-Party Libraries to Nodes

Procedure
1. Package the third-party library into a feature and upload the feature using the Configure Third-Party
Driver wizard in TIBCO Configuration Tool. For details, see the installation manual for your product.
2. Add the feature to the node. See Adding a Feature to a Node.
Setting Node Features

You can set node features by using the CLI.
CLI
About this task
Set requires a complete list of features that you want to have on a node. Features that are present on the node
and missing in data file will be removed after set and reprovision actions are executed.
Procedure
1. In the data file, specify a Feature element nested in a Node element.
<Node xsi:type="amxdata:Node" name="node1"
<Feature xsi:type="amxdata_base:FeatureID" componentID="myFeature"
version="myFeatureVersion"/>
</Node>
2. In the build file, set the action attribute of the AMXAdminTask element to set and the objectSelector
attribute to Environment/Node/Feature.
<AMXAdminTask action="set" objectSelector="Environment/Node/Feature"/>
3. In the AMXAdminTask element, set the action attribute to reprovision and the objectSelector element
to Environment/Node. If the feature includes a resource instance that is dependant on drivers that must
be installed in the resolve mode, specify the options="resolve" attribute. Using the resolve option
restarts the node.
<AMXAdminTask action="reprovision" objectSelector="Environment/Node"/>
Removing Features from a Node

You can remove features from a node with the GUI or by using the CLI.
GUI
Procedure
Choose a starting point and follow the procedure.
Option
Description
Nodes
1.
2.
3.
4.
5.
6.
7.
8.
Software
Management
1. Select Infrastructure > Software Management .

2. Click the Features tab.
3. In the View By drop-down list, choose display either features or nodes as the parent
object.
4. Click one or more features and choose one of the following actions:
Edit
1. The Edit Nodes for Feature Version dialog displays.
2.
Click one or more nodes in the Selected Nodes list and click
. The nodes
move to the Available Nodes list.
Select Infrastructure > Nodes .

In the Nodes list, click a node.
Click the Features link.
Click a feature.
Click Remove.
Click Save.
Remove from Nodes

1. A dialog box listing the impact of the action is displayed.
Apply- Removes the selected feature versions from the nodes.
Apply with Resolve - Removes the selected features from the nodes, restarts the
nodes, and causes all applications deployed on the nodes to use the latest versions
of the features on which they depend. Select this option to remove feature versions
that are being used by an application.
Cancel
CLI
Procedure
In the build file, set the action attribute of the AMXAdminTask element to remove and the objectSelector
attribute to Node/Feature.
<AMXAdminTask action="delete" objectSelector="Node/Feature"
/>
Deleting Features from the Enterprise

You can delete features from the enterprise from the GUI or by using the CLI. If features are provisioned on
nodes, you cannot delete them until the are explicitly removed.
GUI
Procedure
1.
2.
3.
4.
Select Infrastructure > Software Management.

Click the Features tab.
Click one or more features.
Click Delete from Software Repository.
The features are deleted from the enterprise. However, if the features are provisioned on nodes, the features
remain on the nodes until they are explicitly removed.
CLI
Procedure
1. In the data file, specify a Feature element in base format.
<Feature componentID="JavaHelloWorld2Soa_feature" version="1.0.0"/>
</Enterprise>
element to Feature.
<AMXAdminTask action="delete" objectSelector="Feature" />
Feature Reference
<Feature xsi:type="amxdata_base:FeatureID"
attributeList />
Property
Description
Name
The feature name.
Version
The feature version. When deleting a feature though CLI, the version functions as a wildcard.
For example, specifying a version of 1.0 deletes all features whose version starts with 1.0.
Features Reference
For each feature, you can display the name, type, feature status, and node state. You can include system
features in the feature list or display only features that you added to the enterprise.
By default a node's Features list contains the feature named TIBCO ActiveMatrix Platform. This feature
contains the runtime and implementations of the components in the platform application.
Click Show System Features to view the installed system features. This link toggles between Show System
Features and Hide System Features.
Column
Description
Name
The feature name.
Type
The type of the feature:

System - defined by a system.
Shared Library - features.
Version
The feature version. When deleting a feature though CLI, the version functions as a
wildcard. For example, specifying a version of 1.0 deletes all features whose version
starts with 1.0.
Expand the version to view additional details.
Node
The node where the feature is deployed.
Feature Status
The runtime status of the feature:

Marked for Install - after a feature has been added to a node and before the change
has been applied to runtime.
Marked for Uninstall - after a feature is removed and before the change is applied
to runtime.
Installed - after a feature has been applied to runtime.
Node Runtime
State
The runtime state of the node:

Not Running - after a node has been installed or when it was detected that the node
ended without being stopped by the host. This applies when the process is detected
as stopped.
Stopping - Stopping a node is expected to be a quick activity. If the node is stuck at
Stopping for more than a few minutes, checking the logs may indicate the problem.
Starting - Starting a node is expected to be a quick activity. If the node is stuck at
Starting for more than a few minutes, checking the logs may indicate the problem.
Start Failed - The host was not able to start the node process. Possible causes are
that the node_classpath.tra file contains errors, the JRE libraries are not found,
Column
Description
or the OS is unable spawn additional processes. After this state ,the node is disabled
and must be manually enabled.
Running
Application Templates
An application template is a root composite and a set of related configuration files including nested composites,
WSDL files, substitution variable files, and resource templates. An application template is added to the
Administrator software repository when you upload a DAA.
While multiple applications can be created from an application template, each application is associated with
a single application template. During upgrade you can switch to a new version of the application template.
Adding Application Templates to the Enterprise

You can add an application template to the enterprise from the GUI or by using the CLI. As part of the process,
you can import the template features.
GUI
Procedure
Starting Point
Procedure
Software Management 1. Select Infrastructure > Software Management .
2. Click the Features or Application Templates tab.
c. Click Open.
Applications
3. In the General tab, click the Upload DAA or EAR link next to the Template
Version field.
c. Click Open.
2. Click Save.
Results
The application templates contained in the DAA are added to enterprise.
CLI
Procedure
1. In the data file, specify a DAA element in full format.
<DAA xsi:type="amxdata:DAA" location="testApp.daa" />
attribute to DAA.
<AMXAdminTask action="add" objectSelector="DAA" />
Deleting Application Templates

You can delete an application template from the GUI or by using the CLI.
GUI
Procedure
1.
2.
3.
4.
Select Infrastructure > Software Management.

Click the Application Templates tab.
Click one or more templates.
Click Delete.
The templates are deleted from the Administrator database and the software repository.
CLI
Procedure
1. In the data file, specify an AppTemplate element in base format.
<AppTemplate xsi:type="amxdata_base:AppTemplateID" name="myAppTemplate"
version="1.0.0"/>
2. In the AMXAdminTask element, set the action attribute to delete and the objectSelector attribute to
AppTemplate.
<AMXAdminTask action="delete" objectSelector="AppTemplate" />
Application Template Reference

<AppTemplate xsi:type="amxdata_base:AppTemplateID"
attributeList />
CLI Element or
Attribute
Required?
Editable?
Description
name
The name of the application template.
version
The version of the application template.
Versions
A version is a property that controls how an object is treated at installation or deployment. Versions are
specified in TIBCO Business Studio and cannot be modified in Administrator.
The following objects have versions:
Composites and application templates.
Components - During application upgrade, Administrator compares component versions to determine
whether the component needs to be upgraded.
Features
Plug-ins
Packages
Version Numbers
A version number is a multicomponent number of the form major. minor. service.qualifier. Changes in the value
of each component reflect different types of changes in the versioned object:
major - Reflects breaking changes to the interface.
minor - Reflects non-breaking changes in an externally visible way. Examples of externally visible changes
include binary compatible changes, significant performance changes, major code rework, and so on.
service - Reflects changes that are not visible in the interface. For example, a bug has been fixed in the code,
documentation has changed, compiler settings have changed, and so on.
qualifier - Identifies when and where the object was built or packaged.
When you create an object in TIBCO Business Studio, the version is set to "1.0.0.qualifier". If the qualifier
component of a version is set to "qualifier" when you create a DAA, TIBCO Business Studio replaces "qualifier"
with a generated qualifier that defaults to a timestamp. You can customize the format of the generated qualifier
by specifying a qualifier replacement.
Version Ranges
Some fields require you to specify a version range. For example, a feature may have a dependency on a range
of versions of another feature. A version range is an interval specified as: bracket lower limit, upper limit bracket,
where bracket can be [ or ], which denotes an inclusive end of the range or ( or ), which denotes
an exclusive end of the range. If one end of the range is to be included and the other excluded, the range can
contain a square bracket with a round bracket.
There are three common use cases:
A strict version range, such as [1.0.0,1.0.0], denotes version 1.0.0 and only that version.
A half-open range, such as [1.0.0,2.0.0),which has an inclusive lower limit and an exclusive upper limit,
denotes version 1.0.0 and any later version, up to, but not including, version 2.0.0.
An unbounded open range expressed as a single number such as 2.0.0, which is equivalent to the
range [2.0.0, infinity), denotes version 2.0.0 and any later version.
Distributed Application Archives

You can package a shared library as a distributed application archive. A distributed application archive (DAA)
is a package that contains TIBCO ActiveMatrix applications and libraries.
A DAA contains zero or one application template, zero or more features, and zero or more resources. When
you upload a DAA, Administrator extracts the contents of the DAA and stores them in the Administrator
staging area. The original DAA file is not stored, so the only way to delete a DAA is to delete each entity
contained in the DAA.
By default, DAAs are stored in the Deployment
Artifacts
special folder in an SOA project.
Uploading a Distributed Application Archive

You can upload a distributed application archive from the GUI or by using the CLI. As part of the process,
you can import selected custom features.
GUI
Procedure
1. Select Infrastructure > Software Management. Click Features or Application Templates.
The Upload DAA or EAR dialog displays.
3. Click Browse to navigate to a DAA file.
a) Navigate to a directory containing the DAA file.
b) Click the DAA file.
c) Click Open.
4. The DAA is validated. If the DAA contains errors the DAA is not uploaded and the error can be seen by
clicking the More details link. If the DAA does not contain errors proceed to the next step.
5. Check the Import Custom Features checkbox to enable importing custom features defined in the DAA.
The Custom Features list displays.
6. In Custom Features list, check the checkboxes next to the features to import.
7. Click Save.
Results
The application templates contained in the DAA are added to enterprise. The selected custom features are
added to the enterprise. The archive is discarded.
CLI
Procedure
1. In the data file, specify a DAA element in full format.
<DAA xsi:type="amxdata:DAA" location="testApp.daa"/>
2. In the build file, set the action attribute of the AMXAdminTask element, to add and the objectSelector
attribute to DAA.
<AMXAdminTask action="add" objectSelector="DAA"/>
Distributed Application Archive Reference

<DAA xsi:type="amxdata:DAA"
attributeList />
Property

SVars?
Description
Upload
File
The file path to the DAA file.
Import
Features
Indicate whether to import features contained in the DAA.
Import
N
Resource
Templates
Indicate whether to import resource templates defined in

the application template contained in the DAA.
Chapter
12
Governance
Governance is a concept to exercise organizational control over development, deployment, and operations of
services.
In service-oriented architecture, operational governance assures service execution to ensure that services behave
according to the specified mandates and guidelines. It can include service monitoring, resource optimization, fault
tolerance and access control. Several features in the design, runtime, and administration components of the TIBCO
ActiveMatrix platform support operational governance. At design-time, TIBCO Business Studio allows application
developers to specify intents and policy sets. At administration time, TIBCO ActiveMatrix Administrator supports
metrics collection and monitoring and credentials that support identity management.
Topics
Dashboards
Users, Groups, and Permissions
Log Viewer
Monitoring
290 | Governance
Dashboards
Dashboards display runtime object performance statistics. They allow you to monitor the overall health and
performance of infrastructure objects, applications, and resources.
Displaying the Dashboards

Procedure
1. Select Dashboards > Infrastructure.
The dashboards display.
2. Click a link at the top to display the performance statistics for a class of runtime object.
3. In the Filter Criteria gadget on the right:
Click the Time Period drop-down list and select a time period. The time period affects averages and
counts, but not metrics with an explicit last value such as Uptime. Basic monitoring provides one hour
and since started time periods.
Click
next to a category to display the available objects in the category and select one or more
objects.
The items displayed in the table on the left are filtered by the selected time period and objects.
Filter Criteria Gadget

The Filter Criteria Gadget allows you to specify criteria to filter the statistics that display in the dashboards.
When you display the gadget, you can specify criteria.
Governance | 291
You open and close lists by clicking the arrow icons on the right.
You can multi-select the items in a list.
Clicking All at the top of each list clears the selection
You can filter the items in a list by typing a string in the text box at the top of the list. Only items that
match the string display. However, the items selected before the list was filtered remain selected even
though they are hidden.
Lists with selections have a bluish background when closed.
Setting Dashboard Preferences

You can set dashboard preferences by clicking the preferences icon in the GUI.
About this task
After upgrading from an earlier 3.1.x version of the product, only those metrics for basic monitoring are
displayed by default. Set the dashboard preferences to view any additional metrics.
Procedure
1. Click
above a dashboard table.
The User Preferences dialog displays.
292 | Governance
2. In the Refresh Interval field, type the time to wait before the statistics are refreshed.
3.
In the accumulator list, select one or more statistics on the right and click
to add them to the display
and select one more statistics on the left and click
4. Click OK.
to remove them from the display.
Drilling Down into Objects

Procedure
1. Choose filter criteria.
2. Click a tab for a runtime object category.
A table of statistics for the object that satisfy the selected filters displays.
3. Double-click a row in the table.
Detailed statistics for the object and the children of the selected object display. For example, if you
double-click a row in the Applications table, detailed statistics for the application and its components,
promoted services and references, and service and reference bindings display.
Dashboard Controls
Dashboard controls allow you to quickly change the dashboard view.
Control
Behavior
Open the preferences dialog.
Minimize a gadget.
Maximize a gadget.
Refresh statistics.
Switch to enterprise graphical view.
Display a previously viewed dashboard.
Governance | 293
Users, Groups, and Permissions

TIBCO ActiveMatrix Administrator supports centralized authentication and authorization.
A user is a person that has an authentication credential. A group is a collection of users. Authorization (or
permission) to access and act upon objects can be assigned to both users and groups. Using Administrator,
a user with the appropriate permissions can define which users and groups should have access to Administrator
features and runtime objects.
Authorization for all runtime objects is provided by the Administrator server. Hence, a server must be running
and connectivity must be available from each node for any kind of management action on the nodes.
Users and groups can be searched for, viewed, and optionally edited. The asterisk wildcard is supported in
all search areas in Users and Groups. The availability of editing functionality depends on the type of
authentication realm you have chosen
Database Realm Read-write access provided within Administrator.
LDAP Realm Read-only access provided within Administrator. Edit functionality must go through the
tools provided by your LDAP vendor.
Users
A user has the following attributes:
User ID Required. A string identifier that is unique within the realm. I18n characters are allowed.
Password Required. A string containing at least one character.
Creating a User
You can create a user from the GUI or by using the CLI.
GUI
Procedure
1. Select Governance > Users & Groups and click the Users tab.
2. Click New.
A user dialog appears on the right.
3. Type the user ID and password in the respective fields.
4. Click Save.
The dialog disappears. The user is added to the list in the Users tab and is selected.
CLI
Procedure
1. In the data file specify a user definition in full format.
<User xsi:type="amxdata:User" username="linda" password="123" />
attribute to User.
<AMXAdminTask action="add" objectSelector="User[@username='linda']" />
294 | Governance
Changing a User Password

You can change your password in the Administrator GUI. You are asked to type in your current password
when you change your password.
Procedure
1.
2.
3.
4.
In the header of TIBCO ActiveMatrix Administrator, click the username (Profile) link.
In the Current Password field, type your current password.
In the New and Confirm Password fields, type the new password.
Click Save.
Resetting a User Password

Users with appropriate permissions can reset the password for users in the system.
About this task
This task can only be performed by superusers and users that have been granted the enterprise permission
Reset Password.
Procedure
1.
2.
3.
4.
5.
Select Governance > Users and Groups .

In the Users table, click a user.
In the right pane, click Reset Password.
In the New and Confirm Password fields, type the new password.
Click Save.
Superusers
A superuser has implicit Owner permission for all objects. Superusers have no security restrictions. They are
allowed to do anything in the system.
Superusers can manage objects that have no owners. For example:
An owner of an object is on vacation, leaves the company, or is otherwise unreachable.
An owner of an object removes himself from the Owner permissions and saves the object. From then on,
the object has no explicit owner.
A group had been granted Owner permission for an object. The group initially had two users. Over a
period of time, the two users left the company, and each one got removed from that group. The object's
permissions were unchanged during this time, but effectively it has no owner.
All superusers are users in the Administrator authentication realm. For example, for the LDAP realm, users
must be present in the LDAP server. If a superuser is deleted from the LDAP server, the user loses superuser
privilege only in the next login session. A current login session still treats the user as a superuser.
Because of the potential for a rogue superuser to vandalize the system, exercise caution when assigning the
superuser role to a user or creating superuser groups.
Contact TIBCO Support to reset the superuser password.
Governance | 295
Assigning Superuser Privileges

Users with appropriate permissions can assign superuser privileges to existing users.
GUI
Before you begin
The user must already exist in the authentication realm.
Procedure
2. Click Superusers.
The Superusers dialog displays.
3. Click Add Users.
The Add Superusers dialog displays.
4. Click users in the list on the left.
Click
.
Holding the left mouse button down, drag to the list on the right, and release the button.
The user is added to the list on the right.
5. Click Save.
The user is added to the list of superusers.
CLI
Procedure
1. In the data file specify a ListOfSuperUser definition in full format.
<ListOfSuperUser xsi:type="amxdata_base:ListOfSuperUser">
<superUser username="linda"/>
<superUser username="tom"/>
</ListOfSuperUser>
attribute to ListOfSuperUser.
<AMXAdminTask
action="add"
objectSelector="ListOfSuperUser"
/>

Removing Superuser Privileges
Users with appropriate permissions can remove superuser privileges from existing users from the GUI or
by using the CLI.
GUI
Before you begin
The user must already exist in the authentication realm.
Procedure
1. Select Governance > Users and Groups .
2. Click Superusers.
The Superusers dialog displays.
296 | Governance
3. Select an user in the list on the left and click

The user is removed from the list.
4. Close the dialog box.
CLI
Procedure
1. In the data file specify a ListOfSuperUser definition in full format.
<ListOfSuperUser xsi:type="amxdata_base:ListOfSuperUser">
<superUser username="linda"/>
</ListOfSuperUser>
attribute to ListOfSuperUser.
<AMXAdminTask
action="delete"
objectSelector="ListOfSuperUser"
/>
Groups
A group is a collection of users. Some authentication realms support group hierarchies.
A group has the following attributes:
Name Required. A string identifier that is unique among all groups. I18n characters are allowed.
Description Optional. A string that describes the group.
Members A list of users that belong to that group. A user may belong to zero or more groups and a group
may have zero or more members.
Group Hierarchy
Groups can exist within a hierarchy. The existence and nature of a group hierarchy depends on the type of
the authentication realm. This section describes the group hierarchy available in each type of authentication
realm.
Database
The Database authentication realm supports a group hierarchy. In the Database realm, groups do not
have a common root element; Administrator allows multiple groups at the root level.
A group can contain zero or more subgroups. A group is either at the root level, or it has one and only
one parent group. The parent-subgroup relationship always implies membership inclusion from subgroups
to parent groups. For example, if the Company Staff group contains the City Staff group, the members of
the City Staff group are also members of the Company Staff group.
LDAP
The LDAP authentication realm supports a group hierarchy as it exists in your LDAP server. A change
in the structure in LDAP is reflected in Administrator, but only after a cache-expiry interval.
Adding Users to Groups
Privileged users can add users to groups from the GUI or by using the CLI. You can add multiple users at
the same time.
GUI
Procedure
Governance | 297
Option
Procedure
Users
1.
2.
3.
4.
Select Governance > Users & Groups and click the Users tab.
Click one or more users.
Click Add Group Membership.
Click one or more groups.
Holding the left mouse button down, drag to the list on the right, and release
the button.
Click
.
5. Click Save.
Groups
1. Select Governance > Users & Groups and click the Groups tab.
2. Click a group.
3. Click Add Users.
Holding the left mouse button down, drag to the list on the right, and release
the button.
Click
4. Click Save.
CLI
Procedure
1. In the data file, specify a Group in base format and User in base format.
<Group xsi:type="amxdata_base:Group_base"
name="sales">
<User xsi:type="amxdata_base:User_base" username="linda"/>
</Group>
attribute to Group/User.
<AMXAdminTask
action="add"
objectSelector="Group/User"/>

Removing Users from Groups
Privileged uses can remove users from groups from the GUI or by using the CLI. Removing the user from
the group is not the same as deleting a user.
GUI
Procedure
Option
Procedure
Users
2. Click a user.
The groups that the user belongs to are displayed in the Groups table.
3. Select the group from this table and click the
Groups
298 | Governance
Option
Procedure
2. Click a group.
The users that belong to this group are displayed in the User pane.
3. Select the group from this table and click the
CLI
Procedure
1. In the data file, specify a Group in base format and User in base format.
name="sales">
<User xsi:type="amxdata_base:User_base" username="linda"/>
</Group>
attribute to Group/User.
<AMXAdminTask
action="delete"
objectSelector="Group/User"/>

Creating a Root Group
If group hierarchies are supported in your authentication realm, you can create a root group from the GUI
or by using the CLI.
GUI
Procedure
2. Click New Root Group.
The group dialog displays on the right.
3. Type the group name and description in the respective fields.
4. Click Save.
The dialog disappears. The group is added to the list in the Groups tab and is selected.
CLI
Procedure
1. In the data file specify a Group definition in full format.
<Group
xsi:type="amxdata:Group"
name="acme">
</Group>
attribute to Group.
<AMXAdminTask
action="add"
objectSelector="Group"/>
Governance | 299
Creating a Subgroup
If group hierarchies are supported in your authentication realm, you can create a subgroup of the root group
from the GUI or by using the CLI.
GUI
Before you begin
A root group must already exist.
Procedure
2. Click a root group.
3. Click New Subgroup.
The group dialog displays on the right.
4. Type the group name and description in the respective fields.
5. Click Save.
The group is added to the list in the Groups tab as a child of the parent root group and is selected.
CLI
Procedure
1. In the data file specify a parent group in base format and child group definition in full format.
name="acme">
<Group xsi:type="amxdata:Group"
name="sales">
</Group>
attribute to Group/Group.
<AMXAdminTask
action="add"
objectSelector="Group/Group"/>

Deleting a Group
Privileged users can delete a group from the GUI or by using the CLI.
GUI
Procedure
2. Select a group or a subgroup.
3. Click Delete.
The selected group is deleted.
CLI
Procedure
1. In the data file specify a Group definition in full format.
Group xsi:type="amxdata_base:Group_base"
name="acme">
<Group xsi:type="amxdata:Group"
300 | Governance
name="sales">
</Group>
attribute to Group.
<AMXAdminTask
action="delete"
objectSelector="Group/Group"/>
Permissions
Permissions constrain the types of actions that a user can perform on an object. The Administrator object
types, environments, hosts, nodes, resource templates, logging appenders, and applications, have permissions
that grant access of a particular type to lists of users and groups. Enterprise-level permissions control whether
a user can manage users and create top-level objects (which are not controlled by the permission settings of
other objects.
Permission Types
There are three types of permissionsView, Edit, and Ownerthat are generally applicable to any type of
object. These permissions allow the following actions:
View Browse objects in a list or view details for an object. Excludes the viewing of object permissions.
Edit
Perform all the actions allowed with View.
Edit the properties of an object.
Add items to a parent object. For example, if a you have Edit permission for an environment, then you
can add a node, application, or any other type of object that belongs to an environment to that
environment. When you add an object, its parents permissions are copied into that new object.
Additionally, you are granted Owner permission for that object.
Owner
Perform all the actions allowed with Edit.
View and modify object permissions.
Delete the object.
In addition to the View, Edit, and Owner permission types, there are object-specific permission types and
enterprise permission types.
Object-specific permission types grant permissions for actions that apply only to specific types of objects. For
example, environments have a Create Node permission type. In order to be able to create nodes in an
environment, a user would require either Edit or Create Node permission for the environment. The ability
to perform runtime actions such as start, stop, install, uninstall, deploy, and undeploy is also controlled by
object-specific permission types. For example, nodes have a Start-Stop permission type.
Enterprise permission types grant permissions for actions that apply to objects whose parent is the enterprise
object. Many Administrator objects such as nodes and resource instances are created under a parent object
that can be created by a user. For example, an environment is the parent of a node. Permissions on user-created
parent objects control who can create new child objects. For example, if you have Edit permission for an
environment, you can create a node in that environment. The parent of other objects, such as environments,
resource templates, and hosts is the enterprise object. The permissions of such objects are managed in the
Enterprise Permissions screen. For example, the permission type to create an environment in the Enterprise
Permissions screen is Create Environment. Enterprise permission types can be granted by superusers.
Governance | 301
Permission States
If you select multiple objects of the same type and open the Permissions screen, the checkbox can take the
following values:
- the selected objects do not grant that permission type to the user or group.
- the selected objects grant that particular type of permission to the user or group.
- at least one of the selected objects grants the permission type to the user or group. For example, if you
select nodes Node1, Node2, and Node3, and appears next to a user in the Edit column, the user might
have been granted Edit permission for Node1 and Node2, but not to Node3.
To change the permission state:
- The first click toggles to . Converting into grants the user or group the chosen permission type
for all selected objects for which the user or group does not have the permission type. If a selected object
already has the permission type, the value doesn't change.
or - Click toggles between the on and off states.

Default Permissions and Permission Propagation
The default permission for any object is no permission.
When you create an object, you are granted Owner permission for the object.
When a child object is created, the View permissions from the parent object are propagated to the child
object. For example, a user that had View permission for an environment will have View permission for
a newly created node in that environment. However, if you change the View permission on the parent
environment at a later time, the change is not propagated to the nodes.
When a group is granted a permission, all the group members, including the members of any child groups
of a parent group, are granted the permission.
When a user is in multiple groups where the groups have varying permissions, the user is granted the
union of all permissions.
Setting Object-Specific Permissions
Privileged users can create object-level permissions by selecting the objects in the GUI.
Procedure
1. Display a list of objects.
2. Click one or more objects in the list.
3. Click
in the list toolbar.
The Permissions dialog displays.
4. Click Add User or Add Group to add a user or group.
A user or group row is added to the table with all checkboxes set to .
5. For a given user or group, check the checkboxes in a permission type column.
6. Click Save.
The selected users and groups are granted the selected permission types for the selected objects and have
unchecked permissions revoked.
Setting Enterprise Permissions
Privileged users can set enterprise permissions. Enterprise permissions are managed separately from object
permissions.
Procedure
1. Select Governance > Enterprise Permissions.
302 | Governance
The Permissions screen displays.

2. Click a tab to configure a permission type.
Create environment, resource template, logging appender, substitution variables. Additional permissions
can configured to access the Force Delete option and the Log Viewer.
The Force Delete option is available when deleting applications, nodes, and resource instances. By
default no user, including root, has permission to access the Force Delete option. You have to explicitly
configure this permission in order to make this menu option visible. Upload DAA option is available
for creating an application and for cleaning application template.
Server register host, upload plug-in, and skip WSDL validation.
User/Group manage groups, manage users, and reset password.
3. Optionally click Add User or Add Group to add a user or group.
A user or group row is added to the table with all checkboxes set to .
4. For a given user or group, check the checkboxes in a permission type column.
5. Click Save.
The selected users and groups are granted the selected permission types for the selected objects.
If you have modified the permissions for the Force Delete option, log out of the Administrator web interface
and log in for the configuration changes to take effect.
Permission Reference
The permission a user is granted determines which actions the user can perform on which object.
To perform an action on an object, you must have been granted at least the minimum level of permissions
indicated in the table.
Table 31: Environments
Action
Minimum Permission Required
Create
Enterprise Permissions:
Create Environment
Delete
Owner
View details
View
Edit details
View
Edit
Promoting or demoting a service

or reference
View, Promote / Demote Service or Reference
Create wire
View
Edit
Promote / Demote Service or Reference
Permission must be granted for both source and target
environments
Governance | 303
Table 32: Hosts

Action
Register
Register Host
Unregister
Owner
Discover
Register Host
View details
View
Edit details
View
Edit
Edit logging configuration
View
Edit Logging Config
Table 33: Resource Templates

Action
Create at global scope
Create Resource Template
Create at environment scope
Environment Permissions:
Create Resource Template
Create at application scope
Application Permissions:
Manage Resource Template
Delete global or environment

scoped resource template
Owner
View, edit, or delete Application

scoped resource template
Application Permissions:
Manage Resource Template
View global or environment scoped View

resource template
Edit global or environment scoped View
resource template
Edit
Table 34: Nodes
Action
Create
Environment Permissions:
View
Create Node
Host Permissions:
View
304 | Governance
Action

Create Node
Delete
Owner
View details
View
Edit details
View
Edit
Install or uninstall
View
Edit
Start or stop
View
Start / Stop
View
Edit Logging Config
Edit features and apply
View
Edit Software
Add and install resource instance View

Create Resource Instance
Download logs
View
Table 35: Resource Instances

Action
Create
Node Permissions:
View
Resource Template Permissions (for global and environment scoped
resource templates):
View
Resource Template Permissions (for application scoped resource
templates):
View
Delete
Node Permissions:
View details
Node Permissions:
View
Install and uninstall
Node Permissions:
Governance | 305
Table 36: Applications

Action
Create
Upload DAA
Environment Permissions (if creating application under environment):
View
Create Application
or
Application folder Permissions (if creating application under application
folder)
View
Create Application
Delete
Owner
View Details
View
Edit properties, binding,

substitution variables, wires
View
Edit
View
Edit Logging Config
Start or stop the application
View
Start/Stop
Distribute application to nodes
View
Edit
Node Permissions:
View
Deploy App To
Upgrade
View
Edit
Skip WSDL validation during

upgrade
Enterprise Permission (in server tab)

Skip WSDL Validation
Deploy or undeploy
View
Deploy/Undeploy
Node Permissions:
Deploy App To
306 | Governance

Action
Create, edit, or delete from the list Enterprise Permissions (for substitution variables at global scope):
of substitution variables
Create SVar
View and Edit permission on the parent object (for substitution variables
at other scopes - environment, host, node, application, app fragment)
View the list of substitution
variables
None (for substitution variables at global scope)

View permission on the parent object (for substitution variables at
other scopes - environment, host, node, application, app fragment)
Table 38: Logging Appenders

Action
View, edit, create, or delete
Create Logger Appender
Table 39: Log Viewer

Action
View or search logs in the logging Enterprise Permissions:

database
Log Viewer
Table 40: Users
Action
Create or delete
Manage Users
Assign to groups
Manage Groups
Reset password
Reset Password
View
None
Table 41: Groups

Action
Create, delete, add, or remove users Enterprise Permissions:

Manage Groups
View
None
Governance | 307
Table 42: DAAs, Features, and Application Templates

Action
Upload DAA
Upload DAA
Add or remove features from nodes Node Permissions:

through Software Management
View
Edit Software
Delete features or application
templates
Upload DAA
308 | Governance
Log Viewer
The Log Viewer allows you to search the log entries stored by a log service. The log service stores the logs
sent from a JMSAppender.
To display the Log Viewer, select Governance > Log Viewer . The Log Viewer contains three areas:
Search Builder A filter area and toolbar. In the filter area, you specify search parameters to filter log
events. In the toolbar you invoke actions to perform searches.
Log A table of log events that satisfy the attribute values.
Log Detail Property sheets that display the details of a log event selected in the Log.
Running Searches
About this task
The Log Viewer supports a flexible approach to running queries. You can run newly constructed or modified
queries.
Procedure
1. Choose a search type.
Search Type
Basic Search
Perform a search based on keywords, time
period, and severity.
Procedure
1. In the Search Builder toolbar, select New Search
Basic Search.
2. Specify keyword, time period, and severity values
to search for.
The search is case sensitive.
Governance | 309
Search Type
Procedure
Advanced Search
1. In the Search Builder toolbar, select New Search

Advanced Search
2. Build a search in the filter area.
Perform a search based on filters constructed

from operations applied to event model
properties.
2. Click the Search button at the bottom of the Search Builder.

A search result summary displays above the search builder
and the Log table is filled with the matching log
entries.
3. Click X to dismiss the search result summary.
Search Builder
The search builder is divided into three areas:
Toolbar Contains actions for minimizing and maximizing the query builder, and building queries.
Event Model control Contains an event model selector and a tree of the attributes available for each type
of event model.
Filter area Contains a canvas displaying the active filters.
Figure 14: Search Builder

Model Area
The Log Viewer allows you to search for and view log events based on different log event models.
By default, the event models shown in Event Model Control are displayed. Only attributes from the currently
selected model are displayed in the attribute tree.
310 | Governance
Figure 15: Event Model Control

To set the model, select the model from the drop-down list.
Filter Area
You create new searches by adding filters to the filter area. Filter Area on page 310 shows the filter area with
the creation time and severity filters.
Figure 16: Filter Area

Creation Time Filter
The Creation Time filter causes log events to be filtered based on when the events were created. You can set
the creation time filter as a relative or absolute time. To set a relative creation time, click the top radio button
and select a time from the drop-down list. To set an absolute creation time, click the bottom radio button and
specify From and To date and times using the respective date and time pickers.
Filter Operators
Some filters allow you to provide an attribute value against which the attribute in log event is compared. For
example, the filter in Filter Area on page 310 shows the = operator selected for the EEF Severity filter. The
Log Viewer supports the operators listed in Filter Operators.
Table 43: Filter Operators
Operator
Description
The attribute value you provide exactly matches (strings) or equals (numbers) the
attribute value in the log event.
Governance | 311
Operator
Description
>=
The attribute value you provide is greater than or equal to the attribute value in the log
event. Available only for EEF Severity and EEF Priority.
<=
The attribute value you provide is less than or equal to the attribute value in the log
event. Available only for EEF Severity and EEF Priority.
CONTAINS
The attribute value you provide contains a substring of the attribute value in the log
event. For example, the value MyContext for a Context ID attribute, matches the
following Context ID values: MyContext, MyContextXXX, XXXMyContextXXX
Adding and Removing Filters

Adding Filters
1. Left-click an attribute in the Event Model control, hold the mouse button down, and release the button in
the filter area.
Removing Filters
Click
next to a filter name.
Event Models
An event model specifies the type of attributes associated with a log event.
The supported event models are:
Base Event Format (BEF) The root of all event formats. It includes the most common attributes of an event.
Engine Event Format (EEF) Adds engine-level attributes to the Base Event Format. This is the default
model.
BW Engine Event Format (BWEEF) Adds BusinessWorks-specific engine attributes to the Engine Event
Format.
Base Event Format Attribute Reference
Attribute
Field Key
Description
Creation Time
_cl.creationTime
The time the log event was created.
Expiration Time
in DB
_cl.expirationTimeInDB
Expiration time (in hours) of log record. Log record

will be automatically purged from db if it expires
from the creation time.
Msg ID
_cl.msgId
Identifier of the log event message.
Msg
_cl.msg
The event message string.
Physical
Component ID
_cl.physicalCompId.key
name
Physical component identifier category. Subcategories

are either generic or identified by a scheme. Contains
a scheme field and fields defined by the scheme.
Generic Physical Component ID A generic physical
component identifier. Contains a scheme field and
up to eight fields defined by the scheme. Used to
search for log events that don't have a scheme or
whose scheme is not supported by the Log Viewer.
For example, an application could specify a
312 | Governance
Attribute
Field Key
Description
Generic Physical Component ID with field1 named
cluster_name and field2 called host_name.
AMX Physical Component ID
An ActiveMatrix physical component identifier.
The ActiveMatrix scheme identifier is amx. The
ID is: amx#environment name#host name#node
name#typeadapter name.
Logical
Component ID
_cl.logicalCompId.key
name
Logical component identifier category. Subcategories

are either generic or identified by a scheme. Contains
a scheme field and fields defined by the scheme.
Generic Logical Component ID A generic logical
component identifier. Contains a scheme field and
up to eight fields defined by the scheme. Used to
search for log events that don't have a scheme or
whose scheme is not supported by the Log Viewer.
AMX Logical Component ID
A TIBCO ActiveMatrix logical component
identifier. The scheme identifier is amx. The ID is:
amx#application#service name#operation name.
Scheme
_cl.logicalCompId.scheme
The logger names type: amx or bw.
Logger Name
_cl.reportingCompId.Value
The name of the destination for the log events.
Class Loader
_cl.reportingCompId.Classloader
The class loader active at the time the event was

logged.
Hierarchy
_cl.reportingCompId.hierarchyName
The hierarchy of entities when the event was logged.
Global Instance
ID
_cl.globalInstanceId
Globally unique identifier of the log event.
Correlation ID
_cl.correlationId
The ID to correlate the context with which the log

event is associated with another context in the same
message exchange.
Location ID
_cl.locationId
A physical address that corresponds to the location

of a component.
Context ID
_cl.contextId
An identifier of the context with which the log event

is associated.
Parent Context
ID
_cl.parentContextId
An identifier of the parent context of the context with

which the log event is associated.
Classifier
_cl.classifier.key
name
A set of name-value pairs. The name and the value

are strings composed of any alphanumeric characters.
Supports searching for log events based on log event
contents. For example, you could search for log
records with the following classifiers:
classifierA: name=PONumber value=0001
classifierB: name=BuyerName value=aBuyer
Governance | 313
Attribute
Field Key
Description
Situation
_cl.situation
The situation that caused the log event to be

generated. For the list of situation types and the
contexts in which the situation type applies, see Table
110.
Security
Principal
_cl.securityPrincipal
The authenticated entity that created the log event.
Situation Types
enumerates the situation types that cause components to log events and describes the Table 44: Situation
Types on page 313contexts in which the situation applies.
Table 44: Situation Types
Situation Type
Description
StartSituation
Deals with the component startup process. Messages indicate that a component
has finished the startup process or that it has aborted the startup process. Existing
messages include words such as: starting, started, initializing, and initialized.
StopSituation
Deals with the component shutdown process. Messages indicate that a component
has begun to stop, that it has stopped, or that the stopping process has failed.
Existing messages include words such as: stop, stopping, stopped, completed, and
exiting.
ConnectSituation
Deals with aspects of a components connection to another component. Messages

indicate that a connection failed, that a connection was created, or that a connection
was ended. Existing messages include words such as: connection reset, connection
failed, and failed to get a connection.
RequestSituation
Deals with the situations that identify the completion status of a request. Typically
these requests are complex management tasks or transactions that a component
undertakes on behalf of a requestor and not the mainline simple requests or
transactions. Existing messages include words such as: configuration
synchronization started and backup procedure complete.
ConfigureSituation
Deals with components identifying their configuration. Any changes that a

component makes to its configuration or that describe current configuration state
should be logged using this category. Existing messages include words such as:
port number ID, address ID, and process ID.
AvailableSituation
Deals with component operational state and availability. Provides a context for
operations that can be performed on the component by distinguishing if a product
is installed, operational and ready to process functional requests, or operational
and ready or not ready to process management requests. Existing messages include
words such as: ready to take requests, online, and offline.
ReportSituation
Deals with the situations reported from the component, such as heartbeat or
performance information. Messages indicate current CPU utilization and current
memory heap size. Existing messages include words such as: utilization value is,
buffer size is, and number of threads is.
CreateSituation
Deals with the situations documenting when a component creates an entity.

Messages indicate a document was created or a file was created. Existing messages
include words such as: was created, about to create, and now exists.
314 | Governance
Situation Type
Description
DestroySituation
Deals with the situations documenting when a component removes or destroys an

entity. Messages indicate that a document was destroyed or a file was deleted.
Existing message include words such as: was created, about to create, and now
exists.
FeatureSituation
Deals with the situations that announce that a feature of a component is ready (or
not ready) for service requests. Message indicate services being available and
services or features being unavailable. Existing messages include words such as:
now available, currently available, and transport is listening on port 123.
DependencySituation
Deals with the situations in which components cannot find some component or
feature that they require. Messages indicate a resource was not found, that an
application or subsystem that was unavailable, or that the expected version of a
component was not found. Existing messages include words such as: could not
find and no such component.
OtherSituation
Provides support for product-specific situations other than the predefined categories.
Engine Event Format Attribute Reference

Attribute
Field Key
Description
Severity
_cl.severity
Priority
_cl.priority
The importance of the event: Low, Medium, or

High.
Thread ID
_cl.threadId
The ID of the thread running the component or

subcomponent that generated the event.
OS Process ID
_cl.OSProcessId
The ID of the operating system process hosting

the engine.
Class Name
_cl.className
The name of the class that implements the engine.
The perceived severity of the status the event is

describing in the context of the application that
reports the event:
Trace All events. Provides finer-grained
informational events as compared to the Debug
level.
Debug Fine-grained informational events used
Info Coarse-grained informational messages
that highlight the progress of the application.
Warn Potentially harmful events.
Error Application errors that allow the
application to continue running.
Fatal Very severe errors that will cause the
process to abort.
BW Engine Event Format Attribute Reference

Attribute
Field Key
Description
Host Name
_cl.hostName
The name of the host hosting the BusinessWorks

engine.
Governance | 315
Attribute
Field Key
Description
Engine
Name
_cl.engineName
BusinessWorks engine name.
Job ID
_cl.jobId
BusinessWorks job ID.
Process
Instance ID
_cl.processName
BusinessWorks process name.
Activity
Name
_cl.activity
BusinessWorks activity name.
Project
Name
_cl.projectName
BusinessWorks project name.
Starter
Name
_cl.starterName
BusinessWorks process starter name.
Tracking
ID
_cl.trackingInfo
BusinessWorks tracking identifier.
Custom ID
_cl.customId
BusinessWorks custom identifier.
Log Table
The log table displays the log events returned from a search.
Configuring Log Table Columns
To configure the columns that appear in the log table:
1.
Click the
icon in the Search Builder toolbar. The column picker will display:
316 | Governance
2. Check or uncheck column names.

3. Click the log.
Paging Through the Log
When a large number of events is returned from a query the log is split into multiple pages. To scroll through
the pages, click the arrows in the page control
below the Log.
Exporting the Log

You can export the log entries to an XML file in CBE format. To export a log, click the Export button in the
Search Builder toolbar. You can export up to 100,000 log entries at a time.
Purging Displayed Logs
You can configure the duration for which the expired logs continue to be displayed. The
cl_logservice_timeinterval property of the log service application specifies the frequency with which
the expired logs are purged from the Log Viewer and deleted from the database. See Setting a Property Value
on page 181.
Alternatively you can the Delete Log Entries button to delete logs. See Deleting Log Entries on page 316 for
more information.
Deleting Log Entries

Procedure
1. Select Governance > Log Viewer.
2. Click the Delete Log Entries button.
Governance | 317
The Delete log entries dialog box displays.

3. Specify the date and time range for which you want to delete the log entries and click the Delete button.
Results
The log entries for the specified time range are deleted.
318 | Governance
Monitoring
Monitoring is a facet of operational governance. Monitoring is supported by a monitoring service, which
aggregates performance data emitted by governed objects and dashboards, which display the data and
provide mechanisms for drilling into the objects. The TIBCO ActiveMatrix monitoring architecture is depicted
in Figure 17: Monitoring Architecture on page 318.
Figure 17: Monitoring Architecture

For information on monitoring and managing your hosts and nodes, refer to
TIBCO_HOME/amx/3.3/samples/hawk/rulebases/readme.txt.
Monitoring Service
The monitoring service and dashboards in TIBCO ActiveMatrix Administrator provide summary and detailed
views into the operational health and performance of your TIBCO ActiveMatrix infrastructure, applications,
and services.
The monitoring service is created when you create an Administrator server. For details, see the installation
manual for your product. The monitoring service is configured with a database for storing performance data
and the notification server that conveys the performance data from runtime objects to the monitoring service.
Basic monitoring provides one hour and since started time periods and a select number of metrics such as
runtime state, requests, faults, response time. These features support advanced performance troubleshooting,
but impose an additional load on the machine on which Administrator runs.
Disabling the Monitoring Service

About this task
To disable a deployed monitoring service:
Procedure
1.
2.
3.
4.
Select Applications.
Select SystemEnvironment from the Environment drop-down list.
Expand the System folder.
Select com.tibco.amx.mcr.aggregator from the Applications list and click Stop.
This stops the processing of messages by the monitoring service.
Governance | 319
5. To stop nodes from sending messages to the queue, add the following property to the .tra file for the node:
java.property.com.tibco.serviceprobe.monitoring.enabled=false. The .tra file for the node is
located in the folder CONFIG_HOME/tibcohost/
Admin-enterpriseName-adminServerName/nodes/nodeName/bin.
What to do next
To ensure that the monitoring service is never deployed, you can disable monitoring when you create the
Administrator server using the TIBCO Configuration Tool. For details, see the installation manual for your
product.
Configuring a Fault Tolerant Monitoring Service

Procedure
1.
2.
3.
4.
Select Infrastructure > Nodes .

In the Environment drop-down list, select SystemEnvironment.
Create, install, and start a node, say AggregatorNode, on which to replicate the monitoring service.
Add and install instances of the following resource templates on the AggregatorNode you created in the
previous step.
TIBCO ActiveMatrix Governance JDBC Resource
TIBCO ActiveMatrix Governance Hibernate Resource
TIBCO ActiveMatrix Governance Teneo Resource
TIBCO ActiveMatrix Governance JNDI Connection Resource
TIBCO ActiveMatrix Governance JMS ConnectionFactory Resource
TIBCO ActiveMatrix Governance JMS Destination Resource
TIBCO ActiveMatrix Governance statistics internal JMS Destination Resource
TIBCO ActiveMatrix Governance statistics JMS Destination Resource
If the notification server is enabled for SSL:
TIBCO ActiveMatrix Governance CSP Keystore for EMS Resource
TIBCO ActiveMatrix Governance SSL Client for EMS Resource
If the database is enabled for SSL:
TIBCO ActiveMatrix Governance CSP Keystore for DB Resource
TIBCO ActiveMatrix Governance SSL Client for DB Resource
5. Make sure the JDBC driver feature is provisioned on the AggregatorNode.

7. In the Environment drop-down list, select SystemEnvironment.
8. Expand the System folder.
9. Click com.tibco.amx.mcr.aggregator .
10. Click the Distribution tab.
11. Distribute the following components to the AggregatorNode.
Aggregator
CLEventParserExtension
StandardPeriodicWindowExtension
StandardAggregateFunctionsExtension
12. Click the Properties tab.
13. Set the allInstancesActive property to true.
320 | Governance
14. Click Save.

15. Click Deploy.
The components are deployed to the selected node. The Runtime State changes to Starting and then
Running.
16. Verify that the replicated monitoring service works:
a) Select Infrastructure > Nodes .
b) In the Environment drop-down list, select SystemEnvironment.
c) Click SystemNode and click Stop.
d) Check the Enterprise Message Service server queue amx.governance.stats for pending messages. For
information on how to check Enterprise Message Service server queues, see TIBCO Enterprise Message
Service User's Guide. If the monitoring service running on the replica node is processing messages, the
pending messages should be should be zero.
Updating the Messaging Configuration

Procedure
2. Edit the resource template Governance JNDI Connection Resource.
3. Apply the change to all nodes by running: ant -f
CONFIG_HOME/tct/admin/timestamp/scripts/build.xml -Denv.name=environmentName
update.monitoring.log.config, where environmentName is the name of each of your environments.
4. Apply the change to the monitoring service Administrator plug-in by running: ant
-f
CONFIG_HOME/tct/admin/timestamp/scripts/build.xml update.mcr.plat.service.log.config .
5.
6.
7.
8.
9.
Select Infrastructure > Hosts.

Click SystemHost and click the Resource Instances tab.
Install the updated resource instance.
Select Shared Objects > Resource Templates.
Edit the following resource templates to modify their descriptions:
Governance JMS ConnectionFactory Resource
Governance JMS Destination Resource
The status of the resources instances changes to Out of Sync.

11. Click SystemHost and click the Resource Instances tab.
12. Install the updated resource instances listed in step 9 on page 320.
14. In the Environment drop-down list, select SystemEnvironment.
15. Expand the System folder.
16. Restart the com.tibco.amx.mcr.aggregator application.
Governance | 321
Metrics Reference
Table 45: Metrics Definitions and Objects
Metric
Object
Description
Basic or
Extended
Status
Host, Node,
The state of a runtime object .
Component,
Component
Instance, Binding,
Binding Instance,
Wire, Reference
Instance, Reference,
Application,
Composite, Service,
Service Instance,
Resource Instance
CPU %
Host, Node
(managed by a
TIBCO Host
instance only)
The % of the CPU time consumed by an object. Basic
CPU Total (ms)
Host, Node
(managed by a
TIBCO Host
instance only)
The total CPU time consumed by an object.
Basic
Memory Used
(bytes)
Host, Node
(managed by a
TIBCO Host
instance only)
The (heap) memory consumed by the object.
Basic
Free Memory
(bytes)
Host, Node
(managed by a
TIBCO Host
instance only)
The available (heap) memory.
Basic
Uptime (ms)
Host, Node,
The length of time the object has been running. Basic
Component,
Component
Instance, Binding,
Binding Instance,
Wire, Reference
Service, Service
Instance, Resource
Instance
Components
Running
Node, Component, The number of components running.

Component
Instance,
Application,
Composite
Basic
Basic
322 | Governance
Metric
Object
% Uptime
Component
The ratio between the length of time an instance Basic
Instance, Binding is running and its lifetime.
Instance, Reference
Instance, Reference
Instances Avail
Component,
The number of instances running.
Binding, Reference,
Service
Basic
Requests
Component,
The number of requests arriving at an object.
Component
Instance, Binding,
Binding Instance,
Application,
Composite, Service,
Service Instance
Basic
Request Rate
Component,
The rate of requests incoming to an object.
Component
Instance, Binding,
Binding Instance,
Application,
Composite, Service,
Service Instance
Extended
Success
Binding, Binding The number of successful responses.

Instance,
Application,
Composite, Service,
Service Instance
Basic
Faults
Binding, Binding The number of fault responses.

Instance, Reference
Application,
Application Folder,
Composite, Service,
Service Instance
Basic
Fault Rate
Wire, Reference
The rate of fault responses.
Application,
Application Folder,
Composite, Service,
Service Instance
Extended
% Success
Component,
The ratio of successful responses to incoming
Component
requests.
Instance, Binding,
Binding Instance,
Application,
Composite, Service,
Service Instance
Basic
Description
Basic or
Extended
Governance | 323
Metric
Object
Description
Basic or
Extended
Req Completed
Binding, Binding The number of responses returned from an

Instance,
object.
Application,
Composite, Service,
Service Instance
Basic
Req Comp Time

(ms)
Component,
The length of time between the arrival of a
Component
request and the generation of the response.
Instance,
Application,
Composite, Service,
Service Instance
Basic
Req Queued for

Comp
Binding, Binding The number of requests that have passed from Extended
Instance,
a service binding to a component
Application,
implementation.
Composite, Service,
Service Instance
Req Comp Finished Binding, Binding

Instance, Reference
Service, Service
Instance
The number of responses returned from a

component implementation. The component
has finished its processing and a response (if
appropriate) is returned to the caller of the
service.
Extended
Avg Comp Proc

Time (ms)
Component,
Component
Instance, Binding,
Binding Instance,
Application,
Composite, Service,
Service Instance
The average length of time between a request

being dispatched to a component
implementation and the response being
returned from the implementation.
Extended
Req Comp Finish

Rate
Binding, Binding The rate of responses returned from a

Instance, Wire,
component implementation.
Reference Instance,
Reference, Service,
Service Instance
Extended
Requests In Queue Component,

The number of requests active between the
Extended
Component
endpoint and the component implementation.
Instance, Binding,
Binding Instance,
Application,
Composite, Service,
Service Instance
Ref Invoc
Component,
The number of requests a component makes to Basic
Component
a referenced service.
Instance, Wire,
Reference Instance,
Reference,
Application,
Composite
324 | Governance
Metric
Object
Description
Ref Invoc Time

(ms)
Component,
The average length of time for a response to be Basic
Component
returned from a referenced service.
Instance, Wire,
Reference Instance,
Reference,
Application,
Composite
Ref Invoc Rate
Wire, Reference
The rate of requests a component makes to a
Instance, Reference, referenced service.
Application,
Composite
Integrate with Hawk ActiveMatrix Plug-in to view the CPU and CPU
Refer to the Hawk ActiveMatrix Plug-in for more information.
Table 46: Basic and Extended Metrics
Object
Basic Metrics
Node
Status
CPU %
CPU Total
Memory Used
Free Memory
Uptime
Components Running
Host
Status
CPU %
CPU Total
Memory Used
Free Memory
Uptime
Resource
Instance
Status
Uptime
Application
Status
Uptime
Components Running
Faults
Success
% Success
Requests
Req Completed
Req Comp Time
Ref Invoc
Ref Invoc Time
Extended Metrics
Fault Rate
Req Completed
Requests In Queue
Request Rate
Req Comp Finish Rate
Ref Invoc Rate
Basic or
Extended
Extended
Total metrics on the dashboard.
Governance | 325
Object
Basic Metrics
Extended Metrics
Component
Status
Uptime
Faults
Success
% Success
Requests
Req Completed
Req Comp Time
Instances Avail
Ref Invoc Time
Fault Rate
Req Completed
Requests In Queue
Request Rate
Avg Comp Proc Time
Ref Invoc Rate
Component
Instance
Status
Uptime
Faults
Success
% Success
Requests
Req Completed
Req Comp Time
% Uptime
Ref Invoc
Ref Invoc Time
Fault Rate
Req Completed
Requests In Queue
Request Rate
Avg Comp Proc Time
Ref Invoc Rate
Promoted
Service
Service
Service Binding
Status
Uptime
Faults
Success
% Success
Requests
Req Completed
Req Comp Time
Instances Avail
Fault Rate
Req Completed
Requests In Queue
Request Rate
Avg Comp Proc Time
Service Endpoint
Status
Uptime
Faults
Success
% Success
Requests
Req Completed
Req Comp Time
Fault Rate
Req Completed
Requests In Queue
Request Rate
Avg Comp Proc Time
Status
Uptime
Faults
Success
% Success
Requests
Fault Rate
Ref Invoc Rate
Promoted
Reference
Reference
Reference
Binding
326 | Governance
Object
Basic Metrics
Extended Metrics
Ref Invoc
Ref Invoc Time
Instances Avail
Reference
Endpoint
Status
Uptime
Faults
Success
% Success
Requests
Ref Invoc
Ref Invoc Time
Fault Rate
Ref Invoc Rate
Service
Operation
Faults
Success
% Success
Requests
Req Completed
Ref Invoc
Ref Invoc Time
Faults
Success
% Success
Ref Invoc
Ref Invoc Time
Fault Rate
Ref Invoc Rate
Service
Operation
Instance
Reference
Operation
Reference
Operation
Instance
Service Binding Faults

Success
Operation
% Success
Service Binding
Uptime
Operation
Requests
Instance
Req Completed
Service Endpoint
Req Comp Time
Operation
Fault Rate
Req Completed
Requests In Queue
Request Rate
Avg Comp Proc Time
Fault Rate
Req Completed
Requests In Queue
Request Rate
Avg Comp Proc Time
Service Endpoint
Operation
Instance
Reference
Binding
Operation
Reference
Binding
Operation
Instance
Faults
Success
% Success
Uptime
Ref Invoc
Ref Invoc Time
Fault Rate
Ref Invoc Rate
Governance | 327
Object
Basic Metrics
Extended Metrics
Reference
Endpoint
Operation
Reference
Endpoint
Operation
Instance
Chapter
13
Logging
The TIBCO ActiveMatrix platform supports a flexible logging architecture that enables runtime objects to log events
to various types of destinations.
The TIBCO ActiveMatrix logging environment is depicted in Figure 18: TIBCO ActiveMatrix Logging Architecture
on page 329.
Figure 18: TIBCO ActiveMatrix Logging Architecture

TIBCO ActiveMatrix runtime objectshosts, nodes, and applicationsuse log4j technology to output log statements
to a variety of output targets. In log4j, a target is called an appender. TIBCO ActiveMatrix supports the following
logging appender types:
clear text file
Common Base Event (CBE) format file
JMS
Events logged to a JMS appender are stored in a database.
In log4j, a logger associates a runtime object with an appender, specifies the types of events to be logged, and
whether to pass messages to a parent logger. In the Administrator web interface, a logger is referred to as a logging
configuration.
A TIBCO ActiveMatrix logging environment involves the following participants:
Log event generator A TIBCO ActiveMatrix runtime object that generates log events. You specify the appender
to which runtime objects send log events in a logging configuration. In Figure 18: TIBCO ActiveMatrix Logging
Architecture on page 329, Node 1 sends message to a JMS appender. Node 2 sends messages to a file and JMS
appenders.
Log event queue A JMS queue to which log event generators can send events.
Log service An application that monitors a log event queue and stores log events to a database.
Payload service An application that manages large payloads associated with log events.
330 | Logging
Log viewer A browser-based server and client UI for viewing log events stored to a database.
Topics
Log Services
Logging Appenders
Payload Services
Creating Additional Log and Payload Services
Logging | 331
Log Services
A log service is a TIBCO ActiveMatrix application that offers logging services.
The log service application com.tibco.amx.commonlogging.logservice.app is deployed in the environment
SystemEnvironment on SystemNode, the node that runs the Administrator server.
A log service receives log entries sent to a JMS destination and stores the entries in a database.
A log service is created when you create an Administrator server. The log service uses the same Enterprise
Message Service server for receiving log messages as the Administrator server uses for receiving notification
messages. You can configure a log service to use the Enterprise Message Service server of your choice. You
can choose to store log data in the same database used by Administrator server or use another database. For
details, see the installation manual for your product.
If the connection to the EMS server is lost, logservice messages and payload service data is stored in the folder
CONFIG_HOME/tibcohost/Admin-enterpriseName-serverName/data_3.2._x/nodes/nodeName/work/clrecovery.
The logservice messages and payload service data is processed when the connection to the EMS server is restored.
Editing Log Service Properties

Edit log service properties to change where log events are sent, the database where log events are stored,
and how often log events are purged from the database.
About this task
To edit log service properties, follow the process in Setting a Property Value on page 181.
Procedure
1. In the Environment drop-down list, select SystemEnviroment.
2. In the Applications list, click com.tibco.amx.commonlogging.logservice.app.
Log Service Property Reference

Name
Type
Description
com.tibco.amx.commonlogging.logservice.app
cl_logservice_teneo
Teneo
The name of the Teneo resource instance to which log entries are
stored.
cl_logservice_jmsDestination JMS Queue The name of the JMS Destination resource instance that represents
the JMS queue to which the log events are sent.
cl_logservice_
jmsConnectionFactory
defaultConnector
JMS
The name of the JMS Connection Factory resource instance that
Connection represents the Enterprise Message Service server that receives log
events.
string
cl_logservice_timeinterval int
(h)
The name of the HTTP Connector used by the Log Viewer. It must
be set to the same value as the HttpInboundConnectionConfig
property.
The frequency with which expired log entries are purged from the
database.
0 - log entries are never purged.
332 | Logging
Name
Type
Description
1 - expired log entries are purged every hour.
Default: 0.
cl_logservice_largeMessages boolean
ToPayload
Indicate whether to save messages larger than 2K to the payload

service.
false - messages larger than 2K are truncated to 2K. The
truncated messages are saved to the log service database. The
original message is discarded.
true -messages larger than 2K are saved into the payload
database. Messages of size larger than 2K are truncated to 2K.
The truncated message is then saved to the log service database.
The original message can be accessed from the payload service
database.
Default: false.
logserviceinstancemanager.soapbinding
HttpInboundConnectionConfig HTTP
Connector
The name of the HTTP Connector resource instance used by the

log service.
payloadservice.soapbinding
HttpOutboundConnectionConfig HTTP
Client
The name of the HTTP Client resource instance used by the log
service.
Logging | 333
Logging Appenders
TIBCO ActiveMatrix runtime objectshosts, nodes, and applicationsuse log4j technology to output log
statements to a variety of output targets. In log4j, a target is called an appender.
TIBCO ActiveMatrix supports the following logging appender types: clear text file, Common Base Event
(CBE) format file, and JMS. Events logged to a JMS appender are stored in a database.
Logging appenders are defined at the enterprise level and can be referenced by multiple logging configurations.
You can create the following types of logging appenders:
File Appends events to a log file.
Clear Text - the log file is stored in clear text format.
CBE - the log file is stored in CBE format.
JMS Appends events to a log service instance, which in turn stores the events to a database.
Default Logging Appenders
The default logging configurations use a file logging appender named nodeName_ROOT whose File Path
property is configured as listed in Table 47: Default Logging Appender File Paths on page 333.
Table 47: Default Logging Appender File Paths
Object
File Path
SystemHost
CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\host\logs\tibcohost.log
Nodes managed by
SystemHost
CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\nodes\nodeName\logs\nodeName
TIBCO Host instance
CONFIG_HOME\tibcohost\instanceName\host\logs\tibcohost.log
Nodes managed by a
TIBCO Host instance
CONFIG_HOME\tibcohost\instanceName\nodes\nodeName\logs\nodeName.log
.log
Creating a Logging Appender

You can create a logging appender from the GUI or by using the CLI. Three types of appenders are supported:
Clear Text File, CBE XML File, and JMS.
GUI
Procedure
1. Select Shared Objects > Logging Appenders.
2. Click New.
The New Logging Appender dialog displays with the drop-down list of the logging appender type
expanded.
3. Select an appender type from the Type list.
JMS Appender - Append events to a log service.
CBE XML File Appender - Appends events to a file in Common Base Event (CBE) format.
Clear Text File - Appends events to a file in clear text format.
The dialog redraws with the appender-specific fields.
334 | Logging
4. Accept the default name or type a name for the appender in the Name field.
5. Fill in the fields and click Save.
The appender is added to the Logging Appenders table and is selected.
Results
CLI
Procedure
1. In the data file, specify the type of the appender in the xsi:type attribute.
File Log Appender
<LogAppender
xsi:type="amxdata:FileLogAppender"
name="HelloWorldFileAppender"
filePath="C:/amx-3admin/tibco/cfgmgmt/tibcohost/Admin-amxadmin-instanceOne/
nodes/DevNode/logs/HelloWorld.log"
maxSize="10000" maxBackupNum="5"/>
CBE File Appender

<LogAppender xsi:type="amxdata:FileLogAppender"
name="myFileLogAppender"
description="This is File LogAppender"
filePath="C:/amx-3admin/tibco/cfgmgmt/tibcohost/Admin-amxadmin-instanceOne/
nodes/DevNode/logs/HelloWorld-CBE.log"
type="cbe"
maxSize="1000"
maxBackupNum="5"/>
JMS Appender without payload support

<LogAppender xsi:type="amxdata:JmsLogAppender"
name="myJmsLogAppender"
description="This is Jms LogAppender without payload support"
jmsConnectionFactoryName="cl_logservice_jmsConnectionFactory"
jmsConnectionName="cl_logservice_jndiConnectionConfig"
jmsDestination="cl_logservice_jmsConnectionDestionation"
type="jndi"
sync="true"/>
JMS Appender with payload support

name="myJmsLogAppender"
description="This is Jms LogAppender with payload support"
jmsConnectionFactoryName="cl_logservice_jmsConnectionFactory"
jmsConnectionName="cl_logservice_jndiConnectionConfig"
Logging | 335
jmsDestination="cl_logservice_jmsConnectionDestionation"
type="jndi"
sync="true"
payloadURL="c:/payloadURL"
sharedDiskURL="c:/sharedDiskURL"/>
LogAppender.
<AMXAdminTask action="add" objectSelector="LogAppender"/>

Results
Refer to Composite Development for information on how to retrieve log entries from the destination queue of
a JMS appender.
Logging Appender Reference

You can create a file appender or JMS appender. For each appender, you specify properties.
File Appender
<LogAppender xsi:type="amxdata:FileLogAppender"
attributeList />
Property

SVars?
Description
File Path
The fully-qualified path to the log file. The filename

component of the path is appended with a number as
described in Max Backup Index.
Pattern
Layout
Controls the format of the log entries for a clear text file
appender. Conforms to the log4j pattern layout.
Default:
"%d{dd MMM yyyy HH:mm:ss,SSS} [%t] [%-5p] %c
%X{_cl.correlationId} - %m%n"
This string prints the date, the name of the thread that
generated the event, the level of the logged event, the
category of the logged event, a correlation ID (an enrichment
field), a message, and a line separator. For example:
17 Dec 2009 16:43:41,250 [Job_Executor2] [INFO
]
com.tibco.amf.hpa.tibcohost.node.TibcoHostNode.IntegrationNode
- Successfully finished processing of RDA
rda6705267566599374829.zip
In addition to the default format, TIBCO ActiveMatrix also

supports the pattern layouts extended with enrichment
fields.
%R{_cl.physicalCompId.matrix.host} %d'{dd MMM
yyyy HH:mm:ss,SSS}' [%t] [%-5p] %c - %m%n
When the CBE file appender is chosen, the appender's layout

is set to BEF2CBELayout, whose pattern is not configurable.
Max File
Size
The maximum size of each log file in kilobytes.
Max
Backup
Index
The number of log files to keep. When a log file reaches the
maximum size, a new log file is created. After the number
of files matches the number specified, the oldest is deleted
336 | Logging
Property

SVars?
Description
when a new file is created. Each file is appended with a
number.
JMS Appender
GUI
Property

SVars?
attributeList />
Description
JNDI
Y
Connection
Factory
A JMS Connection Factory on page 221 resource template.
JNDI
Y
Connection
A JNDI Connection Configuration on page 225 resource

template.
JNDI
Y
Destination
A JMS Destination on page 224 resource template.
Log
N
Message
Expiration
Time (h)
The length of time before a log entry is marked as expired.

Expired log entries are purged from the database according
to the cl_logservice_timeinterval property of the log service.
Payload Logging (optional)

Payload
Logging
Indicate whether payload logging should be enabled. When

checked, the Payload Connection Factory, Payload
Connection, Payload Destination , and Shared Disk URL
fields display.
Default: unchecked.
Payload
Y
Connection
Factory
A JMS Connection Factory on page 221 resource template.
Payload
Y
Connection
A JNDI Connection Configuration on page 225 resource

template.
Payload
Y
Destination
A JMS Destination on page 224 resource template.
Shared
N
Disk URL
(optional)
The complete path to the file where the payload data will
be saved.
If blank, the payload data will be saved to the payload
service database.
Log Entry Enrichment

Upon receipt of a log entry from a log client, the TIBCO ActiveMatrix platform sets enrichment fields that
can be used to augment the log record.
The enrichment fields are set in two locations: LRE and MDC.
Logging | 337
To include an LRE field in the log output, preface the name of the field key surrounded by brackets with
%R in the pattern layout of the simple file appender . For example, %R{_cl.physicalCompId.matrix.host}.
To include an MDC field, preface the field surrounded by brackets in the simple file appender's pattern
layout with %X. For example, %X{_cl.correlationId}.
The following table lists the available enrichment fields and where they are set. All the enrichment fields are
included in CBE file and the JMS appender.
Table 48: Enrichment Fields
Field Key
MDC
Description
_cl.correlationId
ID to correlate the context with which the log

event is associated with another context in
the same message exchange.
_cl.contextId
Context with which the log event is

associated.
_cl.parentContextId
Parent of the context with which the log

event is associated.
Scheme of the physicalCompId format.
_cl.physicalCompId.scheme
LRE
Default: amx3.
_cl.physicalCompId.matrix.env
Environment name. Field1 of the physical

component ID. Scheme must be amx3.
_cl.physicalCompId.matrix.host
Host name. Field2 of the physical component

ID. Scheme must be amx3. Only available on
host logging.
_cl.physicalCompId.matrix.node
Node name. Field3 of the physical

_cl.physicalCompId.matrix.typeadapter
Implementation or binding type name. Field4

of the physical component ID. Scheme must
be amx3.
_cl.logicalCompId.scheme
Scheme of the logicalCompId format.

Default: amx3.
_cl.logicalCompId.matrix.application
Application name. Field 1 of the logical

component ID.
_cl. logicalCompId.matrix.component
Composite or component name. Field 2 of

the logical component ID.
_cl.
Component version.
Component revision.
logicalCompId.matrix.component.version
_cl.
logicalCompId.matrix.component.revision
_cl.logicalCompId.matrix.service
Service name. Field3 of the logical component

ID. Scheme must be amx3.
_cl.logicalCompId.matrix.reference
Reference name. Field3 of the logical

338 | Logging
Field Key
LRE
MDC
Description
_cl.logicalCompId.matrix.operation
Operation name. Field4 of the logical

_cl.securityPrincipal
Value of the security principal if applicable.
_cl.payload.id
_cl.payload.name
Auto-generated file name
_cl.payload.type
Auto-detected mimetype of payload file.
_cl.payload.uri
URI of payload data. This has been

deprecated.
_cl.payload.size
File size of payload file.
_cl.payload.MD5
MD5 value of payload file.
_cl.payload.TTL
Time to leave of payload data. The payload

data will be automatically purged if it's
reached the time to leave. Unit of TTL is
hour.
_cl.payload.data
Binary data of payload file.
Logging | 339
In log4j, a logger associates a runtime object with an appender, specifies the types of events to be logged, and
whether to pass messages to a parent logger. In the Administrator web interface, a logger is referred to as a
A logger is an ancestor of another logger if its name followed by a dot is a prefix of the descendant logger
name. A logger is a parent of a child logger if there are no ancestors between itself and the descendant logger.
For example, com.tibco is a parent of com.tibco.silver. Each host, node, and application can have a logging
configuration and each logging configuration has a root logger. The logging level is specified for each appender
that belongs to a logger. This lets a logger to send logs to different destination with a different level. You can
use the Administrator graphical and command-line interfaces to create loggers and appenders and to add
appenders to existing loggers.
Default Logging Configurations
TIBCO ActiveMatrix nodes log at the WARN level by default. Node level configuration and application level
configuration are independent. However, the node and application levels share a configuration when a root
logger has not been configured for an application. It such a case, the application logging configuration shares
the root logger configuration of the node where part or all the application components run.
To modify the default log configurations for a node, edit
theCONFIG_HOME/admin/amxadmin/private/instanceName/DefaultLogConfiguration.properties file.
Basic and Advanced Mode
Logging configuration setting is available in two modes for hosts and nodes, basic and advanced. The advanced
mode is available for an application when it is not selected to share the node level configuration.
In the basic mode for hosts and nodes, default log level settings for FileAppender and JmsAppender are
available.
In the advanced mode, you can do the following:
Set additivity
Select an appender from a predefined list and set its log level
Create a new appender
Navigating to a Logging Configurations List

Procedure
1.
2.
3.
4.
Navigate to a list of hosts, nodes, or applications.

Select a host, node, or application.
Click the Logging link.
The logging configurations table for the host, node, or application displays.
340 | Logging
Creating a Logging Configuration for an Application

For an application, you can use the logging configuration of the node, or use one of the existing logging
configurations, or create a new logging configuration.
Procedure
2. Select an application.
3. Click Configuration > Logging.
Click the Use the node's logging configuration checkbox, and click Apply and Save.
You can select a new logging configuration by clicking Add.
4. In the Logger Name column, type a logging configuration name or select from the list.
5. In the Additivity column, select an additivity.
6. Click Set Appender.
A row is added to the list.
7. In the Appender column, select an appender from the list.
8. In the Level column, select a logging level.
9. If you want to create a new appender, click New Appender. If not, go to the next step.
New Logging Appender window appears. See Creating a Logging Appender on page 333
10. Click Save and Apply.
CLI
Procedure
1. In the data file specify Logger, AppenderRef, and Appender elements.
<Logger xsi:type="amxdata:Logger" name ="HelloWorldLogger" additivity="false">
<AppenderRef xsi:type="amxdata:AppenderRef" effectivelevel="INFO">
<Appender xsi:type="amxdata_reference:LogAppender_reference"
name="HelloWorldFileAppender/>
</AppenderRef>
</Logger>
2. In the build file set the action attribute of the AMXAdminTask element to add or set and the objectSelector
attribute to Path/Logger, where Path is the navigation path to the logger. For example, to set the logging
configurations for all application loggers in a data file, action is set and objectSelector is
Environment/Application/Logger:
<AMXAdminTask action="set" objectSelector="Environment/Application/Logger"/>
Creating a Logging Configuration for a Host or a Node

You can create a logging configuration for a host or node from the GUI or by using the CLI. Basic Mode and
Advanced Mode are available for setting the logging. In Basic Mode, you can choose a log level for the File
and Jms appender. In Advanced Mode, you have the option to set up a new appender.
GUI
Procedure
1. Click Infrastructure and select Hosts or Nodes.
Hosts or Nodes panel appears with a list.
Logging | 341
2. Select a host or node.

Details of the host or node displays.
3. Click Configuration > Logging.
4. Click Basic Mode or Advanced Mode.
Mode
Procedure
Basic
1.
2.
3.
4.
5.
Click Add. A row is added to the list.

In the Logger Name column, type a logging configuration name.
Select the FileAppender log level.
Select JmsAppender log level.
Click Save And Apply, or Save, or Revert.
Advanced
1. Click Add. A row is added to the list.

2. In the Logger Name column, type a logging configuration name or select from the
list.
3. In the Addivity column, select an additivity.
4. Click Set Appender. A row is added to the list.
5. In the Appender column, select an appender from the list.
6. In the Level column, select a logging level.
7. If you want to add a new appender, click New Appender. If not, go to the next step.
See Creating a Logging Appender on page 333.
8. Click Apply or Save or Revert.
CLI
Procedure
1. In the data file specify Logger, AppenderRef, and Appender elements.
<Logger xsi:type="amxdata:Logger" name ="HelloWorldLogger" additivity="false">
<AppenderRef xsi:type="amxdata:AppenderRef" effectivelevel="INFO">
<Appender xsi:type="amxdata_reference:LogAppender_reference"
name="HelloWorldFileAppender/>
</AppenderRef>
</Logger>
2. In the build file set the action attribute of the AMXAdminTask element to add or set and the objectSelector
attribute to Path/Logger, where Path is the navigation path to the logger. For example, to set the logging
configurations for all application loggers in a data file, action is set and objectSelector is
Environment/Application/Logger:
<AMXAdminTask action="set" objectSelector="Environment/Application/Logger"/>
Applying a Logging Configuration

You can apply a logging configuration from the GUI or from the CLI.
GUI
Procedure
1. Select the object for which logging is being configured.
2. Navigate to a logging configurations list and click a logging configuration.
3. Click Apply.
342 | Logging
Results
The logging configuration is propagated to the object.
CLI
Procedure
1. In the data file specify an Logger definition in full format.
In the following example, the Node element contains a logging configuration for a node named
admin01-node. The logging configuration named com.tibco specifies an appender that logs all Debug,
Info, Warn, Error and Fatal events to a file specified in the logging appender named node_file. The log
messages are passed to the root parent logging configuration.
<Node xsi:type="amxdata:Node" name="admin01-node">
<Logger xsi:type="amxdata:Logger" name="com.tibco" additivity="true">
<AppenderRef xsi:type="amxdata:AppenderRef" effectiveLevel="DEBUG">
<Appender xsi:type="amxdata_reference:LogAppender_reference" name="node_file"/>
</AppenderRef>
</Logger>
</Node>
2. Create a build file. In the AMXAdminTask element set the action attribute to deploy or deployLog and the
objectSelector attribute to Environment/Object, where Object is the object for which logging is being
configured.
<AMXAdminTask
action="deploy"
objectSelector="Environment/Node"/>

The logging configuration is propagated to the object.
Logging Configuration Reference

A logging configuration is modeled with nested Logger, AppenderRef, and Appender elements. The Logger
specifies the name and additivity properties. The AppenderRef element specifies the logging level. The
Appender element references a logging appender.
<Logger xsi:type="amxdata:Logger" name="loggerName" additivity="additivity" >
<AppenderRef xsi:type="amxdata:AppenderRef" effectiveLevel="effectiveLevel">
<Appender xsi:type="amxdata_reference:LogAppender_reference" name="appenderName" />
</AppenderRef>
</Logger>

Property

SVars?
Description
Logger Name

Log Level

TRACE All events.
(FileAppender,
JmsAppender)
Logging | 343
Property

SVars?
Description
continue running.
Additivity
One of:
configuration.
Appender
Table 50: Appender

Property

SVars?
Description
Name
The appenders defined in the enterprise.
344 | Logging
Payload Services
payload service supports archiving, persisting and retrieving large size payload data. It is an independent
service and does not depend on a log service. However, a log record sent to a log service can include a payload
URL field to link a log message and payload data. This is achieved by using the payload API in an application.
A payload service is created when you create an Administrator server. You can choose to store payload data
in the same database used by the Administrator server or use another database. Use the payload API in an
application to store payload data.
Refer Composite Development for information on how to save and retrieve payload data.
Payload Service Properties Reference

You can view the payloads properties from the Applications tab. choose the payload service application and
navigate to the Properties tab.
The following table lists the properties defined for a payload service. For information on modifying the
properties see Setting a Property Value on page 181. N
Name
Type
Description
serverType
string
If the value of this property is db, the payload data will stored in a
database, otherwise the payload data is stored in the file specified by
the fileRootDir property.
teneoSessionFactory
Teneo
Name of the Teneo on page 231 resource instance to which payload

entries are stored.
fileRootDir
string
Path to the file where the payload data is stored.
contextRoot
string
Value must be set to payload.
defaultConnector
string
Name of the HTTP Connector used by the Log Viewer. Must be set to
the same value as the HttpInboundConnectionConfig
jmsConnFactory
JMS
JMS Connection Factory on page 221 resource instance that represents
Connection the Enterprise Message Service server that receives log events.
jmsDest
JMS Queue JMS Destination on page 224 resource instance that represents the JMS
queue to which the log events are sent.
payloadservice.soapbinding
HttpInboundConnection HTTP
Name of the HTTP Connector resource instance used by the payload
Connector service.
Config
Logging | 345
Creating Additional Log and Payload Services

A log service and a payload service are created on the SystemNode node when you create an Administrator
server. If you want to create logs or payload services on other nodes, you can do so explicitly.
About this task
For instructions to deploy the logging and payload services to the SystemNode if they were not
deployed when creating the Administrator server using TIBCO Configuration Tool, refer to
TIBCO_HOME\administrator\version\scripts\logging\readme.txt.
Procedure
1. Create a JMS queue that will be used by the log service and a JNDI name for the queue.
2. Create the resource templates used by the log service. Refer Log Service Property Reference on page 331.
Additionally create the resource templates for the referenced resource instances.
3. Create resource instances for the resource templates created in the previous step. Creating Resource
Instances on Nodes on page 256.
4. Create a new log service application using the log service application template. Creating an Application
on page 122.
5. Distribute the application. Refer Distributing an Application on page 125.
6. Update the properties for the application using the previously created resource instances. Setting a Property
Value on page 181.
7. Deploy the application. Deploying Applications on page 127.
What to do next
Create a payload service using the above procedure. Refer Payload Service Properties Reference on page 344
for the required resource templates.
The log and payload services cannot monitor the same JMS queue. However, more than one log service
can monitor the same JMS queue and store logs to the same database. This feature can be used to achieve
high availability of the log service.
If multiple log services monitor the same queue, the log service data should be saved to the same database.
Similarly, If multiple payload services monitor the same queue, the payload data should be saved to the
same database.
The log and payload services cannot share an HTTP Connector on page 214.
Chapter
14
Secure Communication Channels
The ActiveMatrix platform is partitioned across many components. You can secure the corresponding communication
channels during the initial configuration or later.
ActiveMatrix components communicate with each other and with third-party applications over several
communication protocols. Figure 19: Communication Channels on page 347 illustrates the components and
communication protocols.
Figure 19: Communication Channels

By default, the communication channels are not secure. To secure them, you can configure the channels to use the
Secure Sockets Layer (SSL) protocol. SSL is a cryptographic protocol that provides security and data integrity for
communications over TCP/IP networks.
An SSL client and server negotiate a connection by using a handshaking procedure. During this handshake, the
client and server agree on various parameters to establish the connection's security, as follows:
1. A client requests a secure connection from an SSL-enabled server requesting a secure connection.
2. The server sends back its identification in the form of a digital certificate.
The certificate usually contains the server name, the trusted certificate authority (CA), and the server's public
encryption key.
You can specify the SSL configuration of the communication channels at different times in the life cycle of a
deployment. Table 51: SSL Configuration Summary on page 348 lists how to perform the initial SSL configuration
348 | Secure Communication Channels
and how to upgrade, downgrade, and change the configuration of each channel. The Key column in the table points
to the numbers in Figure 19: Communication Channels on page 347.
Table 51: SSL Configuration Summary
Key
Channel
Initial Configuration
Upgrade, Downgrade, or Change

Configuration
Administrator
server (external
HTTP port) - web
and CLI clients
When creating the Administrator server Upgrade or downgrade: Administrator

in TIBCO Configuration Tool.
CLI
Change SSL configuration:
Administrator CLI
Administrator
server (internal
web UI or CLI
HTTP port) - hosts
and nodes
Administrator web UI or CLI
Administrator
server - Enterprise in TIBCO Configuration Tool.
web UI or CLI
Message Service
server
(Notification Server
and Messaging
Bus)
TIBCO Host
instance - TIBCO
or TIBCO Host instance in TIBCO
CLI
Enterprise Message Configuration Tool.
Service
Administrator CLI
Administrator
When creating the Administrator server Change SSL configuration:
server - external
Administrator CLI
database and LDAP
servers
Administrator
server - hosts and
nodes
(management)
Administrator
-UDDI server
When creating Administrator in TIBCO Upgrade: Administrator web UI or CLI

Configuration Tool.
Administrator CLI
Manually import the UDDI server
Same procedure as initial configuration
certificate into the Administrator server
trust store using keytool.
Enable secure communication in
Administrator web UI or CLI.
Administrator
server (external
HTTP port) TIBCO Business
Studio
Administrator - When creating

Administrator server in TIBCO
Configuration Tool.
TIBCO Business Studio - When you
connect to Administrator.
Administrator Upgrade or downgrade:

Administrator CLI
Administrator CLI
Secure Communication Channels | 349
Key
Channel
Initial Configuration
Resource instances Administrator web UI or CLI

(JDBC, JMS, SMTP,
LDAP, HTTP) external servers
Upgrade, Downgrade, or Change

Configuration
Topics
Trust Stores
Enabling Secure Communication Channels Using Command-Line Scripts
Installing Unlimited Jurisdiction Files
TIBCO Credential Service
Trust Stores
A trust store is a keystore that contains trusted certificates. Each time you configure an external server
connection for SSL, you create and configure a trust store for that connection.
You can create a trust store by using certificates imported from trusted servers or by uploading a keystore
file.
Creating a Trust Store Keystore

You can create a trust store with keytool if you have a trusted public certificate.
Procedure
1. Acquire the public certificate for your server or the root CA certificate authority that signed the certificate.
A root CA is an entity like VeriSign that digitally signs your certificate. The certificate will be in a file with
a special extension such as .pem extension.
2. Use the JDK keytool utility to create a keystore containing the certificate from step 1.
JAVA_HOME\bin\keytool -import -v -trustcacerts -alias MyCert
-file server.cer -keystore MyTrustStore.jks -keypass secret -storepass keystorePassword
Record the values of the keytool options because you must supply them when you upload the trust store
keystore into TIBCO Configuration Tool or Administrator.
Configuring a Trust Store

You can configure a trust store by importing or by creating a keystore and uploading it.
About this task
You can only configure a trust store containing Microsoft SQL Server certificates by the Upload method.
Procedure
1. Choose the method for configuring the trust store and follow the appropriate procedure.
Method
Procedure
Import
1. Click Configure SSL. The Configure SSL wizard displays certificates imported from the
trusted server.
2. In the Certificates list, check the checkboxes next to the certificates to trust and click
Finish.
3. In the SSL Client Provider area, choose one of the following:
Existing SSL Client Provider - Select an SSL Client Provider resource instance.
New SSL Client Provider
1. In the SSL Client Provider Name field, type a name for the SSL Client Provider.
2. In the Keystore Provider as Trust Store field, type the name of a Keystore Provider
resource instance.
3. In the Keystore Password field, type the password that protects the keystore.
4. Click Done.
Upload
1. Create a keystore containing the certificates from the trusted server.

2. In the SSL Client Provider field, click new. In the Name field, type a name.
3. In the Keystore Provider as Trust Store field, click new. In the Name field, type a name.
Method
Procedure
4. Click the Browse button, select the keystore you created in 1.a on page 350, and click
Open.
5. In the Type drop-down list, select JKS.
6. In the Password field, type the keystore password.
7. Click Save for the Keystore Provider.
8. Click Save for the SSL Client Provider.
9.
The SSL Client Provider field is configured.

2. Click Test Connection to verify that the keystore enables an SSL connection.
3. Click Save.
Enabling Secure Communication Channels Using Command-Line

Scripts
You can use CLI scripts to enable secure communication channels for the HTTP connector, external database,
database authentication realm, and LDAP authentication realm.
Before you begin
Edit the file TIBCO_HOMEadministrator/versionscripts/bootstrap-edit-build.properties. Specify
appropriate values for the following properties:
instance.properties.file - the location of the remote_props.properties file.
tibco.config.mgmt.home - the folder containing runtime object configuration, referred to as
CONFIG_HOME.
admin.enterprise.name - the enterprise name.
admin.instance.name - the name of the Administrator server instance.
About this task
Follow these procedures to enable SSL for the listed components.
HTTP Connector
Procedure
1. Edit the data file for the HTTP connector. The file is located at
TIBCO_HOME/administrator/version/scripts/edit-httpconnector-data.xml .
a) Update the serverBaseUrl attribute to point to the correct host and port. Make sure the https prefix
is used.
b) Uncomment the SSLConfig element.
c) Specify valid keystore details.
2. From the command-line prompt, navigate to the TIBCO_HOME/administrator/version/scripts folder.
3. Run the ant script ant -f bootstrap-edit-build.xml edit-httpconnector .
Results
You will see the sequence in which the resources are redeployed. Lastly the SystemNode is restarted.
External Database
Procedure
1. If moving from a different database, use the database specific migration tools to export or import existing
data to the new database.
2. Edit the data file for the application database. The file is located at
TIBCO_HOME/administrator/version/scripts/edit-external-database-data.xml.
a) Uncomment the SSLConfig element and specify valid keystore details.
b) Set the sslJNDIName to the value of the SSLConfig > SSLClientResource > name field.
c) Add the attribute sslJNDIName to the element JdbcResourceTemplate which is a child of
AppDatabaseDetails.
4. Run ant script with command line ant
-f bootstrap-edit-build.xml edit-external-database.
Results
Database Authentication Realm

Procedure
1. If moving from a different database, use the database specific migration tools to export or import existing
data to the new database.
2. Edit the data file for the database realm database. The file is located at
TIBCO_HOME/administrator/version/scripts/edit-authrealm-external-database-data.xml.
a) Uncomment the SSLConfig element and specify valid keystore details.
b) Set the sslJNDIName to the value of the SSLConfig > SSLClientResource -> name field.
c) Add the attribute sslJNDIName to the JdbcResourceTemplate element.
4. Run ant script with command line ant -f bootstrap-edit-build.xml edit-inprocess-database.
Results
LDAP Authentication Realm

Procedure
1. Edit the data file for the database realm database. The file is located at
TIBCO_HOME/administrator/version/scripts/edit-authrealm-ldap-data.xml.
a) Uncomment the SSLConfig element and specify valid keystore values.

b) Make sure the LDAP URL has the ldaps:// prefix.
3. Run ant script with command line ant -f bootstrap-edit-build.xml edit-authrealm-ldap.
Installing Unlimited Jurisdiction Files

Java vendors ship a default set of policy files that do not permit unlimited strength cryptography. In countries
exempt from these restrictions, an unlimited strength set of these policy files can be downloaded and installed.
The default set of policy files typically restricts usage of 192-bit AES, 256-bit AES.
About this task
Follow these steps to install the unlimited strength policy files on site of such key lengths:
Procedure
1. Download the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files from the
JRE vendor.
2. Back up the files located in TIBCO_HOME/tibcojre/jre_version/lib/security.
3. Extract the files you downloaded to TIBCO_HOME/tibcojre/jre_version/lib/security
4. Restart the node and the TIBCO Host instance.
TIBCO Credential Service

The TIBCO Credential Service provides credentials that secure the management connections between the
Administrator server, hosts, and nodes. TIBCO Credential Service runs as a plug-in to the Administrator
server.
The Credential Service acts as a certificate authority and creates a unique identity for each node and host.
The Credential Service is automatically created when you create an Administrator server. For information
on how to specify the properties of the TIBCO Credential Service, see the installation manual for your product.
Chapter
15
Network Configuration
This section provides information on network configuration and port usage.
Topics
IPv6 Support
Port Usage
358 | Network Configuration
IPv6 Support
If an object has a property that can contain an IP address, the address is usually set to the unspecified IP
address (0.0.0.0). That means the object listens on IPv4 and IPv6 addresses. By default clients use the IPv4
address. You can override this behavior so that clients use the IPv6 address.
Prerequisites
Before using an IPv6 supported network, perform the following tasks:
1. Complete all the network configuration changes required for network traffic routing.
2. Enable all physical machines participating in the installation topology for IPv4 and IPv6 addressing in
dual-stack IP implementations.
3. Configure the names of all machines to resolve to at least one IPv4 or IPv6 address.
4. Configure clients to communicate with the servers in one of the following ways:
a. Use explicit IPv4 or IPv6 addresses.
b. Use the addresses returned by the address translation mechanism (DNS or local host files) performed
on the machine name.
IPv6 Address Support
IPv6 addresses are supported by machine names and URLs in the following tools and objects:
Administrator and TIBCO Business Studio wizards and CLI property files
Components that use dynamic wiring
Resource templates
IPv6 Address Representation
IPv6 address representation is described in the IPv6 Addressing Architecture and Format for Literal IPv6
Addressing in URLs specifications, and summarized in Table 52: IPv6 Address Representation on page 358.
Table 52: IPv6 Address Representation
Address Type
Representation
All
Eight fields of four hexadecimal digits, where each field is separated by a colon.
If the field is non-zero there must be at least one digit. For example,
2001:db8:1234:ffff:4354:45ab:3455:ab45. You can apply the following shortening
procedures:
Omit leading zeros in a field. For example, :00db: can be represented as :db:.
Replace one or more consecutive fields of zeros and separators (:0:0:0:0:) with
a single empty field (::). For example, 2001:db8:0:0:0:0:3455:ab45 can be
represented as 2001:db8::3455:ab45.
Localhost or loopback
0:0:0:0:0:0:0:1 or ::1.
Unspecified
0:0:0:0:0:0:0:0 or ::. This address is equivalent to the unspecified IPv4 address

0.0.0.0.
Embedded in a URL
Enclose the address in square brackets ([]). For example, the URL of an
Administrator server running on a machine at the address
FEDC:BA98:7654:3210:FEDC:BA98:7654:3210 is
http://[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]:8120/amxadministrator.
Network Configuration | 359
IP Address Use and Resolution

The default configuration of the Administrator server network adapter is the unspecified IP address (0.0.0.0),
which means that it listens on IPv4 and IPv6 addresses. When clients access the Administrator server by
machine name, the name lookup resolves to both addresses. By default, Administrator clients use the IPv4
address. To override this behavior and use the IPv6 address, set the value of the JVM system property
java.net.preferIPv6Addresses to true. The Nodes chapter in Administration explains how to set a JVM
property for a node.
360 | Network Configuration
Port Usage
The default ports and the mechanism for configuring the ports differ for TIBCO Host instances, Administrator
server, and Enterprise Message Service processes. .
Process
Default
Port
Client
How to Set
SystemHost
6001
Satellite host
6051
SystemNode
6021
SystemHost
DevNode
6031
SystemHost
HTTP connector
8120
Credential Service
6041
Hosts and Administrator server.

Configuration Tool
Enterprise Message
Service
7222 or
7243
TIBCO Host Instances
Enterprise Message Service

configuration file.
Notification server
Administrator servers, nodes, hosts,

monitoring service
Messaging Bus
Applications:
Monitoring service
Logging service
Implementation and binding
types
Product
User-defined
Chapter
16
UDDI Servers
Universal Description, Discovery and Integration (UDDI) is an standard that enables organizations to publish and
discover services using a platform-independent framework. You can configure a UDDI server in Administrator
so that when you deploy an application in Administrator, the service is automatically registered with the UDDI
server.
Topics
Registering an SSL-Enabled UDDI Server

Registering a UDDI Server
Setting the Default UDDI Server
Configuring SSL Communication
Publishing Services in a UDDI Server
References
362 | UDDI Servers
Registering an SSL-Enabled UDDI Server

This task must be completed before registering a UDDI server that is SSL enabled.
About this task
Before registering a UDDI server that is SSL enabled, you must prepare a keystore that has the public certificate
or root CA certificate of the UDDI server that is imported into the keystore as trusted certificate entries. You
can create a trust store by using the keytool provided with a JDK installation and importing your UDDI
server's public certificate or its root CA certificate using -importcert option.
Procedure
1. Edit the file
CONFIG_HOME/tibcohost/Admin-instance/data_version/nodes/SystemNode/bin/tibamx_SystemNode.tra
to add the following SSL-related properties:

java.property.javax.net.ssl.trustStore=/keystore/example/path/my_truststore.jks
java.property.javax.net.ssl.trustStoreType=JKS
java.property.javax.net.ssl.trustStorePassword=secret
Change the keystore path, type, and password to match your trust store. Both trustStoreType and
trustStorePassword are optional while trustStoreType defaults to JKS. When specified
trustStorePassword only serves for a checksum validation of the trust store.
2. Restart the SystemNode for the properties to take effect.
3. If the ActiveMatrix Administration is replicated, then repeat Step 1 and 2 for the replicated nodes.
Wait for the Administration UI to display.
4. Use the Administrator to register a UDDI Server that is SSL enabled.
UDDI Servers | 363
Registering a UDDI Server

You can register a UUDI service from the GUI or by using the CLI.
Before you begin
To register a UDDI server that is SSL enabled, you must first register an SSL enabled UDDI server.
About this task
If you plan to enable secure communication between the Administrator server and the UDDI server, you
must first configure SSL communication between the two servers.
GUI
Procedure
1. Select Infrastructure > Servers.
2. Select UDDI from the View drop-down menu.
3. Click New.
The New Server dialog displays.
4. In the Name field, type a name for the server.
5. Select a server type from the UDDI Server Type drop-down list.
If you select TIBCO, the UDDI URLs will be set to those for TIBCO ActiveMatrix Registry Runtime UDDI
Server. If you pick Other, you can edit the UDDI URLs. You cannot change the UDDI server type after
you create it.
6. Complete the server configuration fields. The username and hostname cannot be modified after creation.
7. If the Administrator and the UDDI server are not on the same machine, and you want to enable secure
communication between the servers, check the Secure Communication checkbox to enable SSL connections.
8. Click Test Connection to verify the connection to the server.
9. Click Set as Default UDDI Server to use the server as the default UDDI server.
10. Click Save.
CLI
Procedure
1. In the data file, specify an server element in base format.
<target name="GetUDDIServers" description="List all registry server configurations">
<AMXAdminTask
remote="true"
propsFile="${instanceProperties}"
action="getUDDIServers"
objectSelector="declare namespace
amxdata_uddi='http://tibco.com/amxadministrator/command/line/types_uddi';
amxdata_uddi:UDDIPlugin"
overwrite="true"
merge="true"
force="true"
</target>
364 | UDDI Servers
2. In the build file, set the action attribute of the AMXAdminTask element to xxx and the objectSelector
attribute to yyy.
<target name="AddUDDIServer">
<add
serverName="SOAUDDI" businessName="BusinessTest"
uddiUsername="admin" uddiPassword="admin"
default="true" autoPublish="false"
inquiryUrl="http://hostname:port/uddi/services/inquiry"
publicationUrl="http://hostname:port/uddi/services/publication"
securityUrl="http://hostname:port/uddi/services/security"/>
</target>
<target name="UpdateUDDIServer">
<update
serverName="SOAUDDI" businessName="BusinessTest"
default="true" autoPublish="true"
inquiryUrl="http://hostname:port/uddi/services/inquiry"
publicationUrl="http://hostname:port/uddi/services/publication"
securityUrl="http://hostname:port/uddi/services/security"/>
</target>
UDDI Servers | 365
Setting the Default UDDI Server

You can set the default UDDI server from the GUI.
Procedure
1.
2.
3.
4.
5.
Select Infrastructure > Servers.

In the View drop-down list, select UDDI.
In the Servers list, click a UDDI server.
Click Set as Default UDDI Server.
Click Save.
366 | UDDI Servers
Configuring SSL Communication

You can configure SSL communication between Administrator and the TIBCO ActiveMatrix Registry Runtime
UDDI Server.
About this task
For further information on configuring SSL in TIBCO ActiveMatrix Registry Runtime UDDI Server TIBCO
ActiveMatrix Registry Runtime UDDI Server, see
http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html#SSL_and_Tomcat
Procedure
1. Open a command window in UDDI_HOME/tibcojre/VERSION/bin.
2. Generate a keystore with alias TAMRUS:keytool -genkeypair -alias TAMRUS -keyalg RSA -keystore
.keystore -storepass password -dname "CN=YourName, OU=YourName, O=Engineering, L=YourCity,
ST=YourState, C=YourCountryCode"
3. In TIBCO_HOME/RuntimeUDDIServer/version/server/conf/server.xml replace:
<Connector port="58080" protocol="HTTP/1.1" connectionTimeout="20000" />
with
Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true"
maxThreads="150" scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS" keystoreFile="./.keystore" keystorePass="password"/>
4. Export the TAMRUS certificate: keytool

-storepass
-exportcert -alias TAMRUS -keystore .keystore
password -file TAMRUS.cert
5. Import the TAMRUS certificate into the Administrator server trust keystore: keytool
-importcert
-alias TAMRUS -file TAMRUS.cert

-keystoreTIBCO_HOME/tibcohost/3.3/templates/admin.default.ssl.trust.store.ts -storepass
secret
$ keytool -importcert -alias TAMRUS -file TAMRUS.cert -keystore
TIBCO_HOME/tibcohost/1.2/templates/admin.default.ssl.trust.store.ts -storepass secret
Owner: CN=YourName, OU=YourName, O=Engineering, L=YourCity, ST=YourState, C=YourCountryCode
Issuer: CN=YourName, OU=YourName, O=Engineering, L=YourCity, ST=YourState, C=YourCountryCode
Serial number: 4ba255a3
Valid from: Thu Mar 18 17:32:35 CET 2010 until: Wed Jun 16 18:32:35 CEST 2010
Certificate fingerprints:
MD5: 4D:B0:EE:FC:A2:72:A0:6E:4C:13:BD:8E:F12:90:06
SHA1: B99:5A:6D:15:53:BA:DC:63:AB:70:89:61:2C:C3:DA:1C:FA:EB:E3
Signature algorithm name: SHA1withRSA
Version: 3
Trust this certificate? [no]: yes
Certificate was added to keystore
UDDI Servers | 367
Publishing Services in a UDDI Server

You can manually publish UDDI services and edit tags associated with the services.
Before you begin
Configure a UDDI server.
About this task
If you configure the UDDI server with Automatic Publication, services are automatically published when an
application is deployed. The Apply Changes to UDDI Server button is enabled when the application is
deployed.
Procedure
3. Click the UDDI Publication tab.
If you have configured a UDDI server, the services exposed by the application display in the Services list.
Otherwise, click Configure a new UDDI server to configure the server.
4.
To edit the tags associated with the service, in the Tags column, click
.
Add - Type a name in the Tag Name field, a value in the Value field, and click Add.
Edit - Click
, select a tag name, and edit the value in the Value field.
Delete - Click next to a tag value.
5. Choose an action:
Check the Publish checkbox to publish the service.
Uncheck the Publish checkbox to delete the published service.
The pending actions are listed in the last column of the Services table.
6. In the Publication Business drop-down list, optionally select the business or type a new business in which
to publish the service.
If you do not provide a business, the business selected when the UDDI server was created will be used.
If you type a business name and the business was already created by a different user, Administrator
throws an exception when you apply the changes. Change the permission of the existing business to allow
you to publish the service to the business. Refer to your UDDI server documentation for managing
permissions.
7. If you want to configure multiple services with different settings, click Save.
8. Click Apply Changes to UDDI Server, where UDDI Server is the name of the default UDDI server.
Saves the changes in the database and applies the changes to the UDDI server.
368 | UDDI Servers
References
UDDI Server Reference

Details
Property

SVars?
Description
Name
Name of the UDDI server.
Description N
Description of the UDDI server.
Automatic Y
Publication
Indicate whether deployed services are automatically

registered in the UDDI server. When you set the server as
default UDDI server, you can define if all deployed services
are automatically publish or not. If you select this option,
all services are published by default. If you don't select this
option, you must manually publish the services.
Set as
Default
UDDI
Server
Indicate whether a UDDI server is the default server to

which services should be published.
Server Configuration
Property

SVars?
Description
Hostname/IP Y
Hostname or IP address of the UDDI server. For CLI,

hostname or IP and port are deduced from the Inquiry URL.
Port
Port of the UDDI server.
Username Y
Administrator username for the UDDI server.
Password Y
Administrator password.
UDDI
Server
Type
Type of the UDDI Server.
Server URLs
Inquiry
URL
URL to which to send inquiry requests.
Publish
URL
URL to which to send publish requests.
Security
URL
URL to which to send security requests.
Publication Y
Business
Business to which the services will be published. You can

type a business or select one from the drop-down list. If the
UDDI Servers | 369
Property

SVars?
Description
business name does not exist it is added to the server. Only
the businesses that belong to the user will be shown.
Run ant
-fCONFIG_HOME/admin/enterpriseName /samples/uddi_amx_servermngt.xmlcommand
, where
command is:
GetUDDIServers
AddUDDIServer
RemoveUDDIServer
UpdateUDDIServer
The properties used by the script are defined in

CONFIG_HOME/admin/enterpriseName/samples/uddi_amx_servermngt_data.properties.
Application UDDI Publication Reference

Property

SVars?
Description
Service
The services exposed by the application.
Tags
Publish
Indicates whether the service should be published or

unpublished when the Apply changes button is clicked.
Publication N
Status
The publication status.
Changes/Pending N
Actions
The pending changes and actions.
Run ant
-f uddi_amx_pubmngt.xml
The number of tags associated with the service. Click

to open a tag editor.
target where target is:
GetOrCreatePubs: List the service publication configuration.

UpdatePubs: Update configuration, such as unpublish a service, add a tag, and so on.
ApplyPubs: Publish into or unpublish from registry.
The properties used by the script are defined in
TIBCO_CONFIG_HOME/admin/enterpriseName/samples/uddi_amx_pubmngt_data.properties.
Chapter
17
NodeUtil
The NodeUtil utility is used to remove components where attempts to undeploy or force undeploy an application
does not remove the components from the node's runtime.
A typical sequence for this use case:
1. Undeploy or force undeploy an application using the Administrator UI or CLI command. The application
components should be removed from the node's runtime.
2. Delete the application using the Administrator UI or CLI command. The application and it's components should
be removed from the Administrator database.
3. If either of the above steps fail, use the force delete option using the Administrator UI or CLI command to
remove the application and it's components from the Administrator database.
4. Use the nodeutil to remove the application components from the node's runtime.
The nodeutil -removeApplication command removes components and endpoints of an application.
However, it does not remove resource instances with scope defined to an application. In cases where an
application has scoped resource instances, they need to be removed explicitly using OSGi console.
When using this utility for updating the dependency metadata for components, use it only when the component
instance is not visible from the Administrator UI. When a component instance is not visible from the Administrator
UI, any upgrade of dependent components would leave the component instance in a Waiting for dependency
state. A typical sequence for this use case:
1. Find the URI of the component dependency before and after the upgrade.
2. Shut down the runtime node. This can be done from Administrator UI or CLI command or the tibcohost
command.
3. Use the nodeutil utility to update the dependency for the component.
4. Start the node. Verify that the component is no longer in the Waiting for dependency state.
Topics
Invoking the NodeUtil Utility

NodeUtil Commands
372 | NodeUtil
Invoking the NodeUtil Utility

You can use the NodeUtil utility interactively or non-interactively.
About this task
The utility is installed in the TIBCO_HOME\amx\version\bin\nodeutil folder.
The utility can be used in these modes:
1. Interactive - run the command nodeutil
The utility enters an interactive shell where you execute the nodeutil commands.
Use the help command for a list of available commands.
2. Non-interactive - run the command
nodeutil command -nodeName nodename -tibcoHostInstanceFolder foldername, where
command is the command to execute. See NodeUtil Commands on page 373 for the available commands.
nodename is the node on which you ant to execute the command.
foldername is the path to the tibcohost instance.
Use help commandName for information on a specific command.
See NodeUtil Commands on page 373 for details of the supported commands.
NodeUtil | 373
NodeUtil Commands
The NodeUtil utility includes commands for information display and to remove components and endpoints.
Table 53: NodeUtil Commands
Command
Description
Arguments
version
Displays the utility version.
none
validateNodeConfig
Validate a node configuration,

All standard nodeutil command
displaying any error and optionally arguments.
repairing them. The caller must
-repair
provide a node name.
Global Commands
This command is only

relevant for platform
versions 3.1.x and associated
hotfixes.
validatePlatformFeatureVersion
Validate that a node's platform

feature version is correct for its node arguments.
type, displaying any errors. This
command is only relevant for
platform versions 3.1.2 and 3.1.3 and
associated hotfixes.
howlLogReader
Examines the transactions logs of a

node for active transactions. The full
arguments.
path to the HOWL log directory for
a node has to be specified.
-howlLogDirectory path
-txLogNum integer
-txLogSize integer
-activeTransactionsFile path
-tibcoHostInstanceFolder
-nodeName
NodeUtil Commands
NodeUtilCommands
Common arguments for all nodeutil -configFile

commands.
-tibcoHostInstanceFolder
-nodeName
-stackTrace
Component Commands
removeComponents
Removes components from the

specified application from the
specified node.

arguments.
-applicationName
374 | NodeUtil
Command
Description
Arguments
-version
-includeEndpoints
-dryRun
This is the complete path to the
TIBCO Host instance folder.
removeEndpoints
Removes endpoints from the

specified applications from the
specified node.
Ensure that the node is shut
down before calling this
command to avoid server
errors. The command does
not verify that the node is
shut down.
listComponents
Lists components of the specified

application for the specified node.
-applicationName
-version
-dryRun
-nodeName nodename
tibcoHostInstanceFolder path
-applicationName
-version
-includeEndpoints
-nodeName nodename
listEndpoints
Lists endpoints for the specified

application for the specified node.
-applicationName
-version
-includeEndpoints
-nodeName nodename
listObsoleteComponents
Lists obsolete components from the

-nodeName nodename
specified node.
removeObsoleteComponents
Removes obsolete components from

-dryRun
the specified node.
-nodeName nodename
NodeUtil | 375
Command
Description
Arguments
updateDependency
Updates the dependency of

-oldDependency
components for the specified node.
-newDependency
-nodeName nodename
exportComponents
Export components from an

application from a node.
shut down.

arguments.
-applicationName
-version
-toFile
-printFolder
-dryRun
importComponents
Import components into a node.

arguments.

-fromFile
-dryRun
shut down.
removeApplication
Remove components and endpoints All standard nodeutil command

from an application in a node.
arguments.
Ensure that the node is shut -applicationName
-version
errors. The command does -dryRun
shut down.
updateDependencies
Automatically find missing

dependencies and update them for arguments.
all affected components on a node.
-applicationName
Components for which the
-version
dependencies are updated will be
listed.
-dryRun
Command Loop commands

getConfiguration
Displays the current configuration. none

All subsequent commands without
explicit overrides use this
configuration.
376 | NodeUtil
Command
Description
Arguments
changeConfiguration
Changes the configuration used to -tibcoHostInstanceFolder

access a node. All subsequent
-nodeName nodename
commands use this configuration
information to access the node.
exit
Exits the command loop.
none
The nodeUtil.tibcoHostInstanceFolder and nodeUtil.nodeName properties can be specified in

a configuration file. If such a configuration file is used, additionally specify the -configFile
configfilename argument.
Example:
nodeUtil.tibcoHostInstanceFolder=TIBCO_HOME/data/tibcohost/Admin-amxadmin-instanceOne
nodeUtil.nodeName=DevNode
Appendix
A
Troubleshooting
Administrator
The Runtime State of applications is Lost Contact or Unknown
If the Runtime State column of applications is Lost Contact or Unknown, the connection to theEnterprise
Message Service server acting as the notification server and Messaging Bus has been lost.
Action History is stuck at In Progress
An Action History column stuck at In Progress could indicate that:
One or more of the pending tasks in the dialog that displays when you click the Action History link have
failed, most likely due to lost communication with the notification server. The tasks will not be re-queued
even after the notification server starts up.
A node involved in that action is unavailable. When the node becomes available, the action will execute
and complete.
Failure to reconnect to the notification server
Restart the server if you see the following message after you try to reconnect to the notification server:
Refresh Status Cache action failed , caused by:
com.tibco.tibems.qin.TibQinRecoveryException: Connection to the
server is failed, caused by: Connection to the server is failed,
caused by: Session is closed
Notification Server URL needs to be changed manually

When the configured notification server fails, add another available notification server manually to the
notification.xml file in the TIBCO host configuration folder. This will enable the TIBCO host to restart.
However, the Administration UI continues to display the old notification server URL. Use the following steps
to correct it:
1. Select Admin Configuration > Admin Server.
2. Change the Notification Server URL to the one you added to the notification.xml file and Save
3. Click Reconnect to EMS Server.
Action History shows Paused Offline
This means that actions in Administrator are queued up while runtime objects are offline and executed when
they comes back online.
Recover from network outages or IP address changes
The IP address of the machine on which the Administrator server is running could change due to DHCP
reconfiguration if the machine is connected to a new network after being created. To recover from
communication errors that can arise from the change in IP address:
1. Stop all nodes managed by the SystemHost TIBCO host instance.
2. Stop the SystemHost TIBCO host instance.
3. If the machine on which the Administrator server is running also hosts the Enterprise Message Service
server, restart the Enterprise Message Service server.
378 | Troubleshooting
4. Start the SystemHost TIBCO host instance.

Reconnect to EMS Server after Restarting the QIN EMS Server
Actions such as Deploy, Undeploy, Start, or Stop after the QIN EMS server crash results in Error Queing
Task. After the QIN EMS server is restarted, go to Admin Configuration > Admin Server > Transport
Configurationand click Reconnect to EMS Server for the Administration action function.
Improve the Administrator UI response time
Create an index on the TASK table to increase the Administrator UI response time.
For example, if using the Microsoft SQL server create the index using the statement CREATE
ON task (objectURI,queueURI).
INDEX index-name
Administrator Host instances

tibcohost.exe doesn't start
Ensure tibcohost.tra is in the same folder.
Ensure the Java classpath in the tra file is updated for your environment. tibcohost is automatically
configured to use the JRE version that is installed with the product.
Ensure your Java version is at least JRE 1.6.0_14, which is required because of a bug in the Java IO
implementation on Windows.
If you see an exception while starting a TIBCO Host instance that looks like this:
C:\amx\tibcohost\1.0\instances\TibcoHostInstance\HPAInstance\bin>
tibcohost [TibcoHost - START] [INFO ]
com.tibco.amf.hpa.tibcohost.runtime.TibcoHost - No running TibcoHost instance
found on localhost. [TibcoHostInstance] [ERROR]
com.tibco.amf.hpa.tibcohost.runtime.TibcoHost TIBCO-AMX-TIBCOHOST-RUNTIME-103: TibcoHost: TIBCO ActiveMatrix host
pingz-t400_TibcoHostInstance failed to start. Cause
com.tibco.tibems.qin.TibQinException: Connection to the server is failed.
Check your Enterprise Message Service server configuration, especially if you installed Enterprise Message
Service on Windows.
2009-12-17 15:09:49.954
Storage Location: 'datastore'. 2009-12-17 15:09:49.954 Routing is disabled.
2009-12-17 15:09:49.954 Authorization is disabled. 2009-12-17 15:09:49.972
Accepting connections on tcp://pingz-t400:7222. 2009-12-17 15:09:49.972
Recovering state, please wait. 2009-12-17 15:09:49.975 Server is active.
2009-12-17 15:26:01.026 WARNING: [admin@pingz-t400]: create subscriber failed:
not allowed to create dynamic topic
[EMSGMS.UnboundHost_amxadmin.132ba2cc_1259ef65268_-80000a699217]. 2009-12-17
15:26:01.564 WARNING: [admin@pingz-t400]: create subscriber failed: not allowed
to create dynamic topic
[EMSGMS.UnboundHost_amxadmin.132ba2cc_1259ef65268_-80000a699217]. 2009-12-17
[EMSGMS.UnboundHost_amxadmin.7f68b7a6_1259ef68ea8_-80000a699217]. 2009-12-17
[EMSGMS.UnboundHost_amxadmin.7f68b7a6_1259ef68ea8_-80000a699217]. 2009-12-17
[EMSGMS.UnboundHost_amxadmin.-5e8ec58d_1259ef71a70_-80000a699217]. 2009-12-17
[EMSGMS.UnboundHost_amxadmin.-5e8ec58d_1259ef71a70_-80000a699217].
In this case you likely have an invalid Enterprise Message Service configuration, which was created
automatically by the Enterprise Message Service installer on Windows. To fix this, run the installer of Enterprise
Message Service and replace the installer filled default ProgramData with a valid folder. The installer does
not create missing folders and therefore Enterprise Message Service does not work properly.
Troubleshooting | 379
Disable notifications for the host and the nodes.

To disable notifications for the host and the nodes, delete the CONFIG_HOME/tibcohost/
Admin-enterpriseName-adminServerName/host/configuration/notification.xml file.
Memory guidelines for the SystemNode for enterprises with a large number of nodes.
When many nodes restart at the same time, such as after a power failure, the SystemNode will be flooded
with messages and will temporarily need increased heap memory to handle this load. The maximum heap
size should be set to handle peak load. Giving a heap size of 3G (-Xmx3g) will accommodate simultaneous
messages from around 400 nodes hosting user applications. If your enterprise has more nodes, then the
maximum heap memory size should be appropriately increased.
TIBCO host shows erratic behavior after waking up from hibernation
Sometimes the tibcohost process runs into problems with communicating with its nodes. This happens when
the machine was hibernated or suspended and woken up afterwards. The management connections do not
always reinitialize properly leaving the connection 'hanging'. Only a restart can solve this issue, but tibcohost
may not be able to properly shut down the node processes.
Another effect is the problem of the connection to the notification server not initializing properly after the
wakeup from hibernation. This is especially true when the wakeup is performed in a different environment
from the hibernation. For example, hibernate in the office, wakeup at home. In this case, the IP address changes
upon wakeup, which causes communication problems with connections relying on the TCP/IP stack in Java.
Avoid wakeup in a different environment or restart with the new IP address.
Is TIBCO Host instance connected to the right node process?
With the problem described in the preceding section, it can happen that a node process sticks around long
after control is returned to the TIBCO Host instance. If the instance is either restarted or it is told to start the
node again, it may immediately connect to the older node process that is in the process of shutting down.
To verify that the TIBCO Host instance is connected to the correct node process, it prints out the node process
unique identifier when it successfully connected. This UUID can be compared to the UUID printed in the
node process log file upon startup. Since the UUID is unique for every run, it becomes easy to verify the
correctness of the connection.
Node process log:
[DEBUG] control.internal.FrameworkImpl - framework is starting with UUID
116295c6-adea-472d-9655-1d6e305a1959
TIBCO Host instance log:

[DEBUG] ProxyImpl.AMXAdministratorNode - reached node
AMXAdministratorNode_116295c6-adea-472d-9655-1d6e305a1959
When installing a TIBCO Host instance and some nodes on remote systems you have to make sure that they
are properly connected via the network. The instance and the node will try to reach the Enterprise Message
Service server on the configured port (7222 per default) and for this it is necessary that the port is enabled on
the firewall. Especially on Windows systems this port may be blocked by default.
The same problem will occur when the node is trying to reach Administrator. Make sure that the connector
is configured on an interface that is reachable over the network and the port is unblocked on the firewall.
TIBCO Host instance or node does not come up on remote systems
When installing a TIBCO Host instance and some nodes on remote systems you have to make sure that they
are properly connected via the network. The instance and the node will try to reach the Enterprise Message
Service server on the configured port (7222 per default) and for this it is necessary that the port is enabled on
the firewall. Especially on Windows systems this port may be blocked by default.
The same problem will occur when the node is trying to reach Administrator. Make sure that the connector
is configured on an interface that is reachable over the network and the port is unblocked on the firewall.
Nodes
Node runs out of memory (Java heap space)
When this occurs, configure the node JVM to dump a snapshot of the heap by editing the .tra file of the node
and adding the following argument to java.extended.properties:
-XX:HeapDumpPath=file
where file is the name of the file in which the binary heap dump will be written. The dump file can then be
analyzed offline by profiling tools.
The .tra file of the node is located in the folder CONFIG_HOME/tibcohost/
Admin-enterpriseName-adminServerName/nodes/nodeName/bin.
Node does not start
Look at the following places to analyze the problem:
Check the log file of the node for exceptions
Check the node-stdout.log file of the instance for exceptions and unusual error messages, which may
indicate a problem
Check the Equinox log file, which is always written to <nodename>/configuration/123....log. Every start
of the node process produces a new version of the file. Check for exceptions.
Bundles cannot be started. The likely causes are a Java.lang.ClassNotFoundException in the Equinox log file
indicates a fatal condition in the node, which prevents it from starting up. For example:
!ENTRY
com.tibco.trintiy.server.credentialserver.common 4 0 2009-05-21 11:06:05.186
!MESSAGE !STACK 0 org.osgi.framework.BundleException: The activator
com.tibco.trintiy.server.credentialserver.jmx.Activator for bundle
com.tibco.trintiy.server.credentialserver.common is invalid at
org.eclipse.osgi.framework.internal.core.AbstractBundle.loadBundleActivator(AbstractBundle.Java:146)
at
org.eclipse.osgi.framework.internal.core.BundleContextImpl.start(BundleContextImpl.Java:980)
at
org.eclipse.osgi.framework.internal.core.BundleHost.startWorker(BundleHost.Java:346)
at
org.eclipse.osgi.framework.internal.core.AbstractBundle.resume(AbstractBundle.Java:355)
at
org.eclipse.osgi.framework.internal.core.Framework.resumeBundle(Framework.Java:1074)
at
org.eclipse.osgi.framework.internal.core.StartLevelManager.resumeBundles(StartLevelManager.Java:616)
at
org.eclipse.osgi.framework.internal.core.StartLevelManager.incFWSL(StartLevelManager.Java:508)
at
org.eclipse.osgi.framework.internal.core.StartLevelManager.doSetStartLevel(StartLevelManager.Java:299)
at
org.eclipse.osgi.framework.internal.core.StartLevelManager.dispatchEvent(StartLevelManager.Java:489)
at
org.eclipse.osgi.framework.eventmgr.EventManager.dispatchEvent(EventManager.Java:211)
at
org.eclipse.osgi.framework.eventmgr.EventManager$EventThread.run(EventManager.Java:321)
Caused by: Java.lang.ClassNotFoundException:
com.tibco.trintiy.server.credentialserver.jmx.Activator at
org.eclipse.osgi.framework.internal.core.BundleLoader.findClassInternal(BundleLoader.Java:483)
at
org.eclipse.osgi.framework.internal.core.BundleLoader.findClass(BundleLoader.Java:399)
at
org.eclipse.osgi.framework.internal.core.BundleLoader.findClass(BundleLoader.Java:387)
at
org.eclipse.osgi.internal.baseadaptor.DefaultClassLoader.loadClass(DefaultClassLoader.Java:87)
at Java.lang.ClassLoader.loadClass(ClassLoader.Java:251) at
org.eclipse.osgi.framework.internal.core.BundleLoader.loadClass(BundleLoader.Java:315)
at
org.eclipse.osgi.framework.internal.core.BundleHost.loadClass(BundleHost.Java:227)
at
org.eclipse.osgi.framework.internal.core.AbstractBundle.loadBundleActivator(AbstractBundle.Java:139)
Node does not stop after the TIBCO Host instance stop -wait true has completed
Occasionally, you will find that it takes several minutes for the node processes to finally disappear.
Unfortunately, this may or may not be a problem and requires a closer look almost every time. In most cases,
it is a normal behavior and can be explained like this:
The node process runs an OSGi framework. There are many concurrent activities in separate threads that
interact during the shutdown sequence. These include Springframework Timers, Framework Event
Dispatcher, Startlevel Thread, custom extenders from TIBCO and from customers.
Each thread is competing for the same shared resources (CPU, IO). Depending on the overall load of the
system (operating system), it may take some time for threads to be scheduled and proceed. Because of
interdependencies, this may cause a delay of the overall shutdown sequence
During shutdown, the Activator.stop() method is called for every bundle if present. Any long running or
CPU/IO intensive operation performed in that implementation stalls the overall shutdown procedure.
Therefore, it is essential to keep this implementation short and quick.
As a last item of work before ending the process, the OSGi framework (Equinox in our case) persists the
current state of the runtime to the disk. This includes bundles and wiring information. Depending on the
number of bundles in the runtime and the availability of IO cycles, this operation may take a long time
(i.e. > 1min) to complete. It is essential not to disrupt this procedure or else the runtime state may get
corrupted and the node may not come up and function as expected.
With all or most of the possible reasons for the delays listed above, there is still the possibility of a problem
with the node itself. Any process that hangs around for an excessively long time, that is, > 5min should be
examined carefully. To diagnose the issue you can open the node log files and look at the end for where the
node may have gotten stuck. A typical run ends with statements similar to this:
11 Feb 2010 18:07:08,412 [Event Dispatcher] [DEBUG] control.internal.FrameworkImpl com.tibco.commonlogging.cbe.model stopped
11 Feb 2010 18:07:08,412 [Framework - sync] [INFO ] control.internal.FrameworkImpl - Sync
thread ends.
11 Feb 2010 18:07:08,413 [Bundle Shutdown] [DEBUG] control.internal.FrameworkImpl removing node.lck
11 Feb 2010 18:07:08,482 [Bundle Shutdown] [INFO ] stdout - Restoring STDOUT
11 Feb 2010 18:07:08,482 [Bundle Shutdown] [INFO ] stdout - Restoring STDERR
11 Feb 2010 18:07:10,968 [shutdown thread] [INFO ] control.internal.FrameworkImpl - exiting
process!
11 Feb 2010 18:07:10,971 [Shutdown] [INFO ] org.mortbay.log - Shutdown hook executing
11 Feb 2010 18:07:10,971 [ Shutdown] [INFO ] org.mortbay.log - Shutdown hook complete
Node cannot be removed

This problem only exists on Windows systems and has to do with file locking. If you see a message like this
in the tibcohost.log file:
AMXAdminHost 26 Feb 2010
14:35:22,458 [Job_Executor10] [ERROR]
com.tibco.amf.hpa.tibcohost.runtime.TibcoHostInstance - error removing node
"node2": error preparing for delete by renaming
C:\MatrixDevInstall\tibcohost\1.0\instances\TibcoHostInstance\Nodes\node2 to
C:\MatrixDevInstall\tibcohost\1.0\instances\TibcoHostInstance\Nodes\node2.tmp0
then Java code tries to delete a folder for which another process: Windows Explorer, a text editor open with
a log file, or even the node process has a lock. On Windows systems, those locks have to be removed before
the node folder can be deleted.
The tool is very helpful in finding the processes that keep holding the lock.
The entire directory tree of the node folder must be unlocked.
TIBCO host takes a long time to start up on Linux platforms.

This may happen intermittently and is not always reproducible. The pseudo-random number generator needs
to be seeded with truly random bits. Reads from /dev/random device will wait until there's data to return
and in case of insufficient entropy the wait can last for a long time (many minutes). To confirm that the problem
is due to seeding of pseudo-random number generator, run kill -QUIT pid or kill -3 pid. The stacktrace
should include com.sun.SeedGenerator. For truly random seed bits, run the daemon rngd which reads from
a hardware device and inserts verified random entropy bits to /dev/random. If fast start is more important,
switch to /dev/urandom which does not wait for random bits but reuses already returned bits. Alternatives
include:
Add the line {{java.properties.java.security.egd=file:/dev/./urandom}} to tibcohost.tra.
The .tra file of the host is located in the folder CONFIG_HOME/tibcohost/
Admin-enterpriseName-adminServerName/host/bin.
Edit $JAVA_HOME/jre/lib/security/java.security and replace securerandom.source with
securerandom.source=file:/dev/./urandom.
Errors when starting a node in a replicated environment if an external URL used for load balancing.
If an external port is used for load balancing during replication, using the Administrator UI add to the
SystemNode and SystemNodeReplica a logging configuration named org.mortbay.log with a logging
appender systemnode_root with the Level set to ERROR.
Thread blocks are observed at java.security.SecureRandom with higher concurrence
Secure random behavior if securerandom.source pointing to /dev/random when the entropy pool is emply
1. Stop the node.
2. Modify the files as mentioned below:
Add the following property to java.securities file at TIBCO_HOME/tibcojre64/1.6.0/lib/security.
securerandom.source=file:/dev/./urandom
Add the following property to the node tra file (appended to java.extended.properties)
Djava.security.egd=file:/dev/./urandom

Applications
Application deployment failures caused by resource instance failures
When deploying an application, ActiveMatrix Administrator automatically installs resource instances if there
are resource templates with scope to the application. If the resource template installation fails, then application
deployment also will fail. For example, if the HTTP connector has a port conflict, it fails to start. For HTTP
Connector port conflicts use substitution variables to assign different port numbers for each node to avoid
port conflicts. Then uninstall the application and redeploy it.
Unable to revert to older version of an application
Issue
A version 1 of an application is deployed. Then the application is upgraded to version 2 with new features with
backward-compatible WSDL for the services provided by the application. After upgrading to version 2, the
application fails. The user is prevented from reverting back to version 1 of the application due to incompatible
WSDL changes. While the user is able to upgrade the application from version 1 to version 2, the user is unable
to downgrade from version 2 to version 1.
Workaround
1. Log in to ActiveMatrix Administrator as a super user.
2. Go to Governance > Enterprise Permissions.
3. Select Server.
4. Grant Skip WSDL Validation permission to the user who tired to revert back to the older verison of an
application.
5. Click Save.
After the above step, the user can now try to downgrade the application.
1. Log in to ActiveMatrix Administrator and attempt to downgrade the application.
2. In the dialog box, check Skip WSDL validation this time to allow reverting to a previous version.
3. Click Save.
Application is downgraded without WSDL validation error.
4. Click Deploy.
You can also skip WSDL validation using the CLI option skipWsdlValidation for upgrade.app target.
<target name="upgrade.app" description="Upgrade Existing Application">
action="upgrade" dataFile="${basedir}/appupgrade626-V2.deployment-config.xml"
createIfNotExists="true" force="false" failOnError="true" options="skipWsdlValidation"/>
</target>
Resource Templates
HTTP connecter Acceptor Thread Count changed from 1 to 20
When HTTP Connector is changed from Blocking IO Socket to Non-Blocking IO Socket using the Advanced
tab, the acceptor threads count in the General tab automatically changes to 1. However, HTTP Connector
instance shows 20 threads when you check the threads in the node VM using jvisualvm or similar tool.
Issue
1. Shared Objects > Resource Templates
2. Create a new HTTP Connector resource template with Blocking IO Sockets with an instance.
3. Set the Acceptor Thread Count to -20.
4. Click Advanced tab.
5. Check the Use Non-Blocking IO Sockets box and Save.
6. Click Yes to reinstall the resource instance.
Now, the Acceptor Thread Count is changed to 1 and the Save button is enabled.
8. Check the thread in the node VM.
It shows 20 threads for the HTTP Connector instead of 1.
Workaround
1. Click General and click Save.
2. Click Yes to reinstall the resource instance.
The Acceptor Thread Count now shows 1 in the node VM for the HTTP Connector instance.
Users of KeyStore provider fail to detect KeyStore refreshes
Users of KeyStore Provider such as Identity Provider, Trust Provider, and Mutual Identity Provider initialize
at startup with credentials obtained from the KeyStore. However, they fail to detect future KeyStore refreshes.
In order to avoid any service failures, perform the following procedure:
1.
2.
3.
4.
5.
6.
7.
Stop dependent services.

Stop Subject, Trust, and Mutual Identity providers that supply the credentials.
Stop KeyStore provider that supplies the KeyStore containing the credentials.
Change login credentials of external system.
Change the credentials in the ActiveMatrix Administrator's hosted KeyStore.
Restart the KeyStore Credential and Subject, Trust, and Mutual Identity providers.
Restart the dependent services.

Tib Amx Administration

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Tib Amx Administration

Uploaded by

Copyright:

Available Formats

TIBCO ActiveMatrix Service Bus

TIBCO ActiveMatrix Service Bus Administration

Chapter 2 Administrator Interfaces................................................29

Chapter 3 Administrator Server Management..............................55

TIBCO ActiveMatrix Service Bus Administration

Administrator Configuration Reference..................................................................................60

TIBCO ActiveMatrix Service Bus Administration

Chapter 8 Resource Templates.....................................................185

Chapter 9 Resource Instances.....................................................255

TIBCO ActiveMatrix Service Bus Administration

Chapter 10 Substitution Variables................................................269

Chapter 11 Software Management...............................................275

Chapter 14 Secure Communication Channels............................347

TIBCO ActiveMatrix Service Bus Administration

TIBCO Credential Service....................................................................................................355

Chapter 15 Network Configuration...............................................357

Chapter 16 UDDI Servers..............................................................361

Invoking the NodeUtil Utility..................................................................................................372

TIBCO ActiveMatrix Service Bus Administration

TIBCO ActiveMatrix Service Bus Administration

TIBCO Product Documentation

TIBCO ActiveMatrix Service Bus Administration

Other TIBCO Product Documentation

TIBCO ActiveMatrix Service Bus Administration

TIBCO ActiveMatrix Service Bus Administration

bold code font

Bold code font is used in the following ways:

Italic font is used in the following ways:

Table 2: Syntax Typographical Conventions

An optional item in command syntax.

| param2} {param3 | param4}

TIBCO ActiveMatrix Service Bus Administration

TIBCO ActiveMatrix Service Bus Administration

Connecting with TIBCO Resources

TIBCO ActiveMatrix Service Bus Administration

TIBCO ActiveMatrix Service Bus Administration

TIBCO ActiveMatrix Service Bus Administration

Logical View of the Enterprise

TIBCO ActiveMatrix Service Bus Administration

Figure 1: Logical View

Physical View of the Enterprise

TIBCO ActiveMatrix Service Bus Administration

Figure 2: Physical View

TIBCO ActiveMatrix Service Bus Administration

TIBCO ActiveMatrix Service Bus Administration

TIBCO ActiveMatrix Service Bus Administration

TIBCO ActiveMatrix Service Bus Administration

Figure 3: TIBCO ActiveMatrix Administrator

Logging in to the Web Interface

TIBCO ActiveMatrix Service Bus Administration

Click List View

A tree list has the following interactions:

TIBCO ActiveMatrix Service Bus Administration

By default, each level is always in alphabetical order (ascending A-Z).

Displaying the Graphical View

TIBCO ActiveMatrix Service Bus Administration

Choose Infrastructure > Enterprise Graphical View

Re-size the boxes to display detailed information.

TIBCO ActiveMatrix Service Bus Administration

If wiring a service to a reference, double click the FreeWire option.

4. Wire the components.

1. When wiring a service to a reference, the service expands to display its

TIBCO ActiveMatrix Service Bus Administration

Not Deployed - before an application is deployed.