![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |
You must define the options in this tab before other options can be configured. Click Apply before leaving this dialog to apply the changes.
Table 3 Adapter Instance Configuration See Guidelines for Choosing an Instance Name for more information. The version string indicates the TIBCO ActiveEnterprise (AE) configuration format in which the adapter instance is saved. An adapter instance can be saved in AE 4.0, AE 5.0 or AE fro1 format.When a new adapter instance is created in TIBCO Designer 5.x, the version string is set to AE Version 5.1. When a 4.x adapter instance is opened in Designer 5.x, the Version field is set to AE Version 4.0.---If a 4.x adapter instance is to be run against a 4.x runtime adapter, the instance must be saved with the Version field set to AE Version 4.0.---If you are using TIBCO Designer 5.x to modify 4.x adapter instances, change only the features supported by the 4.x. runtime adapter and use the validation utility to verify the instance before deploying the project. Invoke the utility from the Project>Validate Project for Deployment menu in Designer.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 plug-in allows you to manipulate incoming and outgoing data before sending it on the network or handing it to the target application. Plug-ins can be written using TIBCO Adapter SDK. See TIBCO Adapter SDK Programmer’s Guide for information about writing a message filter.
• 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 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, a Kenan adapter instance named TEST and a Siebel adapter instance named TEST can coexist in the same project.
• Each instance name must be unique for each adapter within a project even if each instance is defined in a different folder. In other words, 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 are derived 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 the next time you rename the adapter instance.This tab allows you to define the connection parameters used to connect to the Kenan/BP application during configuration. At design time, the palette connects to the Kenan/BP application to fetch the details for various operations. Specify values in the following fields to set up the runtime connection.
Table 4 Runtime Connection Tab Security Server Realm The realm of the Kenan/BP server. Global variables can be used to specify the realm of the Kenan/BP server. This is a mandatory field. Security Server Login Name A valid login name used to log on to the Kenan/BP application. Global variables can be used to specify a valid login name. This is a mandatory field. Security Server Password A valid password corresponding to the username. Global variables can be used to specify a valid password. This is a mandatory field. Remember Password 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. The default is -1. Interval Between Reconnect Attempts (milliseconds) Adapter Termination Criteria
Table 5 Multithreading Tab Number Of Threads Specify the number of threads in this field. The maximum value that can be specified for the number of threads is one less than or equal to the number of threads specified in the property PoolableATMI Size of pools properties:The limitation here is that when using the adapter in the mixed mode (in other words, when sending both normal requests and custom call requests), the number of threads configured should be half of the value specified for the PoolableATMI Size of pools properties.Note that by default, the adapter will create one thread to dispatch events for each session listed. The zero in the Number Of Threads column means one thread.This tab allows you to set a termination subject or topic and specify the encoding type, debug level, and verbose mode. Note that the adapter should communicate only with other applications that support the same code pages or Unicode.Click Apply before leaving this dialog to apply the changes.In the Configuration tab, check the Show All Tabs checkbox. Then select the General tab. You can configure general options such as Termination Subject and Encoding values which will be used by all services.
Table 6 General Tab Termination Subject or Topic A message sent on this 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 documentation for information about specifying subject names. See the TIBCO Enterprise Message Service documentation for information about publishing on a topic. Response Namespace This field allows you to designate the namespace of the response message from the adapter. For example, if you type CSG in this field, the response message from the adapter will include namespace information which is xmlns=”CSG”. By default, the value of this field is CSG. Enable DirectParse Check or uncheck this checkbox to enable or disable the direct parse function for the UDT call. For more information, please refer to Chapter 4, Transaction Handling. By default, this field is not checked.Use these settings to configure a log file or log sinks, including which types of trace messages you want to log and where the trace messages are sent. Click Apply before leaving this dialog to apply the changes.
Table 7 Logging Tab Use Advanced Logging If unchecked, the standard log file is used. This is the default. Fill out the remaining fields on this tab. You do not need to read the rest of this field description.If checked, you can set two standard output destinations (sinks) for trace messages and set the tracing level for the roles selected. The following sink types are available:See Creating Log Sinks for more information. Log to Standard I/O If checked, trace messages are displayed in the command prompt window where the adapter is started. This is the same as creating a STDIO sink. If unchecked, trace messages do not display in the window. Specify the name of the log file to which trace messages are written. This is the same as creating a file sink. Global variables can be used to specify the location of the log file. See Using Global Variables for more information.Type the name and file system path, or click Browse and select an existing log file. If no file name is specified, trace information is not written to a file. Log Info/ Debug/ Warning/ Error Messages By default all the error, warning, debug, and information messages are printed in the console window in which the adapter was started. Alternatively, you can specify a log file and path to redirect trace output to a log file located anywhere on your file system. The default log file name is %%DirTrace%%/%%Deployment%%.%%InstanceId%%.log, and is saved in the same directory where your project (repository instance) is stored.Most errors received by the adapter are logged. The only errors that might not be logged are any TIBCO Rendezvous or TIBCO Adapter SDK errors that appear at startup time before tracing can be initialized.Logging trace messages is helpful for troubleshooting. There are four levels of trace messages that you can log: Information, Warning, Debug, and Error. Trace messages are described and listed in Appendix B, Trace MessagesDebug messages should not be logged 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.By default, the Use Advanced Logging checkbox is not checked. In this mode, you configure a standard log file using the fields in this tab.If you check the Use Advanced Logging checkbox, you configure log sinks using icons in the TIBCO Designer project panel. This gives you complete control of selecting the destinations and associating the desired roles with each of the destinations.
1. Check the Use Advanced Logging checkbox.
2. Click Apply.
3. In the TIBCO Designer project panel, select the Log Sinks folder under the Advanced folder.
−
− Create a new log sink by dragging and dropping the GenericLog Sink icon from the palette panel to the design panel. Then select a type in the Sink Type drop-down list in the Configuration tab. Click Apply.
5. With the desired log sink icon selected in the design panel, fill in the fields in the configuration panel. You can also change the name and enter a description for each sink by right-clicking on the sink icon in the project panel.
− File sink logs the trace messages to a file. Specify the file limit, file count, and the option to append or overwrite. By default, the file limit is 30000 bytes, the file count is 3, and the mode is append.
−
− Hawk sink sends each trace message to TIBCO Hawk Monitor or TIBCO Hawk Display using the Hawk session that is created by the adapter for monitoring purposes.
− Network sink publishes each trace message on TIBCO Rendezvous. Specify the session and the subject on which the trace messages needs to be published.
Table 8 Startup Tab Show 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 is predefined and cannot be changed. It specifies the location where the adapter searches for base schemas. All schemas that have been defined and saved at this location are loaded at startup.These settings do not need to be configured unless TIBCO Hawk is installed.You can use microagents to supplement the monitoring information provided by the standard logging capability. Examples of supplemental information that you can obtain with microagents include the repository URL and the command line arguments used to start the adapter.Click Apply before leaving this dialog to apply the changes.See Chapter 7, Monitoring the Adapter Using TIBCO Hawk for a list of all supported microagents.Many of the following fields can use global variables. Click the Global Variables tab in the project panel to add or modify a global variable.
Table 9 Monitoring Tab Enable Standard Microagent This field allows you to turn on or off the standard TIBCO Hawk Microagent. Clicking the globe icon changes the checkbox to a text field, allowing you to specify a global variable. When this is a text field, turn the microagent on and off by entering true or false. 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, COM.TIBCO.ADAPTER.adkenan.%%Deployment%%.%%InstanceId%%.The value for the %%deployment%% and %%InstanceId%% global variable can be set or modified by selecting the session icon and then clicking the Global Variables tab in the project panel. Standard Microagent Timeout This field allows you to specify 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 This field allows you to configure how the class microagent is turned on and off. In most cases, the default setting %%HawkEnabled%% is used. Clicking the globe icon changes the text field to a checkbox. It allows you to turn the instance-specific or class-specific standard TIBCO Hawk 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, COM.TIBCO.adkenan.%%Deployment%%.%%InstanceId%%. Class Microagent Timeout This field allows you to specify 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 This field is predefined and cannot be changed. The session is automatically generated by TIBCO Designer and will be used by the standard, class, and custom microagents.
![]() |
Copyright © TIBCO Software Inc. All Rights Reserved |