Documentation Index

Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt

Use this file to discover all available pages before exploring further.

Create Dataset

Prev Next

Creating a Dataset in reports is essential because it acts as the semantic layer between raw database tables and user‑facing reports, enabling reusable metrics, calculated columns, and flexible visualizations without altering the source database.

Before creating reports, datasets must be configured and the supported dataset types are:

Physical Dataset

A Physical Dataset is a dataset that directly maps to an existing database table or view. It is essentially a registered reference to a physical object in your connected database.

Example

Suppose you have a table incident_records in Database. Registering this table as a Dataset makes it a Physical Dataset. You can then define calculated columns (e.g., CASE WHEN status='Closed' THEN 1 ELSE 0 END) and reusable metrics (e.g., COUNT(incident_id)) on top of it.

To create a Physical Dataset, perform the following steps:

  1. Navigate to Reports > Custom widget > Datasets.
    The Datasets page is displayed.

    Figure: Datasets

  2. Click + Dataset to create a new Dataset.
    The New dataset page is displayed.

    Figure: New dataset

  3. Enter the required details as described in the following table and click Create and explore dataset.

    Field

    Description

    Database

    Select or enter the connected data source. The selected data source identifies which database is pulling tables or views from.

    Schema

    The logical namespace inside the database that organizes tables and views. When a database is selected, its default schema is automatically applied. The schema helps Superset locate the correct table for dataset creation.

    Table

    Select or enter the physical table or view in the selected schema. Automatically reads the table’s columns and datatypes when registered. Selecting a table registers it as a physical dataset.


    The list of the configured table is displayed.

    Figure: Table list

Identifying the Table Name

Tables in the mart follow a defined naming convention:

Table

Name

Static tables

Mart_<module code>_<functional name>

Custom attribute tables

Mart_<module code>_customattributes_sv

Multi‑valued custom attribute tables

Mart_<module code>_customattributes_mv

Module Name

Module Code

Incident

im

Service Request

sr

Knowledge Master

km

Change Management

cm

Problem Management

pm

Workorder

wo

CMDB

cmdb

Admin

adm

Asset Management

am

Note

Avoid using Physical Datasets to create charts. Instead, use a virtual dataset based on the required system data. For more information, refer Best Practise of Reports.

Virtual Dataset

A Virtual Dataset is a dataset created from a custom SQL query rather than directly mapping to a physical table or view in the database.

Example

Suppose you want to analyze Incident Records linked with Change Requests:

  • A physical dataset would only give you data from incident_records or change_requests.

  • A virtual dataset could be created with a SQL query joining both tables:

    SELECT i.incident_id, i.priority, c.change_id, c.status
    FROM incident_records i
    JOIN change_requests c ON i.change_ref = c.change_id;


    This query can be saved in SQL Lab and converted into a Virtual Dataset, enabling dashboards that show incident–change correlations.

Prerequisites

The required guidelines to ensure the dataset supports row-level security, naming standards, and time zone handling.

Required columns

Include the following columns in every virtual dataset. The column names must match exactly.

Column

Description

tenant_id

Identifies the tenant associated with the record.

assigned_workgroup_id

Identifies the workgroup assigned to the record.

location_id

Identifies the location associated with the record.

customer_id

Identifies the customer associated with the record.

These columns are required to implement Row-Level Security (RLS), which restricts report data based on the user's assigned permissions. After you save the dataset, it is available on the Dataset List page.

Dataset naming convention

When you save a custom query as a dataset, use the following naming convention:

mart_<module_code>_custom_<functional_name>

Placeholder

Description

module_code

Specifies the module code for the dataset.

custom

Indicates that the dataset is a custom dataset.

functional_name

Specifies a descriptive name that identifies the dataset.

Example

mart_im_custom_customer_ticket_sla_details.

Use a meaningful functional name so that the purpose of the dataset can be easily identified. After creating the dataset, you can edit it to create calculated fields, configure column properties, and add or update the dataset description.

Create Virtual Dataset

To create a Virtual Dataset, perform the following steps:

  1. Navigate to Reports > Custom widget > SQL > SQL Lab.
    The SQL page is displayed.

    Figure: SQL

  2. Enter the required details as described in the following table.

    Field

    Description

    Database

    Select or enter the connected data source. The connected data source in reports where the SQL query will run. You must select the database against which your virtual dataset query will be executed.

    Schema

    The logical namespace inside the selected database that contains tables and views. Choosing the schema ensures your SQL query references the correct objects.

    Table Schema

    Select the table name from the list for creating a virtual dataset, the reports uses the schema context to validate and execute the query

  3. Select the required table(s) to view their columns and structure and in the Query Editor window on the right, write your SQL query using the selected table(s).


    Figure: SQL Query

  4. Click Run the query to validate syntax and preview results.

Configure column properties

After registering a dataset, configure its column properties to control how the columns are used in charts, filters, and the Explore workflow.

The following table describes the available column properties.

Property

Description

Is temporal

Specifies whether the column contains date or time values that can be used in time-series charts.

Is filterable

Specifies whether the column can be used as a dashboard or chart filter.

Is dimension

Specifies whether the column is available as a dimension for grouping and analysis.

Datetime format

Specifies how date-time values are parsed by using the ISO-8601 format.

Description

Adds a description for the column. The description is displayed next to the dataset name when users select the help icon.

Default datetime

Specifies the default date-time column used for dashboard and chart filtering. This option is available only for columns marked as Is temporal.

Synchronize columns from the source

When the source dataset schema changes, synchronize the dataset to update its column definitions.

To synchronize columns from the source, perform the following steps:

  1. Open the Dataset.

  2. Click Sync Columns from Source and click Save.

Synchronizing the dataset updates the column definitions to reflect changes in the source dataset, such as newly added or renamed columns.

Note

After synchronizing the dataset, update any charts or dashboards that use the modified columns to ensure they display the correct data.