Configuration file: adapter.properties

This page describes the options that can be set in a RET adapter’s adapter.properties file, which configures the adapter’s application behaviour.

For descriptions of a RET adapter’s Caplin DataSource options, see Configuration file: datasource.conf.

For descriptions of a RET adapter’s TrAPI options, see Configuration file: trapi-connection.properties.

File location and format

When a RET adapter is deployed to a Caplin Deployment Framework, the adapter’s application configuration file is available for editing at global_config/overrides/adapter/etc/adapter.properties.

The configuration file is in INI format.

Example adapter.properties file for a RET LBN adapter
# Time gap between two trades for the same currency
# one_click_gap_time=

# Time interval for JMX statistics publishing
# jmx_publish_interval=

# Error messages from RET
# message_translation=

# Enables the director user manager
use_director_user_manager=false

# How many days to fetch for historic blotter and hour when to restart the adapter
historic_blotter_days_to_fetch=7
#blotter_rollover_hour=0

# Set this if you want the executed & historic blotters to show
# only the completed deals. Otherwise don't set these attributes
# because by default they are both false.
executed_blotter_display_only_completed_deals=true
historic_blotter_display_only_completed_deals=true

# These are the precious metal unit conversions.
metal_conversion=XAUUSD:[KG 995, 31.99], [KG 999, 32.12], [KG 9999, 32.148], [100G 999, 3.212], [10 TOLA, 3.746]
metal_conversion=XAGUSD:[KG,32.1507], [TON, 32150.7]
metal_conversion=XPTUSD:[KG, 32.150722]
metal_conversion=XPDUSD:[KG, 32.150722]

Properties common to all adapter types

Configuration properties common to all types of RET adapter.

Option Default Description

connection_request_timeout

default_connection_request_timeout

30000

use_legacy_trading_types_format

trading_type_to_legacy_type_map

Mapping current FXTradingType values to old values e.g [SPOT:SPOT, FWD:FORWARD, NDF:NDF, TIME_OPTION:TIME OPTION, SWAP:SWAP]

metal_conversion

These are the precious metal unit conversions. (e.g. metal_conversion=XAGUSD:[KG,32.1507], [TON, 32150.7])

jmx_publish_interval

5000L

Time interval for JMX statistics publishing. Java Long literal.

use_director_user_manager

false

Enables the director user manager

message_translation

Error messages from RET

Order adapter properties

Configuration properties specific to order adapters.

Option Default Description

delete_orders_on_fail

false

The Adapter deletes the orders that failed on activation

enable_order_alerts

false

Set this to true to enable the alert feature for orders

alert_on_status

The order statuses that trigger an alert on the front end.

FX trading adapter properties

Configuration properties specific to FX trading adapters.

Option Default Description

use_global_one_click_gap_time

true

Enable to check time gap between two trades for the same currency

use_legacy_one_click_price_mode

one_click_gap_time

5000L

Time gap between two trades for the same currency. Java Long literal.

one_click_gap_time_mode

validate_quote_on_rfs_execution

LBN adapter properties

Configuration properties specific to LBN adapters.

Option Default Description

blotter_rollover_hour

0

Hour when to restart the LBN adapter to resubscribe to blotter.

Pricing adapter properties

Configuration properties specific to pricing adapters.

Option Default Description

serial_executor_pool_size

12

Executor pool size for pricing adapter

Permissioning adapter properties

Configuration properties specific to permissioning adapters.

Option Default Description

load_permissions_in_single_transaction

true

Load permissions from different sources in one transaction instead of separate once

refresh_interval_in_hours

5

Refresh permissions from RET

refresh_interval_in_minutes

0

Refresh permissions from RET

refresh_interval_in_seconds

0

Refresh permissions from RET