Generic Adapter Configuration Reference

When you drag a Generic Adapter Configuration into the design panel, or load a legacy adapter into TIBCO Designer, the configuration panel allows you to specify information about the adapter.

This section is a reference for the information you supply for a generic adapter in the configuration panel.

The Configuration tab allows you to specify the following information:

Table 45 Configuration Tab Field
Instance Name	Name of the adapter instance. This name corresponds to the adapter instance configuration object stored in the tibco/private area of TIBCO Repository.
Version	Version of the adapter repository. To change the default, click the Change Version button at the bottom of the page.
SDK AppName	Short name of the adapter used in the source code.
Description	Optional description of the adapter.
Message Filter	Allows you to specify a java class that performs manipulations on incoming and outgoing data. For more information, see the Using a Message Filter.

Table 45 Configuration Tab Field

Instance Name

Name of the adapter instance. This name corresponds to the adapter instance configuration object stored in the tibco/private area of TIBCO Repository.

Version

Version of the adapter repository. To change the default, click the Change Version button at the bottom of the page.

SDK AppName

Short name of the adapter used in the source code.

Description

Optional description of the adapter.

Message Filter

Allows you to specify a java class that performs manipulations on incoming and outgoing data. For more information, see the Using a Message Filter.

Two buttons at the bottom of the Configuration tab allow you to change configuration values.

Table 46 Configuration Tab Fields
Change Version	Allows you to change the adapter repository version.
Edit Adapter XML	Allows you to edit the raw adapter xml configuration. You should use the palette features to edit the adapter. You are responsible for making sure the configuration is valid.

Table 46 Configuration Tab Fields

Change Version

Allows you to change the adapter repository version.

Edit Adapter XML

Allows you to edit the raw adapter xml configuration. You should use the palette features to edit the adapter. You are responsible for making sure the configuration is valid.

The Logging tab allows you to specify your logging preferences and information. You have two choices:

•

If you are using custom roles, choose Advanced Logging, then use the resources in the Log Sinks folder to configure logging information. See Custom Log Sink Reference.

Table 47 Logging Tab Field
Use Advanced Logging	When this check box is selected, you configure log sink resources from the Log Sinks folder of the adapter’s Advanced folder. See Custom Log Sink Reference.
Log to Standard I/O	Sends logging information to standard I/O.
Log File	Sends logging information to the specified file. See A Note on Global Variables for information on the value.
Log Info Messages	Sends all messages of type INFO to the specified location(s).
Log Debug Messages	Sends all messages of type DEBUG to the specified location(s).
Log Warning Messages	Sends all messages of type WARNING to the specified location(s).
Log Error Messages	Sends all messages or type ERROR to the specified location(s).

Table 47 Logging Tab Field

Use Advanced Logging

When this check box is selected, you configure log sink resources from the Log Sinks folder of the adapter’s Advanced folder. See Custom Log Sink Reference.

Log to Standard I/O

Sends logging information to standard I/O.

Log File

Sends logging information to the specified file. See A Note on Global Variables for information on the value.

Log Info Messages

Sends all messages of type INFO to the specified location(s).

Log Debug Messages

Sends all messages of type DEBUG to the specified location(s).

Log Warning Messages

Sends all messages of type WARNING to the specified location(s).

Log Error Messages

Sends all messages or type ERROR to the specified location(s).

The Startup tab allows you to specify startup information for your adapter.

Table 48 Startup tab Field
Show Startup Banner	If checked, a banner is displayed when the adapter is started.
Metadata Search URL	Click the browse icon to specify a previously defined Metadata Search URL for this adapter. See Metadata URLs Folder for information on defining a Metadata Search URL.

Table 48 Startup tab Field

Show Startup Banner

If checked, a banner is displayed when the adapter is started.

Metadata Search URL

Click the browse icon to specify a previously defined Metadata Search URL for this adapter. See Metadata URLs Folder for information on defining a Metadata Search URL.

The Monitoring tab allows you to provide TIBCO Hawk information for the standard TIBCO Hawk microagent. See Adding Custom Hawk Microagents to Your Adapter for information on configuring custom microagents.

Table 49 Monitoring Tab Field
Enable Standard MicroAgent	If true, a standard TIBCO Hawk microagent is available for this adapter. Its name is COM.TIBCO.ADAPTER. Default is false.
Standard MicroAgent Name	TIBCO Hawk microagent name. Defaults to COM.TIBCO.ADAPTER.
Standard MicroAgent Timeout	Specifies the amount of time the Hawk Agent should wait for HMA method invocations to complete before timing them out. The default is 10000 milliseconds. Normally there is no need to change this value, however, on machines under extreme stress where method invocations are timing out, this new option allows the timeout value to be increased.
Enable Class MicroAgent	If true, an adapter-specific TIBCO Hawk microagent is available for this adapter. Its name is COM.TIBCO.ADAPTER.adaptername.
Class MicroAgent Name	Redefines the name for the adapter-specific agent. Defaults to COM.TIBCO.ADAPTER.adgeneric.%%Deployment%%.%%InstanceId%%. See A Note on Global Variables for information on the value.
Class MicroAgent Timeout	Specifies the amount of time the Hawk Agent should wait for HMA method invocations to complete before timing them out. The default is 10000 milliseconds. Normally there is no need to change this value, however, on machines under extreme stress where method invocations are timing out, this new option allows the timeout value to be increased.
Default MicroAgent Session	TIBCO Rendezvous session to be used for TIBCO Hawk microagents by default. If not defined, the SDK creates a default session on RV service 7474 (the default for TIBCO Hawk).

Table 49 Monitoring Tab Field

Enable Standard MicroAgent

If true, a standard TIBCO Hawk microagent is available for this adapter. Its name is COM.TIBCO.ADAPTER. Default is false.

Standard MicroAgent Name

TIBCO Hawk microagent name. Defaults to COM.TIBCO.ADAPTER.

Standard MicroAgent Timeout

Specifies the amount of time the Hawk Agent should wait for HMA method invocations to complete before timing them out. The default is 10000 milliseconds. Normally there is no need to change this value, however, on machines under extreme stress where method invocations are timing out, this new option allows the timeout value to be increased.

Enable Class MicroAgent

If true, an adapter-specific TIBCO Hawk microagent is available for this adapter. Its name is COM.TIBCO.ADAPTER.adaptername.

Class MicroAgent Name

Redefines the name for the adapter-specific agent. Defaults to COM.TIBCO.ADAPTER.adgeneric.%%Deployment%%.%%InstanceId%%. See A Note on Global Variables for information on the value.

Class MicroAgent Timeout

Default MicroAgent Session

TIBCO Rendezvous session to be used for TIBCO Hawk microagents by default. If not defined, the SDK creates a default session on RV service 7474 (the default for TIBCO Hawk).