Blotter configuration

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

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

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

Contents:

Configuration file format

Configuration file format

The configuration file, BlotterConfig.json, contains a single JSON object, with each configuration item a property of the object.

All property names and enumerated values are case sensitive unless stated otherwise.

Some numeric values are declared as JSON strings. This is a deliberate decision to avoid issues that may arise from floating-point rounding error.

The table below lists the properties of the configuration object.

Property	Data Type	Description
BLOTTER_SUMMARY	Object	The subscription subjects used to populate the trade and order summary tiles.
DEFAULT_SELECTED_TAB	Object	The trade and order blotters to display by default, and, for tablets only, the blotter to display on application load.
ORDER_BLOTTERS	Object	The configuration settings for order blotters
TRADE_BLOTTERS	Object	The configuration settings for trade blotters

Property

Data Type

Description

BLOTTER_SUMMARY

Object

The subscription subjects used to populate the trade and order summary tiles.

DEFAULT_SELECTED_TAB

Object

The trade and order blotters to display by default, and, for tablets only, the blotter to display on application load.

ORDER_BLOTTERS

Object

The configuration settings for order blotters

TRADE_BLOTTERS

Object

The configuration settings for trade blotters

Example

{
    "BLOTTER_SUMMARY": <object>,
    "DEFAULT_SELECTED_TAB": <object>,
    "ORDER_BLOTTERS": <object>,
    "TRADE_BLOTTERS": <object>
}

BLOTTER_SUMMARY

The BLOTTER_SUMMARY configuration property defines the subscription subjects that populate the trade and order summary tiles.

This property takes a single object as its value.

BLOTTER_SUMMARY object
Property	Data Type	Description
ORDERS	String	The subject used to populate the order summary tile.
TRADES	String	The subject used to populate the trade summary tile.

Example:

"BLOTTER_SUMMARY": {
    "ORDERS": "/PRIVATE/FX/BLOTTER/ORDER",
    "TRADES": "/FILTER/PRIVATE/FX/BLOTTER/HISTORIC?filter=(L1_Amount>0);sort=ExecutionDateTime:number:descending"
},

DEFAULT_SELECTED_TAB

The DEFAULT_SELECTED_TAB property determines which trade and order blotters are displayed on first pressing the trade and order summary tiles.

This property takes a single object as its value.

DEFAULT_SELECTED_TAB object
Property	Data Type	Description
ORDERS	String	The route to the default order blotter.
TRADES	String	The route to the default trade blotter.

Example:

"DEFAULT_SELECTED_TAB": {
    "ORDERS": "order-blotter",
    "TRADES": "trade-blotter"
},

ORDER_BLOTTERS

The ORDER_BLOTTERS configuration property holds the configuration settings for each order blotter in FX Mobile.

This property takes an associative array of blotter configuration objects as its value. In the FX Mobile UI, blotter tabs will be laid out from left-to-right in the order in which they are defined in the array.

Blotter configuration object
Property	Data Type	Description
NAME	String	An i18n key for the name of the blotter. The blotter name is displayed in the blotter’s tab and in the global menu. To edit localised text for a blotter’s name, change the entry for `mobile.global-nav-menu.<NAME>` in FX Mobile’s locale dictionaries, where `<NAME>` is the value of this property.
BLOTTER_TYPE	String	The type of the blotter. Valid value: "Orders".
SUBJECT	String	The subscription subject used to populate the blotter.
ROUTE	String	A unique identifier used in JavaScript routing. The route must be unique among order blotters.
SHIELD_MESSAGE	String	An i18n key for the message displayed when there are no records in the blotter. To edit localised text for a blotter’s shield message, change the entry for `mobile.blotter.shield.no.<SHIELD_MESSAGE>` in FX Mobile’s locale dictionaries, where `<SHIELD_MESSAGE>` is the value of this property.
BULK_ACTIONS	Boolean	Set to true to display the bulk actions menu. This property is optional and has a default value of false. This configuration property affects only unfiltered order blotters.

Example:

"ORDER_BLOTTERS":{
  "ALL_ORDERS": {
    "NAME": "allOrders",
    "BLOTTER_TYPE": "Orders",
    "SUBJECT": "/PRIVATE/FX/BLOTTER/ORDER",
    "ROUTE": "order-blotter",
    "SHIELD_MESSAGE": "noOrders",
    "BULK_ACTIONS": true
  },
  "ACTIVE": {
    "NAME": "activeOrders",
    "BLOTTER_TYPE": "Orders",
    "SUBJECT": "/FILTER/PRIVATE/FX/BLOTTER/ORDER?filter=(Status#^Active.*$)",
    "ROUTE": "working-orders",
    "SHIELD_MESSAGE": "noActive"
  },
  "COMPLETED_ORDERS": {
    "NAME": "completedOrders",
    "BLOTTER_TYPE": "Orders",
    "SUBJECT": "/FILTER/PRIVATE/FX/BLOTTER/ORDER?filter=(Status#^completed.*$)",
    "ROUTE": "completed-orders",
    "SHIELD_MESSAGE": "noCompleted"
  },
  "SUSPENDED_ORDERS": {
    "NAME": "deactivatedOrders",
    "BLOTTER_TYPE": "Orders",
    "SUBJECT": "/FILTER/PRIVATE/FX/BLOTTER/ORDER?filter=(Status#^deactivated.*$)",
    "ROUTE": "suspended-orders",
    "SHIELD_MESSAGE": "noDeactivated"
  },
  "CANCELLED_ORDERS": {
    "NAME": "cancelledOrders",
    "BLOTTER_TYPE": "Orders",
    "SUBJECT": "/FILTER/PRIVATE/FX/BLOTTER/ORDER?filter=(Status#^cancelled.*$)",
    "ROUTE": "cancelled-orders",
    "SHIELD_MESSAGE": "noCancelled"
  }
},

TRADE_BLOTTERS

The TRADE_BLOTTERS configuration property holds the configuration for each trade blotter in FX Mobile.

Blotter configuration object
Property	Data Type	Description
NAME	String	An i18n key for the name of the blotter, as displayed in the blotter’s tab and in the global menu. To edit localised text for a blotter’s name, change the entry for `mobile.global-nav-menu.<NAME>` in FX Mobile’s locale dictionaries, where `<NAME>` is the value of this property.
BLOTTER_TYPE	String	The type of the blotter. Valid values: "Trades" and "FilteredTrades". The value "FilteredTrades" is a special value used only for a blotter that displays unsettled trades.
SUBJECT	String	The subscription subject used to populate the blotter. If BLOTTER_TYPE is set to "FilteredTrades", this property is ignored.
ROUTE	String	A unique identifier used in JavaScript routing. The route must be unique among trade blotters.
SHIELD_MESSAGE	String	An i18n key for the message displayed when there are no records in the blotter. To edit localised text for a blotter’s shield message, change the entry for `mobile.blotter.shield.no.<SHIELD_MESSAGE>` in FX Mobile’s locale dictionaries, where `<SHIELD_MESSAGE>` is the value of this property.

Example:

"TRADE_BLOTTERS": {
  "ALL_TRADE": {
    "NAME": "allTrades",
    "BLOTTER_TYPE": "Trades",
    "SUBJECT": "/FILTER/PRIVATE/FX/BLOTTER/HISTORIC",
    "ROUTE": "trade-blotter",
    "SHIELD_MESSAGE": "noTrades"
  },
  "UNSETTLED_TRADE": {
    "NAME": "unsettledTrades",
    "BLOTTER_TYPE": "FilteredTrades",
    "SUBJECT": "",
    "ROUTE": "unsettled-trades",
    "SHIELD_MESSAGE": "noUnsettled"
  }
}