FDC3 Technical Reference
FDC3 Options
Fdc3Options
Options for configuring FDC3 in AdapTable
Configures the default FDC3 Actions column
columnId: 'fdc3ActionColumn', headerName: 'FDC3 Actions', width: 200, resizable: true, movable: false, rowScope: ExcludeDataRows: false, ExcludeGroupRows: true, ExcludeSummaryRows: true, ExcludeTotalRows: true
Configures FDC3 standard Contexts that AdapTable will listen for and broadcast
Maps Context Type to AdapTable Grid Data
Configures FDC3 standard Intents that AdapTable will listen for and raise
(context:ResolveContextDataContext) => Context
Builds Context Data (useful for postprocessing Context Data mapped from Grid data)
{ contexts?: { [contextName in StandardContextType]?:UIControlConfig; }; intents?: { [intentName in StandardIntent]?:UIControlConfig; }; }
Customises FDC3 UI Controls
contexts: , intents:
actionColumnDefaultConfiguration is an ActionColumnDefaultConfiguration:
ActionColumnDefaultConfiguration
Default configuration to use for an FDC3 Action Column
gridDataContextMapping is a GridDataContextMapping:
GridDataContextMapping
Which grid columns fill each standard FDC3 context, keyed by the context type.
Set custom for a context type that is not one of the standard names.
Fdc3ContentMapping<Action>
Maps an fdc3.action context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Chart>
Maps an fdc3.chart context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<ChatInitSettings>
Maps an fdc3.chat.initSettings context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<ChatMessage>
Maps an fdc3.chat.message context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<ChatRoom>
Maps an fdc3.chat.room context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<ChatSearchCriteria>
Maps an fdc3.chat.searchCriteria context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Contact>
Maps an fdc3.contact context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<ContactList>
Maps an fdc3.contactList context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Country>
Maps an fdc3.country context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Currency>
Maps an fdc3.currency context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Email>
Maps an fdc3.email context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Instrument>
Maps an fdc3.instrument context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<InstrumentList>
Maps an fdc3.instrumentList context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Interaction>
Maps an fdc3.interaction context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Message>
Maps an fdc3.message context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Organization>
Maps an fdc3.organization context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Portfolio>
Maps an fdc3.portfolio context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Position>
Maps an fdc3.position context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<TimeRange>
Maps an fdc3.timerange context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<TransactionResult>
Maps an fdc3.transactionResult context. Each field is a _colId. or _field. reference.
Fdc3ContentMapping<Valuation>
Maps an fdc3.valuation context. Each field is a _colId. or _field. reference.
{ [key: string]: Fdc3ContentMapping<Context>; }
Column mapping for a context type that is not one of the standard names. The key is the context type.
resolveContextData receives a ResolveContextDataContext:
ResolveContextDataContext
Used to build Context Data
Context
FDC3 Context Data which has been mapped from the grid data based on the given configuration in gridDataContextMapping
ContextType
FDC3 Context Type
Primary Key value of row
any
Row data which is the source of the context data
IRowNode
Row Node which is source of the context data
Custom application Context provided in AdaptableOptions.adaptableContext
uiControlsDefaultConfiguration is a UIControlConfig:
UIControlConfig
Used to customise FDC3 controls (e.g. Action Columns)
Icon to display
FDC3 Intent Options
The FDC3 Intent Options property handles FDC3 Intents behaviour:
Fdc3IntentOptions
Options for configuring FDC3 Intent Behaviour in AdapTable
(context:HandleFdc3IntentContext) => Promise<IntentResult> | void
Handles incoming Intents (standard and custom)
(context:HandleFdc3IntentResolutionContext) => Promise<void>
Handles the IntentResolution that a raised Intent might return
Intent[]
Subscribe to given standard Intent(s)
Raises given standard Intent(s) on various Grid Actions
raises is a RaiseIntentConfiguration:
RaiseIntentConfiguration
When each standard FDC3 intent is raised from the grid. The property name is the intent.
Each value lists the grid actions that raise it (for example a cell click or a button). Use custom for an intent that is not a standard name.
{ [customIntent: string]:RaiseIntentConfig[]; }
When to raise an intent that is not one of the standard names. The key is the intent name.
Grid actions that raise the standard StartCall intent.
Grid actions that raise the standard StartChat intent.
Grid actions that raise the standard StartEmail intent.
Grid actions that raise the standard ViewAnalysis intent.
Grid actions that raise the standard ViewChart intent.
Grid actions that raise the standard ViewContact intent.
Grid actions that raise the standard ViewHoldings intent.
Grid actions that raise the standard ViewInstrument intent.
Grid actions that raise the standard ViewInteractions intent.
Grid actions that raise the standard ViewNews intent.
Grid actions that raise the standard ViewOrders intent.
Grid actions that raise the standard ViewProfile intent.
Grid actions that raise the standard ViewQuote intent.
Grid actions that raise the standard ViewResearch intent.
handleIntent receives a HandleFdc3IntentContext:
HandleFdc3IntentContext
Context used when handling incoming FDC3 Intents
Intent
The FDC3 Intent
Custom application Context provided in AdaptableOptions.adaptableContext
handleIntentResolution receives a HandleFdc3IntentResolutionContext:
HandleFdc3IntentResolutionContext
Context provided in handleIntentResolution callback
IntentResolution
The FDC3 Intent Resolution
Custom application Context provided in AdaptableOptions.adaptableContext
FDC3 Context Options
The FDC3 Context Options property handles FDC3 Context behaviour:
Fdc3ContextOptions
Options for configuring FDC3 Context Behaviour in AdapTable
Broadcasts given standard Context(s) on various Grid Actions
(context:HandleFdc3Context) => void
Handles incoming Contexts (standard and custom)
ContextType[]
Subscribe to given standard Context(s)
broadcasts is a BroadcastConfiguration:
BroadcastConfiguration
When each standard FDC3 context is broadcast from the grid. The property name is the context type.
Use custom for a context type that is not a standard name.
When to broadcast an fdc3.chart context.
When to broadcast an fdc3.chat.initSettings context.
When to broadcast an fdc3.contact context.
When to broadcast an fdc3.contactList context.
When to broadcast an fdc3.country context.
When to broadcast an fdc3.currency context.
When to broadcast an fdc3.email context.
When to broadcast an fdc3.instrument context.
When to broadcast an fdc3.instrumentList context.
When to broadcast an fdc3.organization context.
When to broadcast an fdc3.portfolio context.
When to broadcast an fdc3.position context.
When to broadcast an fdc3.timerange context.
When to broadcast an fdc3.valuation context.
{ [customContext: string]:BroadcastConfig; }
When to broadcast a context type that is not one of the standard names. The key is the context type.
handleContext receives a HandleFdc3Context:
HandleFdc3Context
Context used when handling incoming FDC3 messages
FDC3 API
Fdc3Api
FDC3 intents and context raised from a grid row, and checks for standard FDC3 types.
Promise<void> | undefined
Broadcasts the given Context from the given Row Node with the given Primary Key Value
Promise<void>
Broadcasts the given Context from the given Row Node
Context | undefined
Builds FDC3 Context Data based on the given Context Type and the Row Node with the given Primary Key Value
Context
Builds FDC3 Context Data based on the given Context Type and Row Node
string
Returns the human-friendly label for the given Context Type
DesktopAgent
Returns the FDC3 Desktop Agent
boolean
Whether this context type is one of the FDC3 standard types.
boolean
Whether this intent is one of the FDC3 standard intents.
Promise<IntentResolution> | undefined
Finds and raises an Intent based on the given Context from the given Row Node with the given Primary Key Value
Promise<IntentResolution>
Finds and raises an Intent based on the given Context from the given Row Node
Promise<IntentResolution> | undefined
Raises an Intent with the given Context from the given Row Node with the given Primary Key Value
Promise<IntentResolution>
Raises an Intent with the given Context from the given Row Node
FDC3 Message Event
The FDC3 Message Event is triggered whenever a FDC3 Message is sent or received.
Fdc3MessageInfo
There are 2 different Message Info objects that the Event provides depending whether the FDC3 message was sent or received:
- The
Fdc3MessageSentInfoobject provides details of sent messages:
Fdc3MessageSentInfo
A message AdapTable sent through FDC3.
eventType is RaiseIntent, RaiseIntentForContext or BroadcastMessage. intent is set for RaiseIntent.
Extends , so adaptableApi is included.
AppIdentifier
Target application for the message
Context
Full FDC3 Context for object related to the Event
'sent'
Direction - always 'sent'
'RaiseIntent' | 'RaiseIntentForContext' | 'BroadcastMessage'
What was sent: RaiseIntent, RaiseIntentForContext or BroadcastMessage.
Intent
FDC3 Intent which caused Event to fire (if type is RaiseIntent)
Custom application Context provided in AdaptableOptions.adaptableContext
- The
Fdc3MessageReceivedInfoobject provides details of received messages:
Fdc3MessageReceivedInfo
A message AdapTable received through FDC3.
eventType is IntentRaised or ContextBroadcast. intent is set for IntentRaised.
Extends , so adaptableApi is included.
Context
Full FDC3 Context for object related to the Event
'received'
Direction - always 'received'
'IntentRaised' | 'ContextBroadcast'
EventType: IntentRaised, ContextBroadcast
Intent
FDC3 Intent which caused Event to fire (if type is IntentRaised)
ContextMetadata
Metadata associated with the FDC3 Context
Custom application Context provided in AdaptableOptions.adaptableContext
Event Subscription
Subscribing to the Event is done the same way as with all Adaptable Events:
api.eventApi.on('Fdc3Message', (eventInfo: Fdc3MessageSentInfo) => {
// do something with the info
});
api.eventApi.on('Fdc3Message', (eventInfo: Fdc3MessageReceivedInfo) => {
// do something with the info
});