Adapter Properties File


The run-time adapter parses a properties file at startup.

The default properties file is located in bin subdirectory of the adapter installation directory.

Each line in a properties file is a single property. Each property consists of a key and a value. The key starts with the first non-whitespace character and ends at the first "=", ":", or whitespace character. The value starts at the first character after the equal sign (=). For example:

 
tibco.configurl=/tibco/private/adapter/test/config/config1 
tibco.repourl=tibcr://TEST_PROJECT 
tibco.username=admin 
tibco.password=samplePassword 
tibco.clientVar.service=7600 
tibco.clientVar.daemon=tcp:7600 

Properties defined in the properties file override the same properties defined in the project.

Properties File Format

The following restrictions apply to properties:

Predefined Properties

The next table describes predefined properties. Properties that start with ntservice are available only on Microsoft Windows platforms.

All paths inside a properties file, including Microsoft Windows directory names, must use forward slashes.

Table 7 Predefined Properties for Adapter Service
Property
Description
tibco.repourl
Identifies the absolute pathname to the TIBCO Designer project where the adapter configuration is defined. See Server Repository URL for information about the locator string.
tibco.configurl
Specifies the location of the adapter configuration inside the project file.
  • If a relative path is specified, the adapter service is assumed to be under the default area in the project: /tibco/private/adapter/
  • If an absolute path is specified, the adapter configuration is looked up in the project as defined by the argument.
tibco.username
The user name and password used by the repository server to access the project.
tibco.password
adcom.perfMon <on/off>
Turns the performance statistics microagent on or off.
adcom.addCustomHawkMethodstoStdMAgent <on/off>
If set to on, custom methods are added to the standard microagent. If set to off, custom methods are not available from the standard microagent. Default is on.
adcom.dispcount
Specifies the polling interval at which the adapter should poll the configured JMS queues, when JMS transport is used. The valid values are between 100 - 1000. To achieve stability, setting an optimum value, which is 500, is recommended. For example, adcom.dispcount 500.
ntservice.name
Name for this Microsoft Windows Service.
This property is useful if you wish to have multiple Microsoft Windows Services for the same executable. That is, you may wish to have two adapters running on the same machine. By specifying different service names and display names for the adapters, you can accomplish this.
ntservice.displayname
Name to display in the Services control for this Microsoft Windows Service.
This property is useful if you wish to have multiple Microsoft Windows Services for the same executable. That is, you may wish to have two adapters running on the same machine. By specifying different service names and display names for the adapters, you can accomplish this.
ntservice.starttype
Start type for this Microsoft Windows Service. Either manual or automatic. For example:
ntservice.starttype=automatic 
You can use this property to initially set the start type for the service, but once the service is installed, use the Microsoft Windows Services control to change the start type of services.
ntservice.binary.path.absolute
Absolute path to the executable that is run when the service is started. For example:
ntservice.binary.path.absolute=C:/tibco/a
dapter/adcom/5.3/bin/adcomService.exe 
ntservice.interactive
Specifies whether the Microsoft Windows Service is interactive. Either true or false.
ntservice.interactive=true 
ntservice.account
Username under which to run the Microsoft Windows Service.
You can use this property to initially set the account for the service, but once the service is installed, use the Services control to change the user account of services.
ntservice.password
Password for the username in the ntservice.account property.
You can use this property to initially set the password for the user account, but once the service is installed, use the Services control to change the password.

Table 8 Predefined Properties for Adapter Interceptor
Property
Description
tibco.clientVar.<varname>
Specifies run-time values to substitute for global variables defined in the project. This value takes precedence over the named global value set in the project. Substitution takes place only at start up.
You append the global variable to tibco.clientVar, then give its value. For example:
tibco.clientVar.DirLedger=C:/tibco/adapte
r/adcom/5.3/myledger 
adcom.AdStartTime
Specifies the start up timeout value of the adapter’s Interceptor component, in minutes, when a repository file is used over the HTTP protocol. The valid values are between 5 - 50 minutes. For example, adcom.AdStartTime 5.


TIBCO Adapter™ for COM User’s Guide
Software Release 5.3, September 2005
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com