Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

WSO2 Dashboard Server (WSO2 DS) is a gadget container. WSO2 DS includes a portal application, which is a web application, that allows users with editor permission to create dashboards via the Dashboard Designer, and also allows users with viewer permission to view dashboards via the dashboard view mode. The  Dashboard Designer allows WSO2 DS users to customize dashboard layouts, add pages to a dashboard, configure inter-gadget communication based on the Pub/Sub mechanism, add dashboard banners, and much more.

...

The following diagram illustrates the high level architecture of WSO2 DS:

High level architecture in DS

At the core of WSO2 Dashboard Server is the WSO2 Carbon Server, which is based on the WSO2 Carbon Kernel, and the WSO2 Carbon Dashboard platform, which is packaged with Jaggery and Apache Shindig to support the portal application. As the WSO2 Dashboard Server is based on the WSO2 Carbon Kernel, all the features provided by the Kernel (e.g., user management, resource management, etc.) are available in WSO2 DS. In addition, WSO2 DS also supports Single Sign-on (SSO), which can be enabled for internal or external identity providers, so that users can access the portal application and also communicate with third-party APIs, which are used by various gadgets, provided the third-party APIs have a mechanism to validate the OAuth token with the WSO2 Dashboard Server.

The following diagram illustrates the low level architecture of WSO2 DS:

Low level architecture in DS

The various components that make-up the Dashboard Server architecture are explained as follows:

...

The tenant router filters all the incoming requests to the Dashboard Designer, by analyzes the request URL context, and redirects those requests to either the API or page router, which are routers in WSO2 DS used to  differentiate the incoming API and page requests. 

...

Modules contain the functionality that the WSO2 Dashboard Server uses to handle the registry transactions and to perform business logic related to user requests.

Store

The WSO2 DS Store contains the dashboard layouts and gadgets, which the WSO2 DS users make use of when creating dashboards. The tenant needs to create a separate directory, based on their tenant name, inside the <DS_HOME>/repository/deployment/server/jaggeryapps/portal/store directory to maintain their customized gadgets and layouts.  

Theme

The WSO2 DS theme, which is located within the <DS_HOME>/repository/deployment/server/jaggeryapps/portal directory, contains the following two directories: image and templates. The image directory contains the images that are used in the web pages and the templates directory contains web views.

...