Architectural Overview

The RET Adapter Suite contains a host of integration adapters that are designed to integrate a RET system with your trading platform, and supply RET functionality and data. Supplied with the Adapter Suite is a toolkit that provides integration points between RET- AD and various Caplin connectivity tools.


Here’s how the RET Adapter Suite fits in with the Caplin stack:

  • Dark Blue layers - RET Specific tools

  • Shaded Green layer - Your own custom implementations and extensions

  • Light Blue layers - Caplin product stack and components (See below)

Caplin FX Motif web app

This layer can be your own client side web trading application or the Caplin FX Professional web trading app. The FX Motif delivers an advanced browser-based web trading application that is built entirely using HTML5, CSS and JavaScript. The application implements many of the tools, libraries and components available with Caplin Trader (see below).

Caplin Trader

This layer can represent your own front-end systems and libraries that power your web trading application. Caplin Trader is a complete development suite for creating HTML5 web trading apps, built on BladeRunnerJS - the development framework for enterprise-scale HTML5 applications. Caplin Trader includes class-leading display components and domain-specific libraries to help you deliver your project. Usually, a completed app will get streaming data and trade services from the Caplin Platform (see below).

Caplin Platform

These layers represent various back-end distribution components for electronic trading over the web. Caplin Platform technology is utilised to handle trading, and stream financial data and messages over the internet to the Presentation layer using the Platform components Liberator and StreamLink. The Caplin Platform also includes Transformer - a high-speed data transformation engine for filtering and managing data streamed from external FX pricing systems, as well as other components to handle permissioning and user-authentication.

Caplin Integration Suite

The Caplin Integration Suite provides a rich of set connectivity tools and APIs that integrate external systems with the Caplin Platform.

FX Integration API

The FX Integration API is a back-end Java library that you can use to quickly and easily integrate the Caplin FX Motif with your existing systems. The library consists of a set of APIs specifically designed to provide the data expected by the FX Motif, in the exact format required. The FX Integration API fully supports the core features of the FX Motif. See The FX Integration API for more details.

Caplin RET Adapter Suite

Supplied with the suite is a number of ready-made adapters that you can easily configure and deploy into the Caplin Platform environment. The various adapters are used to integrate RET functionality. Here’s the full list of the included adapters:

Caplin RET Adapter What it does


The Caplin RET Calendar Adapter is using the RET Adapter Toolkit to provide Tenor dates and Settlement dates.


The Caplin RET FxTradingAdapter is using the RET Adapter Toolkit to provide trading functionality like ESP, RFS and Block Trading.


The Caplin RET LBNAdapter is a Local Bank Node (LBN) adapter using the RET Adapter Toolkit to provide historic blotter data detailing the user’s open and executed deals.


The Caplin RET OrderAdapter is using the RET Adapter Toolkit to provide orders functionality.


The Caplin RET PricingAdapter is using the RET Adapter Toolkit to provide pricing (rates) functionality.


The Caplin RET PermissioningAdapter provides an integration point for an existing external permissions service.


The Caplin RET DirectorPermissioningAdapter integrates with Caplin Director and can replace the Caplin RET PermissioningAdapter.


The Caplin RETAdapterCommonConfig adapter is used for the ActivityBlotter to receive data from the LimitOrderAdapter as well as from the FxTradingAdapter.

RET Adapter Toolkit

The Toolkit contains a pre-built abstraction layer that makes it easy to create new adapters or to customise existing ones. It provides a number of extension points including default implementations for custom RET concerns such as calendar, pricing, trading, permissions, LBN & Orders (assuming that data is incoming via RET or XML files).

RET Toolkit drill down


They include generic code and tests that handle the translation of RET messages into Caplin message specifications and vice versa, as well as handling other business logic.


Default implementations exist for:

  • Calendars

  • Trading

  • Pricing

  • Orders

  • Permissions

  • Blotters

  • Notifications

Custom extensions

These allow you to implement extension points to suit your own specific needs. Caplin supplied modules can be extended and customised. E.g., User Manager can obtain the user mapping via XML, the banks internal system or a flat file. There are custom extension points for:

  • User Manager

  • Account Manager

  • Pricing

  • Trading

  • Orders

  • Audit Trail

  • Blotter

  • Authentication and Permission loading

RET Integration API

This is Caplin’s proprietary abstraction layer that provides easy access and connectivity for Reuters Trading API (TrAPI), Limit Order Management (LOMS,) Local Bank Node (LBN) and Admin API. It converts TrAPI layer messages to FX Integration API/Caplin messages (and vice versa) and handles the connection management with RET systems. The RET Integration API serves as a point of connection between the Trading API provided by Reuters (via TrAPI connectivity) and the RET Adapter Suite. Various RET Integration APIs can be generated to accommodate different versions of TrAPI (3.5/3.X).

Deployment Architecture

The following diagram represents a typical deployment architecture for the Caplin RET Adapter Suite and internal banking systems:

RET Network diagram2

Of course deployment topologies vary in complexity, and the Caplin RET Adapter Suite is equipped with the versatility for deployment into any type of banking system structure.