User Guide

Settings - Advanced Analytics

Suggest Edits

Security

The Security section in Superset allows administrators to manage user access, roles, and permissions to ensure secure and controlled usage of the platform. It includes the following key components:

  • List Users – Displays all registered users along with their details, such as name, email, active status, and assigned roles.
  • List Roles – Defines different user roles and their permissions within the platform, ensuring appropriate access control.
  • Action Log – Tracks user activities, providing a detailed log of actions performed within the system.
  • Row Level Security – Enables administrators to enforce data access restrictions based on user roles, ensuring that users can only access relevant data.

These settings help maintain the integrity and security of the analytical environment, ensuring compliance with organizational policies.

List Users

The List Users section under Security Settings in Superset provides an overview of all registered users and their associated details. This section allows administrators to manage user access and roles efficiently.

User Attributes

Each user is listed with the following attributes:

  • First Name – The user's first name.
  • Last Name – The user's last name.
  • User Name – The unique username assigned to the user.
  • Email – The email address associated with the user.
  • Is Active? – Indicates whether the user account is active (True for active users, False for inactive users).
  • Role – Defines the user's level of access and permissions within Superset.

This section helps administrators manage user accounts, assign roles, and ensure secure access to the platform.

List Roles

The List Roles screen displays all available user roles within Superset. Each role defines specific permissions and access levels for users.

Key Features:

  • Role Name: Displays the name of each role in the system.
  • Actions:
    • Show Record: View details of the selected role.
    • Edit Record: Modify role permissions.
    • Delete Record: Remove a role from the system.

Role Details:

When you click Show Record, the details page provides:

  • Detail Tab: Displays the role's name and assigned permissions.
  • List Users Tab: Lists all users who have been assigned this role.

This section helps administrators efficiently manage user permissions and maintain security within the platform.

Action Log

The Action Log screen tracks all user activities, providing administrators with a detailed trail of actions performed.

Key Features:

  • User: Identifies the user who performed the action.
  • Action Type: Displays the type of action taken.
  • Timestamp: Shows when the action occurred.

When you click Show Record, the details page provides:

  • Detail Tab: Displays the user, action type, timestamp, and additional information.

This section helps administrators track user activities and maintain security within the platform.

Row Level Security

Row Level Security allows you to control access to data at the row level based on user attributes. This ensures that users can only view data that is relevant to them. The "Add Rule" section in the Row Level Security settings helps you create and manage rules that define who can access specific rows of data.

Data

Database Connection

The Database Connections section allows users to manage and configure database connections for querying and data analysis.

The main screen displays a list of existing databases with the following details:

  • Name: The database connection name.
  • Backend: The database type.
  • AQE (Asynchronous Query Execution): Enables or disables AQE for the database.
  • DML (Data Manipulation Language): Indicates if DML operations are allowed.
  • File Upload: Specifies if file uploads are supported.
  • Expose in SQL Lab: Determines if the database is accessible in SQL Lab for queries.
  • Last Modified: Shows the date and user who last modified the database settings.
  • Actions: Provides options to edit, export or delete the database connection.

Adding a Database

The +Database button allows users to connect a new database to the system.

Select a Database

  1. Click +Database to start the setup.
  2. Choose a database from the supported options.
  3. Any databases that allow connections via SQL Alchemy URIs can be added. Learn about how to connect a database driver here.

This step helps users select and connect a database for data management and analysis.

Manage

CSS Templates

Dashboards allow you to create a visually appealing and well-structured presentation of your data. With CSS customization, you can modify the look and feel of your dashboard beyond standard settings.

To create a reusable CSS template, follow these steps:

1. Access the CSS Template Interface

  • In the Toolbar, navigate to Settings.
  • From the dropdown menu, select CSS Templates.

  • The CSS Templates screen displays:
    • Name: The name of each template.
    • Last Modified: The last modification date of the template.
    • Actions: Options to edit or delete the template.

2. Define a New CSS Template

  • Click + CSS Template to create a new template.
  • In the CSS Template Name field, enter a name for your template.
  • In the CSS field, input your custom CSS code.
  • Click Add to save your new CSS template.

Apply a CSS Template to a Dashboard

Once you have created a CSS template, follow these steps to apply it to a dashboard:

1. Enter Dashboard Edit Mode

  1. Navigate to the dashboard you want to customize.
  2. Click the Edit Dashboard button (pencil icon) on the right side of the screen.

2. Open the CSS Editor

  1. Click the ellipsis (…) icon next to the save button.
  2. From the dropdown, select Edit CSS.
  3. The CSS Editor window will appear, displaying the current CSS applied to the dashboard.

3. Use the CSS Editor

The CSS Editor contains two main fields:

  • Load a Template: A drop-down menu to select and apply an existing CSS template.
  • Live CSS Editor: A real-time editing environment where you can modify the CSS and immediately see changes applied to the dashboard.

4. Apply a CSS Template

  1. Click the Load a Template field.
  2. Select an existing template from the drop-down list.
  3. The new style will be applied instantly to your dashboard.

Annotation Layers

Annotations allow you to add extra details and explanations to your chart. They can be used to highlight key events or add more context to your data.

There are different types of annotations that you can use depending on the type of information you want to add:

  1. Time Series: Add a new time series to your chart from a different data set.
  2. Interval: Add a range of dates to represent a period of time.
  3. Event: Mark a single event on a specific date.
  4. Formula: Use a formula to represent data, like marking the time passed since a certain date.
How to Access Charts

To use annotations, follow these steps to navigate to the charts section:

1.Go to the Charts Section

  • Navigate to the Analytics > Report - Superset > All Reports Charts area.

2.Find the Annotations and Layers Section

  • Within the charts section, locate Annotations and Layers in the settings panel.

3.Click on “+ Add Annotation Layer”

  • This will allow you to create a new annotation layer for your chart.

This feature allows marketers and data analysts to enhance their charts with valuable insights, making trend analysis more effective.

How to Add an Annotation Layer

Once you've accessed the Annotations and Layers section, follow these steps to add an annotation:

1: Configure the Annotation Layer

  • Layer Configuration:
    • Name: Enter a name for your annotation layer to help identify it later.
    • Hide Layer: Toggle this option if you want to temporarily hide the annotation.
    • Show Label: Enable this option to display a label for your annotation.
    • Annotation Layer Type: Choose one of the following annotation types:
      • Time Series: Add a new dataset overlay to your chart.
      • Interval: Highlight a range of dates to represent a specific period.
      • Event: Mark a single significant date on your chart.
      • Formula: Use a formula-based annotation for calculated values.
    • Annotation Source: Select the data source for the annotation.

2: Customize Display Settings

  • Display Configuration:
    • Style: Choose a display style for your annotation.
    • Opacity: Adjust the transparency of the annotation to blend with your chart.
    • Color: Select a color that makes the annotation stand out.
    • Line Width: Define the thickness of the annotation line.

3: Click OK and Apply the Annotation

  • After configuring the settings, select Apply to see the annotation shown on your chart.

User

The User section in Settings allows users to view their account details and log out.

Info

The Info screen displays your user details and login activity.

  • User Name: Shows your username.
  • Is Active?: Indicates if your account is active.
  • Role: Displays your assigned role.
  • Login Count: Tracks the number of times you've logged in.
  • Personal Info: Edit your first name, last name, and email.
  • Reset Password: Click to change your password.

This section helps manage your account information.

Logout

The Logout option securely ends your session. Click "Logout" to sign out.

Updated about 20 hours ago