Copyright © TIBCO Software Inc. All Rights Reserved

Adapter Instance Fields

You can use the following tabs to define an adapter instance:

•	Configuration Tab

•	Design-time Connection Tab

•	Runtime Connection Tab

•	General Tab

•	Multithreading Tab

•	Logging Tab

•	Startup Tab

•	Monitoring Tab

Configuration Tab

The Configuration tab contains the fields listed in Table 1, Field Description of Configuration Tab:

Table 1 Field Description of Configuration Tab  

Field	Description
Instance Name	Use the default name or replace it with a name of your choice. • An instance name must use alphanumeric characters. An underscore (_) character can be used. The entire instance name must be less than 80 characters. The space character cannot be used in an instance name. • An instance name cannot use global variables. • An instance name must be unique with respect to other adapter instances for the same adapter in the project. The same instance name can be used to name an adapter instance for a different adapter in the same project. For example, an R/3 adapter instance named TEST and a Siebel adapter instance named TEST can coexist in the same project. • Each instance name must be unique per adapter within a project even if each instance is defined in a different folder. That is, configuring same-named adapter instances in different folders will not make their names unique. 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 to which they belong. 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.
Description	Provide information about the adapter instance that you want stored in the project. The field is optional.
Version	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.1, AE Version 5.2 and 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.3. To change versions, click the Change Version button.
Message Filter	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 TIBCO Adapter SDK Programmer’s Guide for information about writing a message filter.
Show All Tabs	Select this box to display additional tabs for configuring advanced options.

Design-time Connection Tab

The Design-time Connection tab contains the fields listed in Table 2, Field Description of Design-time Connection Tab (Sheet 1 of 3). Many of these fields make use of global variables. Click the Global Variables tab in the Project panel to enter a value for a global variable.

Table 2 Field Description of Design-time Connection Tab

Field	Description
Server Type	Specify the type of server. This is the name of the LDAP server that the adapter will connect to. You can select from the following server types: Microsoft Active Directory/Microsoft Active Directory Application Mode, IBM Directory Server, Oracle Directory Server Enterprise Edition, Oracle Unified Directory, Oracle Internet Directory, OpenLDAP Software, Red Hat Directory Server, and Others. To connect to Sun Java System Directory Server Enterprise Edition 6.0, 6.3.x, or 7.0, select the Oracle Directory Server Enterprise Edition item. Only limited testing has been conducted with the Others server type, thus Others is not officially supported.
Server Name	Specify the name of the machine where the LDAP server is installed. If an existing DAT file is opened and the machine name is changed, then the following message displays: You have already configured adapter instances and services for a particular LDAP server. The change that you are attempting will be valid only if the new server has identical directory information tree and schemas. Please confirm this and that you do wish to proceed with this change. Click the Yes button to effect the changes to the machine name. Click the No button to revert to the previous value. LDAP Adapter supports Server Name as a global variable.
Use SSL	Check this checkbox to specify whether the SSL protocol should be used. By default, this checkbox is not checked.
LDAP Port	Specify the number of the port that the adapter is configured to listen to. The default port number for LDAP servers is 389. The default SSL port number is 636.
Authentication Mode	The mode of authentication used for connecting to the LDAP server. Currently, the following are supported: • Simple — If you select the Simple authentication mode, you must specify the user name and password required to log on to the LDAP server. Click the Test Connection... button. If the entries are accurate, the adapter will connect to the server. • Anonymous — If you select the Anonymous authentication mode, you do not need to specify the user name and password. You will be logged on to the LDAP server automatically. Click the Test Connection... button. If the configuration is accurate, the adapter will connect to the server. • External — This field is only available if you check the Use SSL checkbox. If you select the External authentication mode, you must ensure that the User DN and Password fields are empty. In the Client Identity field, provide the path to the userident.p12 file. Also, enter the password for the .p12 file in the Identity Password field. Click the Test Connection... button. If the entries are accurate, the adapter will connect to the server.
User DN	Specify the user name that will be used to log on to the LDAP server. You must specify the DN used to bind to the LDAP server. For example, cn=Administrator,cn=Users,dc=adsldap.
Password	Specify the password that will be used to log on to the LDAP server at design time. When the Server Type is IBM Directory Server, and if SSL external mode is used, correct User DN and Password must be entered. If SSL external mode is used, but the Server Type is not IBM Directory Server, User DN and Password fields are disabled.
Remember Password	If this check box is not checked, the password must be entered each time the project is opened. If it is selected, the password will be stored in the project repository. This password is for the design-time connection only. The password for the runtime connection is stored in the adldap.tra file, either in clear text or in obfuscated format.
Use Design-time Connection for Runtime	Check this check box to use the design-time connection information for the runtime adapter.
Trusted Certificate Authorities	This is the file that contains the list of trusted certificates and specifies which Certificate Authorities should be trusted as issuers of the LDAP server certificate. The file is created using keytool. This field supports the use of global variables
Client Identity	You must specify the complete path of the client .pfx or .p12 file. This field supports the use of global variables
Identity Password	This is the password that is used to decrypt the private key of the client. This field supports the use of global variables
Verify Server Certificate Common Name	The design-time connection does not support this option.
Test Connection	Click to test the validity of the connection information that you specified for the adapter instance.

Runtime Connection Tab

The Runtime Connection tab contains the fields listed in Table 3, Field Description of Runtime Connection Tab (Sheet 1 of 4).:

Table 3 Field Description of Runtime Connection Tab

Field	Description
Server Type	Specify the type of server. This is the name of the LDAP server that the adapter will connect to. You can select from the following server types: Microsoft Active Directory/Microsoft Active Directory Application Mode, IBM Directory Server, Oracle Directory Server Enterprise Edition, Oracle Unified Directory, Oracle Internet Directory, OpenLDAP Server, Red Hat Directory Server, and Others. To connect to Sun Java System Directory Server Enterprise Edition 6.0, 6.3.x, or 7.0, select the Oracle Directory Server Enterprise Edition item. Only limited testing has been conducted with the Others server type, thus Others is not officially supported.
Server Name	Specify the name of the machine where the LDAP server is installed. LDAP Adapter supports Server Name as a global variable.
Use SSL	Check this checkbox to specify whether the SSL protocol should be used. By default, this checkbox is not checked.
LDAP Port	Specify the number of the port that the adapter is configured to listen to. The default port number for LDAP servers is 389. The default SSL port number is 636.
Authentication Mode	The mode of authentication used for connecting to the LDAP server. Currently, the following are supported: • Simple — If you select the Simple authentication mode, you must specify the user name and password required to log on to the LDAP server. Click the Test Connection... button. If the entries are accurate, the adapter will connect to the server. • Anonymous — If you select the Anonymous authentication mode, you do not need to specify the user name and password. You will be logged on to the LDAP server automatically. Click the Test Connection... button. If the configuration is accurate, the adapter will connect to the server. • External — This field is only available if you check the Use SSL checkbox. If you select the External authentication mode, you must ensure that the User DN and Password fields are empty. In the Client Identity field, provide the path to the userident.p12 file. Also, enter the password for the .p12 file in the Identity Password field. Click the Test Connection... button. If the entries are accurate, the adapter will connect to the server.
User DN	Specify the user name that will be used to log on to the LDAP server. You must specify the DN used to bind to the LDAP server. For example, cn=Administrator,cn=Users,dc=adsldap.
Password	Specify the password that the adapter must use at run time. The password is encrypted and stored in the project file. If you check the Use Design-time Connection For Runtime checkbox under the Design-time Connection tab, the adapter uses the design-time password at runtime too. To maintain backward compatibility, if the runtime password is not specified or if the field is empty in the project file, the adapter uses the password from the .tra file. This field is mandatory. The adapter handles the password at design time and runtime as follows: • You can enter the runtime password in the Password field under the Runtime Connection tab. The adapter looks for the runtime password in the project file. • You cannot specify a runtime password through TIBCO Designer. However, if you check both the Remember Password and Use Design-time Connection For Runtime checkboxes, the adapter first looks for the password in the project file. If there is no specified password, the adapter uses the password specified in the .tra file.
Trusted Certificate Authorities	This is the file that contains the list of trusted certificates and specifies which Certificate Authorities should be trusted as issuers of the LDAP server certificate. The file is created using keytool. This field supports the use of global variables
Client Identity	You must specify the complete path of the client .pfx or .p12 file. This field supports the use of global variables
Identity Password	This is the password that is used to decrypt the private key of the client. This field supports the use of global variables.
Verify Server Certificate Common Name	The runtime connection does not support this option.
Maximum Number of Reconnect Attempts	Specify the total number of reconnection attempts to make before the runtime adapter or adapter service is stopped. A value of -1 means reconnection attempts will continue indefinitely. You cannot specify a value of zero.
Number of Reconnect Attempts Before Suspending Impacted Service(s)	Specify the number of reconnection attempts to make before suspending the adapter services.
Interval between Reconnect Attempts (milliseconds)	Specify the time interval in milliseconds, between each reconnection attempt.
Adapter Termination Criteria (after max number of reconnect attempts)	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. However, since the adapter currently supports only a single connection to a LDAP server, either choice results in the same behavior. The adapter stops after the maximum number of reconnection attempts.

General Tab

The General tab contains the fields listed in Table 4, Field Description of General Tab:

Table 4 Field Description of General Tab  

Field	Description
Termination Subject or Topic	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 TIBCO Enterprise Message Service User’s Guide for information about publishing on a topic.
Adapter Encoding	This field has been disabled and is no longer available for use.

Multithreading Tab

It is possible to run the adapter in the multithreaded mode for improved throughput and performance. You can specify the number of concurrent dispatcher threads that are to be operated for a given session.

Table 5 Field Description of Multithreading Tab  

Field	Description
Session Name	Shows the TIBCO-enabled application session that has been created by TIBCO Designer. A termination service must use a different session from the session that is configured because if all threads are waiting for a connection, there will be no thread available to process the termination request. Setting a session for the termination service that is different from the configured session ensures that the request is processed immediately.
Number of Threads	Specifies the number of dispatch threads to be started for this session. It is recommended that you set the threading after configuring all the services. Setting the threads after configuring the services will allow you to inspect all the different sessions and choose the appropriate thread counts.

Logging Tab

The Logging tab contains the fields listed in Table 6, Field Description of Logging Tab:

Table 6 Field Description of Logging Tab  

Field	Description
Use Advanced Logging	When the Use Advanced Logging checkbox is not checked (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 checked, you have complete control on selecting the destinations and associating desired 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: • File • Hawk • Network • STDIO 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 Hawk sessions, see Chapter 6, Monitoring the Adapter Using TIBCO Hawk. 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 messages 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.
Log to Standard I/O	(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.
Log File	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.
Log Info/Debug/Warning/Error Messages	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.

Startup Tab

The Startup tab contains the fields listed in Table 7, Field Description of Startup Tab:

Table 7 Field Description of Startup Tab  

Field	Description
Show Startup Banner	Select this option to show the startup banner. The startup banner displays the runtime adapter version, the infrastructure version on which the adapter is built, and copyright information in the console window when the adapter is started.
Metadata Search URL	This field has been disabled and is no longer available for use.

Monitoring Tab

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.

Table 8 Field Description of Monitoring Tab  

Field	Description
Enable Standard Microagent	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 checkbox or text value (true or false) can be used to turn the standard microagent on or off.
Standard Microagent Name	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 runtime by the runtime adapter.
Enable Class Microagent	Allows you to turn on or off the instance or class specific standard TIBCO Hawk Microagent. The way to turn it on or off is also configurable. By clicking the globe icon, a standard checkbox or text value (true or false) can be used to turn the class microagent on or off.
Class Microagent Name	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.
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.
Standard Microagent Timeout	See Class Microagent Timeout above.
Default Microagent Session	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.

Copyright © TIBCO Software Inc. All Rights Reserved