Skip to content

Latest commit

 

History

History
223 lines (186 loc) · 11.9 KB

README.md

File metadata and controls

223 lines (186 loc) · 11.9 KB
Raw

CBoard

An open BI Dashboard platform that supports interactive multi-dimensional report design and data analysis

Server side framework is Spring+MyBatis and front-end is based on AngularJS1 and Bootstrap. The whole architecture graphic is as below:

image

Screenshot

image

Near Realtime data refresh

**Be attention, refresh level is cube level rather than whole dashboard ** realtime_demo

Features Of CBoard

  • Simple and beautiful interface and layout
  • Lightweight architecture and concise source code, the entire project does not rely on any third-party multi-dimensional analysis tools
    • Front page style and layout of CBoard is based on AdminLTE2
    • The chart plugin uses ECharts
    • Javascript uses MVVM AngularJS 1.X framework
  • Interactive, drag-and-drop OLAP classisc report development experience
  • One dataset, multiple report widgets. Maximize reuse query resoult
  • Supports OLAP slice filter operation
  • Supports sort multiple columns/rows at the sametime
  • Global query cache, to avoid repeated query requests for data
  • Support common charts and cross tables
    • Columnar/Stacked vertical and horizontal bar and line mixed chart with dual axis view
    • Pie chart
    • Radar Chart
    • Sanky Chart
    • Funnel Chart
    • KPI Widget
    • Cross-tabulation (Support Drill Down/Roll Up)
    • China Map
    • Bubble Chart
  • Support JDBC data connection
  • Support Native Elasticsearch connection for version 1.x, 2.x, 5.x
  • Support Native Kylin connection for version 1.6
  • Support to connect one of the most popular open source multi-dimensional analysis of products Saiku2, and will be able to selectively create data and graphics
  • Cube level data refresh / realtime chart for quick query
  • Easy to implement your own DataProvider to connect any data source. Even for expensive commercial BI suite, it's not possible to connect all the NOSQL and NewSQL data source in the era of big data. Due to the schema of NOSQL are various, such as hash tables, arrays, trees, maps, etc., different people using the same NoSQL products designed Schema may vary widely. The user who most familiar with their storage schema are the user themselves. And it's easy to find a Java programmers to code a Class to connect their own data source. So we leave this part of work to the end user with an easy extended data connection framework in CBoard

Demo (Click pics for full screen demo!)

Load Data from query or DataSet Basic Operation
case 0-switchdataload case 1-
Switch Chart Type Calculated Measure
case2 case 3-calculatedmeasures 1
Add Dashboard Parameters Use Parameters
case4-addboardparam case4-useparam

Access Control

RBAC (Role Based Access Control), easy admin and view your users' role and roles' access resource list in one page.

  • Grant roles to user by left Grant button.
  • Grant access resource to a role by right Grant button.
  • Resource can only be granted to role. A user can act as more than one roles.

image

Quick start

Quick Start from docker

We provide a docker image build on centos6 with a sample dataset in it.

docker pull peterzhang921/cboard:0.4.1
docker run --rm -itd --name=cboard -p 8026:8080 --privileged=true peterzhang921/cboard:0.4.1

# after docker container is start then attach into it and start tomcat server
docker attach cboard
/opt/apache-tomcat/bin/startup.sh

# wait after server successfully started
tail -f /opt/apache-tomcat/logs/catalina.out

Acccess cboard with url http://docker-hostip:8026/cboard

  • username: admin , password: root123
  • There is no prepared charts and dashboard in it
  • Meta data of CBoard is stotred in embedded DB H2 with file storage, user can change or add your own configuration by yourself then build project and docker image again
    • how to rebuild docker
    # use configuration files in h2 folder, use env parameter then all the files in h2 folder will overwrite same files in resource folder
maven clean package -Denv=h2
# build docker image
docker build --network=host -t cboard .

Build project by yourself

Prerequisite

Before the start, make sure you have setup environment:

  • JDK version above 1.8
  • MySQL
  • Maven
  • Tomcat
  • Phantomjs (for export dashbaord)
  • Mail Servier

How to build project

  • 1 Download or git clone project
git clone https://github.com/TuiQiao/CBoard.git

  • 2 Install metadata of CBoard (take MySQL database as example)

    • 2.1 Install demo metadata and sample foodmart db
      • Download cboard_demo & foodmart
      • Enter into the path of these two files
      • Use MySQL Command Line tool login and execute
          source cboard_demo.sql
    source foodmart.sql
      • After success completed, check if cboard_demo2 and foodmart2 databases have been created
    • 2.2 You can alternative choose start from a blank setting 
          -- CREATE DATEBASE cboard;
    Execute ddl to create metadata table: sql/mysql/mysql.sql

  • 3 Modify metadata connection properties file according to your db environment

    CBoard/src/main/resources/config.properties

    validationQuery=SELECT 1
jdbc_url=jdbc:mysql://localhost:3306/cboard # set to your metadata db connection url, if you are using demo db, change db name to cboard_demo2
jdbc_username=root # change to the username/password of your db
jdbc_password=111111

# Service configuration
dataprovider.resultLimit=300000
admin_user_id=1
phantomjs_path=D:/phantomjs-2.1.1-windows/bin/phantomjs.exe  # change to the install path of your phantomjs
web_port=8026 #
web_context=  # web context name of your app, can be blank for ROOT deploy

# configuration of Mail service
mail.smtp.host=127.0.0.1
mail.smtp.port=8825
[email protected]
#[email protected]
#mail.smtp.password=111111
#mail.smtp.ssl.checkserveridentity=false

# Cache Properties if you wanna use redis as cache layer
cache.redis.hostName=127.0.0.1
cache.redis.port=6379

  • 4 Comile and package project with Maven

    cd root path of CBoard
# Install SQLServer JDBC Driver into your local respository
mvn install:install-file -Dfile=lib/sqljdbc4-4.0.jar -DgroupId=com.microsoft.sqlserver -DartifactId=sqljdbc4 -Dversion=4.0 -Dpackaging=jar
mvn clean package

  • 5 Deploy war to Tomcat application

  • Copy CBoard/target/cboard.war to webapp folder of Tomcat and rename cboard.war would be better to change name to ROOT.war
  • Start up Tomcat
  • 6 Access CBoard
http://_yourserverip_:8080
Default login username and passwor: admin/root123
  • 7 For Demo DB user, check and test the source of foodmart

Road Map

All tasks are listed in Issue Page group by milestone. Also you can get our development status from Project Page

For more detailed Chinese document CBoard 中文文档

For more detailed English document CBoard Manuel

Contact us

You can create any issue or requirements through the Issue system of github.
If you like CBoard then use it, contribute to CBoard and don't forget to star it ⭐
Waiting for your Contribution and pull request!

Let us kown you are using CBoard

If your company is using CBoard or prepare to use it, please let us known. You can check in at this issue page TuiQiao#122

Donate (请我们喝咖啡)

image

相关博文推荐

Gitbook文档 villare关于CBoard二次开发的总结

中国用户QQ交流群（301028618）进群须知

  • 很久很久以前，为了方便CBoard使用者之间沟通，我们一直有一个QQ群，可是沟通效果非常不理想
    • CBoard在数据分析领域的简单、实用、性能方面的特点毋庸置疑，引来了一大批入群者，短短几个月时间入群人数突破300，登记在册大小企业用户近30余家，如果贵司正在实用CBoard也请告诉我们
    • 可是99%QQ交流群用户都是僵尸用户，从不发言
    • 偶尔发言也只是单纯的为了找我们解决问题（甚至大部分问题在使用文档里面有详细说明），而且当其他人遇到类似问题的时候被帮助过的人却很少站出来互相帮助
    • 其结果就是我一遍遍的回答着用户同样的问题，无奈之下我们暂停了接纳新用户入群
    • 请记住QQ交流群里面的内容是不能检索的，有价值的问题请尽量在GitHub的Issue系统里面开一个主题存档（GitHub里面关闭和非关闭状态的Issue都是可以检索的）
  • 重启交流群须知
    • 用户交流群是为方便CBoard使用者之间进行沟通，请注意不是答疑群，请大家能够尽量互相帮助
    • CBoard只是我们的一个业余项目，我们有自己的日常工作，没有时间一直盯着群里面每个人的发言和问题，开源是为了方便有相同需求的企业，避免大家重复造轮，为行业做一点微薄的贡献
    • 管理员会定义清理最近3个月不曾发言的僵尸用户
    • 有使用方面的问题请先仔细阅读阅档，尝试在文档中找答案
    • 在Issue系统里面搜索看看是否有类似问题
    • 确定是程序上的bug请再GitHub issue系统里面创建新的issue， 参照如何真确提问创建Issue主题
      • What steps will reproduce the problem?（该问题的重现步骤是什么？）
      • What is the expected output? What do you see instead?（你期待的结果是什么？实际看到的又是什么？）
      • What version of the product are you using? On what operating system?（你正在使用产品的哪个版本？在什么操作系统上？）
      • Please provide any additional information below.（如果有的话，请在下面提供更多信息。）
    • 最后喊个口号，开源项目的健康发展需要大家共同的努力，“众人拾柴火焰高”，“人人为我，我为人人”，让我们共同努力打造一个免费好用的开源分析平台