Configuring Your Application

The OpenFin Runtime requires each application to provide a JSON formatted configuration file. This configuration file defines the visual properties of the app, its dependencies, and other deployment settings. The developer is in control of the app development process and how this file is hosted and configured. Both the openfin-cli and OpenFin RVM will use a configuration file to launch applications as well as make use of other configuration data.

{
    "licenseKey": "contract_identifier",
    "runtime": {
        "version": "14.78.46.23"
    },
    "startup_app": {
        "name": "MyApp",
        "uuid": "33aa9062-9eb0-4875-b819-c90f38ef03ea",
        "url": "http://localhost:8000/index.html",
        "autoShow": true,
        "defaultWidth": 500,
        "defaultHeight": 500
    }
}

Top-level properties

❗️
Properties with an * are mandatory

Property
`startup_app`
`devtools_port`

startup_app object properties

Property
`name`*
`url`*
`uuid`*
`alwaysOnTop`
`applicationIcon`
`autoShow`
`backgroundColor`
`childWindowAutoAuth`
`clearChildSubscriptionsOnReload`
`contextMenu`
`contentNavigation`
`cornerRounding.height`
`cornerRounding.width`
`customWindowAlert`
`defaultCentered`
`defaultHeight`
`defaultLeft`
`defaultTop`
`defaultWidth`
`description`
`fdc3`
`frame`
`icon`
`loadErrorMessage`
`enableAppLogging`
`logManagement`
`logManagement.enabled`
`logManagement.encryptionKey`
`logManagement.url`
`maxHeight`
`maximizable`
`maxWidth`
`minHeight`
`minimizable`
`minimumRVMVersion`
`minWidth`
`nonPersistent`
`opacity`
`plugins`
`preloadScripts`
`resizable`
`resizeRegion.size`
`resizeRegion.bottomRightCorner`
`saveWindowState`
`shadow`
`showTaskbarIcon`
`state`
`taskbarIcon`
`waitForPageLoad`

Property
`permissions`
`ExternalWindow`
`ExternalWindowWrap`
`ExternalWindow.System`
`ExternalWindow.System.downloadAsset`
`ExternalWindow.getAllExternalWindows`
`ExternalWindow.launchExternalProcess`
`ExternalWindow.readRegistryValue`
`ExternalWindow.terminateExternalProcess`

"startup_app": {
    "name": "YourApp",
    "icon": "http://cdn.openfin.co/YourApp/favicon.ico",
    "description": "YourApp",
    "url": "http://cdn.openfin.co/YourApp/",
    "uuid": "OpenfinPOC",
    "backgroundColor": "#fffff",
    "contextMenu": true,
    "contentNavigation": {
        "whitelist": ["https://openfin.co/*"]
    },
    "autoShow": true,
    "defaultWidth": 480,
    "maxWidth": 480,
    "minWidth": 480,
    "maxHeight": 50,
    "defaultHeight": 50,
    "minHeight": 50,
    "defaultTop": 50,
    "defaultLeft": 10,
    "resizable": false,
    "maximizable": false,
    "frame": false,
    "cornerRounding": {
        "width": 5,
        "height": 5,
    },
    "taskbarIconGroup": "myApp",
    "loadErrorMessage": "There was an error loading the application."
}

Runtime properties

Click the link below for additional runtime properties:

Additional Runtime properties

Top-level properties

Property
`appAssets`
`dialogSettings`
`licenseKey`
`offlineAccess`
`overrideConfigUrl`
`runtime`
`services`
`shortcut`
`splashScreenForceDownload`
`splashScreenImage`
`supportInformation`

{
    "splashScreenImage": "http://SERVER/image.png",
    "offlineAccess": true,
    "licenseKey": "8f5ac730-b6a4-4b11-a71c-500427190fda",
}

Runtime object properties

Property
`version`*
`fallbackVersion`
`futureVersion`
`arguments`
`forceLatest`
`enableCacheMigration`

"runtime": {
    "arguments": "",
    "version": "15.80.48.12",
    "fallbackVersion": "14.78.48.16",
    "futureVersion": "16.83.53.26",
    "forceLatest": true
}

appAssets object properties

Property
`alias`
`args`
forceDownload
mandatory
`src`
`target`
`version`

"appAssets": [{
    "src": "http://server/hostedApp.zip",
    "alias": "my-app",
    "version": "3.2.50.71",
    "target": "myapp.exe",
    "args": "--flag=3",
    "mandatory": true
}, {
    "src": "http://server/anotherApp.zip",
    "alias": "foo",
    "version": "0.0.0.72"
}]

shortcut object properties

Property
`company`*
`description`
`diagnostics-shortcut`
`force`
i`con`*
`name`
`startMenuRootFolder`
`target`
`uninstall-shortcut`

"shortcut": {
    "company": "OpenFin",
    "description": "YourApp",
    "icon": "http://cdn.openfin.co/YOurApp/favicon.ico",
    "name": "YourApp",
    "target": ["desktop", "start-menu"],
    "startMenuRootFolder": "foo"
}

dialogSettings object properties

Property
`bgColor`
`logo`
`progressBarBgColor`
`progressBarFillColor`
progressBarBorderColor
`textColor`

"dialogSettings": {
    "logo": "http://openfin.co/wp-content/uploads/2014/11/logo.png",
    "bgColor": 4163183909,
    "textColor": 4293980400,
    "progressBarBgColor": 4278190080,
    "progressBarFillColor": 4281513430,
    "progressBarBorderColor": 4282137660
}

supportInformation object properties

Property
`company`*
`email`*
`enableErrorReporting`
`forwardErrorReports`
`product`*

"supportInformation" : {
    "company": "Company Name",
    "product": "Product Name",
    "email": "[email protected]",
    "forwardErrorReports": true
}

Have questions? Get in touch with us at [email protected].

Top-level properties

❗️Properties with an * are mandatory

startup_app object properties

Runtime properties

Runtime object properties

appAssets object properties

shortcut object properties

dialogSettings object properties

supportInformation object properties

❗️
Properties with an * are mandatory