Configuration file: trapi-connection.properties
This page describes configuration properties that can be set in a RET adapter’s trapi-connection.properties
file, whichi configures the adapter’s connection to RET.
For descriptions of a RET adapter’s Caplin DataSource options, see Configuration file: datasource.conf.
For descriptions of a RET adapter’s application options, see Configuration file: adapter.properties.
File location and format
When a RET adapter is deployed to a Caplin Deployment Framework, the adapter’s TrAPI connection configuration file is available for editing at global_config/overrides/adapter/etc/trapi-connection.properties
.
The configuration file is in INI format.
[common]
host=192.168.1.50
port=8912
reconnection_exponential_initial_interval=5
reconnection_exponential_max_interval=600
[LBNConnection]
username=lbn_proxy
password=letmein
order_type=LBN
[AdminConnection]
username=lbn_admin
password=letmein
order_type=admin
Common connection properties
Configuration properties common to all connections.
Option | Default | Description |
---|---|---|
|
|
Enables wrapping of Admin API log output with the Adapter logging framework |
|
|
Loads the users from a user’s userset assignments |
|
|
Adds the user to the userset |
|
A comma separated list of locations and their time zones in the following format:
where |
|
|
|
When true order history is cached as part of order caching. |
|
Whether or not settlement currency holidays should be valid to trade on |
|
|
|
The connection type |
|
|
Folder holding all configuration files. |
|
|
Connection pool key |
|
If only certain currency pairs should be loaded, list them here. By default all currency pairs are loaded. |
|
|
|
The default timeout for keeping a connection locked in each of the engine locking transactions |
|
A comma-separated list of hosts on which the SCS Relay runs. Each host can be a hostname or IP address. |
|
|
The instruments configured in the RET system. Required if there are more instruments than FX.CROSS. |
|
|
|
Reserved property name that is populated from the section header, e.g |
|
|
|
|
|
|
|
|
Location of the LBN ret log files |
|
|
|
|
|
The RET LBN Order resource name. |
|
Enable query records with paging. |
|
|
|
Number of records per page. |
|
|
Whether the admin connection should automatically create inverse currency pairs |
|
|
The time to keeping a strategy locked measured from the last action in a strategy modify transaction |
|
|
When set to |
|
|
The cypher used to encrypt passwords |
|
Base 64 encoded key |
|
|
Base 64 encoded password to the key in |
|
|
|
The delay in milliseconds to wait between receiving an |
|
The default timeout for keeping a connection locked for cancel order engine transactions |
|
|
The default timeout for keeping a connection locked for delete order engine transactions |
|
|
The default timeout for keeping a connection locked for modify order engine transactions |
|
|
A comma-separate list of ports, corresponding the comma-separated list of option |
|
|
|
Pool size of rate subscription threads. |
|
|
Determines whether the inverse of a restricted currency pair should also be restricted |
|
|
The interval, in seconds, between connection and re-connection attempts. |
|
|
The number of re-connection attempts to be made. Set to |
|
The initial reconnection interval interval value which will be increased exponentially |
|
|
The maximum reconnection interval value which can be set exponentially |
|
|
|
If true we re-request the deal from Refinitiv. On Default false we just process the incoming deal as it is. |
|
|
The desired name of the TrAPI log |
|
|
The desired location of the TrAPI/LBN/AdminAPI logs. Bypassed on Admin API if |
|
|
True if you want the logs to be appended or false if you want individual logs |
|
|
Enable TrAPI/LBN/AdminAPI logging. Bypassed on Admin API if |
|
The default timeout for keeping a connection locked for unlock order engine transactions |
|
|
The default timeout for keeping a connection locked for lock order engine transactions |
|
|
The default timeout for keeping a connection locked for activate order engine transactions |
|
|
The default timeout for keeping a connection locked for deactivate order engine transactions |
|
|
The default timeout for keeping a connection locked for submit and activate order engine transactions |
|
|
The default timeout for keeping a connection locked for submit order engine transactions |
|
|
|
Optional property to multiply calculate how many seconds per time unit used in timeouts |
|
|
The time in milliseconds between which trading connections are connected to RET. |
|
A pipe separated list of TrAPIProperties |
|
|
A pipe separated list of TrAPIProperties |
|
|
||
|
If only certain user groups should be loaded, list them here. By default all user groups are loaded. |
|
|
A comma-separated list of users from which to load user sets. |
|
|
|
When received |
|
|
Set this flag for order submit if LOMSServer setting |
|
|
If true then sets 'Use Client Decimal Places' to true on a trade before submitting it. This must be true if 'Edit Extra Spot DPS' is enabled in your RET Admin Applet, else you may see inconsistent SPOT and All In Rates. |
|
|
Defines whether the taker order custom field for orders and trades is URL Encoded. |
|
|
Determines whether Order Activation should be regarded as successful on a |
Specific connection properties
Configuration properties specific to a single connection.
Option | Default | Description |
---|---|---|
|
Optional parameter for rates connections, if specified then the rate connection will explicitly select this proxy client |
|
|
|
Specifies which type of RET Connection to make: |
|
Password of the RET user for this connection |
|
|
|
Set to true if this is a trading connection, which means it is not necessary to specify a client (unlike rates connections). |
|
Username of the RET user for this connection (all connections in a suite of RET adapters must have unique user names) |