Congratulations on choosing to use AdaptableBlotter.JS. We hope you appreciate the value it brings to the applications and systems you build and manage.
This short guide will help you to install, set up, and make the most of the Adaptable Blotter. You can find more information in the links provided in the ‘Further Information’ section at the end of this guide.
Adaptable Blotter provides huge amounts of exciting functionality that will help end users to be more productive and efficient.
But the needs of Administrators, Developers and Support have not been forgotten, as Adaptable Blotter provides tools to help each of these in their day to day tasks.
Administrators will be able to use simple configuration to manage user permissions, storage locations and other related activities.
Developers will find that it is trivial to integrate Adaptable Blotter into existing applications, add new Adaptable Blotter Objects at design time, access the underlying grid and use their organisation's own themes, calendars, and workflows.
Support will benefit from how Adaptable Blotter will help them quickly to look up a user's activity when dealing with an urgent support call.
It is very straightforward to integrate Adaptable Blotter into an existing HTML5 application - just a couple of lines of code are required. For a step by step guide to this simple process see Integration.
Adaptable Blotter configuration tools allows administrators easily to manage user permissions, storage locations and team sharing.
You can set Configuration Server o be either Local Storage or Remote Storage. If it is set to 'Remote Storage' then all user configuration is always available, irrespective of which computer the user is using.
Configuration Server is also used to manage Team Sharing - enabling users easily to share Adaptable Blotter Objects they have created with colleagues and team members.
For more information please see Configuration.
There might be times when you need to access the Adaptable Blotter programmatically at run-time. To help you, the AdaptableBlotter class contains an IBlotterApi member which includes a number of useful methods and events that you can use.
For more information please see Blotter API.
By default all searching and filtering takes place on the client. However if you want to perform some (or all!) searches or filters on the server then AdaptableBlotter.JS facilitates this.
See Server Searching for more details.
AdaptableBlotter.JS streams a continuous flow of audit data into Audit Log so that everything that happens in the Blotter is fully audited and available for reporting or alerts. For more information on how to set up (and filter the stream to) Audit Log and how to run reports on this data, see Audit Log.
AdaptableBlotter.JS sits on top of an HTML5 underlying grid component. Although the Blotter provides identical functionality, regardless of which grid component you choose, you will still want to choose the right grid for your needs. More information on the grids supported can be found at Underlying Grids.
You are able to to continue to develop against the underlying grid you choose - which is fully exposed - as well as using the API of the Adaptable Blotter.
Administrators can disable or hide each Function in AdaptableBlotter.JS for all users, named users, or roles. More information on managing entitlements can be found at Permissions.
Developers are able easily at design time to create their own Adaptable Blotter Objects (e.g. searches, layouts, editing rules, validation rules etc.) and then ship them with the Adaptable Blotter to their users when they initially deploy the host application.
For more information please see Adaptable Blotter Objects.
As well as providing Adaptable Blotter Objects at design time, you might want occasionally to access (or even create or edit) your objects are run-time.
You can do this by using the BlotterAPI (see above for more details). Alternatively you can access our Store directly - we use Redux internally and our Store is publicly available to you.
Read more at Accessing the Store.
AdaptableBlotter.JS works exactly the same whether it is hosted in a container such as Electron or OpenFin, or it is running directly in the browser.
When running in OpenFin additional functionality is included that leverages the benefits of the container. OpenFin
AdaptableBlotter.JS supports multiple instances of the Blotter each sharing the same data set.
For more information please see Multiple Blotters.
The code for AdaptableBlotter.JS is available from the adaptable blotter repository at Github.
It is free for developers to use the Adaptable Blotter so you can work with the product in any way you want. But end users in a production require a commercial end-user licence. For more details see Licences.
AdaptableBlotter.JS ships with a couple of common pre-installed bootstrap themes. But if you have a particular colour scheme you wish to use, then you can create / load your own bootstrap theme and that will then be used instead.