You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »


Introduction

The Apache Superset Userview Menu plugin is used to integrate Apache Superset dashboards into Joget DX Userview Menu. User can choose to embed their dashboard in either public or protected. Customisation options can be configured to show or hide before rendering the dashboard.

This plugin is created with the use of Superset Embedded SDK to embed the Superset dashboards into Joget DX.

This plugin source code and jar is available in JogetOSS repository at https://github.com/jogetoss/superset-menu.


Plugin Information

Plugins Available in the Bundle:

  1. Apache Superset Userview Menu

This plugin bundle is compatible with Joget DX 8.


Expected Outcome

Able to display an Apache Superset dashboard in Joget Userview Menu as shown in Figure 1.

Figure 1: A dashboard from Apache Superset displayed in userview menu


Get Started

Prerequisites / Assumptions

Please follow the link to setup Apache Superset using docker: https://superset.apache.org/docs/installation/installing-superset-using-docker-compose/. If you wish to use other means to setup Apache Superset, please dive into their documentation under Installation and Configuration for more details.

Steps

1. Obtain the plugin source and jar file from https://github.com/jogetoss/superset-menu.

2. You can get the jar file by the latest release at https://github.com/jogetoss/superset-menu/releases.

3. Upload the plugin jar file in Joget by going to Settings → Manage Plugins.

4. Once the plugin in uploaded, go to UI Builder.

5. Under Marketplace section, drag the Apache Superset Userview Menu into the UI.

6. Fill in all the plugin configuration properties by referring to the next section.

7. Save and run in UI. You will be able to see the Apache Superset Dashboard.


Apache Superset Userview Menu Properties

Configure Apache Superset Dashboard Menu

Name

Description

Label

Menu label. Mandatory field.

Menu ID

Menu element unique ID. 

Dashboard Type

The type of dashboard that is shown to the user.

  • Public

  • Protected

Dashboard URL

This field is visible when "Dashboard Type" is public. Defines the entire URL of the dashboard. 

Example: http://localhost:8088/superset/dashboard/5/ (Assuming your Apache Superset is running on default http://localhost:8088/).

Apache Superset URL

This field is visible when "Dashboard Type" is protected. Defines the domain running Apache Superset.

Example: http://localhost:8088 (Assuming your Apache Superset is running on default http://localhost:8088/)

Superset Username

This field is visible when "Dashboard Type" is protected. Superset username used to create guest token. Refer to Configure Superset User Permissions.

Superset Password

This field is visible when "Dashboard Type" is protected. Superset user password used to create guest token.

Dashboard Embed ID

This field is visible when "Dashboard Type" is protected. Embed ID retrieved from Superset dashboard. Refer to Retrieve Superset Dashboard Embed ID.

Show Title

This option is visible when "Dashboard Type" is protected. Show or hide the title of the dashboard.

  • No

  • Yes

Show Tabs

This option is visible when "Dashboard Type" is protected. Show or hide the tabs of the dashboard.

  • No

  • Yes

Show Chart Controls

This option is visible when "Dashboard Type" is protected. Show or hide the chart controls of the dashboard.

  • No

  • Yes

Show Filters

This option is visible when "Dashboard Type" is protected. Show or hide the filter bar of the dashboard.

  • No

  • Yes



Apache Superset Dashboard Configurations

Configure All Dashboard to be Public

  1. Settings > List Roles > Edit Record for "Public" role 

  2. Add Permissions:

    1. can read on chart

    2. can read on Dashboard

    3. can dashboard on Superset

    4. can explore json on Superset

    5. all datasource access on all_datasource_access

    6. all database access on all_database_access

    7. ...and any other permissions if required





Figure 2: Edit Role for "Public"


Configure Specific Dashboard to be Public

  1. Settings > List Roles > Edit Record for "Public" role 
  2. Add Permissions:
    1. can read on chart
    2. can read on Dashboard
    3. can dashboard on Superset
    4. can explore json on Superset
    5. datasource access on [examples]
    6. database access on [examples]
    7. ...and any other permissions if required

Figure 3: Permission "datasource access on [examples]"


Figure 4: Permission "database access on [examples]"



Configure Superset User Permissions

When "Dashboard Type" is protected, username and password is required. The user is required to generate guest token for end user to access the dashboard anonymously. The guest token that is generated follows the role configured in config.py for Superset (Figure 5). Note: the guest does not follow the role of the user configured in Apache Superset Userview Menu. The default role for guest is "Public".

To generate the least permission user to only be used to generate guest token, create a new user and role for it.

Create a new role (Figure 6):

  1. Settings > List Roles > Add a new record
  2. Add Permissions:
    1. can read on SecurityRestApi
    2. can grant guest token on SecurityRestApi

Create a new user (Figure 7):

  1. Settings > List Users > Add a new record 
  2. Link Role (Role created in Figure 6)


Figure 5: Default setting for Guest Role at Config.py for Superset


Figure 6: Add new role to generate guest token


Figure 7: Add new user to generate guest token



Retrieve Superset Dashboard Embed ID

  1. At config.py for Superset, enable "EMBEDDED_SUPERSET" to True.

  2. Dashboards > any dashboard > Settings > Embed dashboard

  3. Copy the embed ID 

Figure 8: Enable Embedded_Superset to True at Config.py for Superset


Figure 9: Embed dashboard option enabled after setting in Config.py


Figure 10: Embed ID in Embed dashboard



Customising Options for Superset Dashboard before Render

  • Show Title

  • Show Tabs

  • Show Chart Controls

  • Show Filters


Figure 11: Original dashboard without customisation


Figure 12: Show Title


Figure 13: Show Chart Controls



Disabling CSRF protection

  1. At config.py for Superset, enable "WTF_CSRF_ENABLED" to False. This will disable all CSRF protection.



Source Code and Plugin Download

  1. Please visit https://github.com/jogetoss/superset-menu for the plugin's source code.
  2. You can find the latest release at https://github.com/jogetoss/superset-menu/releases.
  3. Upload the plugin to your Joget by navigating to Settings > Manage Plugins > Upload Plugin as admin.


Related Links


  • No labels