Configuration Reference
This document is a complete reference of Finsemble's config options (settings). It is generated from the JSON schema file node_modules/@finsemble/finsemble-core/configs/schemas/finsemble.schema.json
. Required fields are highlighted in green. Hover over any field to get the complete "dot notation" config path.
Config files are located in /public/configs
. You may use "$importConfig" as a way to reference JSON files from one another.
Finsemble's "manifest" is the top level config and is used to bootstrap your SmartDesktop. Within the manifest, finsemble
contains all config that is not directly related to bootstrapping. By convention we consider "finsemble" to be the root of config. So for instance, the full path to a config item would be written as finsemble.foo.bar
.
-
manifestmanifest (object) Highest level manifest object, which includes "finsemble" configuration.
-
allowEvalInPreloadmanifest.allowEvalInPreload (boolean) Set to `true` to delete `unsafe-eval` and `script-src directives` from the content security policy..
-
appAssetsmanifest.appAssets (array) Manifest array of external assets to be automatically downloaded by FEA (as Zip files) and unpacked for use as native applications..
-
aliasmanifest.appAssets[].alias (string) The downloaded asset is referred to in application configurations by alias. Replace the window.path field of a native application with window.alias to use the appAsset.
-
srcmanifest.appAssets[].src (string) URI from which to download a Zip file containing the asset.
-
targetmanifest.appAssets[].target (string) The path within the appAsset Zip file to use to launch the application. This will usually be a path to a .exe, .jar or .bat file..
-
versionmanifest.appAssets[].version (string) A version number for the asset to be downloaded. FEA will only download an asset if it has not already downloaded and cached a copy of the asset with the specified version number..
-
Content-Security-Policymanifest.Content-Security-Policy (string "respect-server-defined-csp") Overwrite the default content security policy for all components. Replace `respect-server-defined-csp` with a custom policy string to activate.
-
devtools_portmanifest.devtools_port (number 9090) Manifest property to set Chromium devTools port. .
-
disableWMICallsmanifest.disableWMICalls (boolean true) (Deprecated) When set to true, Finsemble will not make calls that require Windows Management Instrumentation Command-line (WMIC). This option fills GPU information for the getHostSpecs method and will be removed in a future version..
-
finsemble*finsemble (object) Finsemble's root runtime config. This can be found int "manifest-local.html"..
-
accessibleLinker*finsemble.accessibleLinker (boolean) (DEPRECATED).
-
appd*finsemble.appd (object) Contains Finsemble's app configurations. App config is the primary way that Finsemble learns about apps. Finsemble uses this to create its launcher menus and for driving data integration (interop)..
-
appd[]finsemble.appd[] (object) AppD entries describe apps. (This format follows the FDC3 AppD specification)..
-
appId*finsemble.appd[].appId (string) A unique identifier for the app. This is used programmatically and is not necessarily the same as the app name. It can be any unique string. For instance, there may be more than one app with the same name, such as with different versions..
-
contactEmailfinsemble.appd[].contactEmail (string) Email address to contact for information about the app. (Used when apps are picked out of a third party app catalog.).
-
descriptionfinsemble.appd[].description (string) Textual description of the app..
-
iconsfinsemble.appd[].icons (array) Set of icons for the app. Finsemble will attempt to pick the best matching icon but best practice is a single png size 64x64 with a transparent background..
-
iconfinsemble.appd[].icons[].icon (string) (DEPRECATED) FDC3 1.0 - 1.2 version of 'src' field.
-
sizesfinsemble.appd[].icons[].sizes (string) The size of the icon in the form 32x32. Multiple sizes may be provided for certain image types. This follows the Web Manifest specification..
-
srcfinsemble.appd[].icons[].src (string) The url path for the icon image.
-
imagesfinsemble.appd[].images (array) Set of "screenshots" that describe the app. (This is used when picking apps out of an app catalog.).
-
intentsfinsemble.appd[].intents (array) The set of intents that this app will be listening for. (See Interop tutorial).
-
intents[]finsemble.appd[].intents[] (object) An intent (following the FDC3 format).
-
contextsfinsemble.appd[].intents[].contexts (array) An optional filter stating that this app only handles intents for *these* context types. (Some intents don't have a context type while others may have one or more possible context types.).
-
displayNamefinsemble.appd[].intents[].displayName (string) 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)..
-
name*finsemble.appd[].intents[].name (string) The official name of the intent. This name is referenced in interop config..
-
manifest*finsemble.appd[].manifest (object) The name of the component you are configuring.
-
bootParamsfinsemble.appd[].manifest.bootParams (object) Boot parameter properties.
-
childWindowOptionsfinsemble.appd[].manifest.childWindowOptions (object) Configuration for all child windows created via window.open for this app. Child windows may not join workspaces, group, tab, or tile. childWindowOptions supports the same properties as component....
-
componentfinsemble.appd[].manifest.component (object) Properties associated with how Finsemble manages this application.
-
canMaximizefinsemble.appd[].manifest.component.canMaximize (boolean) (DEPRECATED) Use foreign.services.windowService.allowMaximize.
-
canMinimizefinsemble.appd[].manifest.component.canMinimize (boolean) (DEPRECATED) Use foreign.services.windowService.allowMinimize.
-
categoryfinsemble.appd[].manifest.component.category (string) During dynamic configuration, Finsemble can overwrite components already in the configuration . To prevent this from happening, set this value to "system". This setting is used, for example, to prevent system UI components from being dropped out of the config..
-
centralLoggerNamePrefixfinsemble.appd[].manifest.component.centralLoggerNamePrefix (string) Prefixes the windowDisplayName for the entry in the Central logger..
-
displayNamefinsemble.appd[].manifest.component.displayName (string) Changes the applications's name in the launcher and its label in the pinned item section..
-
enableGrpcfinsemble.appd[].manifest.component.enableGrpc (boolean) (DEPRECATED) Enables GRPC. Can be used from Browserview based applications. grpc is a global variable available at window.grpc or at fin.grpc. Note: sandbox is disabled for these applications..
-
maxReloadAttemptsfinsemble.appd[].manifest.component.maxReloadAttempts (number) Number of maximum reload attempts that should be executed if the component's webcontents fails to load..
-
preloadfinsemble.appd[].manifest.component.preload (boolean,string,array) A preload is a JavaScript file that is inserted into browser page and runs before any other content. Specify a full path for your preloads. You can specify a list of files to be included. Learn more about preloads in Integrating HTML Applications..
-
reloadTimeoutfinsemble.appd[].manifest.component.reloadTimeout (number 60000) Reload timeout for the component's webcontents..
- minimum: 0
- maximum: 999999
-
showDevConsoleOnVisiblefinsemble.appd[].manifest.component.showDevConsoleOnVisible (boolean) If set to `true`, a Chrome developer console will spawn along with the application to assist with debugging..
-
singletonfinsemble.appd[].manifest.component.singleton (boolean) If set to `true`, the application will behave as a singleton; only a single instance can be launched. If the application has already been launched, attempting to launch it will bring it to front..
-
spawnOnHotkeyfinsemble.appd[].manifest.component.spawnOnHotkey (array) The application will be launched when this global hotkey combination is activated by the end user. Example: ["ctrl","alt","a"].
-
spawnOnStartupfinsemble.appd[].manifest.component.spawnOnStartup (boolean) When true, Finsemble will automatically launch this application when the application starts..
-
customfinsemble.appd[].manifest.custom (object) This area is free-form and can support any custom elements associated with the app..
-
foreignfinsemble.appd[].manifest.foreign (object ) This section contains configurations that other applications and services read when they interact with this component..
-
componentsfinsemble.appd[].manifest.foreign.components (object ) Configurations specific to other applications that wish to interact with this app..
-
App Launcherfinsemble.appd[].manifest.foreign.components.App Launcher (object ) App launcher is a drop down menu that launches other application..
-
launchableByUserfinsemble.appd[].manifest.foreign.components.App Launcher.launchableByUser (boolean) If true, then an App Launcher menu may include this application..
-
Toolbarfinsemble.appd[].manifest.foreign.components.Toolbar (object) Configurations related to the global toolbar (at the top of the monitor)..
-
Window Managerfinsemble.appd[].manifest.foreign.components.Window Manager (object) Configurations specific to an app's window title bar..
-
alwaysOnTopIconfinsemble.appd[].manifest.foreign.components.Window Manager.alwaysOnTopIcon (boolean) When set to `true`, all windows can be pinned so that they are always on top (like a sticky note). You can override this setting for specific components in their config..
-
componentCloseTimeoutfinsemble.appd[].manifest.foreign.components.Window Manager.componentCloseTimeout (number 5000) Time (in ms) to wait for the component to close successfully. If the component hasn't closed within this limit, it will be force closed..
-
deliveryMechanismfinsemble.appd[].manifest.foreign.components.Window Manager.deliveryMechanism (string "injection") Which delivery method to use for scripts (e.g., FSBL, title bar, etc.) - Valid values are:
"injection" - Injects the code into the window..
"injection"
"preload"
-
disableBrowserViewfinsemble.appd[].manifest.foreign.components.Window Manager.disableBrowserView (boolean) (DEPRECATED) Use titlebarType instead. When set to `true`, the window titlebar will be injected directly into the window's content pane, rather than separated out into a separate browserview within the window..
-
floatingTitlebarComponentfinsemble.appd[].manifest.foreign.components.Window Manager.floatingTitlebarComponent (string) This config sets which component Finsemble will use as a title bar for native application components. By default, the only value is "FloatingTitlebar." This config exists in the event you wish to customize this behavior with a customized title bar component and created a configuration for it in components.json.
-
FSBLHeaderfinsemble.appd[].manifest.foreign.components.Window Manager.FSBLHeader (boolean,object true) This config controls the Finsemble window title bar UI component. FSBLHeader can be true, false or an object. If true then the window title bar will be injected into the component and the maximize, minimize, and close buttons will be displayed. If false, the title bar will not be displayed. If an object, you can tweak several details as to whether buttons are shown or how content is loaded under the title bar..
-
hackScrollbarfinsemble.appd[].manifest.foreign.components.Window Manager.FSBLHeader.hackScrollbar (boolean) Unless set to false, a window's vertical scrollbar will be positioned underneath the Finsemble window title bar using html{ overflow-y: none} and body{ overflow-y: auto}.
-
hideClosefinsemble.appd[].manifest.foreign.components.Window Manager.FSBLHeader.hideClose (boolean) Value indicating whether the close button is hidden in the component titlebar.
-
hideMaximizefinsemble.appd[].manifest.foreign.components.Window Manager.FSBLHeader.hideMaximize (boolean) When set to true, the Maximize icon will be hidden from the component's titlebar..
-
hideMinimizefinsemble.appd[].manifest.foreign.components.Window Manager.FSBLHeader.hideMinimize (boolean) When set to true, the Minimize icon will be hidden from the component's titlebar..
-
persistWindowStatefinsemble.appd[].manifest.foreign.components.Window Manager.FSBLHeader.persistWindowState (boolean) If the component is part of the workspace, this tells Finsemble whether it should persist the position of the window when it moves..
-
showLinkerfinsemble.appd[].manifest.foreign.components.Window Manager.FSBLHeader.showLinker (boolean) (DEPRECATED Set this to true only when using deprecated linkerClient. The linker will now automatically display when the FDC3 Interop client is activated with an API call. `showLinker: false` will override, preventing the linker from being displayed if you have a use case where you don't want to display the linker..
-
titlefinsemble.appd[].manifest.foreign.components.Window Manager.FSBLHeader.title (boolean) (DEPRECATED) Sets the title in the window title bar. Instead, please set the title in your HTML and Finsemble will pick it up..
-
zoomDefaultfinsemble.appd[].manifest.foreign.components.Window Manager.FSBLHeader.zoomDefault (number) Default zoom level to set for the component when using the zoom.js sample preload..
-
titlebarTypefinsemble.appd[].manifest.foreign.components.Window Manager.titlebarType (string "browserview") Determines how the window titlebar is added to the window. The default 'browserview' separates the titlbar and content pane into separate browserviews, while setting 'injected' will cause the titlebar and its styles to be injected directly into the content pane..
"browserview"
"injected"
-
zoomfinsemble.appd[].manifest.foreign.components.Window Manager.zoom (object) Configuration for the zoom.js preload.
-
maxfinsemble.appd[].manifest.foreign.components.Window Manager.zoom.max (number 5) The maximum allowed zoom level..
-
minfinsemble.appd[].manifest.foreign.components.Window Manager.zoom.min (number 0.2) The minimum allowed zoom level..
-
stepfinsemble.appd[].manifest.foreign.components.Window Manager.zoom.step (number 0.1) How much the zoom should increase or decrease when zooming in or out..
-
timeoutfinsemble.appd[].manifest.foreign.components.Window Manager.zoom.timeout (number 3000) The number of milliseconds the zoom pop up should be displayed before it is hidden..
-
servicesfinsemble.appd[].manifest.foreign.services (object) Configurations for services that will interact with this application..
-
windowServicefinsemble.appd[].manifest.foreign.services.windowService (object) Configurations that the window service will apply to this app..
-
allowAutoArrangefinsemble.appd[].manifest.foreign.services.windowService.allowAutoArrange (boolean true) If `true`, the window can be auto arranged. If `false`, will disable the window's ability to be auto arranged by the Window Service..
-
allowGroupingfinsemble.appd[].manifest.foreign.services.windowService.allowGrouping (boolean true) If `true`, the window can form groups with other windows. If `false`, this window cannot be placed into a group..
-
allowMaximizefinsemble.appd[].manifest.foreign.services.windowService.allowMaximize (boolean true) If `true`, the window can be maximized. If `false`, the window cannot be maximized..
-
allowMinimizefinsemble.appd[].manifest.foreign.services.windowService.allowMinimize (boolean true) If `true`, the window can be minimized to the taskbar. If `false`, the window cannot be minimized..
-
allowSnappingfinsemble.appd[].manifest.foreign.services.windowService.allowSnapping (boolean true) If `true`, this window can be snapped. If `false`, this window cannot benefit from snapping..
-
allowTabbingfinsemble.appd[].manifest.foreign.services.windowService.allowTabbing (boolean) If `true`, the window's titlebar will include a tab header that can be dragged or have other tabs dropped onto it. If `false`, tabbing will be disabled for this window..
-
allowTilingfinsemble.appd[].manifest.foreign.services.windowService.allowTiling (boolean) If `true`, the window can be tiled on by other windows by dragging tab headers onto its body (below the titlebar). If `false`, tiling will be disabled for this window..
-
isArrangablefinsemble.appd[].manifest.foreign.services.windowService.isArrangable (boolean) (DEPRECATED) as of 3.6.
-
manageWindowMovementfinsemble.appd[].manifest.foreign.services.windowService.manageWindowMovement (boolean true) If `true`, the Window Service will manage the window's movement. Unless otherwise specified by the following params, this means the Window Service can perform actions on this window: move, group, snap, minimize, maximize, etc. **Note:** If this parameter is omitted and either `foreign.components.Window Manager.FSBLHeader` or if the `window.dockable` is `true`, this will be `true` as well..
-
workspacefinsemble.appd[].manifest.foreign.services.workspace (object) Configurations related to the workspace service..
-
persistPathfinsemble.appd[].manifest.foreign.services.workspace.persistPath (boolean) When true, the application will automatically persist its path through restarts and workspace reloads, even when the path changes in the config. Path is used for "native" (aka "assimilation") windows..
-
persistURLfinsemble.appd[].manifest.foreign.services.workspace.persistURL A global config for application URL persistence. When true, components automatically save their last URL instead of using the one in the config. The application config will override the global config..
-
interopfinsemble.appd[].manifest.interop (object) Interop (data integration) related config for this app.
-
autoConnectfinsemble.appd[].manifest.interop.autoConnect (boolean) If set to true then the app will automatically connect to the Interop service. In most cases, this will cause the linker to display. If set to false (the default) then the app will connect upon the first call to any `fdc` function. .
-
selectConnectfinsemble.appd[].manifest.interop.selectConnect (array) (Experimental). Interop messaging rules to support no-code integration of modules. It allows you to specify precisely which modules can communicate and in what way..
-
selectConnect[]finsemble.appd[].manifest.interop.selectConnect[] (object) A specific selectConnect rule that consists of one or more properties..
-
authorize[]finsemble.appd[].manifest.interop.selectConnect[].authorize[] (object) When set, messages will be restricted to apps that meet the authorization criteria. Note: using 'authorize' is the same as using both 'to' and 'from'..
-
namefinsemble.appd[].manifest.interop.selectConnect[].authorize[].name (string) When set, messages will be delivered to or received from apps with this name only. App name is verified by Finsemble..
-
ccfinsemble.appd[].manifest.interop.selectConnect[].cc (string) The name of a valid selectConnect module. When cc is set, that module will receive a copy of the message. cc works on both outgoing and incoming traffic..
-
contextTypefinsemble.appd[].manifest.interop.selectConnect[].contextType (string) Apply this rule only to this specific context type. (optional).
-
from[]finsemble.appd[].manifest.interop.selectConnect[].from[] (object) When set, messages can be received only from apps that meet the authorization criteria..
-
namefinsemble.appd[].manifest.interop.selectConnect[].from[].name (string) When set, messages will be received only from apps with this name. App name is verified by Finsemble..
-
fwdfinsemble.appd[].manifest.interop.selectConnect[].fwd (string) The name of a valid selectConnect module. When fwd is set, that module will receive the message *instead* of the original description. fwd is intended primarily for outgoing traffic but will also work on incoming traffic..
-
to[]finsemble.appd[].manifest.interop.selectConnect[].to[] (object) When set, messages will be sent only to apps that meet the authorization criteria..
-
namefinsemble.appd[].manifest.interop.selectConnect[].to[].name (string) When set, messages will be sent only to apps with this name. App name is verified by Finsemble..
-
useLinkerfinsemble.appd[].manifest.interop.useLinker (boolean) The linker is turned on by default for any app that uses FDC3. Set this flag to false in order to turn off the linker for this app. For instance, if your app only uses App Channels (i.e. 'well known' named channels)..
-
windowfinsemble.appd[].manifest.window (object) Configurations that manage placement of the application's window on the screen. Configuration settings in this section may also be passed as parameters to `LauncherClient.spawn()`..
-
addToWorkspacefinsemble.appd[].manifest.window.addToWorkspace (boolean true) Specifies whether to add the new component to the workspace. The value set in the component manifest takes priority over any value passed as a parameter to `LauncherClient.spawn` or related functions..
-
affinityfinsemble.appd[].manifest.window.affinity (string) You can control which processes are isolated and which are grouped through the
affinity
config. In this way, you can strike a balance between performance and memory footprint. This config is a string. Group applications together thoughtfully by setting them to the same value. See the Process Management tutorial for more information..
-
aliasfinsemble.appd[].manifest.window.alias (string) May be used with native applications (i.e. when windowType is "native" or "assimilation") instead of `path`. Specifies the alias of a bundled asset to launch..
-
argumentsfinsemble.appd[].manifest.window.arguments (string) Specifies the arguments to be sent to a native application (i.e. when windowType is "native" or "assimilation") on launch. Separate the arguments by spaces: `--arg1 foo --arg2 bar` except when `params.argumentsAsQueryString` is true, in which case set this parameter to be single string in URI format: `arg=1&arg=2`.
-
argumentsAsQueryStringfinsemble.appd[].manifest.window.argumentsAsQueryString (boolean) For native applications (i.e. when windowType is "native" or "assimilation"), causes the generated arguments (the automatically generated arguments and any supplied as the "arguments" parameter) to be encoded as a query string and appended to the URI. This is useful for applications launched via a protocol handler or online ClickOnce deployment, where the path parameter is a URI..
-
bottomfinsemble.appd[].manifest.window.bottom (string,number,null) A pixel value representing the distance from the top edge of the viewport as defined by "position". A percentage value may also be used, representing the percentage distance from the top edge of the viewport relative to the viewport's height..
-
canGroupfinsemble.appd[].manifest.window.canGroup (boolean) (DEPRECATED) Use foreign.services.windowService.allowGrouping.
-
claimMonitorSpacefinsemble.appd[].manifest.window.claimMonitorSpace (boolean) For use with permanent toolbars. The available space for other components will be reduced by the amount of space covered by the newly spawned component. Users will be prevented from moving windows to a position that covers the claimed space..
-
closeComponentsTogetherfinsemble.appd[].manifest.window.closeComponentsTogether (boolean) Whether to close all components within a launchGroup at the same time..
-
componentfinsemble.appd[].manifest.window.component Type of component to spawn..
-
datafinsemble.appd[].manifest.window.data (array,boolean,integer,null,number,object,string) Optional data to pass to the opening window. If set, then the spawned window can use WindowClient.getSpawnData to retrieve the data..
-
dockablefinsemble.appd[].manifest.window.dockable (array,boolean) Parts of the monitor that the component can dock to. Valid values are `top` and `bottom`. The `[]` value is equal `false`. The `true` value is equal `['top', 'bottom']`..
true
false
[]
["top"]
["bottom"]
["top","bottom"]
-
dockedfinsemble.appd[].manifest.window.docked (string) Which part of the monitor that the component will dock to on spawn. Only valid if combined with the `dockable` property..
"top"
"bottom"
-
dockOnSpawnfinsemble.appd[].manifest.window.dockOnSpawn (boolean) (DEPRECATED) this capability will be deprecated in favor of groupOnSpawn. If true, will automatically dock the window with the "relative" window (dock to the parent window unless specified in params.relativeWindow). Note that you must also position the window in a valid position for docking, for example, by setting the "left" or "top" parameters to "adjacent"..
-
envfinsemble.appd[].manifest.window.env Sets environment variables for a spawned native application. Create a map (JSON) object of names to values. This is only available when running Assimilation..
-
ephemeralfinsemble.appd[].manifest.window.ephemeral (boolean) Indicates that this window is ephemeral. An ephemeral window is a dialog, menu, or other window that is temporarily displayed but usually hidden. Ephemeral windows automatically have the following settings assigned: resizable: false, showTaskbarIcon: false, alwaysOnTop: true. Note: Use `options:{autoShow: false}` to prevent an ephemeral widow from showing automatically..
-
forceOntoMonitorfinsemble.appd[].manifest.window.forceOntoMonitor (boolean,string) If true, tries to make the window have no edges outside the monitor boundary..
true
false
"availableRect"
"monitorRect"
-
groupOnSpawnfinsemble.appd[].manifest.window.groupOnSpawn (boolean) Groups the window to the `relativeWindow` based on their adjacent position..
-
heightfinsemble.appd[].manifest.window.height (number,string) A pixel or percentage value..
-
leftfinsemble.appd[].manifest.window.left (string,number,null) A pixel value representing the distance from the left edge of the viewport as defined by "position". A percentage value may also be used, representing the percentage distance from the left edge of the viewport relative to the viewport's width.
"adjacent" will snap to the right edge of the spawning or relative window.
"center" will center the window. If neither left nor right are provided, then the default will be to stagger the window based on the last spawned window..
-
maxHeightfinsemble.appd[].manifest.window.maxHeight (number,boolean,null) Maximum height window can be resized to..
-
maxWidthfinsemble.appd[].manifest.window.maxWidth (number,boolean,null) Maximum width window can be resized to..
-
minHeightfinsemble.appd[].manifest.window.minHeight (number,boolean,null) Minimum height window can be resized to..
-
minWidthfinsemble.appd[].manifest.window.minWidth (number,boolean,null) Minimum width window can be resized to..
-
monitorfinsemble.appd[].manifest.window.monitor (number,string) Specifies which monitor to place the new window.
"mine" - Place the window on the same monitor as the calling window.
Integer value from 0-n (0 being the primary monitor).
"primary" indicates the user's primary monitor.
"all" - Put a copy of the component on all monitors..
-
namefinsemble.appd[].manifest.window.name (string) Window name to apply to the application. The name is not normally specified, allowing Finsemble to generate a random one from the component type. If specified in the configuration, only a single copy of the component can exist at a time..
-
optionsfinsemble.appd[].manifest.window.options (object) Low level window behavior options. Note that `options` may not be passed as arguments to `LauncherClient.spawn` and related API calls.
-
pathfinsemble.appd[].manifest.window.path (string) Specifies the path to a native application (i.e. when windowType is "native" or "assimilation"). The path can be:
- The name of an exe that is on the system path (e.g., notepad.exe).
- The full path to an executable on the user's machine (e.g., C:\Program Files\app.exe).
- A system installed URI (e.g., myuri://advancedapplauncher).
When windowType is "native" then additional arguments will be automatically appended to the path or the URI. These arguments can be captured by the native application in order to tie it to Finsemble's window tracking. When building an application with finsemble.dll, this is handled automatically. Those arguments are:- uuid - A generated UUID that uniquely identifies this window.
- left - The x coordinate of the new window
- top - The y coordinate of the new window
- width - The width of the new window
- height - The height of the new window
- finsembleWindowName - The name of the window in the Finsemble config
- componentType - The component type in the Finsemble config
- appName - The name of the application in the Finsemble appd.
A common troublesome problem is when a native application needs to be launched from an intermediary application (such as a launcher or batch script) or a window needs to be created by a multi-process. multi-window application. The intermediary application or process can pass these parameters along to the final application or thread, which will use them to connect back to Finsemble..
-
positionfinsemble.appd[].manifest.window.position (string) Defines a "viewport" for the spawn, with one of the Position Types:
- available - Positioned according to the coordinates available on the monitor itself, less space claimed by the operating system (such as the windows toolbar). For instance, `bottom:0` will place the new component with its bottom flush against the windows toolbar.
- monitor - Positioned according to the absolute size of the monitor. For instance, `top:0` will place the component overlapping the toolbar.
- relative - Positioned relative to the relativeWindow. For instance, `left:0;top:0` will join the top left corner of the new component with the top left corner of the relative window.
- virtual - Deprecated. Positioned against coordinates on the virtual screen. The virtual screen is the full viewing area of all monitors combined into a single theoretical monitor.
- absolute - Positioned using native operating system coordinates.
.
"available"
"monitor"
"relative"
"virtual"
"absolute"
-
relativeWindowfinsemble.appd[].manifest.window.relativeWindow The window to use when calculating any relative launches. If not set then the window from which spawn() was called. Primarily used as an argument to `LauncherClient.spawn()` and related functions..
-
rightfinsemble.appd[].manifest.window.right (string,number,null) A pixel value representing the distance from the right edge of the viewport as defined by "position". A percentage value may also be used, representing the percentage distance from the right edge of the viewport relative to the viewport's width..
-
setBoundsOnlyfinsemble.appd[].manifest.window.setBoundsOnly (boolean) If true, then visibility of window will not be changed. In other words, a hidden window will not be made visible. Primarily used as an argument to `LauncherClient.showWindow()` and related functions..
-
slavefinsemble.appd[].manifest.window.slave (boolean) If true then the new window will act as a slave to the relativeWindow (or the launching window if relativeWindow is not specified). Slave windows will automatically close when their parent windows close..
-
staggerPixelsfinsemble.appd[].manifest.window.staggerPixels (number) Number of pixels to stagger (default when neither left, right, top or bottom are set)..
-
topfinsemble.appd[].manifest.window.top (string,number,null) A pixel value representing the distance from the right edge of the viewport as defined by "position". A percentage value may also be used, representing the percentage distance from the bottom edge of the viewport relative to the viewport's width..
-
toSpawnfinsemble.appd[].manifest.window.toSpawn (array) (EXPERIMENTAL) An array of objects defining the components to spawn. Each entry may either represent a single component in the form `{componentType, spawnOptions}` or a tabbed window of components in the form `{components, spawnOptions}`, where `components` is an array of single component definitions (again in the form `{componentType, spawnOptions}`). Most arguments that are normally passed to `LauncherClient.spawn` are supported, although positioning will be interpreted as relative to the group's coordinates and dimensions for single components and ignored for tabbed components (as these use the position specified in the group's spawnOptions). Note - This param will only be taken into account if the "windowType" param is "launchGroup"..
[
{
"componentType": "Welcome Component",
"spawnOptions": {
"top": 0,
"left": 0,
"height": 250,
"width": 600,
"data": {}
}
},
{
"components": [
{
"componentType": "Welcome Component",
"spawnOptions": {
"data": {}
}
},
{
"componentType": "Process Monitor",
"spawnOptions": {
"data": {}
}
}
],
"spawnOptions": {
"top": 250,
"left": 0,
"height": 250,
"width": 600
}
},
{
"componentType": "Welcome Component",
"spawnOptions": {
"top": 500,
"left": 0,
"height": 200,
"width": 600,
"data": {}
}
},
{
"componentType": "Process Monitor",
"spawnOptions": {
"top": 0,
"left": 600,
"height": 700,
"width": 300,
"data": {}
}
}
]
-
componentsfinsemble.appd[].manifest.window.toSpawn[].components (array) An array of components to spawn as a tabbed group within the launchGroup.
-
componentTypefinsemble.appd[].manifest.window.toSpawn[].componentType (string) The name of a component to spawn.
-
spawnOptionsfinsemble.appd[].manifest.window.toSpawn[].spawnOptions (object) Minimal definition for component spawn options.
-
urlfinsemble.appd[].manifest.window.url (string) The URL to load for a web application (i.e. when `windowType` is `undefined`, 'WebWindow' or 'application')..
-
widthfinsemble.appd[].manifest.window.width (number,string) A pixel or percentage value..
-
windowTypefinsemble.appd[].manifest.window.windowType (string) Describes which type of component to spawn.
- WebWindow - A normal HTML window. Requires "url" to be specified.
- assimilation - A window that is managed by the Finsemble assimilation process (usually a native window without source code access). Requires "path" or "alias" to be specified.
- native - A native window that has implemented finsemble.dll. Requires "path" or "alias" to be specified.
- application - A standalone application. This launch a component in its own browser process (splintered, giving it dedicated CPU and memory). This can also point to a standalone web application (such as from a third party). Requires "url" to be specified.
- launchGroup - (EXPERIMENTAL) A component made of other components, usually grouped together. See toSpawn property.
.
-
manifestTypefinsemble.appd[].manifestType (string) The type of manifest. This is always equivalent to "finsemble" and can be omitted..
-
name*finsemble.appd[].name (string) The name of the app. This should be a user friendly name and can contain spaces. There may be more than one app with the same name. (See also AppId).
-
publisherfinsemble.appd[].publisher (string) The name of the organization who publishes the app. (This is used when picking apps out of third party catalogs.).
-
releaseNotesfinsemble.appd[].releaseNotes (string) Release notes for this version of the app..
-
supportEmailfinsemble.appd[].supportEmail (string) An email address to contact for support with this app..
-
tagsfinsemble.appd[].tags (array) A set of searchable tags. (Used when picking apps out of an app catalog).
-
versionfinsemble.appd[].version (string) The version of the app. This should follow semantic versioning rules..
-
applicationRoot*finsemble.applicationRoot (string "https://localhost:3375") Should point to the root of your application. Finsemble will use this to build URLs internally..
-
authenticationfinsemble.authentication (object) Contains authentication profiles. The special “STARTUP” profile will be run when your SmartDesktop launches..
-
authentication[]finsemble.authentication[] (object) Declare an authentication profile that uses simple password collection or any other type of custom authentication process..
-
adapter*finsemble.authentication[].adapter (string) The authentication "adapter" (module) which will be used for this authentication profile. (See the Authentication Tutorial)..
"PASSWORD"
"OAUTH2"
-
authorization_endpointfinsemble.authentication[].authorization_endpoint (string) When used with OAUTH2 adapter, the authorization endpoint for your Identity Provider (IP)..
-
backchannel_endpointfinsemble.authentication[].backchannel_endpoint (string) When used with OAUTH2 adapter, your backchannel endpoint URL..
-
client_idfinsemble.authentication[].client_id (string) When used with OAUTH2 adapter, the "client ID" provided by your Identity Provider (IP)..
-
componentfinsemble.authentication[].component (string) The UI component to use for this authentication profile. Typically this would be "authentication.html" used by the "PASSWORD" adapter to display a user/login form..
-
redirect_urlfinsemble.authentication[].redirect_url (string "$applicationRoot/components/authentication/oauthResponse.html") The component to handle the response from your IP. If you don't provide this, *components/authentication/oauthResponse.html* will be used..
-
scopefinsemble.authentication[].scope (string,null openid) When used with OAUTH2 adapter, the "scope" as specified by your Identity Provider (IP)..
-
availableDashbarItemsfinsemble.availableDashbarItems (object) Available dashbar items to list in dashbar user preferences.
-
bootConfig*finsemble.bootConfig (object) Boot/startup configuration parameters used by the System Manager..
{
"bootConfig": {
"defaults": {
"startServiceTimeout": 10000,
"startComponentTimeout": 15000
}
}
}
-
defaultsfinsemble.bootConfig.defaults (object) Default startup-up properties for System Manager.
-
startComponentTimeoutfinsemble.bootConfig.defaults.startComponentTimeout (number 15000) Default timeout value in milliseconds for components.
-
startServiceTimeoutfinsemble.bootConfig.defaults.startServiceTimeout (number 15000) Default timeout value in milliseconds for services.
- minimum: 0
- maximum: 999999
-
configSchemaURLfinsemble.configSchemaURL (string) URL of this schema. Used for run-time verification of configuration. .
-
configVersionfinsemble.configVersion (string) Version of this schema. .
-
failedComponentCloseNotificationfinsemble.failedComponentCloseNotification (boolean) If true throw a notification when a component fails to close within the time limit specified in `finsemble["Window Manager"].componentCloseTimeout`.
-
feaURLWhitelistfinsemble.feaURLWhitelist (string) A regex pattern that represents a URL whitelist. If set, components will **only** be able to navigate to URLs that match the regex pattern..
-
globalHotkeys*finsemble.globalHotkeys (object) .
-
importConfigfinsemble.importConfig (array) Defines an array of JSON URLs to be imported into the top-level finsemble object. Note that this will overwrite any existing config settings, with two exceptions: New services defined under finsemble.services will be added to the list of existing services (as opposed to replacing the existing list of services). New components defined under finsemble.components will be added to the list of existing components (as opposed to replacing the list of existing components)..
[
"$applicationRoot/configs/application/UIComponents.json",
"$applicationRoot/configs/application/components.json"
]
-
importThirdPartyConfigfinsemble.importThirdPartyConfig (array) This import is essentially the same as importConfig with one notable difference: the imported configuration settings cannot overwrite any existing settings. In this case, the settings for any potential overwrite will be discarded with a warning message written to the Config Service's log..
-
initialWorkspacefinsemble.initialWorkspace (string) The workspace name specified by this config will be the first one presented to an end user the very first time they start the SmartDesktop. This overrides the default behavior set by the config: finsemble.workspaces. After the very first instance of the SmartDesktop, Finsemble will load the last workspace loaded or any workspace specified by user preferences..
-
loggerfinsemble.logger (object) .
-
allowNativeErrorNotificationsfinsemble.logger.allowNativeErrorNotifications (boolean) Set to 'true' to allow electron.Notifications for FEA errors.
-
menusfinsemble.menus Legacy config to configure menus. Still used in some configuration examples.
-
moduleRoot*finsemble.moduleRoot (string "https://localhost:3375/finsemble") Where you are serving the Finsemble core library from. This is important for resolving URLs internally..
-
notificationURLfinsemble.notificationURL (string) .
-
preferences*finsemble.preferences (object) DEPRECATED - configurations used as user preferences can be found in the finsemble.servicesConfig section.
-
promptUserOnDirtyWorkspacefinsemble.preferences.workspaceService.promptUserOnDirtyWorkspace (boolean true) DEPRECATED - This config was moved to finsemble.servicesConfig.workspace.
-
routerfinsemble.router (object) Configurations for Router's communication mechanism..
{
"router": {
"crossDomainTransport": "IPCBus",
"sameDomainTransport": "SharedWorker",
"transportSettings": {
"FinsembleTransport": {
"serverAddress": "ws://127.0.0.1:3376"
}
}
}
}
-
scheduledRestartfinsemble.scheduledRestart (boolean,object) Set Finsemble to automatically restart. These values can be overridden by the user through user preferences.
Additional property: dialogTimeout 10000 - When it is time to restart, the user is presented with a dialog to confirm or cancel. Since resets typically occur at night while the machine is unattended, most often the dialog will time out and Finsemble will restart. The `dialogTimeout` specifies how long to wait for a user response in milliseconds..
-
dayOfWeekfinsemble.scheduledRestart.dayOfWeek (number,boolean) The day of the week the task will be run. Sunday - Saturday: 0 - 6. If set to false, the task will be run weekly.
-
hourfinsemble.scheduledRestart.hour (number) 0 - 23. The hour when Finsemble should restart. This is in 24 hour time according to the user's local machine's timezone..
-
minutefinsemble.scheduledRestart.minute (number) 0 - 59. The minute when Finsemble should run the task.
-
scheduledShutdownfinsemble.scheduledShutdown (boolean,object) Set Finsemble to automatically shutdown. These values can be overridden by the user through user preferences.
Additional property: dialogTimeout 10000 - When it is time to shutdown, the user is presented with a dialog to confirm or cancel. Since shutdown typically occurs at night while the machine is unattended, most often the dialog will time out and Finsemble will shutdown. The `dialogTimeout` specifies how long to wait for a user response in milliseconds..
-
dayOfWeekfinsemble.scheduledShutdown.dayOfWeek (number,boolean) The day of the week the task will be run. Sunday - Saturday: 0 - 6. If set to false, the task will be run weekly.
-
hourfinsemble.scheduledShutdown.hour (number) 0 - 23. The hour when Finsemble should restart. This is in 24 hour time according to the user's local machine's timezone..
-
minutefinsemble.scheduledShutdown.minute (number) 0 - 59. The minute when Finsemble should run the task.
-
servicesConfig*finsemble.servicesConfig (object) Configurations that override the defaults for Finsemble's built-in services. (Defaults are stored in "finsemble.services" and cannot be directly overridden..
-
assimilationfinsemble.servicesConfig.assimilation (object) Assimilation of native windows. This only works on Windows operating systems..
-
authenticationfinsemble.servicesConfig.authentication (object) Authentication service config options.
-
distributedStorefinsemble.servicesConfig.distributedStore (object) Distributed Store configuration.
-
affinityfinsemble.servicesConfig.distributedStore.affinity (string) Only applicable for `spawnAs: "window"`. When set, the service window will be given process affinity based on the string passed in. This allows aggregation of services to a specific browser process..
-
initialStores*finsemble.servicesConfig.distributedStore.initialStores (array) Foundations for any stores which should be seeded on startup.
-
foundationfinsemble.servicesConfig.distributedStore.initialStores[].foundation (object) The data to seed into the store.
-
Advanced App Launcherfinsemble.servicesConfig.distributedStore.initialStores[].foundation.appFolders.folders.Advanced App Launcher (object) Definition for AdvanceAppLauncher application folder.
-
Favoritesfinsemble.servicesConfig.distributedStore.initialStores[].foundation.appFolders.folders.Favorites (object) Definition for AdvanceAppLauncher application folder.
-
namefinsemble.servicesConfig.distributedStore.initialStores[].name (string) The name of the store to seed.
-
preferPreviousStatefinsemble.servicesConfig.distributedStore.initialStores[].preferPreviousState (boolean true) Advanced App Launcher specific config to control the loading of data. If true, any changes from a previous run will be overridden and the state will be restored on every restart to the initial config provided. If true and no foundation is provided, nothing will be affected..
-
visiblefinsemble.servicesConfig.distributedStore.visible (boolean) Set this to `true` in order to reveal the hidden service window. This can be useful for debugging services..
-
dockingfinsemble.servicesConfig.docking (object) Configs specific to the docking service.
-
ALLOW_GROUPS_TO_SNAPfinsemble.servicesConfig.docking.ALLOW_GROUPS_TO_SNAP (boolean true) Allows groups to snap to one another..
-
allowAppropriatedWindowsToGroupfinsemble.servicesConfig.docking.allowAppropriatedWindowsToGroup (boolean) Allow Appropriated Windows (Freestanding Applications and windows opened with window.open) to group.
-
alwaysOnTopLevelfinsemble.servicesConfig.docking.alwaysOnTopLevel (string "normal") The always on top level when setting components `alwaysOnTop` to true. See the Electron alwaysOnTop documentation for valid values..
-
BUFFER_SIZEfinsemble.servicesConfig.docking.BUFFER_SIZE (number 20) The zone around a window that will cause it to snap to other windows. This value is in pixels..
-
claimSpacefinsemble.servicesConfig.docking.claimSpace (object) Settings for claiming space on Desktop at the operating System level. Windows Only..
-
alwaysOnTopfinsemble.servicesConfig.docking.claimSpace.alwaysOnTop (boolean) If true, docked windows that claim space will be always on top when docked.
-
enabledfinsemble.servicesConfig.docking.claimSpace.enabled (boolean true) If true, docked windows will behave like the Windows Taskbar and claimed space on the operating system.
-
enableWindowsAeroSnapfinsemble.servicesConfig.docking.enableWindowsAeroSnap (boolean) If `true`, windows aero snap keyboard shortcuts (WINDOWS KEY + UP, RIGHT, DOWN, or LEFT arrow key) will move the current window when pressed. Windows will move the window and Finsemble will respond by updating bounds within the Window Service. If `false` (default), these actions will be cancelled by Finsemble..
-
fillHolesOnUndock*finsemble.servicesConfig.docking.fillHolesOnUndock (boolean true) If set to `true`, a rectangular group will maintain its rectangularity when windows leave the group..
-
fillHolesOnUndock finsemble.servicesConfig.docking.fillHolesOnUndock If set to `true`, a rectangular group will maintain its rectangularity when windows leave the group..
-
enabledfinsemble.servicesConfig.docking.GROUP_MODE.enabled (boolean true) Whether to allow windows to group to one another..
-
groupTileBuffer*finsemble.servicesConfig.docking.groupTileBuffer (number 30) Defines the size of the buffer in pixels wherein a dragged window will trigger a tile operation..
-
headerHeight*finsemble.servicesConfig.docking.headerHeight (number 32) This defines the height of the window title bar..
-
headerWidthfinsemble.servicesConfig.docking.headerWidth (number 32) This defines the width of the window title bar..
-
MINIMUM_HEIGHTfinsemble.servicesConfig.docking.MINIMUM_HEIGHT (number 28) The smallest height to allow a window to shrink on resize..
-
MINIMUM_WIDTH*finsemble.servicesConfig.docking.MINIMUM_WIDTH (number 98) The smallest width to allow a window to shrink on resize..
-
requireRectangularityForGroupResize*finsemble.servicesConfig.docking.requireRectangularityForGroupResize (boolean true) If a group of windows forms a rectangle, it can be resized. By turning this to `false`, the user can resize any shaped group by grabbing a corner that is not on another window's edge..
-
RESIZE_EVENT_THROTTLE_PERIODfinsemble.servicesConfig.docking.RESIZE_EVENT_THROTTLE_PERIOD (number) Value (in milliseconds) to throttle resize events. If you find that the quantity of resize events is causing poor performance, tweak this value until you are happy with the performance..
-
SNAPPING_OPACITYfinsemble.servicesConfig.docking.SNAPPING_OPACITY (number 0.8) The opacity windows change to when other windows encroach on their buffer zone..
-
allowEditingfinsemble.servicesConfig.docking.tabbing.allowEditing (boolean true) DEPRECATED - Use servicesConfig.window.allowWindowTitleRenaming.
-
enabledfinsemble.servicesConfig.docking.tabbing.enabled (boolean) Allows windows to tab onto each other..
-
enabledfinsemble.servicesConfig.docking.tiling.enabled (boolean) Allows windows to tile onto each other..
-
undockDisbandsEntireGroup*finsemble.servicesConfig.docking.undockDisbandsEntireGroup (boolean) By default, when a user clicks the "Undock" button in the title bar, it will leave the group without destroying that group. Set this value to `true` if you would like to eliminate the group when the user clicks the "Undock" button..
-
visiblefinsemble.servicesConfig.docking.visible (boolean) Set this to `true` in order to reveal the hidden service window. This can be useful for debugging services..
-
hotkeysfinsemble.servicesConfig.hotkeys (object) Hotkeys service config options.
-
interopfinsemble.servicesConfig.interop (object) Interop Service config options.
-
launcherfinsemble.servicesConfig.launcher (object) Launcher Service config options.
-
linkerfinsemble.servicesConfig.linker (object) Linker config options.
-
loggerfinsemble.servicesConfig.logger (object) Central Logger config options.
-
notificationsfinsemble.servicesConfig.notifications (object) configs specific to the notifications service.
-
searchfinsemble.servicesConfig.search (object) Search service config options.
-
storagefinsemble.servicesConfig.storage (object) Storage Service config options.
-
windowfinsemble.servicesConfig.window (object) Window Service config options.
-
workspacefinsemble.servicesConfig.workspace (object) Configurations related to the workspace service..
-
shutdownTimeoutfinsemble.shutdownTimeout (number 30000) Amount of time (in milliseconds) to give services to shutdown before forcibly quitting the application. Components get 2 seconds less than services..
-
stackedWindowfinsemble.stackedWindow (object) Configuration for tabbed and tiled windows.
-
addReadyTimeoutfinsemble.stackedWindow.addReadyTimeout (number 6500) Sets the time in milliseconds for a tabbed/tiled windows to become ready..
-
systemTrayComponent*finsemble.systemTrayComponent (string) .
-
systemTrayIconfinsemble.systemTrayIcon (string) Sets the location of the system tray icon (lower right corner of the terminal).
-
toolbarMenusfinsemble.toolbarMenus (object) Optional configuration for custom launcher menus on the Finsemble Toolbar.
-
toolbarMenus[]finsemble.toolbarMenus[] (object) toolbar menu entries provide configuration for an individual menu.
-
applications[]finsemble.toolbarMenus[].applications[] (string) An array of application names, as defined in the appD configuration, to include in the menu.
-
displayNamefinsemble.toolbarMenus[].displayName (string) The name of the menu, to be displayed on the toolbar.
-
positionfinsemble.toolbarMenus[].position (number) Used to sort menus into order on the Toolbar (higher position values are displayed further to the right).
-
waitForUpdatefinsemble.waitForUpdate (boolean) When set to true, Finsemble will wait for updates, if available, to download and install, before continuing to start up the application..
-
Window Manager*finsemble.Window Manager (object) Global options for the windowTitleBar. See "Window Manager" under appd.manifest for options....
-
workspaces*finsemble.workspaces (array) An array of workspaces to be presented to the user the first time they start Finsemble. By default, the first workspace listed in the array will be the one first presented to an end user the first time they load their SmartDesktop..
-
workspaces[]finsemble.workspaces[] (object) Template for config specified workspace.
-
defaultfinsemble.workspaces[].default (boolean) If set to true then this workspace will be the default that is loaded the first time the app is run.
-
name*finsemble.workspaces[].name (string) Name of the workspace.
-
permanentfinsemble.workspaces[].permanent (boolean) If set to true then this workspace cannot be deleted or renamed by end users.
-
Blank Templatefinsemble.workspaceTemplates.Blank Template (object) Template for config specified workspace.
-
defaultfinsemble.workspaceTemplates.Blank Template.default (boolean) If set to true then this workspace will be the default that is loaded the first time the app is run.
-
name*finsemble.workspaceTemplates.Blank Template.name (string) Name of the workspace.
-
permanentfinsemble.workspaceTemplates.Blank Template.permanent (boolean) If set to true then this workspace cannot be deleted or renamed by end users.
-
finsemble-electron-adapterfinsemble-electron-adapter (object) Finsemble's Electron Adapter config (this is dynamically added to manifest).
-
allowedManifestDomainsfinsemble-electron-adapter.allowedManifestDomains (array) Allow the ability to specify manifest urls at run time by setting the allowed domains where the hostname matches one of the entries. Every subdomain needs an entry. Wildcards are not allowed..
{
"allowedManifestDomains": [
"finsemble.com",
"cosaic.io"
]
}
-
disableZoomfinsemble-electron-adapter.disableZoom (boolean) Disable the internal electron zoom action for "Ctrl +" and "Ctrl -"..
-
downloadUpdatesViaElectronfinsemble-electron-adapter.downloadUpdatesViaElectron (boolean) Downloads the Electron/Squirrel autoUpdate packages to the local machine before checking for, and performing updates. The files are downloaded using the same proxy and headers Electron uses..
-
ignoreCertificateErrorHostsfinsemble-electron-adapter.ignoreCertificateErrorHosts (array) Certificate errors (SSL/TLS) will be ignored for these hosts or URLs. Useful when using self-signed TLS certificates..
{
"ignoreCertificateErrorHosts": [
"https://github.com:80/ChartIQ",
"self-signed.badssl.com"
]
}
-
loggerfinsemble-electron-adapter.logger (object) The logger for logging to a file. The log file location is %AppData%/Roaming/Electron/logs.
-
logHTTPErrorsfinsemble-electron-adapter.logHTTPErrors (boolean true) Set to false to prevent FEA logging of load failures in the 400-599 range.
-
manifestsfinsemble-electron-adapter.manifests (object) Allow the ability to specify manifest environments at run time by adding entries for each environment.
{
"manifests": {
"dev": "http://localhost:3375/configs/application/manifest-local-dev.json",
"qa": "http://localhost:3375/configs/application/manifest-local-qa.json"
}
}
-
useDOMBasedMovementfinsemble-electron-adapter.useDOMBasedMovement (boolean true) Set to false to use native window movement with Electron.
-
removePathInSpawnExternalAppsmanifest.removePathInSpawnExternalApps (boolean) Set to false to allow spawning by path.
-
splashScreenImagemanifest.splashScreenImage (string "http://localhost:3375/assets/img/FinsembleSplash.svg") URL to use for the splash screen when starting Finsemble. The URL can point to either an HTML page or SVG file. Both HTML and SVG splash screen's support transparency. Use an HTML splash screen if you want to use a .PNG image with transparent background or desire more flexibility in styling or animating your splash screen..
-
splashScreenTimeoutmanifest.splashScreenTimeout (number) Amount of time (in milliseconds) to show the splash screen. The default value 0 causes the splash screen to hide in the `user` stage. This is after the UI Components have loaded and the same time that Workspace components start loading. If you set it to a negative number, you must call `FSBL.System.hideSplashScreen()` in a component when you want to hide the splash screen..
-
startup_app*manifest.startup_app (object) Manifest property for the initial startup app, which reference Finsemble's System Manager..
{
"startup_app": {
"name": "My App",
"url": "http://localhost:3375/finsemble/services/systemManager/systemManager.html",
"uuid": "MyAppAndOrEnvironment",
"requireHandshake": true,
"applicationIcon": "http://localhost:3375/assets/img/Finsemble_Taskbar_Icon.png"
}
}
-
cornerRoundingmanifest.startup_app.cornerRounding Specifies corner rounding for a window.
-
namemanifest.startup_app.name (string) Defaults to the name of the application as specified in installer.json. This is used for certain dialogs and in the central logger. The name must be alphanumeric characters and spaces. Don't use any other characters.
-
uuidmanifest.startup_app.uuid (string "Finsemble") Uniquely differentiates environmental instances of the same application (see server-environment-startup.json) to avoid storage conflicts. The uuid must be alphanumeric characters. Do not use spaces. The uuid is available for use in storage keys, such as those generated by the IndexedDBStorageAdapter..
Further reading
For a discussion about dynamic configuration, as opposed to the static configuration described here, check out the Dynamic Configuration tutorial.