Subjects configuration

This page contains information on how to configure subjects FX Mobile.

For information on how to configure subjects in the FX Mobile web app, see see Configure FX Mobile.

For information on how to configure subjects in the FX Mobile native app, contact your Caplin Account Manager.

Configuration file format

The configuration file Subjects.json contains a single JSON object. Each property of the object constitutes a configuration option.

The table below lists the properties of the JSON configuration object. All property names are case sensitive unless stated otherwise.

JSON object properties
Property Type Value description

TRADE.CHANNEL

String

Trade channel subject.

TRADE.RATE

String

Currency-pair rate subject. Accepts ${currencyPair}, ${tenor}, ${dealtCurrency}, and ${amount} substitution tokens.

ORDER.CHANNEL

String

Order channel subject.

ORDER.RATE

String

Order rate subject. Accepts ${currencyPair}, ${tenor}, ${dealtCurrency}, and ${amount} substitution tokens.

BLOTTER.HISTORIC

String

Historical blotter subject.

CALENDAR.TENORDATES

String

Currency-pair tenors subject. Accepts the ${currencyPair} substitution token.

WATCHLISTS.CONTROL

String

Watchlist control subject. Messages are sent on this channel to create, rename, reorder, and delete watchlists.

WATCHLISTS.LIST

String

Watchlist list subject. A list of all watchlists.

CHARTS

String

Prefix for chart subjects.
JSON example
{
  "TRADE.CHANNEL": "/PRIVATE/TRADE/FX",
  "TRADE.RATE": "/FX/${currencyPair}/${tenor}/${dealtCurrency}/${amount}",
  "ORDER.CHANNEL": "/PRIVATE/ORDERS/FX",
  "ORDER.RATE": "/FX/${currencyPair}/${tenor}/${dealtCurrency}/${amount}?ORDER",
  "BLOTTER.HISTORIC": "/PRIVATE/FX/BLOTTER/HISTORIC",
  "CALENDAR.TENORDATES": "/CALENDAR/TENORDATES/${currencyPair}",
  "WATCHLISTS.CONTROL": "/PRIVATE/WATCHLIST/CONTROL",
  "WATCHLISTS.LIST": "/PRIVATE/WATCHLIST/ALL",
  "CHARTS": "/CHARTS"
}