Concepts
Important Information
TIBCO Documentation and Support Services
Introduction
Challenges of Service Delivery
Design
Design Activities
Runtime
Runtime Overview
Hosts
Nodes
Features
Resource Templates
Resource Instances
Administration
Overview of ActiveMatrix Administrator
TIBCO ActiveMatrix Administrator
Enterprise
Environments
Messaging Bus
Governance
Identity Management
Policy Management
Service Components
Composites
Components
Component Implementation
Services and References
Interfaces
Bindings
Properties
Message Exchange Patterns
Java Components
Composite Components
Mediation Components
WebApp Components
Spring Components
REST Bindings
TIBCO ActiveMatrix Policy Director Governance
Advantages over Hard-Coded Policies
Features
High-Level Architecture
Policy Director Governance Administration
Governance Agent
Policy Distribution Engine
Policy Enforcement
Policy Enforcement Point Identifiers
Order of Action
Governance Agent's Merge Behavior
Governance Definitions and Concepts
Governance Controls
Governance Control Templates
Governed Object
Object Groups
Shared Resources
Policy Enforcement Host
Policy Enforcement Point
Policy Decision Point
Policy Action
Policy Runtime Store
Policy Error
Policy Conflict
TIBCO Service Performance Manager
Components
TIBCO Enterprise Message Service Server
TIBCO Service Performance Manager Server
Database
Dashboard
Example Business Scenario
Essential Definitions
Project Life Cycle
Development Tutorials
Important Information
TIBCO Documentation and Support Services
Basic SOA Design Tutorials
Policy Tutorials
Configuring the ResourceInstance Attribute in an External Policy
Preparing an Application that Injects Resource Instances into Policies
Composite Development
Important Information
TIBCO Documentation and Support Services
TIBCO Business Studio
TIBCO Business Studio Configuration
Target Platforms
Displaying the Target Platform
Creating a Target Platform File
Setting the Target Platform
Platform Installation
Setting the Platform Installation
Platform Installation Reference
Starting TIBCO Business Studio
Accessing TIBCO Business Studio Help
SOA Projects
Special Folders
Enabling and Disabling Special Folders
Versions
WSDL Files
Renaming a Port Type
Validation
Validating WSDL and Schema Files Referenced by a Composite
Disabling Validation
Resolving Validation Rule Violations
Creating an Empty SOA Project
Creating a Basic SOA Project
Creating a SOA Project from WSDL Files
Creating an SOA Project from an Implementation
Finding out the Version of TIBCO Business Studio Using which a Project was Created
Enabling "TIBCO SOA Platform Extension"
Legacy Projects
Migrating Legacy Projects
Migration Reference
Composites
Creating a Composite
Setting Composite Diagram Preferences
Adding an Element to a Composite
Popup Toolbars
Palette
Application Modularization
Run Configuration Reference
Running and Debugging a Composite
Creating a Run Configuration
Running a Composite
Run Configuration Reference
Creating a Debug Configuration
Debugging a Composite
Setting Breakpoints
Removing Breakpoints
Configuring Breakpoints
Controlling Composite Execution
Debug Configuration Reference
Terminating a Configuration
Composite Reference
Components
Creating a Component
Changing the Implementation Type of a Component
Configuring a Components External Custom Feature
Component Reference
Services and References
Interfaces
Adding a Service or Reference to a Component
Adding a Service or Reference to a Composite
Promoting a Component Service or Reference
Static and Dynamic Wiring
Creating a Static Wire Between a Service and a Reference
Configuring a Reference for Dynamic Wiring
Service Reference
Reference Reference
Bindings
Viewing Service and Reference Bindings
Adding a Binding to a Service or Reference
SOAP Bindings
SOAP Binding Reference
Fault Messages
WS-Addressing
Endpoint References
Message Addressing Properties
Validation and Fault Handling
Configuring the Action Property
Enabling WS-Addressing
Generating a Concrete WSDL File
WSDL Generation Reference
Generating a SOAP Request
WS-Reliable Messaging
Enabling WS-Reliable Messaging
REST Bindings
JMS Bindings
JMS Binding Reference
Context Parameters
Creating Context Parameters
Mapping Context Parameters to Header Fields
Context Parameter Reference
Enabling Transactions in SOAP and JMS Bindings
Policy Management
Policies
Governed Objects
Intents
Configuring Intents
Intents Reference
At Least Once Intents
At Most Once Intents
Authorization Intents
Client Authentication Intents
Consumer Confidentiality Intents
Consumer Integrity Intents
Credential Mapping Intents
Managed Transaction Intents
Prepare Before Undeploy Intents
Provider Confidentiality Intents
Provider Integrity Intents
Secure Virtualization Intents
Start Services First Intents
Transacted OneWay Intents
Policy Sets
Displaying the Policy Sets Picker
Configuring Policy Sets
Editing Embedded Policy Sets
Creating an External Policy Set
Configuring External Policy Sets with XML
Embedded Policy Sets Reference
JMS At Most Once
JMS At Least Once
JMS Transacted OneWay
Managed Transaction
Message Transmission Optimization Mechanism (MTOM)
Prepare Before Undeploy
Secure Virtualization
Start Service First
Threading
Virtualization At Least Once
Virtualization Transacted OneWay
Virtualize
Never Virtualize
WS-Addressing for References
WS-Addressing for Services
WS-Reliable Messaging
Policy Templates Reference
Policy Template to Intents Reference
Authorization By Role Policies
Basic Authentication Policies
Basic Credential Mapping Policies
Basic Or Username Token Authentication Policies
SAML Authentication For SSO Policies
SAML Credential Mapping For SSO Policies
Username Token Authentication Policies
WS-Security Consumer Policies
WS-Security Provider Policies
Transactions
Managed Global Transactions
Transacted OneWay Transactions
Resource Templates
Resource Instances
Creating a Resource Template
Opening a Resource Template
Finding References to a Resource Template
Renaming a Resource Template
Resource Templates Reference
Resource Templates With Scope
Changing the Scope of a Resource Template
Modifying Resource Templates to Install Multiple BPM Environments
Application Deployment Patterns
Hibernate
HTTP Client
JDBC
Configuring Third-Party JDBC Drivers
JMS Resource Templates
Configuring Third-Party JMS Drivers
JMS Connection Factory
JMS Destination
JNDI Connection Configuration
JMS Destination Configuration
LDAP Connection
Security Resource Templates
Identity Provider
Kerberos Identity Provider
Keystore Provider
Keystores
Creating a Keystore With a Username and Password
SSL Client Provider
SMTP
Thread Pool
Teneo
Properties
Creating a Property
Promoting a Component Property
Setting the Value of a Binding Property
Setting the Value of a Composite Property
Setting the Value of a Component Property
Setting the Value of a Resource Template Property
Creating an Obfuscated Password
Properties Reference
Substitution Variables
Creating a Substitution Variable
Creating a Substitution Variable File
Finding References to a Substitution Variable
Renaming a Substitution Variable
Custom Features
Creating a Custom Feature
Finding References to a Custom Feature
Renaming a Custom Feature
Configuring Plug-ins
Configuring Feature Dependencies
Configuring Excluded Custom Feature Dependencies
Custom Feature Reference
Shared Libraries
Bundles and Plug-in Projects
Creating a Library Plug-in Project
Distributed Application Archives
Packaging a Composite in a DAA
Packaging a Custom Feature in a DAA
Regenerating a Distributed Application Archive Containing a Composite
Generating and Verifying Derived DAAs
Distributed Application Archive Specifications
Qualifier Replacement
Distributions
Creating a Distribution
Editing a Distribution
Creating a Distribution Template
Applications
Creating, Deploying, and Starting an Application
Stopping, Undeploying, and Deleting an Application
Debugging Deployed Applications
Checking Remote Debugger Status
Creating a Debug Configuration
Launching a Debug Configuration
Attaching a Debugger to a Running Application
TIBCO ActiveMatrix Administrator
Deployment Servers
Creating a Deployment Server
Connecting to a Deployment Server
Editing Deployment Server Properties
Refreshing a Deployment Server
Disconnecting from a Deployment Server
Deployment Server Reference
Administrator Explorer View
Displaying the Administrator Explorer View
Administrator Command-Line Interface
Understanding Build Files
Understanding AMXAdminTask
Actions Performed Using CLI
Understanding Data Files
Understanding Objects
Object Formats
Property File Reference
Generating an Administrator Command-Line Interface Script
Script Configuration
Administrator Connection Configuration
Application Configuration
Distribution
Property Configuration
Wiring Configuration
Running Administrator Command-Line Interface Scripts
TIBCO Business Studio Command-Line Interface
Running a TIBCO Business Studio Command-Line Interface Script
TIBCO Business Studio Command-Line Reference
TIBCO Business Studio Command-Line Task Reference
Logging
Application Logging
Message Flow Logging
Logging Payload Reference
IPv6 Support
Java Component Development
Important Information
TIBCO Documentation and Support Services
Java Components
Creating a Java Component
Configuring a Java Components Implementation
Updating a Java Component
Configuring a Java Components Custom Feature
Upgrading a Java Component
Component Feature Dependencies
Java Component Reference
Java Component Implementations
Data Binding
Generating XML Data Binding Classes
Data Binding Classes for Abstract and Concrete WSDL Files
XML Data Binding Reference
Opening a Java Component Implementation
Generating a Java Component Implementation
Generate Java Component Implementation Reference
Regenerating a Java Component Implementation
Upgrading a Java Component Implementation
Life Cycle Events
Component Context
Accessing a Property
Accessing a Resource
Accessing a Hibernate Resource
Accessing a JDBC Resource
Accessing JMS Resources
Accessing LDAP Connections
Accessing SMTP Connections
Accessing a Teneo Resource
Invoking an HTTP Request
Invoking a Reference Operation
Error Handling
SOAPException Reference
Context Parameters
Working with Context Parameters
Endpoint References
Retrieving an Endpoint Reference
Creating an Endpoint Reference
Custom Features
Bundles and Plug-in Projects
Configuring Dependencies on External Java Classes
Versions
Converting Migrated Java Component Implementations
Creating an Abstract Class
Editing a Manifest
Regenerating a Component Implementation
Removing 2.x Data Binding JAR Files
Correcting Custom Feature File
Default XML to Java Mapping
Mediation Component Development
Important Information
TIBCO Documentation and Support Services
Introduction to Mediation
Mediation Flows
Message Exchange Patterns
Mediation Flow Interfaces
Planning Target and Mediation Interfaces
Paths in a Mediation Flow
Mediation Tasks
Mediation Exchange
Designing Mediation Flows
Working with Mediation Flows
Starting the Mediation Flow Wizard
Creating a New, Empty Mediation Flow
Creating New Mediation Flows from Existing Web Services
Editing Mediation Flow Editor Preferences
Working with Mediation Flow Properties
Validation of Message
Adding a Mediation Flow Property
Deleting a Mediation Flow Property
Working with Interfaces
Adding Interfaces to Mediation Flows
Deleting Interfaces from Mediation Flows
Moving Mediation Interfaces
Using the AutoMediate Feature
Creating Local WSDL Files
Supported Policies
Working with Mediation Paths
Changing Mediation Paths
Deleting Mediation Paths
Working with Message Context Properties
Context Parameters
Mediation Context Parameters
Undeclared Fault Headers
Context Parameters in Mediation Components
Adding Context Parameters
Deleting Context Parameters
Defining the Scope of Context Parameters
Working with Exchange Variables
Defining Exchange Variables
Setting Exchange Variable
Creating Simple Schemas
Working with Tasks
Adding a Task to a Path
Deleting a Task From a Path
Mediation Components
Invoking an Operation
Configuring Invoke Operation Tasks
Logging Mediation Exchange Information
Mediation Appenders and Loggers
Configuring a Log Task
Routing Messages in a Mediation Flow
Paths and Route Tasks
Defining a Route
Adding Routing Cases
Specifying Case Targets in the Decision Table
Modifying Case Names
Modifying Destinations
Moving Cases in the List
Deleting Cases
Nesting Multiple Route Tasks
Adding and Deleting Variables
Mapping Data to Variables
Routing Conditions
Editing Route Task Conditions
Conditions for XPath Route Tasks
Changing Route Tasks to XPath Route Tasks
Transforming Tasks
Example of Transformation
Basic Mapping
Using XPath Editor
Data Contribution to the Mediation Exchange
External Stylesheets for Data Transformation
Specifying an External Stylesheet for Data Transformation
Schema Components
Context Panel
Message Panel
Data and Function Tabs
TIBCO XPath Functions
Creating Custom XPath Functions
Exporting Custom XPath Functions
Deploying Custom XPath Functions
Testing Custom XPath Functions
Mapper Toolbar Buttons
Right-Click Menu in the Message Panel
Surrounding a Component With a Choose Statement
If Statements
For Each Statements
Adding a Variable to a Mapping
Managing Mappings
Repairing Incorrect Mappings
Mapping an Empty Complex Type
Using XPath
Transforming XML with Related Tasks
Querying a Database
JDBC Resource Templates
Defining a Resource Template
Configuring a JDBC Driver
Registering a JDBC Driver
Configuration Tabs of the Query Database Task
Dynamic Requests
Service Providers for Dynamic Composite References
Configuring Dynamic Binding
Configuring Dynamic Target Interfaces
Pattern Variables Usage
Dynamic Reference Task Setting
General Tab Configuration
Input Specification
Configuring Dynamic References in Composite
Creating and Deploying Composites Used By Dynamic Binding
Replying to Messages
Fault Processing in a Mediation Flow
Throwing Faults in Mediation Flows
Fault Paths
Catch Fault Configuration
Catching Faults from the Mediation Flow
Sending Faults to the Invoker
Custom Mediation Tasks
Eclipse Plug-in Reference
Support Files
Creating the Model Plug-in
Creating the UI Plug-in
Creating the Runtime Plug-in
Writing Custom Mediation Code
Accessing Task Input/Output Schema
Modifying the Mediation Task Data
Defining Model Attributes
Custom Mediation Task Categories
Thrown Faults
Runtime Exceptions
Installing Custom Mediation Tasks
Deploying Custom Mediation Tasks
Testing Custom Mediation Tasks
Reference
Catch Fault
End Mediation
Generate Reply
Handle Reply
Invoke Operation
Log
Information for Standard Log Messages
Information for Custom Log Messages
Parse XML
Query Database
Render XML
Route Task
Send Fault
Set Context
Set Dynamic Reference
Set Exchange Variable
Throw Fault
Transform
Validate XML
XPath Route
TIBCO AutoMediate Command-Line Tool
AutoMediate Command-Line Tool Flow
Running the AutoMediate Command-Line Tool
AutoMediate Command Syntax and Options
AutoMediate ANT Command Syntax and Options
Introduction to gXML Applications
Developing gXML Applications
Implementing GxApplication
Implementing GxCatalog
Implementing GxResolver
Injecting DOM
gXML Recipes
Parsing a Character Stream and a Byte Stream
Constructing a Data Model Tree Programmatically
Validating
Navigation
Mutation
Serialization
XPath
XSLT
XQuery
Validation
Mediation Java API Reference
Important Information
TIBCO Documentation and Support Services
API Reference Pages
Web Application Component Development
Important Information
TIBCO Documentation and Support Services
Overview
Introduction
Approaches
Web Application Components
Creating a WebApp Component
Creating an SOA Project
Adding an Empty WebApp Component
Starting With an Existing Implementation
OSGi-enabled WebApp Component
Creating an OSGi-enabled WebApp Component
Configuring a Web Application Component
Configuring a WebApp Components Custom Feature
Configuring a WebApp Components External Custom Feature
WebApp Component Reference
Adding Configuring a WebApp Components Security
Using Form-based Authentication Policy
Adding Configuring Form-based Authentication Policy
Security Constraint Policy
Security Constraint Definition Example
Adding or Configuring a Security Constraint Policy
Updating a WebApp Component
ZeroConfiguration DAA Creation Using WAR
Limitations on WAR Files
Web Application Component Implementations
Opening an Implementation
Generating an Implementation
Generate WebApp Component Implementation
Code Generation Details Dialog
XML Data Binding Classes Dialog
Create Servlet Dialog
Regenerating an Implementation
Refreshing an Implementation
Accessing a Property
Invoking a Reference Operation
Enabling a Reference Injection
Adding a Reference to a WebApp Component with Implementation Type as WAR
Adding a Reference in TIBCO Business Studio
Creating a WAR File with the Reference Details
Adding a WebApp Component Using the WAR File
Adding a Context Parameter to an Implementation of Type WAR
Adding a Dynamic Endpoint Reference to an Implementation of Type WAR
Adding a Reference Outside of TIBCO Business Studio
WebApp Component Testing
RAD Communication
JAD Communication
Logging
Handling Errors
URL Mappings
Use of URL Paths
Specification of Mappings
Implicit Mappings
Spring Component Development
Important Information
TIBCO Documentation and Support Services
Spring Components
Creating a Spring Component
Updating a Spring Component
Component Feature Dependencies
Spring Component Reference
Spring Component Implementations
Spring Bean Configuration Files
Data Binding
Generating XML Data Binding Classes
Data Binding Classes for Abstract and Concrete WSDL Files
XML Data Binding Reference
Opening a Spring Component Implementation
Opening a Spring Bean Implementation
Generating a Spring Component Implementation
Regenerating a Spring Component Implementation
Generate Spring Component Implementation Reference
Life Cycle Events
Component Context
Accessing a Property
Accessing a Resource
Accessing a Hibernate Resource
Accessing a JDBC Resource
Accessing JMS Resources
Accessing LDAP Connections
Accessing SMTP Connections
Accessing a Teneo Resource
Invoking an HTTP Request
Invoking a Reference Operation
Error Handling
SOAPException Reference
Context Parameters
Working with Context Parameters
Endpoint References
Retrieving an Endpoint Reference
Creating an Endpoint Reference
Referencing an External Spring Application
Custom Features
Bundles and Plug-in Projects
Configuring Dependencies on External Java Classes
Versions
Default XML to Java Mapping
REST Binding Development
Important Information
TIBCO Documentation and Support Services
TIBCO ActiveMatrix Binding Type for REST Overview
REST Binding Type Key Terms
REST Binding Type Usage
REST Binding Type Key Features
Easy-to-Use Configuration GUI
Message Exchange Patterns
Error Handling
Complex XSD Constructs Mapping Rules
REST Binding Development
Payload Generation
Generating XML Payloads
Generating Badgerfish JSON Payloads
Overriding Media Types (For Service Only)
Configuring REST Bindings
Generating a Swagger JSON File from TIBCO Business Studio
Overview of the Swagger JSON File
Sample Swagger JSON File
Sending and Consuming HTTP Headers
Creating and Mapping Context Parameters
For REST Service Binding
Configuring an Inbound Message
Configuring an Outbound Message
For REST Reference Binding
Configuring for Request (Outbound) Flow
Configuring for Response (Inbound or Fault) Flow
Mapping HTTP Status Code and Status Message
Modifying a REST Resource Configuration File
Policies Supported
Sample Projects
Executing the Bookstore Sample
Importing the Bookstore Sample Project
Reviewing the WSDL that Defines the Service interface
Reviewing the Composite Configuration
Running the Bookstore Sample
Executing the MultipleComplexTypes Sample
Importing the MultipleComplexTypes Sample Project
Reviewing the Mediation Flow
Running the MultipleComplexTypes Sample
Executing the Bookstore Client Sample (Reference)
Importing the Bookstore Client Sample Project
Reviewing the REST Resource Configuration File That Defines the REST Service Interface
Running the Bookstore Client Sample
Executing the Facebook Client Sample (Reference)
Importing the Facebook Client Sample Project
Running the Facebook Client Sample
Executing the Pass-Through Mode Sample (Reference)
Executing the rest.context Sample
Running the rest.context Example
Breakdown of the rest.context Scenario
REST-Java-REST: Success Scenario of REST-Java
REST-Java-REST: Fault Scenario of REST-Java
Executing the rest.extendedJSONConversion Sample
Running the rest.extendedJSONConversion Example
REST-Java-REST: Runtime Node Logs for Rest-Java
Limitations
General Limitations
Validation Limitations
Service Limitations
Schema Limitations
Troubleshooting
Administration Tutorials
Important Information
TIBCO Documentation and Support Services
Overview
Tutorial Prerequisites
Set Up the Runtime Environment
Create a UDDI Server in Administrator
Configure Administrator Command-Line Properties
Set Up the Service Invocation Environment
How to Configure Logging
Creating a Logging Appender
Navigating to a Logging Configurations List
Creating a Logging Configuration for a Host or a Node
Applying a Logging Configuration
How to Deploy and Run the Hello World Application
Completing Hello World Prerequisites
Creating the Hello World Application
Creating an HTTP Connector Resource Template
Creating and Installing the HTTP Connector Resource Instance
Distributing the Hello World Application
Deploying and Starting the Hello World Application
Generating the Hello World WSDL File
Invoking the Hello World Service
Viewing the Hello World Service in the UDDI Registry Server
How to Deploy and Run the Enhanced Hello World Application
Completing Enhanced Hello World Prerequisites
Deploying and Starting the Date Manager Application from the CLI
Creating the Hello World Application
Creating an HTTP Connector Resource Template
Creating and Installing the HTTP Connector Resource Instance
Creating and Installing the HTTP Client Resource Instance
Deploying and Starting the Enhanced Hello World Application
Distributing the Enhanced Hello World Application
Generating the Hello World WSDL File
Invoking the Hello World Service
How to Deploy and Run the Java8 Hello World Application
How to Deploy and Run REST Binding Samples
How to Deploy and Run the Phonebook Application
Completing Phonebook Prerequisites
Creating the Phonebook Application
Creating an HTTP Connector Resource Template
Creating and Installing the HTTP Connector Resource Instance
Creating and Installing the JDBC Shared Resource Instance
Distributing the Phonebook Application
Deploying and Starting the Phonebook Application
Generating the Phonebook WSDL File
Invoking the Phonebook Service
How to Deploy and Run the Hello World Web Application
Completing Hello World Web Application Prerequisites
Creating the Hello World Web Application
Creating an HTTP Connector Resource Template
Creating and Installing the HTTP Connector Resource Instance
Distributing the Hello World Web Application
Invoking the Hello World Web Application
Deploying and Starting the Hello World Web Application
How to Deploy and Run the Content-Based Routing Mediation Application
Creating the Routing and Target Service Mediation Applications
Creating HTTP Connector Resource Templates
Creating and Installing Resource Instances
Distributing the Routing and Target Service Applications
Deploying and Starting the Routing and Target Service Applications
Generating the Routing WSDL File
Administration
Important Information
TIBCO Documentation and Support Services
Introduction to Administrator
Components and Servers
Using the Web Interface
Logging in to the Web Interface
Understanding Administrator Object States
Runtime State
Runtime States
Action History
Action History Reference
Outstanding Actions
Synchronization
Using Command-Line Interface (CLI)
Location of Sample Files
Sample Files Usage Guidelines after Upgrading to Hotfix
Invoking the Command-Line Interface
Understanding Build Files
Understanding AMXAdminTask
Understanding Data Files
Understanding Objects
Supported Objects
Object Formats
Object Navigation
Inter-Object Relationships
Configuring Timeout
Property File Reference
Actions Performed Using CLI
Managing the Administrator Server
Administration Support for Older Hosts and Nodes
Administrator Configuration Reference
Default Ports Used by Servers
Plug-Ins
Plug-Ins Reference
Notification Server
Editing the Notification Server Configuration using the GUI
Editing the Notification Transport Server Configuration using the CLI
Notification Transport Server Configuration Locations
The TIBCO ActiveMatrix Administrator Status Cache
Characteristics of the Approach
Prerequisites for Invoking the Notification Transport Server Configuration Update Target
Sample Scripts
Features
TRA properties and TIBCO ActiveMatrix Administrator CLI Options
Executing the Notification Transport Server Configuration Update from the Administrator CLI
Available ANT Targets
End-to-End Execution with Sample Outputs
Managing Hosts in an Inconsistent State
Sample Outputs
Reconnecting to EMS
Reconnect to EMS for Selected Host Using the GUI
Reconnect to EMS for Selected Host Using the CLI
Reconnect to EMS for JMS Deployment Server Connections
Reconnect to EMS for an Enterprise Using the GUI
Updating Internal HTTP Connector Configuration
Prerequisites
Sample Scripts
Features
Eligibility of a Host or Node for Update
Track Logs Using OperationID
Executing the ANT Script to Update the Internal HTTP Connector
End-to-End Execution with Sample Outputs
Managing Hosts and Nodes in "Not Running" State
Retrieving "Out of Sync" Keystore Resource Instances
Authentication Realms
Administrator Replication
Messaging Bus Configuration of an Enterprise
Determining Whether an Enterprise Uses a Messaging Bus
Configuring an Enterprise to Stop Using a Messaging Bus
Managing Environments
Determining Whether a New Environment should use a Messaging Bus
Creating an Environment
Configuring the Messaging Bus of an Environment
Changing the Messaging Bus of an Environment
Determining Whether an Environment Uses a Messaging Bus
Environment General Reference
Environment Configuration Reference
Messaging Bus Reference
Managing Hosts
Host Processes
Creating a TIBCO Host Instance
Adding a TIBCO Host
Adding a Host While Creating a New Node
Editing a TIBCO Host
Installing a TIBCO Host
Assigning a Host to An Environment
Starting a TIBCO Host
Stopping a TIBCO Host
Restarting a TIBCO Host
Uninstalling a TIBCO Host
Deleting a TIBCO Host
Enabling Secure Communication between a Host and an Administrator Server
Registering a TIBCO Host Instance as a Windows Service
Unregistering Hosts
Binding Hosts to an Administrator Server
Discover Hosts Reference
Register Host Reference
Appending tibcohost Instance Name to the Executable Process for Adminstrator Created TIBCO Host
Updating the JVM Configuration of a Host
Adding all JVM Properties to java.extended.properties
Updating the JVM Properties of a Host Through the GUI
Updating the JVM Properties of a Host Through the CLI
Setting the JVM Properties of a Host Through the CLI
Modifying JVM Properties of a Host Through the CLI
Deleting JVM Properties of a Host Through the CLI
Properties of Resource Templates
Hosts Reference
Host General Reference
Host Configuration Reference
Host Substitution Variables Reference
Host Resource Instances Reference
Caveats for Host Life Cycle Management
Managing Nodes
Node Processes
Developer Node
Navigating to a Nodes List
Creating a Node
Determining Whether a Node Uses a Messaging Bus
Creating Multiple Nodes with the Same Name
Extending Target Platform in Design Time
Extending Target Platform through the GUI
Extending Target Platform through the .ini File
Limitation
Date Display for Features
Copying Preparing for Undeploy (PFU) Components across BPM Nodes
Overview
Understanding the CLI action copyPFUComponents
Running the CLI action copyPFUComponents
Example Scenario for copyPFUComponents
Editing a Node
Updating the Port Number for a Node
JVM Arguments of a Node
Updating the JVM Configuration for a Node using Administrator UI
Enabling and Disabling the Java Security Manager
Enabling and Disabling Debuggers
Installing or Syncing Nodes
Uninstalling Nodes
Uninstalling Features using Wildcards
Starting Nodes
Manually Restarting Nodes
Stopping Nodes
Restarting a Node
Graceful Node Shutdown
TRA Property
Log Information for the Graceful Node Shutdown Feature
Deleting Nodes
Deleting Node Features using Wildcards
Threading Policy
Setting the Threading Policy Properties Through the GUI
Setting the Threading Policy Properties in the Node's TRA File
Example of Threading Policy
Properties of Resource Templates
Nodes Reference
Node General Reference
Node Configuration Reference
Node Substitution Variables Reference
Node Resource Instances Reference
Transaction Recovery Configuration
Configuration Properties for HOWL Log Files
Deleting HOWL Logs
Viewing an Aggregated Status of a Node
Using the GUI
Using the CLI
Using the Web Service API
Checks Done for an Aggregated Status of a Node
Limitations
Managing Applications
Creating an Application
Distributing an Application
Application Dependencies
Deploying Applications
Deployment Preflight Check
Tracking Application Deployment Progress
Undeploying Applications
Undeployment Preflight Check
Determining Whether an Application Uses a Messaging Bus
Starting Applications
Stopping Applications
Deleting Applications
Editing an Application
Upgrading an Application
Applications Reference
Displaying an Applications Dependencies
Displaying an Applications Components
Displaying an Applications Bindings
Application General Reference
Application Configuration Reference
Application Substitution Variables Reference
Application Distribution Reference
Application Folders
Creating a Folder
Renaming a Folder
Deleting a Folder
Moving an Application to a Folder
Properties
Setting a Property Value
Editable Properties Reference
Non-Editable and Policy Set Properties Reference
Services and References
Displaying the Bindings for a Service or a Reference
Adding a Binding to a Service
Editing a Binding
Deleting a Binding
Configuring a Binding for a Reference
Promoting a Service to the Environment
Getting a List of Promoted Services
Generating a WSIL Servlet Page
Invoking the EndpointService API Directly
Promoting a Reference to the Environment
Reference Details Reference
Manual Binding Reference
Bindings
SOAP Bindings
Starting and Stopping Bindings
Generating a WSDL File for a SOAP Service Binding Instance
SOAP Binding Reference
WS-Addressing
Endpoint References
Message Addressing Properties
Validation and Fault Handling
Configuring the Action Property
WS-Reliable Messaging
JMS Bindings
JMS Binding Reference
REST Bindings
Adding a REST Binding
Editing a REST Binding
Deleting a REST Binding
REST Binding Reference
Visualizing and Testing REST Service Bindings Using Swagger
Accessing Swagger UI through ActiveMatrix Administrator
Swagger UI
Invoking an Operation
Invoking a GET Operation
Invoking a POST Operation
Generating a Swagger JSON File
Overview of the Swagger JSON File
Sample Swagger JSON File
Troubleshooting
Wire to Binding Reference
Viewing Policies Applied to an Application
Managing Resource Templates
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 a Resource Template
Creating an Obfuscated Password
Configuring Mutual Authentication
Configuring and Preparing HTTP Connector for Jetty 9
HTTP Request Referrer Header Validation
Configuring Third-party Drivers
Configuring a Third-party JDBC Driver
Upgrading a Third-party JDBC Driver Using the CLI
Sample Output
Sample Logs: Upgrading Third-party JDBC Drivers
Testing a Connection to a JDBC Resource
Disabling Test Connection to a JDBC Resource
Configuring a Third-party JMS Driver
Configuring the Read Response Timeout for an LDAP Connection
Keystores
Creating a Keystore Containing a User Name and Password
Properties of Resource Templates
Hibernate
HTTP Client
HTTP Connector
JDBC
JMS Resource Templates
JMS Connection Factory
JMS Connection Factory Configuration
JMS Destination
JMS Destination Configuration
JNDI Connection Configuration
LDAP Connection
SMTP
Teneo
Thread Pool
Security Resource Templates
Identity Provider
Kerberos Authentication
Kerberos Identity Provider
Keystore Provider
Keystores
Creating a Keystore Containing a User Name and Password
LDAP Authentication
Mutual Identity Provider
SiteMinder Authentication
SSL Client Provider
SSL Server Provider
Trust Provider
WSS Authentication
Managing Resource Instances
Creating Resource Instances on Nodes
Installing Resource Instances on Nodes
Uninstalling Resource Instances from Nodes
Deleting Resource Instances from Nodes
Resource Instances Reference
Using Diagnostics
Accessing and Using Diagnostics Commands
Retrieving Log Files for Hosts and Nodes from Administrator
Service Health Check
Overview
Invoking Service Health Check
Executing a Request from the ActiveMatrix Administrator UI
Response: Graphical Representation on UI
Executing a Request from API Testing Tools
Response: XML Representation
Elements and Attributes in a Response
Database Queries for Service Health Check of JDBC Shared Resource
Example of a Complex Service Health Check Scenario
Status of Failure Scenarios
Caching a Service Health Check Response
Enabling or Disabling the Caching of a Service Health Check Response
Specifying the Validity Duration for a Service Health Check
Ping a SOAP or REST Endpoint
Specifying a Timeout Value for a Service Health Check Invocation
Suppressing Stack Trace in a Service Health Check Response
Service Health Check Logging
Log Information Specific to Service Health Check
Tracing a Request Flow Using the CorrelationID
Types of Log Messages
Deployment Time Messages
Runtime Messages
Disabling the Service Health Check
Service Health Check Samples
Service Health Check Sample for SOAP/HTTP
Service Health Check Sample for SOAP/JMS
Service Health Check Sample for REST
Custom Health Check Using Annotations
Scenarios Explaining Custom Service Health Check
Using TIBCO ActiveMatrix Business Studio for Service Health Check Annotations
Generating a Custom Service Health Check Method
Sample of Custom Service Health Check Method
Combinations of Custom Service Health Check Operations
Removing the Custom Service Health Check Method
Restrictions and Limitations
Coding Guidelines
Using the Custom Service Health Check Feature (Runtime)
Enabling Custom Service Health Check at the Node Level
Request Parameters
Response Elements
Logging
Service Health Check Sample for Annotations
Enterprise Deployment Health Check
Objectives
Running Enterprise Deployment Health Check
Running Enterprise Deployment Health Check using ActiveMatrix Administrator UI
Ping TIBCO ActiveMatrix Entities in Real Time
Enterprise Test Deploy
Getting ActiveMatrix Administrator Information
Getting ActiveMatrix Administrator Configuration Information
Custom Enterprise Health Check
Enterprise Health Check
Viewing Reports for Current or Past Health Check Tests
Updating Timeout Value for Enterprise Deployment Health Check Tests
Disabling Enterprise Deployment Health Check from ActiveMatrix Administrator UI
Running Enterprise Deployment Health Check using ActiveMatrix Administrator CLI
Prerequisites for Invoking Health Check Targets
Invoking Health Check Targets
Available Ant Targets
Restrictions for Target Usage
Chaining Targets
Data File: enterprise_healthcheck_data.xml
Schematic Representation of Enterprise Deployment Health Check
Checking Status of Entities after Reconnect to EMS
Performing Notification Ping for Entire TIBCO ActiveMatrix Enterprise
Performing Notification Ping for Selected Hosts
Performing Notification Ping for Selected Nodes
Performing Notification Ping for Selected Environments
Configuring Total Time Interval and Polling Time Interval of Notification Ping
Viewing Report File for Notification Ping
Sample CLI Output Explanation
CLI Target Validation and Upload of Sample Application
Starting Enterprise Deployment Health Check
Metadata of TIBCO ActiveMatrix Administrator
Runtime Information of TIBCO ActiveMatrix Administrator (Collected in Real-time)
TIBCO ActiveMatrix Enterprise-wide Summary
Hosts and Nodes: Initialization Status and Ping Response
Starting Test Deployment
Test Deployment Cleanup and Reporting
Getting Runtime ActiveMatrix Administrator Information when Performing CLI Action
Report File Explanation
Sample Enterprise Deployment Health Check Outputs
Get Only Metadata of TIBCO ActiveMatrix Administrator
Get Only Runtime Configuration Information of TIBCO ActiveMatrix Administrator
Get Metadata Along With Runtime Information of TIBCO ActiveMatrix Administrator
Ping the Entire TIBCO ActiveMatrix Enterprise
Ping TIBCO ActiveMatrix Nodes and Hosts for Select Environments
Ping TIBCO ActiveMatrix Nodes for Select Hosts
Perform Test Deployment on Select Nodes in a TIBCO ActiveMatrix Environment
OSGi Diagnostic Tool
Accessing the OSGi Diagnostic Tool
Introduction to the GUI of the OSGi Diagnostic Tool
Node Page
Bundle Page
Endpoint Page
Implementation Component Page
Packages Search Utility Page
Exporting Reports from the Tool
Searching in Current Report
Searching for Packages
Reloading Data in Current Report
Sample Scenario: Node does not start during installation or upgrade
Sample Scenario: Application is in Running State but Unable to Respond to Queries
Export and Import
Exported Objects
Export Options
Exporting Data from TIBCO ActiveMatrix Administrator
Exporting from GUI
Exporting from CLI
Selecting Data to be Exported from CLI
Selecting Objects for Exporting from CLI
Selecting Export Options from CLI
Selecting the Administrator from which Data is to be Exported
Downloading the Archive File
Deleting the Archive File Automatically
Export Archive Directory Structure
Folders and Files in Exported Data
Export Reporting and Error Handling
Importing Data to TIBCO ActiveMatrix Administrator
Prerequisites for Importing
Modifying Archive Structure Before Import
Import Options
Scope of Execution of Import CLI Script
Import Order for Applications with Dependencies
Logging for Import
Post Builds Reports for Import
Error Handling
Troubleshooting
Running Report on Data Files
Running Report on Data on the Target Administrator Server
Limitations
FAQ for Export
FAQ for Import
Substitution Variables
Creating a Substitution Variable
How Substitution Variables Are Resolved
Software Management
Adding Features to the Enterprise
Adding a Feature to a Node
Adding Third-Party Libraries to Nodes
Setting Node Features
Removing Features from a Node
Deleting Features from the Enterprise
Enabling or Disabling the Node Features using the tibcohost.exe Command
Synchronizing Node Feature List
Features Sync Status
Adding Application Templates to the Enterprise
Deleting Application Templates
Features Reference
Application Template Reference
Versions
Distributed Application Archives
Managing DAA Files
Uploading a Distributed Application Archive
Distributed Application Archive Reference
Monitoring
Monitoring Entities in an Enterprise from a Single Page
Accessing the Enterprise Status Page
Introduction to the UI of the Enterprise Status Page
Home Tab
Host Tab
Node Tab
Resource Instance Tab
Application Tab
Enterprise Tab
Searching for Entities in an Enterprise
Supported Entities and their Runtime States
Values in the Parent Column
Values in the Synchronization Column
Actions that can be Performed on Searched Entities
Search in Current Table
Bookmark a Search URL
Reload Data in the Table
Export Data from the Table
Accessing Administrator Dashboards
TIBCO ActiveMatrix SPM Dashboard
Accessing the Dashboard
Enterprise Dashboards
Dimension Hierarchies
Asset Status
Web Interface
Server Configuration
User Preferences
System Alerts
Filtering Alerts
Time Range Selectors
Working with Tables
Health Monitoring Summary
Environments Dashboard
Environment Details
Nodes
Node Details
Applications
Application Details
Services
Service Details
Service Instance Details
Shared Resource Instances
HTTP Resource Details
JDBC Resource Details
JMS ConnectionFactory Resource Details
ThreadPool Resource Details
Rules
Structure of a Rule
Example Authoring a Rule with E-mail Action
Rules on Asset Status
Rule Evaluation and Batching
Creating a New Rule
Defining the Scope of a New Rule
Setting Condition
Setting Action
Clearing Condition
Clearing Action
Customization of an Email-Action
Rules with Auto-Populated Dimensions
Rules Dashboard
Using HTTP Header Information to Emit Statistics
Emitting 'Sender Identifier' Information
Configuring the Sender Identifier Expression
Configuring the Sender Identifier Expression from TIBCO ActiveMatrix Business Studio
Configuring the Sender Identifier Expression Using the CLI
Configuring the Sender Identifier Expression Using the TIBCO ActiveMatrix Administrator UI
Sample: Sender Identifier Expression
Log Messages: Sender Identifier
Users, Groups, and Permissions
Creating a User
Changing a User Password
Resetting a User Password
Assigning Superuser Privileges
Removing Superuser Privileges
Adding Users to Groups
Removing Users from Groups
Creating a Root Group
Creating a Subgroup
Deleting a Group
Setting Object-Specific Permissions
Setting Enterprise Permissions
Permission Reference
Groups
Superusers
Users
Permissions
TIBCO ActiveMatrix Policy Director Governance Administration
Object Groups
Creating an Object Group
Publishing an Object Group
Copying a Object Group
Deleting an Object Group
Command-Line Interface for Object Groups
Build Files for Object Groups
Creating a Fixed Object Group
Creating a Dynamic Object Group
Defining the Search Criteria for Object Groups
Selecting Attributes for The Search Criteria
Governance Controls Overview
Authentication
Authorization
Confidentiality
Integrity
Credential Mapping
The mustUnderstand Attribute
Command-Line Interface for Governance Controls
Build Files for Governance Controls
Using the Command-Line Interface to Define Governance Controls
Use Case for User Name Token Authentication
Use Case for WSS Consumer Reference
Use Case for WSS Provider Reference
Governance Control Management
Creating a Governance Control
Deploying a Policy
Activating a Policy
Synchronizing a Policy
Displaying a Policy
Copying a Policy
Deactivating a Policy
Undeploying a Policy
Deleting a Policy
Enforcing Integrity and Confidentiality
Enforcing WSS Provider
Enforcing WSS Consumer
Managing Governed Objects by Using the Governed Object Synchronization Utility
Synchronizing Governed Objects
Deleting Governed Objects
Governance Control Reference
Creating an LDAP Connection Resource Template
Configuring Kerberos Authentication Service Provider
Configuring SiteMinder
Basic Authentication
Basic Credential Mapping
Username Token Authentication
Authentication by Kerberos
Authentication by SiteMinder
Authorization by Role
Logging
View Log Utility
SAML Authentication for SSO
SAML Credential Mapping for SSO
WS Reliable Messaging
WS-Addressing for Reference
WS-Addressing for Service
WSS Consumer
WSS Provider
Policy Status List
Proxy Service Management
Registering an External Service
Modifying an External Service
Deleting an External Service
Creating a Proxy Application
Configuring a Proxy Application
Using System Preferences
Updating a Proxy Application
Deploying a Proxy Application
Starting a Proxy Application
Stopping a Proxy Application
Undeploying a Proxy Application
Deleting a Proxy Application
Command-Line Interface for Proxy Service Management
Build File for Proxy Service Management
Creating a Proxy Application Using the Command-Line Interface
Security Error Message
System Logging
Log Viewer
Running Searches
Search Builder
Filter Area
Adding and Removing Filters
Event Models
Base Event Format Attribute Reference
Engine Event Format Attribute Reference
BW Engine Event Format Attribute Reference
Log Table
Deleting Log Entries
Log Services
Editing Log Service Properties
Log Service Property Reference
Logging Appenders
Creating a Logging Appender
Logging Appender Reference
Log Entry Enrichment
JMS Appender Configuration
Setting the JMS Appender Configuration Properties
Downloading Logs for an Application
Logging Configurations
Navigating to a Logging Configurations List
Creating a Logging Configuration for a Host or a Node
Applying a Logging Configuration
Logging Configuration Reference
Payload Services
Payload Service Properties Reference
Creating Additional Log and Payload Services
Schema Validation for SOAP Messages
Overview
Configuration
Enabling Schema Validation at Node Level
Disabling Schema Validation at Node Level
Enabling Schema Validation at Binding Level
From TIBCO Business Studio
From TIBCO ActiveMatrix Administrator UI
From TIBCO ActiveMatrix Administrator CLI
Runtime Behavior
Sample
Incoming SOAP Messages
Outgoing SOAP Messages
Logging
Secure Communication Channels
Trust Stores
Creating a Trust Store Keystore
Configuring a Trust Store
Enabling Secure Communication Channels Using Command-Line Scripts
Installing Unlimited Jurisdiction Files
TIBCO Credential Service
Network Configuration
IPv6 Support
Port Usage
UDDI Servers
Registering an SSL-Enabled UDDI Server
Registering a UDDI Server
Setting the Default UDDI Server
Configuring SSL Communication
Publishing Services in a UDDI Server
Properties of Resource Templates
UDDI Server Reference
Application UDDI Publication Reference
Suspending or Unsuspending an Enterprise
States of an Enterprise
Suspended State
Unsuspended State
Read-only State
Write State
Enabling or Disabling the Suspend Activity
Build and Data Files
Targets and Attributes in Build File
enterprise_suspend_build.xml
enterprise_suspend_data.xml
Putting an Enterprise in a Suspended State
Putting an Enterprise in an Unsuspended State
Putting an Enterprise in a Read-only State
Putting an Enterprise in a Write State
Getting the Status of an Enterprise
Getting the Status of a Read-only Enterprise
Logging
Samples
Sample: Suspend
Sample: Unsuspend
Sample: Read-only State
Sample: Write State
Sample: Suspend When the Enterprise is in a Suspended State (failOnError Set to True)
Sample: Unsuspend When the Enterprise is in an Unsuspended State
Sample: Unsuspend When the Enterprise is in an Unsuspended State (failOnError Set to False)
Sample: Status of an Enterprise
Sample: Status of Read-only Enterprise
Single Sign-On to SOA Applications Using SAML SSO Web Profile
Using SAML Web Profile to Implement SSO
Configuring Identity Provider for SAML SSO
Creating and Installing a Resource Template and Resource Instance
SAML SSO Web Profile Authentication Resource Template
Applying the SAML SSO Web Profile Authentication Policy
Testing an Application That Uses SAML Authentication
Log Information Specific to SSO using SAML SSO Web Profile
Single Sign-On to SOA Applications using OpenID Connect
OpenID Connect in ActiveMatrix
Implementing OpenID Connect
Create a Web Application with an OpenID Policy
Registering an Application at an Identity Provider
Create a Resource Template of Type 'OpenIDAuthentication'
Deploy a Web Application with the OpenID Policy
Testing a Deployed Web Application that Uses OpenID
Troubleshooting OpenID Connect Issues
Troubleshooting
NodeUtil
Invoking the NodeUtil Utility
NodeUtil Commands
ActiveMatrix Administrator Web Service API Reference
Installation and Configuration
Important Information
TIBCO Documentation and Support Services
Setting Up an Enterprise
Installation Overview
Installation Requirements
Installation Account Requirements
Hardware Requirements
Software Requirements
Database Requirements for SPM
Installation Environment
Installation Profiles
Pre-installation
Configuring External Databases
Database Privileges Needed for Automatic Schema Creation
Database Privileges Needed for Manual Schema Creation
Configuring Ant
Configuring AIX Platforms
Configuring the Environment Settings for AIX Platforms Versions
Configuring the Maximum Number of Open Files on Linux Platforms
Downloading Software Assemblies if No Internet Access is Available
Installation and Configuration Checklist
Installing TIBCO ActiveMatrix Service Grid
Installing in GUI Mode
Installing in Console Mode
Installing in Silent Mode
Moving an Installation to a Destination Machine
Verifying Installation
TIBCO_HOME Files and Directories
Configuration
Configuration Setup and Overview
Networking
Default Ports
Secure Communication Channels
Keystores
Trust Stores
Creating a Trust Store Keystore
Configuring a Trust Store
IPv6 Support
TIBCO Configuration Tool Requirements
Enterprise Messaging Server Requirements
SSL Requirements
Configuring TIBCO Enterprise Message Service Servers for Non-Admin Users
Determining Whether an Enterprise Needs a Messaging Bus
Running TIBCO Configuration Tool
Running TIBCO Configuration Tool in GUI Mode
Running TIBCO Configuration Tool in Console Mode
Running TIBCO Configuration Tool in Silent Mode
Using TIBCO Configuration Tool Scripts and Property Files
Saving a TIBCO Configuration Tool Configuration
Reusing a TIBCO Configuration Tool Configuration
Configure Third-Party Driver Properties
Create TIBCO Host Instance Properties
Create ActiveMatrix Administrator Server Properties
Modifying Scripts from Earlier Releases
Configuration Tool Wizards and Screens
Create Express Developer Environment
Administrator Server Configuration Details
Administrator Server Notification and Messaging Bus Server
Summary
Create TIBCO ActiveMatrix Administrator Server
Administrator Server Configuration Details
Administrator Server TIBCO Host Configuration
Administrator Server Connection Settings
Administrator Server Internal HTTP Port
Administrator Server Notification and Messaging Bus Server
Administrator Server Enterprise Message Service Connection Factory
Administrator Server Database Details
Administrator Server Authentication Realm
Administrator Server Database Authentication Realm
Administrator Server LDAP Authentication Realm
Administrator Server TIBCO Credential Server Details
Administrator Server TIBCO Credential Server Keystore
Administrator Server Logging Notification Server
Administrator Server Log Service Database
Administrator Server Payload Service Database
Summary
Create TIBCO ActiveMatrix Policy Director Governance Administrator Server
TIBCO ActiveMatrix Policy Director Governance Administrator Server Selection
Administrator Server Configuration Details
Administrator Server TIBCO Host Configuration
Administrator Server Connection Settings
Administrator Server Connection Details
Administrator Server Internal HTTP Port
Administrator Server Notification and Messaging Bus Server
Administrator Server Enterprise Message Service Connection Factory
Administrator Server Database Details
Administrator Server Authentication Realm
Administrator Server Database Authentication Realm
Administrator Server LDAP Authentication Realm
Administrator Server TIBCO Credential Server Details
Administrator Server TIBCO Credential Server Keystore
Administrator Server Log Service Database
Administrator Server Payload Service Database
Proxy Management Services Configuration
Summary
Create TIBCO ActiveMatrix Policy Director Governance Proxy Host
TIBCO ActiveMatrix Policy Director Governance Proxy Host Creation Wizard
TIBCO Host Selection
TIBCO Host Instance
TIBCO Host Instance Notification Server
TIBCO Host Instance Administrator Server
Proxy Node Configuration
TIBCO ActiveMatrix Policy Director Governance Proxy Host Configuration Summary
Create TIBCO Host Instance
TIBCO Host Instance
TIBCO Host Instance Notification Server
TIBCO Host Instance Administrator Server
Summary
Configure Third-Party Driver
Third-Party Driver Details
Third-Party Driver JAR Folder
Edit ActiveMatrix Administrator Server Configuration
Edit Administrator Server Configuration
Administrator Server Connection Settings
Edit Administrator Server Database Details
Making Planned Database Configuration Changes
Edit Administrator Server Authentication Realm
Edit Server LDAP Authentication Realm
Summary
Replicate TIBCO ActiveMatrix Administrator Server
Configuring ActiveMatrix Policy Director Governance on Replicated Administrator Server
Remote Administrator Server Details
Create Replicated Instance Validation Info
Administrator Server Configuration Details
Administrator Server TIBCO Host Configuration
Administrator Server Connection Settings
Administrator Server Notification and Messaging Bus Server
Administration Server Database Details
Administrator Server Database Authentication Realm Details
Administrator Server Configuration LDAP Authentication Realm
Administrator Server Configuration Summary
Deleting an Administrator Server
Upgrade or Downgrade TIBCO ActiveMatrix
Upgrade or Downgrade
Upgrade Options
Upgrade Selection
Validate
Upgrade Summary
Downgrade Options
Downgrade Selection
ActiveMatrix Administrator Server
Downgrade Summary
Update JRE used by TIBCO ActiveMatrix
Select JRE Home
Summary
Configure TIBCO Service Performance Manager
TIBCO Service Performance Manager Configuration: Database Configuration
JMS Configuration
Threadpool Configuration
Server Configuration
Storage and Recovery Configuration
Action Configuration
Handle Configuration File
Summary Configuration
Generate TIBCO Service Performance Manager Database Schema
Summary Configuration
Configure TIBCO Service Performance Manager Dashboard
Generate Database Configuration
Database Configuration
JMS Configuration
Threadpool Configuration
Server Configuration
Storage And Recovery Configuration
Action Configuration
Handle Configuration File
Client API JMS Configuration
Client API Configuration
Dashboard Server Configuration
Dashboard Server Security Configuration
Dashboard Server Authentication LDAP Configuration
Tomcat Server Configuration
Dashboard Server Authentication File Configuration
Summary Configuration
DDL Script Generator
Overview of the DDL Script Generator Utility
Creating the Database Schema
Cleaning up the Database Schema
Database Models
DDLGeneratorTask
Configuring TIBCO Service Performance Manager Components
Setting EMS_HOME
Creating EMS Queues and Factories
Setting Properties for the SPM Dashboard
Configuring the SPM Dashboard Server to use the SPM Server
Configuring TIBCO Service Performance Manager Dashboard Server
Configuring the TIBCO Service Performance Manager Server
Generating the Database Schema and Starting the Database
Configuring TIBCO Service Performance Manager Service Probe
Service Probe Installation Prerequisites
Enabling the Service Probe on TIBCO ActiveMatrix Nodes
Enabling the Service Probe Using TIBCO ActiveMatrix Administrator UI
Enabling the Service Probe Using TIBCO ActiveMatrix Administrator CLI
Disabling the Service Probe on TIBCO ActiveMatrix Nodes
Disabling the Service Probe Using TIBCO ActiveMatrix Administrator UI
Disabling the Service Probe Using TIBCO ActiveMatrix Administrator CLI
Client Properties of TIBCO Service Performance Manager
Changing the Heap Size of the Server
Logging Configuration
SPM Server Logging Configuration
SPM Dashboard Logging Configuration
SPM Example Logging Configuration
Using the Service Performance Manager Components
Starting the TIBCO SPM Server
Starting the TIBCO SPM Dashboard
Samples
Running the Client API Application Example
Client Properties
Overriding the Default Property Values
Deployment Scenarios
TIBCO Enterprise Message Service Server Deployment
TIBCO Service Performance Manager Server Deployment
Improving the Performance
Data Retention Policies
Using TIBCO Business Studio
Upgrade and Downgrade
Prerequisites for Upgrading or Downgrading
Upgrade
Upgrading Runtime Hosts and Nodes
Post Upgrade Actions
Creating and Installing Resource Template, Resource Instance required for Service Health Check
Updating ActiveMatrix Administrator
Upgrading REST Binding Type
Upgrading TIBCO Service Performance Manager
Upgrading TIBCO ActiveMatrix Policy Director Governance
Supported ActiveMatrix Policy Director Governance Upgrade Scenarios
Upgrading TIBCO ActiveMatrix Policy Director Governance Installation in TIBCO ActiveMatrix Service Grid 3.3.x
Upgrading TIBCO ActiveMatrix Policy Director Governance Installation on TIBCO ActiveMatrix Service Grid 3.2.x
Verifying the Upgrade
Uninstalling MCR Dashboard Application
Downgrade
Downgrading Runtime Hosts and Nodes
Updating ActiveMatrix Administrator
Downgrading REST Binding Type
Verifying the Downgrade
Using TIBCO Configuration Tool (TCT) to Upgrade or Downgrade
Diagnostic Tests
Tests That Are Common to Upgrade and Downgrade
Additional Tests for Downgrade
Using GUI Mode
Using Console Mode
Using Silent Mode
Using Scripts
Upgrading and Downgrading: An Example
Instance Details
Upgrading Using TCT Wizard
Upgrading the ActiveMatrix Administrator Instance
Upgrading Runtime Hosts
Verifying Upgrade
Analyzing the Upgrade Logs
Start and Stop Action Logs
Upgrade Action Logs
Post Upgrade Action Logs
SystemNode Upgrade Logs
Downgrading Using TCT Wizard
Downgrading Runtime Hosts
Downgrading the ActiveMatrix Administrator Instance
Verifying Downgrade
Analyzing the Downgrade Logs
Start and Stop Action Logs
Downgrade Action Logs
SystemNode Downgrade Logs
Special Case Scenario on Handling REST BT after a Downgrade
Uninstalling TIBCO ActiveMatrix Service Grid in the GUI Mode
Deploying REST BT System and User Applications
Host Manager
Patch Commands
describeAvailablePatches
describeAppliedPatches
applyPatch
revertPatch
Engineering Build Commands
applyEB
revertEB
Host and Node Commands
startAllHosts
startAllNodes
stopAllHosts
stopAllNodes
updateManifest
describeHostUpgradeHistory
updateWindowsServices
Miscellaneous Commands
Common Arguments
clearLog
interactive
intro
version
viewLog
installInfo
Updating JRE Version
Approach
Properties Updated in CLASSPATH .tra Files
Invoking the Tool
Help Commands
Modes of Operation
Commands
Discover Mode
Update Mode
Reverting to the Previous Version of the JRE
Backup of Files
Logging
Troubleshooting
Uninstallation
Prerequisites for Uninstalling
Uninstalling in GUI Mode
Uninstalling in Console Mode
Security Guidelines
Important Information
TIBCO Documentation and Support Services
Introduction
Secure Communication Channels for Various Components
Enable Secure Communication Channels by Using Command-Line Scripts
Trust Stores
Unlimited Jurisdiction Files
Installing Unlimited Jurisdiction Files
TIBCO Credential Service
Other Recommendations for Running the ActiveMatrix Enterprise Securely
Passwords
Internal and External ActiveMatrix Administrator Communication
Disable OSGi Console When Not Required or Not in Use
Hawk ActiveMatrix Plug-in
Important Information
TIBCO Documentation and Support Services
TIBCO Hawk ActiveMatrix Plug-in Overview
ActiveMatrix Host Microagent and Service Microagent
Monitoring Architecture
ActiveMatrix Monitoring Service Application
Configurations
Configuration Prerequisites
Configuring Sample Rulebases
Configuring for Hawk 5.x
Configuring for Hawk 6.1
Configuring for TIBCO Enterprise Message Service
Configuring to Manage and Monitor Multiple TIBCO Host Instances in the Same Hawk Agent
Configuring Service Rulebase Samples
Rulebase Details
ActiveMatrix Host Microagent
isHostRunning
getHostInfo
getNodeInfo
onHostEvent
onNodeEvent
startNode
stopNode
Common Logging Event Publisher Microagent
startPublisher
stopPublisher
startAllPublishers
stopAllPublishers
getEventPublisherInfo
getEventDataSourceDetails
reloadEventDefinitions
Sample Event Definitions Configuration to CLEvents from Hawk
ActiveMatrix Service Microagent
getConfig
changeMonitoringConfig
getComponentInfo
getBindingInfo
onComponentEvent
onBindingEvent
getBindingOperationStats
getComponentOperationStats
onBindingOperationStats
onComponentOperationStats
Service Execution Stats
Configuration of TIBCO ActiveMatrix Hawk Rulebase Samples
Scenarios
Scenario A: When Tibco Host is Abnormally Shutdown
Scenario B: When Administrator Node is Abnormally Shutdown
Scenario C: Runtime Nodes Managed by connected AMX Host
Deploying and Testing Sample Application
Testing the Sample Application
Error Codes
Important Information
TIBCO Documentation and Support Services
Introduction
Error Codes Naming Convention
TIBCO ActiveMatrix Administrator Codes
Environment
Applications
Staging Area
Shared Resources
Application Fragments
Administrator Common
Tasks
Enterprise
Resource Template
Application Folder
Distributed Application Archive (DAA)
API Exceptions
RDA
Enterprise Archive (EAR) Loader
Notification Transport
Administrator Extensions
Debugger
Administrator Server
Host
Permissions
Resource Template Types
Axis2 Server
Resource Instances
Administrator Loggers
SOAP Binding Type Codes
SOAP JMS
SOAP HTTP
Component Framework Codes
XML Beans
JAXB
EMS
Data Binding
Runtime Proxies
Runtime Core
Host Platform Adapter (HPA) Codes
HPA Notifications
Administrator CLI - Bootstrap
Spring Implementation Type Codes
Spring Implementation Type
Shared Resource Codes
HTTP
JDBCXA
Threadpool
Policy Director Governance Custom Actions
Important Information
TIBCO Documentation and Support Services
Introduction to Custom Actions
Setting up the Eclipse Environment for Plug-in Development
Implementing a Custom Action
Packaging the Action for ActiveMatrix
Creating an ActiveMatrix Composite Wrapper for a Custom Action
Policy Templates
Creating an Action Template
Creating a Rule Template
User Interface
Deploying the Custom Policy
Deploying Policy Templates
Deploying User Interface
Restarting the System Node
Deploying the Action on ActiveMatrix
Debugging and Logging
Debugging and Logging ActiveMatrix Environment
Troubleshooting
Sample Action Source Code
Parameters and Action Templates
Sample Action Rule Templates and User Interface Files
Code Snippets
Service Performance Manager API Reference
Important Information
TIBCO Documentation and Support Services
Introduction
TIBCO Service Performance Manager API
Model Overview
RTASchema
Attributes and Facts
Dimension
Time Dimension
Dimension Hierarchy
Dimension Hierarchy Attributes
Cube
Measurement
Retention Policy
Additional Properties in the Schema
Publishing the Facts to the Server
Executing the Query
Setting up the Rules
The Runtime Model API
Creating Custom Metric Functions
Creating a Class with a Metric Function
Creating a Function Catalog
Binding the Metric Parameters to the Fact Attributes in the Schema
Make the Metric Function Available to the Product
Creating Custom Actions
Creating a Class that Extends AbstractActionHandlerContext
Creating a Class that Extends AbstractActionImpl
Creating an Action Catalog
Making the Custom Action Available to the Product
Java API Reference Pages