Skip to main content

The AppD format

{
/**
* A unique application identifier (key). This can be any string and does not necessarily need to describe the app.
* @type String
*/
"appId": "X39A765",

/**
* The name of the application. This name should be descriptive of the app (e.g. Gmail, Slack). There may be multiple instances with the same name, for instance with different versions.
* @type String
*/
"name": "MyApp",

/**
* Version of the application.
* @type String
*/
"version": "1.0.0",

/**
* Icons used for the application. This can be a single icon, or a set of icons of different sizes. Should be an array of url references to images.
* @type Array<String>
*/
"icons": ["http://myapp.com/icons/myapp.png"],

/**
* The list of contexts handled by the App.
* @type Array<object>
*/
"intents": [
{
/* The official name of the intent. This name is referenced in interop config. */
"name": "ViewChart",

/* Friendly printable name for the intent. This will appear in the \"UI Resolver\" when an end user is asked to decide which app to send the intent (whenever there is more than one possible resolution). */
"displayName": "View Chart",

/* An filter stating that this app only handles intents for *these* context types. */
"contexts": ["fdc3.instrument"]
}
]

/**
* Type of manifest. Always "finsemble".
* @type String
*/
"manifestType": "finsemble",

/**
* Finsemble's proprietary application config (Following are the most important fields. See documentation.finsemble.com/docs/reference/ConfigReference for all configuration possibilities)
* @type Object
*/

"manifest": {
"window": {
/**
* The url of the app.
* @type String
*/
"url" : "http://myapp.com/myapp.html"
},
"component": {
/**
* The url of a JavaScript preload to be loaded into the app.
*/
"preload": "http://myapp.com/preload.js"
}
}
}

The following optional AppD fields are generally used only when publishing in an "App Catalog":

title: string
Optional title for the application.

tooltip: string
Optional tooltip description.

description: string
Optional long form description.

images: array of images
Optional array of images to display in App Catalog.

contactEmail: string
Optional e-mail to receive queries about the application

supportEmail: string
Optional e-mail to receive support requests for the application

publisher: string
The name of the company that owns the application.

customConfig: array
An optional set of name value pairs that can be used to deliver custom data from an App Directory to a launcher.

See also

Interop

Add an app to your smart desktop

Integrating FDC3-compliant apps into a workflow using the FDC3 workbench

Integrating native apps