Finance Plugin

AdapTable is data-agnostic and designed to appeal to users in any sector or industry.

However its genesis is in the financial services industry and many of its users work in the financial sector.

Accordingly, the Finance Plugin was developed in order to keep the core product 'sector-neutral' while providing useful functionality for financial services clients through a dedicated plugin.

For instance, it includes specialised Cell Summary operations useful for Financial Services like Weighted Average, and Only.

And it allows columns to be registed as Instrument Columns so they can broadcast FDC3 messages when selected.

Using the Finance Plugin

To use the Finance Plugin you need to do the following:

1. Install the package in npm:

   npm install @adaptabletools/adaptable-plugin-finance

   warning

   The same version of the Finance Plugin must be installed as for the 'core' AdapTable package.

   important

   AdapTable will send a warning message to the console if these are different

2. Import the Plugin in your code when instantiating AdapTable:

   import finance from "@adaptabletools/adaptable-plugin-finance";

3. Add the plugins to the plugins property in AdaptableOptions:

   const adaptableOptions: AdaptableOptions = {

   primaryKey: "OrderId",

   adaptableId: "Finance Demo",

   plugins: [finance()],

   .....

   }

The Finance Plugin Options contains some useful properties if using AdapTable in the financial services sector.

Property	Description
instrumentColumns	Columns to be defined as (FDC3) Instrument
weightedAverageColumns	Columns to use a Weighted Average aggregation

Finance Plugin Options

Cell Summary Definitions

The Finance Plugin provides 2 additional Cell Summary Definitions:

Operation	Columns	Description
Only	Numeric	Returns true if all selected cells match (single column only)
WeightedAverage	Numeric	Calculates the Weighted Average (is using a Weighted Average Column)

Weighted Average Columns

A common scenario in the Finance Industry is to aggregate or summarise data using a Weighted Average.

AdapTable facilitates this by providing Weighted Average Columns which defines the Column on which the aggregation is performed and the supporting Column used to calculate the aggregation.

caution

Aggregations for Weighted Average columns can be turned off and on at runtime through the AG Grid UI, but they can only be defined at design-time

The full definition is as follows:

Property	Description
columnId	Column which will contain the aggregation
weightedColumnId	Column used to perform the aggreation calculation

const adaptableOptions: AdaptableOptions = {

plugins: [

finance({

weightedColumns: [

{

columnId: 'interest',

weightedColumnId: 'bookValue',

},

],

}),

],

};

Weighted Average Cell Summary

The Weighted Average is also used when performing a Cell Summary.

If the selected cells are all in a Weighted Column, the Weighted Average Cell Summary will display the weighted average value for the cells.

FDC3 Instrument Columns

The Finance Plugin Options enables a Column to be defined as an Instrument Column.

The InstrumentColumn object requires a columnId which is the Id of the Column, and at least one 'Instrument Data' column to be picked. It is defined as follows:

Property	Description
bbgColumnId	Column which holds a Bloomberg Ticker value as instrument data
columnId	Column to be defined as an Instrument - its value will provide the name property in the FDC3 message
cusipColumnId	Column which holds a CUSIP value as instrument data
figiColumnId	Column which holds a FIGI value as instrument data
isinColumnId	Column which holds an ISIN value as instrument data
permidColumnId	Column which holds a PERMID value as instrument data
ricColumnId	Column which holds a Reuters Instrument Code value as instrument data
sedolColumnId	Column which holds a SEDOL value as instrument data
tickerColumnId	Column which holds a ticker value as instrument data

const adaptableOptions: AdaptableOptions = {

plugins: [

finance({

instrumentColumns: [

{

columnId: 'instrument',

cusipColumnId: 'CUSIP',

tickerColumnId: 'ticker',

},

],

}),

],

};

When a Column is defined as an InstrumentColumn AdapTable will create an extra Menu Item Broadcast [cell value] to appear in the Context Menu for each cell in the Column.

Broadcasting FDC3 Message

When the context menu item is clicked AdapTable will fire the BroadcastInstrument event which packages the cell value as FDC3 Instrument Context.

For example clicking the entry 'Apple' in a row which contained 'ticker' and 'CUSIP' columns (as per the example above) would produce this Instrument Context:

{

"type" : "instrument",

"name" : "Apple",

"id" :

{

"ticker" : "aapl",

"CUSIP" : "037833100",

},

}

note

If the OpenFin Plugin is also active, then AdapTable will listen to this event and broadcast the context on the currently active channel.

More Information

Visit the Cell Summary Demo to see AdapTable with the Finance plugin.