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.
dfwcommand of the Deployment Framework. Before entering any
./dfw <command-name>, make sure your current (working) directory is set to the Deployment Framework's topmost directory.
In file paths, we've called this topmost directory <Framework-root>
For a list of
dfwcommands, click here.
- Installation instructions
- Check the Refiner Service is available
- Requesting an unfiltered container
- Requesting a filtered container
- Requesting a sorted container
See the table below for a list of products and components required by Refiner 6.2 and Refiner 7.
The Refiner Service is a licenced Caplin product. To confirm that your Transformer is licensed to use the Refiner Service, look for the following line in your Transformer licence file, <Framework_root>/global_config/licenses/license-transformer.conf.
module jtm transformer
To acquire a licence to run the Refiner Service, contact Caplin Support.
To install Refiner, follow the instructions below:
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 <Framework-root> directory:
./dfw activate DemoDataSource
You can verify that the blade has been activated, by running the command:
The Refiner Service blade is supplied in a zip file with a name like CPB_RefinerService-<version>-<build_number>.zip.
Follow the instructions below to check the Refiner Service is available:
- Start the Liberator, Transformer and DemoDataSource adapter, by running ./dfw start from the <Framework-root> directory.
- Log on to Liberator from a web browser and navigate to the status page (for details of how to do this, see Check the Liberator is running correctly in Installing Liberator).
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 stop from the <Framework-root> directory. This is so you can examine various log files to check Transformer's working correctly.
- Examine the log file <Framework-root>/servers/Transformer/var/jtm.log
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 <Framework-root>/servers/Transformer/var/refiner.log
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: ./dfw start
- 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.
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:
In Liberator Explorer, request /FILTER/EXAMPLES/PRICING/CONTAINERS/EQUITIES?filter=(BestBid>20)
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 <Framework-root>/kits/CPB_RefinerService/CPB_RefinerService-<version>/Liberator/etc/rttp.conf).
The /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 20
In Liberator Explorer, request /FILTER/EXAMPLES/PRICING/CONTAINERS/EQUITIES?sort=FullName:text:ascending
Now Refiner sorts the instruments in ascending alphabetical order of the FullName field:
- Refiner overview
- 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... Implement custom sorting and filtering in Refiner
- How can I... Configure Refiner
- How can I... Configure sorting and filtering (in Caplin Trader 4 grids).
- How can I... Set Refiner user permissions and subject mappings
- Reference: Refiner configuration properties