Dashboard composition tooling based on the Uberfire framework
Java Other
Latest commit c39a1d3 Jan 13, 2017 @dgutierr dgutierr committed with romartin DASHBUILDE-169: "Group by" functionality in displayer editor data col…
…umn causing ArrayIndexOutOfBounds

README.md

Dashbuilder

Dashbuilder is a general purpose dashboard and reporting web app which allows for:

  • Visual configuration and personalization of dashboards
  • Support for different types of visualizations using several charting libraries
  • Full featured editor for the definition of chart visualizations
  • Definition of interactive report tables
  • Data extraction from external systems, through different protocols
  • Support for both analytics and real-time dashboards

Licensed under the Apache License, Version 2.0

For further information, please visit the project web site dashbuilder.org

Upcoming features

  • New renderers based on D3 JS, Lienzo GWT & Chart JS
  • Hierarchical (nested group) displayer types: Tree & Pie
  • Support for multiple dynamic data series
  • Rich mobility support
  • Alerts and SLA configuration
  • RESTful API

Architecture

  • Not tied to any chart rendering technology. Pluggable renderers.
  • No tied to any data storage.
  • Ability to read data from: CSV files, Databases, Elastic Search orJava generators.
  • Decoupled client & server layers. Ability to build pure lightweight client dashboards.
  • Ability to push & handle data sets on client for better performance.
  • Based on Uberfire, a framework for building rich workbench styled apps on the web.

Change log

0.4.0.Final

  • User interface upgraded to Bootstrap3/PatternFly

  • MonetDB support added to the SQL provider. (the provider has been tested under the MonetDB 11.21.5 release)

  • MariaDB support added to the SQL provider. (the provider has been tested under the MariaDB 10.1.10 release)

  • New data set filtering functions "IN" and "NOT IN"

  • Data Set Core API available as an embeddable java library (further details here)

0.3.0.Final

  • New provider for the definition of data sets stored into SQL databases. The following is the list of tested and supported DBs:

    • MySQL 5.5
    • Postgres 9.2
    • H2 1.3.168+
    • Oracle 12c and 11gR2
    • IBM DB2 9.7 and 10.5
    • Sybase ASE 15.7
  • New provider for the retrieval of data stored into Elastic Search nodes. The provider has been tested under Elastic Search 1.7.1 release.

  • New data set editor UI module:

    • Creation of SQL, Bean, CSV and Elastic Search data set definitions
    • Data set retrieval testing and preview
    • Filter, sort and export the data previews
  • New displayer for showing single value metrics.

  • Added new displayer subtypes: bar (stacked), pie (3d, donut), line (smooth)

  • Support for real-time dashboards. Displayer refresh settings.

  • Displayer editor data set lookup enhancements:

    • Filter editor for retrieving only a data subset.
    • Time frame function for the retrieval of time series data in real-time.
    • Different strategies for grouping time series data.
    • Ability to add/remove the columns/series to display.

0.2.0.Final

  • Data set definition files: Support for CSV & Bean generated data sets
  • Displayer Editor widget for the creation of displayer definitions
  • Perspective editor integration which allows the creation of dashboards by drag&drop

0.1.1.Final

  • Notify clients about data set registration/removal events
  • Assign an HTML identifier to every Displayer instance (useful for testing purposes)

0.1.0.Final

Main goal of this very first release is to make it possible the creation of composite dashboards using an straightforward API. Feature set:

  • Shared API for defining and registering data sets
  • Shared operation engine for executing filter, group & sort operations over a data set
  • Client API & widgets for defining Displayer instances
  • Uberfire wrapper screen for the Displayer widget
  • Showcase App. providing a built-in displayer gallery plus some dashboard samples
  • Default renderer based on the Google Visualization library
  • Additional table renderer based on the Uberfire PagedTable widget
  • Tomcat 7 and JBoss AS 7 distributions provided

Build & run

Prerequisites

  • Git client
  • Maven 3.2.5+
  • Java 1.6+

First steps

Clone the project

git clone git@github.com:dashbuilder/dashbuilder.git

Now you can build & run the project in development or production mode.

Development mode

Development mode allows a user to develop with the framework by compiling classes and client assets on runtime, which decreases the development time. There are more implications such as browser compatibilities, language support, etc. It's useful for developing and testing the application.

Dashbuilder is currently built using GWT 2.7, so you are forced to use SuperDevMode to run the application.

Super development mode is the new way to work in GWT since version 2.5 (Native support & the default mode in GWT 2.7). It works in most new browsers and it's based on Source Map spec. It's faster and more efficient than the old hosted mode. There are lots of benefits and other important reasons to use it, you can find more information here.

Dashbuilder supports and it's configured by default to use SuperDevMode.

Using it means running two servers, one for the web application and one for the Code Server that compiles classes for SDM when the compile button is pushed on the web page or in the bookmark.

To build the application:

cd dashbuilder
mvn clean install -DskipTests

To run it:

cd dashbuilder-webapp
mvn gwt:run

Login:

admin / admin

(If you are an IntelliJ fan, we also provide a setup for running the application under this fantastic IDE. Details here)

Production mode

Production mode is used to build & package the application for a production environment. The application is compiled and the javascript assets are build using all permutations (browser support), all languages, etc.

In order to build the production mode:

cd dashbuilder
mvn clean install -DskipTests -Dfull

Once build is finished, you'll find the WAR distributions for Wildfly and Tomcat into dashbuilder/dashbuilder-distros/target/.

Just deploy the WAR file into your application server!