AdapTable Version:

Framework:

FDC3 Intents

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 Intents; users can:
- Raise Intents
- Listen for Intents
- Create Custom Intents

Intents are FDC3 actions that a user wants to perform or react to.

AdapTable supports Intents through the intents property in FDC3 Options.

This object is of type Fdc3IntentOptions which contains these properties:

Property	Description
handleIntent	Handles incoming Intents (standard and custom)
handleIntentResolution	Handles the IntentResolution that a raised Intent might return
listensFor	Subscribe to given standard Intent(s)
raises	Raises given standard Intent(s) on various Grid Actions

As can be seen, users are able both to Raise and Listen For FDC3 Intents.

Available Intents

The FDC3 Intents supported by AdapTable (and the Contexts they can be used in) are as follows:

FDC3 Intent	Available Contexts
StartCall	Contact, ContactList
StartChat	Contact, ContactList, ChatInitSettings
StartEmail	Email
ViewAnalysis	Instrument, Organization, Portfolio
ViewChart	Chart, Instrument, Organization, Portfolio, Position
ViewContact	Contact
ViewHoldings	Instrument, InstrumentList, Organization
ViewInstrument	Instrument
ViewInteractions	Contact, InstrumentList, Organization
ViewNews	Country, Instrument, InstrumentList, Organization, Portfolio
ViewOrders	Contact, InstrumentList, Organization
ViewProfile	Contact, Organization
ViewQuote	Instrument
ViewResearch	Contact, InstrumentList, Organization

Raising Intents

Intents are raised using the raises property in the intents section of FDC3 Options.

Each Intent to raise is listed by type (e.g. ViewQuote) and followed by the Intent-raising behaviour.

Caution

Make sure all intents you raise 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 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 raise an Intent using both Context Menu and FDC3 Action Column

raises

RaiseIntentConfiguration

Raises given standard Intent(s) on various Grid Actions

RaiseIntentConfiguration

Property which defines which FDC3 Intents can be raised.

It provides an object of type RaiseIntentConfiguration.

It is essentially a collection of RaiseIntentConfig each of which is defined as follows:

Property	Description
actionButton	Definition of Action Button (to be put in default FDC3 Action Column)
actionColumn	Custom FDC3 Action Column definition for the Intent
contextMenu	Columns to display a 'Raise Intent' Context Menu item
contextType	Key of Context being Raised
handleIntentResolution	Handles the IntentResolution for this specific raise intent configuration

Each Intent Config has a Key which is the Intent being raised (e.g. ViewQuote, StartCall).

It includes 2 main elements:

context type - the contextType property specifies which context to use (e.g. fdc3.instrument)
Caution
- This context should be referenced in the gridDataContextMapping property of FDC3 Options
- See Mapping columns and fields to FDC3 objects for more information
behaviour - how to Raise the Intent (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

fdc3Options: {
  intents: {
    raises: {
      ViewQuote: [
        {
          contextType: 'fdc3.instrument',
          contextMenu: {
            columnIds: ['ticker'],
          },
          actionButton: {
            id: 'ViewQuoteButton',
            label: 'View Quote',
            icon: {
              name: 'info',
            },
            tooltip: '_defaultFdc3',
          },
        },
      ],
      ViewInstrument: [
        {
          contextType: 'fdc3.instrument',
          contextMenu: {
            columnIds: ['instrument', 'ticker'],
          },
          actionColumn: {
            columnId: 'fdc3ViewInstrumentColumn',
            friendlyName: 'FDC3: ViewInstrument',
            button: {
              id: 'ViewInstrumentButton',
              label: '_defaultFdc3',
              tooltip: '_defaultFdc3',
            },
          },
        },
      ],
    },
  },
},

Listening for Intents

Listening for Intents from external applications is done in 2 stages:

Note

Both of these steps uses a property in the intents section of FDC3 Options

all Intents to handle are listed in the listensFor property
an implementation is given for the handleIntent function property

listensFor

Fdc3IntentType

Subscribe to given standard Intent(s)

Fdc3IntentType

Lists which FDC3 Intents are listened for.

The array is of type Fdc3IntentType which are FDC3 strings (e.g. ViewInstrument, StartCall)

contexts: {
  listensFor: ['ViewQuote', 'ViewInstrument', 'StartCall'],
  handleIntent: (fdc3IntentContext: HandleFdc3IntentContext) => {
    console.log(`Received context: `, fdc3IntentContext);
  },
},

These Intents are then typically handled in the handleIntent function property (see below).

Handling Intents

Incoming FDC3 Intents is handled by the handleIntent property.

handleIntent

Promise<IntentResult> | void

Handles incoming Intents (standard and custom)

Property used to handle incoming FDC3 Intents.

Caution

Make sure that the Intent is listed in the listensFor property - also in the intents object

handleIntent?: (context: HandleFdc3IntentContext) => Promise<IntentResult> | void;

As can be seen the function:

receives an object of type HandleFdc3IntentContext which simply contains the FDC3 Intent
asynchronously returns FDC3's IntentResult object (which is of type Context | Channel | void)

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

PreviousFDC3 Contexts NextFDC3 UI Components

Framework:

FDC3 Intents

Summary

Available Intents

Raising Intents

Caution

Hint

raises

Caution

Find Out More

Listening for Intents

Note

listensFor

Handling Intents

handleIntent

Caution