Sprinkle Docs

Switch to New Reports & Dashboards

This document talks about the new Reports & Dashboards on Sprinkle. It guides you through the process of migrating your older reports to new version of reports.
We have released version 2 (V2 or New) for the Reports and Dashboards feature on Sprinkle. The New version is a paradigm shift in how we do analytics at scale on Sprinkle. With enhanced capabilities, performance, and industry-standard features, the V2 of the Reports and Dashboards is our step towards building a powerful analytics interface on Sprinkle.
Read in detail about Reports (New) and Dashboards (New) on the documentation pages.
This document is focused mainly on helping you migrate your older Reports, SQL Explores, and dashboards to the newer version of Reports and Dashboards.

Important Note before starting on Migration

The SQL Explores feature has been subsumed in the Reports (New), where you can choose to create a Report by writing SQL Queries. The Reports (New) is an integrated experience to build all your analysis.
You can start building your reports directly from the tables in your warehouse. This would be handy for quick on-the-go analysis.
You can build reports using Models as an input. This would be helpful in all cases where you want to build analysis on qualified data and use the model as a single source of truth.
You can also build reports by writing SQL queries to fetch your data in tabular format. On top of that data, you may build visualizations to enhance your data storytelling.
All three ways of building reports have a common interface and features to enable you to build reports.

Why do we need to migrate to the New Version

  • The new version gives you a richer experience of building reports. It has many new features, that ensure the performance, and correctness of data along with enhanced options for presentability.
  • The old version of Reports, Dashboards & SQL Explores would be deprecated. The timelines around that will be shared later, stay posted.

What do we need to migrate

  • Reports: In V1 (Legacy), the reports could only be built from the models. In V2 (New) reports can be built in three ways (including from models) as discussed above. So, you may migrate your older reports to a newer version of Reports to utilize the features of V2 (New)
  • SQL Explores: You can migrate your SQL Explores to Reports V2, built using SQL Editor.
  • Dashboards: Migrate your Dashboards to Dashboards V2.

How can we migrate

  • Manually: You may go through each of your Reports, SQL Explores, and Dashboards, and create them with the newer version. The newer version is intuitive to learn. But there are diversions, which for sure is to enhance the functionality. Migrating manually to the newer version enables you to closely observe the requirements of your reports and accordingly achieve that on V2.
  • 🎉
    Using the Migrate feature on Sprinkle: To help you get quickly started with V2, we have provided the automated option to migrate your individual Reports & SQL Explores to the New version of Reports. Read on to learn the process.

Using Migrate Feature

  • Open the Report or SQL Explore that you want to migrate to V2 (New), in the Edit Mode. On the top right corner, you will find the migrate button.
  • Click on the Migrate button.
  • A modal comes up that describes the process of migration. Clicking "Migrate" will clone your report into the latest version.
  • When you proceed, Sprinkle creates a clone of your report in the V2 (New) version of reports. It opens up the newly created report in a new tab on your browser.
  • The newly created report opens up in the edit mode, but the edit is not permitted right away. You need to run the report to get the updated data. Review the report and then you may Accept the Migration (discussed below in detail).

Accept Migration

  • Unless you Accept the Migration, you will not be allowed to make edits in the newer version of the auto-cloned report. This is done to prevent you and your team from making parallel edits to the new as well as the old version.
  • Note: Till you Accept the Migration, you can continue to make edits to the older version.
  • There is the option to Re-Migrate from your older reports to the new version of the report. Re-migrating updates the cloned report of any changes made on the older one. You can click on the dropdown available on the button to view the new cloned V2 report.
  • Once you are confident enough that the New cloned report is good to go. You may Accept the Migration.
  • Accepting the Migration communicates that you are comfortable with the New cloned report. The New cloned report would be opened for edits, while the older report would be locked and no edits to it can be made. You would still be able to view the older reports, till Sprinkle completely deprecates the V1 (legacy) reports.

Does the Migrate option exactly migrate my old (legacy) report to a new one

Though we would have wanted to make the migration as simple as a click for you. The Migrate feature has limitations, due to differences in the structure of the two versions (V1- Legacy & V2 - New).
Primarily, with V2, in order to give scalability to your analysis and ensure the correctness of the data, Sprinkle ensures that the data is structured in the way you want to consume it right away. Sprinkle structures the data during fetching (querying) the data from the warehouse, thus not limiting your analysis due to data fetch limits.
The Migrate feature tries to create a clone of your report as best as it can. Ensuring you at least have the bare minimum in terms of data and settings that would help you get started on the new report.
Below are a few limitations:
  1. 1.
    When you migrate a report that was pivoted and transposed, the migrate feature only creates the Pivoted table.
  2. 2.
    Migration of the Pivot table does not take care of average, column total, row-wise sum, and running total. In V2 we have Table Calculations, which would help you with these calculations. But it is not yet available for Pivot.
  3. 3.
    The freeze option is differently designed for the V2. Your freeze settings would not be carried on from the V1 report. You can go to the format options from the visualization settings and enable Freeze as needed.
  4. 4.
    Charts that can not be migrated: Map, Geo, Histogram, Bubble, Scatter.
    1. 1.
      Map: To be later supported
    2. 2.
      Geo: To be later supported
    3. 3.
      Histogram: This may be considered later.
    4. 4.
      Bubble/Scatter: Already on V2, but with new enhanced functionality, you may manually create those.
  5. 5.
    For the filters the V2 does not have AND and OR grouping possible. All the filters by default are ANDed. You may use Custom Filters (along with variables) to achieve OR logic.
  6. 6.
    There is no Migrate Feature for the migration of Dashboards. Dashboards need to be manually migrated to Dashboards V2 (New).

Few disclaimers on V2

Though we would have wanted to pack V2 (New) with as many powerful features as imaginable, there are a few limitations. The V2 is in the Beta phase, so not everything is available right away.
  1. 1.
    Embedding Reports will no longer be possible in V2. You may embed your reports by putting them on the Dashboard V2. Embedding is possible for Dashboards V2.
  2. 2.
    Multi-level Breakout (or the Drill on Measures) is not yet supported. Presently we have only a single level of Breakout available on V2.
  3. 3.
    Charts can not be plotted on the Pivoted data for now.
  4. 4.
    Pivot can not take in custom metrics (metrics generated by writing expressions) as values.
  5. 5.
    The merged reports are not supported on Dashboards V2.
  6. 6.
    Multiple x-axes on charts are not supported in v2 as of now.
  7. 7.
    Multiple y-series for combo charts are not supported.
Reach out to [email protected] with any queries about the migration.