The following tabs can be used to define an adapter instance:
Use the default name or replace it with a name of your choice.
TEST
and a Siebel adapter instance named TEST
can coexist in the same project.When you create an adapter instance, the palette automatically creates several resources for it. The names of these resources derive from the name of the instance they belong to. Changing the adapter instance name results in an automatic regeneration of the resources names. If you manually modify any resource name, that particular name will not be automatically regenerated next time you rename the adapter instance.
Provide information about the adapter instance that you want stored in the project. The field is optional.
The version string indicates the ActiveEnterprise (AE) format in which the adapter instance is saved. An adapter instance can be saved in AE Version 4.0 or AE Version 5.0, AE Version 5.1.0, AE Version 5.2, or AE Version 5.3 format.
When a new adapter instance is created in TIBCO Designer 5.x, the version string is set to AE Version 5.2
. When a 4.x adapter instance is opened in TIBCO Designer 5.x, the Version
field is set to AE Version 4.0
.
Version
field is set to AE Version 4.0
. If you are using TIBCO Designer 5.x to modify 4.x adapter instances, change only features supported by the 4.x. run-time adapter and use the validation utility to verify the instance before deploying the project. The validation utility scans the project and returns warnings if any 5.2 features are defined for 4.x adapter instances. Invoke the utility from the Project>Validate Project for Deployment menu command in TIBCO Designer.
Version
field should be set to AE Version 5.2
. To change versions, click the Change Version button.
Specify a message filter, if you have configured a message filter resource for use with the adapter. The filter allows you to manipulate incoming and outgoing data before sending it on the network or handing it to the target application. Filters can be written using the TIBCO Adapter SDK. See the TIBCO Adapter SDK Programmer’s Guide for information about writing a message filter.
Select this check box to display additional tabs for configuring advanced options.
Select the run-time component you want to configure:
This tab is available when you select Service
from the Component Type
drop-down in the Configuration
tab.
Specify the number of reconnection attempts to make before the run-time adapter is stopped. A value of -1 implies that reconnection attempts will continue indefinitely. Zero is not a valid value.
Specify the number of reconnection attempts to make before suspending the adapter services.
Specify the time interval in milliseconds to elapse between each reconnection attempt.
The adapter provides the following choices:
When All Services Are Suspended
To stop the adapter when a service is suspended. Therefore, only the adapter service that cannot reconnect is stopped. Other adapter services that are connected continue to function normally.When Any Service is Suspended
To stop the adapter if any one service is unable to re-establish a connection after the specified number of reconnection attempts.
This field is applicable only for the Publication and Request-Response Invocation services. By default, this check box is selected. When selected, the COM UDTs
are validated to verify that they recursively match the TIBCO ActiveEnterprise classes they correspond to. This can be time-consuming.
When this check box is cleared, it turns off validation in the interceptor, which speeds up initialization of the interceptor.
In a testbed environment, you should select this option so that any inconsistencies between COM UDTs
and TIBCO ActiveEnterprise classes or between COM interface methods and TIBCO ActiveEnterprise class operations will be flagged as errors. Such inconsistencies can occur if you make a change to your COM IDL file and rebuild your type library, but forget to make the corresponding change in (or reimport the type library as a whole into) the project file.
Once you have verified that the information in the COM type library and repository is consistent and you are moving into a production environment, clear this check box to allow the interceptor to initialize as quickly as possible.
Note that the interceptor performs extensive metadata validation at startup time and this validation is extremely useful in making sure that your testbed environment is consistent. So, clear this check box only after you are absolutely sure that you have removed all inconsistencies from your environment. If inconsistencies exist, unexpected runtime exceptions will occur.
This field is applicable only for the Publication and Request-Response Invocation services.
The default value is 60000. If the interceptor
component of the adapter is mapping a COM method invocation to a two-way TIBCO Adapter SDK operation, the value of this parameter specifies how long the interceptor should wait for a reply. If the interceptor times out, it will return an error to the COM client.
This field is applicable only for the Subscription and Request-Response services.
The default value is one. The value of this parameter specifies how many threads the service component of the adapter should use to process operation requests or published documents. Increasing this value will increase service throughput.
When a thread gets to the point of invoking the COM server method, the threading model of the COM server determines the behavior. If the threading model of the COM server is single or apartment, the methods are called sequentially. If the threading model of the COM server is free, or both, the methods are called in parallel.
A message sent on the termination subject (if TIBCO Rendezvous is the transport) or topic (if JMS is the transport) stops the adapter. In most cases, you should use the default value.
See TIBCO Rendezvous Concepts for information about specifying subject names. See the TIBCO Enterprise for JMS User’s Guide for information about publishing on a topic.
This field is available only for 4.x adapter configurations. For 5.0 adapter configurations, this field is preselected and unavailable.
Select this check box if you want to log adapter-specific trace information to files. Only errors generated by the adapter are logged to a trace file. Errors from other sources, such as TIBCO Adapter SDK APIs are printed to the console window where the adapter started.
The TIBCO Adapter SDK API (MTrackingInfo
) provides support for end-to-end traceability of documents or messages throughout the system. The information allows you to track a message back to its source when an error occurs in a given component, and provides status information about the progress of a business process that is distributed among multiple components. For information on the different components of a trace message, see Appendix D, Trace Messages.
For error messages (errorrole
), the complete tracking information is traced. For debug, informational, and warning messages, only the tracking ID (trackingId)
is traced. Informational (inforole
) messages are only recorded in the sink files specified in the project file, and not in the Event log or console.
Select this check box to enable logging of informational and error messages to the Microsoft Windows Event Log. Turning on Event Log logging also provides more extensive error logging than can be obtained simply by defining the different kinds of monitoring sinks described for the Logging Tab.
![]() |
The interceptor, when run as a service, will use the updated value only after you restart the service.
|
When Use Advanced Logging
is not selected (the default), you can set two standard output destinations (sinks) for trace messages and set the tracing level for the roles selected.
When Use Advanced Logging
is selected, you have complete control on selecting the destinations and associating roles with each of the destinations.
To create and configure the sinks, select the log sinks folder under the Advanced
folder in the project panel.
To create sinks, drag and drop the Generic log sink
icon from the palette panel into the design panel. From the configuration panel, select the sink type. The following are the sink types available:
When File and STDIO sinks are created from the Generic log sink
they offer further configuration options. For the File sink, the file limit, file count, and the option to append or overwrite can be specified. When created by default, this is set to 30000 bytes, 3 and append mode respectively. For the STDIO sink, the option to write to stdout
or stderr
can be selected. When created by default, stdout
is selected.
The Hawk sink uses the hawk session, created and used by the adapter for monitoring purposes, to send tracing messages to the TIBCO Hawk monitor or Display. For details on TIBCO Hawk sessions, see Using Global Variables. The configuration for the Hawk sink involves specifying the MicroAgent Name
that must be specified in the configuration panel.
The Network sink is used to publish tracing message on TIBCO Rendezvous. The configuration for the network sink involves specifying the session, and the subject on which the trace messages needs to be published.
For all the sinks, optionally the name and description for the sink can be provided.
(STDIO Sink) When selected, trace messages are displayed in the command prompt window where the adapter is started. When not selected, trace messages do not display in the window.
Specify the name of the log file (log sink) to which trace messages are written. Global variables can be used to specify the location of the log file. See Using Global Variables for more information.
The roles available are Info, Debug, Warning, and Error messages. The trace message generated depends on the roles selected. Turning on the roles can affect the performance of the adapter. Therefore, it is recommended that you turn on the required roles only.
Trace messages of the selected level(s) will be collected in the named log sink. You can configure what levels of trace messages you want logged, and where trace messages are sent. There are three types of logs (log sinks) that you can configure to hold trace messages, corresponding to three levels (roles) of trace messages, Information, Warning and Error. A fourth level of trace messages, Debug, is reserved and should not be enabled unless requested by the TIBCO Product Support Group. This option writes a lot of information to the log file and significantly reduces the speed of the adapter.
This field is selected by default. The startup banner displays the run-time adapter version, the infrastructure version on which the adapter is built, and copyright information in the console window when the adapter is started.
If the adapter does not find the class description for a class, it will try to resolve it by referring to the schema location specified by this URL. The field specifies the location where the adapter searches for base schemas. The adapter searches for any schema that has been defined and saved at this location, and that should be loaded at startup.
While setting schema location for an adapter instance, the dependency of the type libraries needs to be considered. For example, the parameter of a method might be defined as TIBCO ActiveEnterprise type any
, which corresponds to the COM type VARIANT
. At run time, the type of this parameter may be a specific TIBCO ActiveEnterprise class associated with a specific COM UDT
. Therefore, the adapter requires the location in which it should search for the class definition.
Select Browse Resources
to specify the location in which the adapter should search for the metadata.
Many of the following fields make use of global variables. Click the Global Variables
tab in the project panel to enter a value for a global variable.
Allows you to turn on or off the standard TIBCO Hawk Microagent. The way to turn it on or off is also configurable. By clicking the globe
icon, a standard check box or text value (true or false) can be used to turn the standard microagent on or off.
This is the name for the standard microagent that will be registered with the TIBCO Hawk system. In most cases the default value is used. The InstanceId
variable need not be set because it is automatically set at run time by the run-time adapter.
This field is predefined and cannot be changed. It specifies the instance or class specific standard TIBCO Hawk Microagent.
This is the name for the class microagent that will be registered with the TIBCO Hawk system. In most cases the default value is used.
This field is predefined and cannot be changed. It specifies the name of the TIBCO Rendezvous session that will be used by the standard, class, and custom microagents.
The session name and the corresponding session is automatically generated by TIBCO Designer. Do not change the session name or the session. However, you can modify the session parameters if required. Navigate to the Sessions
folder under the Advanced
folder to modify the session parameters.
Make sure you have set the correct parameter value for the global variables that correspond to the TIBCO Hawk configuration. If the session parameters are not set properly, the microagents will not display in the TIBCO Hawk Display.
TIBCO Adapter™ for COM User’s Guide Software Release 5.3, September 2005 Copyright © TIBCO Software Inc. All rights reserved www.tibco.com |