Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Appendix B TIBCO Adapter Standards : Integration Requirements

Integration Requirements
This section explains the requirements for an adapter to interact with ActiveEnterprise applications and requirements specific to TIBCO ActiveMatrix BusinessWorks.
Integration with ActiveEnterprise
Any adapter that wants to interact with ActiveEnterprise applications should meet the requirements listed in this section.
Standard Wire Format
An adapter interacting with TIBCO ActiveMatrix BusinessWorks should use one of the ActiveEnterprise wire formats (aeRvMsg or aeXml). If an adapter interacts with a second adapter that uses rvMsg format, it should use rvMsg as well.
Standard Tracing and Logging
A standard adapter should have at least one fileSink with errorRole, warnRole and infoRole defined. If a trace log file is not allowed, a network sink can be used to send trace message for logging by a separate application.
Each component will log the significant steps of a process to the infoRole, which should be turned ON even in normal production operation. A significant step should include the minimum amount of information required for normal operation monitoring. Consider the time duration of a step before defining a significant step.
If a process is taking a fraction of a second, multiple significant steps should not be traced in the log for each event.
Monitoring Integration with TIBCO Hawk
Adapters can implement a custom hawk microagent and methods or at least make use of the TIBCO Adapter SDK provided class microagent.
The class and standard microagent built into the SDK provides basic management methods. For example, the standard microagent can be used to inspect and change the adapter's trace sink and role assignment.
The adapter must have the ability to stop using TIBCO Hawk or other mechanism. An adapter can use the Adapter SDK provided standard method or implement its own. Optionally, a stop message subscriber can be implemented to gracefully shutdown the adapter.
A custom Hawk microagent and method should be implemented to allow dynamic runtime management of the adapter when applicable. Optionally, a custom Hawk method can be included to allow management of the adapter at runtime, such as the ability to toggle the custom debug trace role or off.
Integration with TIBCO ActiveMatrix BusinessWorks
In addition to the requirements listed under Integration with ActiveEnterprise, a number of requirements exist for running a custom adapter in a TIBCO administration domain as part of a TIBCO ActiveMatrix BusinessWorks integration project.
The SDK_HOME/resourceKit/deployableAdapter directory contains a ZAP adapter example program that was modified to run in an administration domain. The directory also contains step-by-step instructions on how to change ZAP adapter to make it compatible with TIBCO Administrator.
TIBCO Wrapper Integration
To provide a uniform adapter launch and shutdown interface, TIBCO Runtime Agent provides a TIBCO Wrapper executable for TIBCO Adapter SDK Java based applications and a TIBCO Wrapper library for TIBCO Adapter SDK C++ based applications.
See Chapter 13, TIBCO Wrapper Utility for details.
Integration with TIBCO Administrator
Generic Adapter Configuration
The following fields must be set to allow TIBCO Administrator to monitor a TIBCO ActiveMatrix BusinessWorks compliant adapter:
Logging Tab  The log file name in the palette should default to %%DirTrace%%/%%Deployment%%.%%InstanceId%%.log
Monitoring Tab  The standard microagent name should be COM.TIBCO.ADAPTER.global_acronym.%%Deployment%%.%%InstanceId%%
Here global_acronym stands for the name that is provided in the domain utility while adding the adapter component to the domain. The checkbox for Has Standard Micro Agent should be checked, that is, the value should be true.
Class MicroAgent Name should be:
COM.TIBCO.global_acronym.%%Deployment%%.%%InstanceId%%
The value for Has Class Micro Agent should be %%HawkEnabled%%.
All runtime connection parameters for the adapter services should be defined as global variables and referred in the palette. Values should not be hard coded.
TIBCO Hawk Method Implementation
TIBCO ActiveMatrix BusinessWorks and its monitoring tool TIBCO Administrator has a different set of requirement for TIBCO Hawk methods, including the naming convention and code implementation that is needed for two TIBCO Adapter SDK standard microagent methods: getAdapterServiceInformation() and getHostInformation(). These two microagent methods allow TIBCO Administrator to obtain adapter runtime status (running, stopped, and so on), performance statistics, and adapter service information.
TIBCO Domain Registration
TIBCO Runtime Agent provides a domain registration utility tool under its tibco/tra/version_num/tools/bin directory. See the TIBCO Administration Server Configuration Guide for more information.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved