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