The latest version for DAS is WSO2 Data Analytics Server 3.1.0. View documentation for the latest release.
WSO2 Data Analytics Server is succeeded by WSO2 Stream Processor. To view the latest documentation for WSO2 SP, see WSO2 Stream Processor Documentation.

All docs This doc
||
Skip to end of metadata
Go to start of metadata

Note that the Analytics Dashboard is:

  • Not supported with IBM JDK.
  • Supports only Google Chrome and Firefox browsers.
  • Not supported with reverse proxy.

    A reverse proxy server retrieves information from a server and sends it to a client as though the information originated from the reverse proxy server rather than the actual server.

Analytics dashboard application is the data visualization component of WSO2 Data Analytics Server. You can create dashboards and real time gadgets event streams. A gadget displays the real-time information processed by WSO2 DAS in a selected format. A dashboard serves as a container for a collection of gadgets organized in a selected layout. The following diagram summarizes how to set up the Analytics Dashboard for WSO2 DAS as per your requirement.

Instructions to set up a dashboard are covered in the following steps.

Prerequisites

The following table specifies the prerequisites for viewing information in a gadget depending on the service provider selected for it.

Service ProviderPrerequisites
Batch Data Source

A persisted event stream should exist in order to populate the gadget with persisted data.

To define an event stream, see Understanding Event Streams and Event Tables.
To persist an event stream, see Persisting Data for Batch Analytics

Relational Database Source
  • A relational database with at least one table that has data should exist.
  • The appropriate JDBC driver should be downloaded and saved in the <DAS_HOME>/repository/conf/lib directory.
Realtime Data Source
  • A real-time event stream should exist in order to get the real-time events based on which information is displayed in the gadget. To define an event stream, see Understanding Event Streams and Event Tables .
  • A UI publisher should exist in order to publish events from the real-time event stream to the Analytics Dashboard. To define a UI Publisher, see UI Event Publisher.
REST Data SourceAn accessible REST endpoint should exist.

Step 1: Log into the Analytics Dashboard

Follow the procedure below to log into the Analytics Dashboard.

  1. Access the WSO2 DAS Analytics Dashboard using the following URL. 
    https://<HOST_NAME>:<PORT>/portal/dashboard
  2. Enter your username and password, and click Login.
     

You can deploy a dashboard and/or its components (e.g. layouts, gadgets, and widgets) in the Analytics Dashboard of WSO2 DAS by bundling them as artifacts of a Carbon Application (cApp). For instructions on deploying cApps in WSO2 DAS, see Packaging Artifacts as a C-App Archive.

Step 2: Create required gadgets

Follow the procedure below to create a gadget to display information processed by WSO2 DAS as required.

  1. In the Anaytics Dashboard, click the menu icon and then click Gadgets to open the Gadgets page as demonstrated below
  2. Click GENERATE GADGET to open the Generate a Gadget wizard.
  3. Enter information as follows to configure a gadget.

    1. In the Select Provider field, select the relevant service provider based on the source from which data should be taken to update the gadget. The source of each provider type is given in the table below. Then click Next. In this example, Batch Data Source is selected to publish data updated in an event table.

      ProviderSource of Data Published in Gadget
      Batch Data Source

      An event table in DAS that contains persisted data from an event stream.

      For more information about events streams and event data, see Understanding Event Streams and Event Tables.

      Relational Database SourceA datasource that can connect to an RDBMS database.
      Realtime Data Source

      Real-time events received in event streams.

      Here, the events are directly obtained from the backend. In order to do this, a UI event publisher should be defined and connected to the event stream that receives the events.

      REST Data SourceA REST endpoint

       

    2. In the Event Table field, select the event stream from which the events to be published are derived. Then click Next. In this example, a table named CITY_USAGE is selected.
    3. Configure a chart as follows.

      Parameter NameDescriptionExample
      Gadget NameThe text to be displayed as the name of the gadget.USAGE - CITIES
      Select Chart TypeThe type of chart that you want the gadget to display.Bar Chart
      X-AxisSelect the attribute for the X axis of the bar chart.metro_area
      Y-AxisSelect the attribute for the Y axis of the bar chart.avg_usage
      Color domainThe points mapped on the line chart will be differentiated using colour based on the value of the attribute selected for this parameter.metro_area
      Max lengthThe maximum length of the chart in terms of the number of records displayed at a given time.30
    4. Click Preview to see the preview of the gadget in the lower section of the page.

    5. Click Add to Store to save the gadget configuration, and then click Go to Portal. the Dashboards page appears again.
  • Once a gadget is created and saved, its configuration is saved in JSON format in the <DAS_HOME>/repository/deployment/server/jaggeryapps/portal/store/<Tenant_Name>/fs/gadget directory.
  • For more detailed information about creating and customising gadgets, see WSO2 Dashboard Server Documentation - Gadget Author Guide.


Step 3: Create a new dashboard

  • If you wish to create a dashboard based on a custom theme, see Adding a Custom Theme for a Dashboard.
  • When a dashboard is created, only the user who created the dashboard has permission to edit, view and delete it. For information about how to allow other users to edit, view and deleted a dashboard, see Managing Access to Dashboards.

Follow the procedure below to add a new dashboard to the Analytics Dashboard.

  1. Log into the Analytics Dashboard if you are not already logged in. For detailed instructions, see Logging into the Analytics Dashboard. If there are any existing dashboards, they are displayed as shown in the example below.
  2. Click CREATE DASHBOARD in the top navigator to open the CREATE A DASHBOARD page. 
  3. Enter information as follows.
    1. Enter a name and a description for the dashboard. In this example, the name and the description is entered as follows.

      ParameterValue
      Name of your DashboardSmart Home
      DescriptionIndicates the average power usage for different cities.
    2. Select a layout based on how you want the gadgets to be organized on your dashboard. In this example, the Single Column layout is selected. A message appears to indicate that the dashboard is successfully created.

    3. Click the icon for gadgets. Drag and drop a gadget displayed into the required column of your dashboard. In this example, the Usage - Cities gadget that was created in Step 2: Create required gadgets is added to the dashboard.

      Once information is entered as described above, the Dashboard saved successfully message appears. The new dashboard can be viewed in the Dashboards page.

  • Once a dashboard is created and saved, its configuration is saved in JSON format in the registry. This can be accessed via the  /_system/config/ues/dashboards/<Dashboard_Name> registry path. For more information about the registry, see Registry.
  • For more detailed information about creating and customising dashboards, see WSO2 Dashboard Server Documentation - Editor Guide.

Step 4: View information

Follow the procedure below to view information in a dashboard in the WSO2 DAS Analytics Dashboard.

  1. Access the WSO2 DAS Analytics Dashboard using the following URL., and log in using your credentials.
    https://<HOST_NAME>:<PORT>/portal/dashboard 
  2. Click View on the required dashboard. In this example, the dashboard created in Step 3: Create a new dashboard is selected.
  3. Simulate some data for the event stream connected to your gadget.

    In this example, data is simulated for the gadget created by building the <DAS_HOME>/samples/smart-home/resources/access.log file. For more information, see Analyzing Smart Home Data.

    The gadget is updated as shown in the following image of the USAGE - CITIES gadget created in this example.

  • No labels