AdapTable Version:

Framework:

FDC3 Context

This AdapTable Help Page is being actively updated

AdapTable has just upgraded to FDC3 2.0 and we are working on updating the documentation

Summary

AdapTable fully supports FDC3 Contexts; users can:
- Broadcast Context
- Listen for Context
- Create Custom Context

AdapTable supports FDC3 Contexts through the contexts property in FDC3 Options.

This object is of type Fdc3ContextOptions and contains these properties:

Property	Description
broadcasts	Broadcasts given standard Context(s) on various Grid Actions
handleContext	Handles incoming Contexts (standard and custom)
listensFor	Subscribe to given standard Context(s)

As can be seen, users are able both to Broadcast and Listen For FDC3 Context.

Available Contexts

The FDC3 Intents supported by AdapTable (and the Intents they can raise) are as follows:

FDC3 Context	Available Intents
Chart	ViewChart
ChatInitSettings	StartChat , StartCall, ViewContact
Contact	StartChat , StartCall
ContactList	StartChat , StartCall, ViewProfile, ViewResearch, ViewInteractions, ViewOrders
Country	ViewAnalysis, ViewNews
Currency
Email	StartEmail
Instrument	ViewAnalysis, ViewChart, ViewInstrument, ViewNews, ViewQuote, ViewResearch, ViewInteractions, ViewOrders
InstrumentList	ViewAnalysis, ViewChart, ViewInstrument, ViewNews, ViewQuote
Organization	ViewAnalysis, ViewNews, ViewProfile, ViewResearch, ViewInteractions, ViewOrders
Portfolio	ViewAnalysis, ViewChart, ViewNews
Position	ViewAnalysis, ViewChart, ViewNews
TimeRange
Valuation

Broadcasting Context

FDC3 Contexts are broadcast using the broadcasts property in the contexts section of FDC3 Options.

Each Context is listed by type (e.g. fdc3.instrument) and details the context-broadcasting behaviour.

Caution

Make sure all contexts you broadcast are referenced in the gridDataContextMapping property of FDC3 Options
This is a required step which AdapTable uses to map columns and fields to FDC3 objects

This context-broadcasting behaviour can take one of 2 forms:

a Context Menu entry
an FDC3 Action Column (either a button or full Column definition can be provided)

Hint

It is possible to broadcast Context using the both Context Menu and an FDC3 Action Column

broadcasts

BroadcastConfiguration

Broadcasts given standard Context(s) on various Grid Actions

BroadcastConfiguration

Property which defines which FDC3 Contexts can be broadcast.

It provides an object of type BroadcastConfiguration which contains a collection of BroadcastConfig objects.

Each has Config object has 2 elements:

a key which is the Context being broadcast (e.g. fdc3.instrument, fdc3.currency).
Caution
- This context should be referenced in the gridDataContextMapping property of FDC3 Options
- See Mapping columns and fields to FDC3 objects for more information
properties to define the Broadcast behaviour, i.e. via the Context Menu or using an Action Column / Button:

Find Out More
See FDC3 Action Columns and Buttons for full details on how these Buttons and Action Columns are rendered

Property	Description
actionButton	Definition of Action Button (to be put in default FDC3 Action Column)
actionColumn	Custom FDC3 Action Column definition to broadcast the Context
contextMenu	Columns to display a 'Broadcast' Context Menu item

contexts: {
  broadcasts: {
    'fdc3.currency': {
      contextMenu: {
        columnIds: ['currency'],
        icon: '_defaultFdc3',
      },
      actionButton: {
        id: 'BroadCastCurrencyButton',
        icon: '_defaultFdc3',
        tooltip: '_defaultFdc3',
      },
    },
    'fdc3.email': {
      contextMenu: {
        columnIds: ['interest'],
        icon: '_defaultFdc3',
      },
    },
  },
},

Listening for Context

Listening for Context (that has been broadcast from external applications) is done in 2 stages:

Note

Both steps use a property in the contexts section of FDC3 Options

all Contexts to handle are listed in the listensFor property
an implementation is given for the handleContext function property

listensFor

Fdc3ContextType

Subscribe to given standard Context(s)

Fdc3ContextType

Lists which FDC3 Contexts are listened for.

The array is of type Fdc3ContextType which are FDC3 strings (e.g. fdc3.instrument, fdc3.contact)

contexts: {
  listensFor: ['fdc3.instrument', 'fdc3.contact'],
},

These Contexts are then typically handled in the handleContext function property (see below).

Handling Context

Incoming FDC3 Context is handled by the handleContext property.

handleContext

void

Handles incoming Contexts (standard and custom)

Property used to handle incoming FDC3 Context.

Caution

Make sure that the Context is listed in the listensFor property - also in the contexts object

handleContext?: (context: HandleFdc3Context) => void;

The void function receives an object of type HandleFdc3Context which contains two FDC3 2.0 objects:

Property	Description
context	The FDC3 Context
metadata	The FDC3 Context Metadata related to the context
adaptableContext	Custom application Context provided in `AdaptableOptions.adaptableContext`

contexts: {
  handleContext: (fdc3Context: HandleFdc3Context) => {
    console.log(`Received context: `, fdc3Context);
  },
},

PreviousFDC3 Data Mappings NextFDC3 Intents

Framework:

FDC3 Context

Summary

Available Contexts

Broadcasting Context

Caution

Hint

broadcasts

Caution

Find Out More

Listening for Context

Note

listensFor

Handling Context

handleContext

Caution