openfin.json
OpenFin application configuration file
| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/openfin-json/latest.json |
| Source | https://www.schemastore.org/openfin.json |
Validate with Lintel
npx @lintel/lintel checkProperties
Determines which runtime version the app will use.
4 nested properties
Specifies what version of the runtime the app should use. The value can either be a specific version or a release channel (e.g. alpha).
Command line arguments to set when launching the runtime. The OpenFin Runtime supports Chromium command line switches e.g.: "– –disable-accelerated-compositing – –enable-threaded-compositing" for a complete list of values please refer to current Chromium switches.
The RVM will fallback to this version if it fails to retrieve the desired Runtime version, assuming this version is already installed. (RVM 2.8+)
If true, forces the runtime to always get the latest runtime version before launching (prevents background installs).
Settings for the app's desktop shortcut
8 nested properties
Company name for the application shortcut.
Location for the icon image to be used when installing the application shortcut.
Name of the application to display with the shortcut.
A short description of the application shortcut. Will be shown when hovering over the shortcut icon.
If set to true, a desktop icon is always created on application start-up (even when user has deleted it). If set to false, a desktop icon is created on initial application launch but not created on subsequent application launches.
Set this value with a folder path (e.g. foo/bar) and the RVM will create the start menu shortcut under RootFolder/Company/App.
Locations for where the application shortcut is added on the desktop owner's machine. Available options are "desktop", "start-menu" and "automatic-start-up". The default is start-menu and desktop.
Removes the Start menu uninstall shortcut.
Specifies the application level configuration.
36 nested properties
The name for the window which must be unique within the context of the invoking Application.
The URL of the window.
The UUID of the application, unique within the set of all other Applications running in OpenFin Runtime.
The name of this builder instance, which can be specified in the only/except property of a provisioner.
4 nested properties
If true, allows the Dev Tools to be opened with the keyboard shortcut: Ctrl+Shift+i.
If true, allows a window to reload with the keyboard shortcuts: Ctrl+r or F5.
If true, allows a window to reload while ignoring the cache with the keyboard shortcuts: Ctrl+Shift or Shift+F5.
If true, enables the Zoom keyboard shortcuts: Ctrl+ (Zoom in), Ctrl- (Zoom out) and Ctrl+0 (Restore to 100%).
A flag to always position the window at the top of the window stack.
A URL for the icon to be shown in the window title bar.
A flag to automatically show the Window when it is created.
Allow non API created child windows, such as window.open, to authenticate.
Clear InterApplication subscriptions of all child windows when main window is reloaded.
A flag to show the context menu when right-clicking on a window. Gives access to the Developer Console for the Window.
This defines and applies rounded corners for the window.
2 nested properties
This defines and applies rounded corners for the window.
This defines and applies rounded corners for the window.
Specifies that the window will be positioned in the center of the primary monitor when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the position from before the window was closed is used.
The default height of the window. Specifies the height of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the height is taken to be the last height of the window before it was closed.
The default left position of the window. Specifies the position of the left of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the value of left is taken to be the last value before the window was closed.
The default top position of the window. Specifies the position of the top of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the value of top is taken to be the last value before the window was closed.
The default width of the window. Specifies the width of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the width is taken to be the last width of the window before it was closed.
The name for the window which must be unique within the context of the invoking Application.
A flag to show the frame.
A URL for the icon to be shown in the window title bar.
The maximum height of a window. Will default to the OS defined value if set to -1.
A flag that lets the window be maximized.
The maximum width of a window. Will default to the OS defined value if set to -1.
The minimum height of a window.
The minimum width of a window.
A flag to configure the application as a non persistent. Runtime exits if there are no persistent apps running.
A flag that specifies how transparent the window will be. This value is clamped between 0.0 and 1.0.
Enable secured APIs
2 nested properties
1 nested properties
5 nested properties
An array of scripts to download and run before other scripts in the page.
A flag to drop to allow the user to resize the window.
Define the attributes of the window's resize region.
2 nested properties
Defines a region in pixels of an additional square at the bottom right corner of a frameless window.
Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
A flag to cache the location of the window or not.
A flag to show the Window's icon in the taskbar.
A string that sets the window to be "minimized", "maximized", or "normal" on creation.
The URL of an icon to be shown on the desktop. Support formats: Portable Network Graphic (PNG); Size: 256 x 256.
Group your OpenFin apps in the Taskbar. v5.0+
When set to false, the page will render before the "load" event is fired on the window. Caution, when false you will see an initial empty white window.
Set this object to co-deploy native apps along with your app.
If an application specifies a valid "assetsUrl", then that "assetsUrl" will be used as the base portion of the URL instead of the OpenFin default, https://developer.openfin.co/release/.
You can access the Chromium development tools by navigating to the selected port, i.e.: http://localhost:9090.
An optional object to customize the appearance of the RVM progress dialog.
6 nested properties
Determines the color of the dialog. Color value is a decimal representation of a 32 bit number (A,R,G,B). For instance : FF00FF00 or 4278255360 is fully opaque green.
Determines the logo or image in the progress dialog. The logo should be a semi-transparent PNG. 100×25 pixels.
Determines the background color of the area where the progress bar is displayed.
Determines the border color of the progress bar.
Determines the color of the progress bar.
Determines the color of the text displayed above the progress bar location.
A string used as a licensing identifier for each customer/contract (RVM 2.7+). The OpenFin team will generate this for your production app.
You can specify an image to display while the runtime is loading. It takes any image file (including semi-transparent PNGs).
An optional object to customize error messages.
5 nested properties
Displays the company name in the title bar for the support error dialog that appears when an application fails to load.
Displays the email to contact in the support error dialog that appears when an application fails to load.
Displays the product name or application name in the support error dialog that appears when an application fails to load.
To disable the error reporting feature, set this value to false.
When set to true, prompts end users with a dialog when a deployment error occurs from within the RVM and enables them send along log files from their machine. Error reports are delivered to your email address set in supportInformation.