In Transformer, data transformation services are implemented in Transformer Modules. Caplin provides a Transformer module called Refiner that allows large lists of data (containers) to be efficiently filtered and sorted in real time on behalf of client applications. Refiner is supplied as a Service blade that’s deployed in the Caplin Platform Deployment Framework. This tutorial shows you how to deploy the Refiner blade and use it to sort and filter container responses.
Once you’ve completed the steps on this page, you should be familiar with how to deploy Refiner and how to request filtered and sorted data via Transformer.
In these instructions you’ll be using the
In file paths, we’ve called this topmost directory
For a list of
1. Install a Deployment Framework, Liberator and Transformer
The Framework has a built-in demonstration Adapter blade called DemoDataSource that you’ll use to show that Refiner is working. Make sure the DemoDataSource blade is active, by running the following dfw command from the
./dfw activate DemoDataSource
You can verify that the blade has been activated, by running the command:
2. Deploy the Refiner Service blade
The Refiner Service blade is supplied in a zip file with a name like
Once deployed, the blade is active.
Ensure the Transformer is licensed to use the Java Transformer Module.
The Transformer licence file is in <Framework_root>/global_config/licenses/license-transformer.conf and should contain the line:
module jtm transformer
If the licence file doesn’t contain this line, please contact Caplin Support to get a Java Transformer Module licence.
Set up the path to the Java Virtual Machine (JVM).
If your Java installation is a standard JDK installation, you don’t need to change this path. But if the Java installation is non-standard, set it up by running the command
<JVM-location-and-name>parameter must be a Linux style pathname with forward slash (/) separators, even if it’s a Windows path. Don’t use Windows-style backslash (\) separators - the command won’t find the path.
3. Check the Refiner service is available
Start the Liberator, Transformer and DemoDataSource adapter, by running
./dfw startfrom the
The Liberator should recognise the following data services and DataSources. In particular, the status page should show a data service for the Refiner Service, as highlighted in red here:
Stop the Liberator, Transformer and DemoDataSource adapter, by running
./dfw stopfrom the
<Framework-root>directory. This is so you can examine various log files to check Transformer’s working correctly.
Examine the log file
If the Transformer is working correctly, this log contains the version number of the Transformer Module library:
<YYYY/MM/DD-HH:MM:SS.NNN> +0000: INFO: Java Transformer module (6.2.0-297741) starting up <YYYY/MM/DD-HH:MM:SS.NNN> +0000: INFO: Loading user class with identifier jtm <YYYY/MM/DD-HH:MM:SS.NNN> +0000: CRIT: Thread [main/1]: Product: Java Transformer Module Version : 6.2.3-bbbbbb Build Date : dd-Mon-yyyy Build Time : hh:mm Build Number : bbbbbb Copyright : Copyright 1995-2014 Caplin Systems Ltd
In the same log file, you should also see Caplin Refiner registering as a provider for the namespace it uses:
2011/12/16-15:41:05.703 +0000: INFO: Registering as a provider of </FILTER/*>
Examine the log file
If Caplin Refiner is working correctly, this log contains its version number:
<YYYY/MM/DD-HH:MM:SS.NNN> +0000 - Thread [main/1]: SEVERE: Refiner 6.2.3-bbbbbb
If everything looks ok, restart the Liberator, Transformer and DemoDataSource adapter, by running
Log on to Liberator from a web browser and navigate to the Liberator Explorer page:
From the menu on the Liberator’s home page, select Diagnostics
On the Diagnostics page that’s displayed, select the Liberator Explorer link.
4. Request an unfiltered container
The DemoDataSource adapter can supply a container called
/EXAMPLES/PRICING/CONTAINERS/EQUITIES that’s populated with stock prices.
Use Liberator Explorer to request
/EXAMPLES/PRICING/CONTAINERS/EQUITIES. This returns the un-filtered and un-sorted container:
5. Filter the container contents
In Liberator Explorer, request
Liberator routes this request to Transformer, because its RefinerService1 data service contains the
include-pattern ^/FILTER/ (have a look in the Liberator configuration file for the Refiner Service blade at
/FILTER prefix directs Transformer to pass the request on to its Refiner module, which then returns just those instruments whose
BestBid field is greater than
6. Sort the container contents
In Liberator Explorer, request
Now Refiner sorts the instruments in ascending alphabetical order of the
|Frequent updates can have an adverse affect on the performance of Caplin Refiner, Liberator, and the requesting clients.|
About Liberator Explorer
How can I… Use Liberator Explorer to request and send data
How can I… Access Refiner through StreamLink
How can I… Filter and Sort in Refiner
How can I… Configure Refiner
How can I… Configure sorting and filtering (in Caplin Trader 4 grids).
Reference: Refiner configuration properties