Embedding Table Reports

Embed Reports enables you to publish interactive reports where users can explore the data independently using the Sprinkle Report builder UI.

This allows for focused analysis and collaboration without needing to grant full dashboard editing access.

Supported Report Types

• This feature is currently applicable to both Model Reports and Table Reports.

• SQL Reports are not currently supported for embedding.

Embedding Process

1. Accessing the Embed Report Modal

For either Model or Table reports, navigate to the specific tab you wish to embed. Within the tab options, locate the "More Options" menu and select "Embed Report Tab".

2. Enabling Embedding

The Embed Report modal will appear. By default, the toggle switch will be in the OFF state (embedding disabled). Flip the switch to ON to activate embedding. The Save button will remain disabled until embedding is enabled.

3. Embed Link & Customization Options

Once enabled, the modal displays the following sections:

Embed Link:

This link provides access to the embedded report. You can enhance security by adding your Sprinkle API Key and Secret to this link before sharing it with users.

Customization Options:

• Show Build and Format Sections: This option determines whether the Build and Format sections are visible within the embedded report. Enabling this allows users to change chart types and formatting options. Disabling it hides the Build and Format sections and locks the visualization type.

  • Allow Changing Chart Types: This option (only available when Show Build and Format Sections is enabled) controls whether users can modify the chart type within the embedded report.

• Allow Changing Filters: Enabling this option shows the Filter pane in the embedded report, allowing users to apply filters and further refine their analysis.

• Show Table/Modal Pane: This option controls whether the embedded report displays the data table (for Table Reports) or the model pane (for Model Reports).

• Show Chart Data: This option determines whether the underlying chart data is visible in the embedded report.

• Show Chart Query: This option controls whether the SQL query used to generate the chart is displayed in the embedded report.

Remember: Disabling Show Build and Format Sections effectively hides the visualization pane and prevents users from changing chart types.

4. Saving Views (Bookmarking)

Similar to bookmarking, the "Saving View" feature lets you capture the current report state, including build settings, filters, visualization type, etc.

• Save View: This button allows you to save a snapshot of the report's current state for future reference.

• All Saved Views: This section lists previously saved views. You can apply a saved view to restore the report state or delete unwanted views.

5. Reset to Original

This button becomes active only when changes have been made to the report. Clicking it restores the report to its original state as initially loaded.