FDC3 Technical Reference

Summary

FDC3 Options are to used configure FDC3
FDC3 API provides runtime programmatic access to FDC3
FDC3 Message Event is fired whenver an FDC3 Message is sent or received

FDC3 Options

The FDC3 Options section of Adaptable Options is the primary way to configure and manage FDC3:

Property	Type	Description	Default
actionColumnDefaultConfiguration	`ActionColumnDefaultConfiguration`	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
contexts	`Fdc3ContextOptions`	Configures FDC3 standard Contexts that AdapTable will listen for and broadcast
enableLogging	`boolean`	Enable logging message exchanges to Console	false
gridDataContextMapping	`GridDataContextMapping`	Maps Context Type to AdapTable Grid Data
intents	`Fdc3IntentOptions`	Configures FDC3 standard Intents that AdapTable will listen for and raise
resolveContextData	`(context:ResolveContextDataContext) => Context`	Builds Context Data (useful for postprocessing Context Data mapped from Grid data)
uiControlsDefaultConfiguration	`\{ contexts?: \{ [contextName in StandardContextType]?:UIControlConfig; \}; intents?: \{ [intentName in StandardIntent]?:UIControlConfig; \}; \}`	Customises FDC3 UI Controls	contexts: , intents:

FDC3 Intent Options

The FDC3 Intent Options property handles FDC3 Intents behaviour:

Property	Type	Description
handleIntent	`(context:HandleFdc3IntentContext) => Promise<IntentResult> \| void`	Handles incoming Intents (standard and custom)
handleIntentResolution	`(context:HandleFdc3IntentResolutionContext) => Promise<void>`	Handles the IntentResolution that a raised Intent might return
listensFor	`Intent[]`	Subscribe to given standard Intent(s)
raises	`RaiseIntentConfiguration`	Raises given standard Intent(s) on various Grid Actions

FDC3 Context Options

The FDC3 Context Options property handles FDC3 Context behaviour:

Property	Type	Description
broadcasts	`BroadcastConfiguration`	Broadcasts given standard Context(s) on various Grid Actions
handleContext	`(context:HandleFdc3Context) => void`	Handles incoming Contexts (standard and custom)
listensFor	`ContextType[]`	Subscribe to given standard Context(s)

FDC3 API

The FDC3 API section of Adaptable API contains functions relating to FDC3:

Method	Returns	Description
broadcastFromPrimaryKey(primaryKeyValue, contextType, channel)	`Promise<void> \| undefined`	Broadcasts the given Context from the given Row Node with the given Primary Key Value
broadcastFromRow(rowNode, contextType, channel)	`Promise<void>`	Broadcasts the given Context from the given Row Node
buildContextDataForPrimaryKey(contextType, primaryKeyValue)	`Context \| undefined`	Builds FDC3 Context Data based on the given Context Type and the Row Node with the given Primary Key Value
buildContextDataFromRow(contextType, rowNode)	`Context`	Builds FDC3 Context Data based on the given Context Type and Row Node
getContextLabel(contextType)	`string`	Returns the human-friendly label for the given Context Type
getDesktopAgent()	`DesktopAgent`	Returns the FDC3 Desktop Agent
isStandardContextType(contextType)	`boolean`	Checks if the given Context Type is a FDC3 standard Context Type
isStandardIntentType(intentType)	`boolean`	Checks if the given Intent is a FDC3 standard Intent Type
raiseIntentForContextFromPrimaryKey(primaryKeyValue, contextType, appIdentifier)	`Promise<IntentResolution> \| undefined`	Finds and raises an Intent based on the given Context from the given Row Node with the given Primary Key Value
raiseIntentForContextFromRow(rowNode, contextType, appIdentifier)	`Promise<IntentResolution>`	Finds and raises an Intent based on the given Context from the given Row Node
raiseIntentFromPrimaryKey(primaryKeyValue, intent, contextType, appIdentifier)	`Promise<IntentResolution> \| undefined`	Raises an Intent with the given Context from the given Row Node with the given Primary Key Value
raiseIntentFromRow(rowNode, intent, contextType, appIdentifier)	`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 Fdc3MessageSentInfo object provides details of sent messages:

Property	Type	Description
app	`AppIdentifier`	Target application for the message
context	`Context`	Full FDC3 Context for object related to the Event
direction	`'sent'`	Direction - always 'sent'
eventType	`'RaiseIntent' \| 'RaiseIntentForContext' \| 'BroadcastMessage'`	Event Type: `RaiseIntent`, `RaiseIntentForContext,`BroadcastMessage
intent	`Intent`	FDC3 Intent which caused Event to fire (if type is `RaiseIntent`)
adaptableContext	`any`	Custom application Context provided in `AdaptableOptions.adaptableContext`

The Fdc3MessageReceivedInfo object provides details of received messages:

Property	Type	Description
context	`Context`	Full FDC3 Context for object related to the Event
direction	`'received'`	Direction - always 'received'
eventType	`'IntentRaised' \| 'ContextBroadcast'`	EventType: `IntentRaised`, `ContextBroadcast`
intent	`Intent`	FDC3 Intent which caused Event to fire (if type is `IntentRaised`)
metadata	`ContextMetadata`	Metadata associated with the FDC3 Context
adaptableContext	`any`	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
});

PreviousFDC3 Example NextSystem Status Messages