Class: ServerModule

Server Finsemble Module

Public API for The Server Finsemble Module

This module allows you to edit the application configs of Finsemble. This must be used server side for your conifg route.

Namespaces

services

Methods

staticServerModule.addComponents
(componentJson)

libs/Server.js, line 102

Add Components to Finsemble

Name Type Description
componentJson JSON

A json file containing all of the component configs

Example
Finsemble.addComponents(require('myComponents.json'))

staticServerModule.addServices
(serviceJson)

libs/Server.js, line 61

Add Services to Finsemble - Soon to be deprecated user Finsemble.services.addServices instead

Name Type Description
serviceJson JSON

A json file containing all of the service configs

Example
Finsemble.addServices(require('myServices.json'))

staticServerModule.getConfig
()

libs/Server.js, line 36

Get your application configs

Example
Finsemble.getConfig()

staticServerModule.launchOpenfin
()

libs/Server.js, line 241

Open Openfin locally- THis should only be used in the development environment.

Example
Finsemble.launchOpenfin(require('openFinConfig.json'))

staticServerModule.setCSSOverridesPath
(path)

libs/Server.js, line 115

Allows you to override any of the Finsemble styling.

Name Type Description
path String

The path to the override css file.

Example
Finsemble.setCSSOverridesPath("/css/myOverride.css")

staticServerModule.setDefaultStorage
(storageName)

libs/Server.js, line 143

setDefaultStorage allows you to set the default storage used for storing application state.

Name Type Description
storageName String

The name of the storage to use. localStorage by default. If you use anything other than localstorage you must add storage models to Finsemble

Example
Finsemble.setDefaultStorage("localStorage")

staticServerModule.setDefaultWorkspaces
()

libs/Server.js, line 258

Sets the default workspace for the application. Use this to set which components load on start for a new user.

Example
Finsemble.setDefaultWorkspaces(require('defaultWorkspace.json'))

staticServerModule.setLogLevel
(number)

libs/Server.js, line 88

This sets the level at which finsemble will log events to the console.

Name Type Description
number Number

A json file containing all of the component configs

Example
Finsemble.setLogLevel(1)

staticServerModule.setUUID
(UUID)

libs/Server.js, line 79

Set the unique ID for your application

Name Type Description
UUID Any

The old group

Example
Finsemble.setUUID('Finsemble')

staticServerModule.updateAppIcon
(iconUrl)

libs/Server.js, line 134

Allows you to set the application icon for Finsemble in the task bar.

Name Type Description
iconUrl String

The path to the application icon.

Example
Finsemble.updateAppIcon("/icons/Finsemble.png")

staticServerModule.updateBaseUrl
(url)

libs/Server.js, line 124

Allows you to set the base route for Finsemble. By defaults, Finsemble looks at the root path /

Name Type Description
url String

The path to the override css file.

Example
Finsemble.updateBaseUrl("/Finsemble")