AdaptableBlotter.JS makes it easy for you to store user settings, storage location details, user permissions and other related information, in a location most suitable for your needs, i.e. locally or remotely. This is done through Configuration.
Included in Settings are 2 types of information:
Properties - e.g. what the current Advanced Search is, which layout is loaded, what colour palette to use etc.
Adaptable Blotter Objects - e.g. Advanced Searches, Layouts, Shortcuts, Conditional Styles etc.
Run-Time - while AdaptableBlotter.JS is running,users can create as many Adaptable Blotter Objects as their permissions allow. Additionally the Adaptable Blotter will automatically save some user-related information (e.g. current Advanced Search or Layout, visible Function Toolbars etc.). Run-time created configuration is known as user configuration.
Design-Time - administrators and / or developers can ship an application with many pre-existing Adaptable Blotter Objects (e.g. a predefined Search called "Today's Trades" or Shortcut where 'M' multiples numeric cells by 1,000,000) and properties (e.g. which shortcut buttons or function toolbars to show in the Dashboard when first launching the application). This is also known as predefined configuration. It can be made read-only for the user and not editable at run-time.
Design-Time configuration can also contain permission-related configuration (e.g. whether a Function is Visible or ReadOnly for a particular User). This is not available in run-time configuration. For more information on managing entitlements see Permissions.
There are 2 modes of storage available in AdaptableBlotter.JS:
Local Storage - user configuration is stored in the browser's local storage using the Blotter's unique Id. This is the default setting. Any predefined storage is specified in the predefinedConfig property of the AdaptableBlotterObjects which can either be the JSON itself or the location of a .json file (see Integration for more details).
If using Local Storage, all user configuration will need to be rebuilt every time the user switches computers or clears the browser cache.
Local Storage is turned on by default; if you want to store settings somewhere more useful, you will need to enable Configuration Server.
Remote Storage - user configuration is stored (via ConfigServer) on a configured location. All configuration changes are sent to the location specified in ConfigServer and then persisted there.
Remote Storage is enabled by setting the enableRemoteConfigServer property true when the Blotter is integrated with the host application. If this is set to false, then Local Storage will be used. (For more details see Integration).
When using Remote Storage, all user configuration is still available even after switching computers.
When the application is launched for the first time the User Configuration is loaded (either from local storage or remote storage) and initialised. If there is any predefined configuration this is loaded as well and merged with User Configuration.
At run-time both user configuration and application configuration are fully available. Anything in the predefined configuration which has been set to be ReadOnly cannot be edited.
Predefined Configuration will include all the information you want AdaptableBlotter.JS to have at start-up. You will need to provide configuration to the Adaptable Blotter which it will inject into the application as required. You can provide this configuration either as a JSON object or as URL to a .JSON file.
See Predefined Config for full details of which properties and objects you can include in configuration files.
There are a number of different configuration sections, each of which has some properties, lists or objects which you can specify.