Migrate to the Watchlist API

This page describes the steps to taken to migrate your existing watchlist solution to the new Watchlist API.

Prior to the introduction of the Watchlist API, watchlist solutions used Webcentric as a persistence store for watchlist configurations. The new Watchlist API moves responsibility for hosting watchlist configurations to Transformer, where watchlist configurations are hosted as persistent objects. This move brings the benefit of real-time synchronisation of watchlists between concurrent user sessions of Caplin Trader.

An automated migration path from the Webcentric model to the Watchlist API is not possible. The two solutions have different metadata models; converting watchlists from one model to the other must be done manually. In order to support a migration path, the Watchlist API has been designed so that it can be run in parallel with your existing watchlist solution for a period, during which time users migrate their watchlists manually.

Configure support for legacy watchlists

By default, the introduction of version 6.2.2 of the Watchlist Service blade disables support for legacy watchlists. When you upgrade to latest version of the Watchlist Service blade, you must re-enable support for legacy watchlists to allow your users time to migrate their watchlists from the old model to the new model.

Important: if you upgrade to the latest version of the Watchlist Service blade but do not intend to migrate to the Watchlist API, you must still re-enable support for legacy watchlists or your user's existing watchlists will not work.

Instruct users on how to migrate watchlists

Advise users that only new watchlists will take advantage of real-time synchronisation between devices. To migrate old watchlists to the new model, users should:

  1. Navigate to a Caplin Trader screen displaying the old watchlist
  2. Create a new watchlist
  3. ​Drag and drop the contents of the old watchlist into the new watchlist
  4. ​Delete the old watchlist

See also: