LogoLogo
codatum.comSign InStart for free
  • Introduction
  • Getting Started
    • Quick Start
    • Concept (Further reading)
      • Why did we a choose Block Editor over Cell-based Editor?
  • Connect and Manage Data
    • Connection
      • Sync Table Metadata
    • Supported Warehouses
      • BigQuery
      • Snowflake
      • Other Warehouses
    • Catalog
    • Search
  • Data Exploration
    • Data Exploration Overview
    • Notebook
      • Doc Page
      • Grid Page
      • SQL Block
      • Version
      • Notebook FAQ
    • Chart
    • Explorer
    • Parameter
    • (Appendix) Cache
  • AI Assist
    • SQL Assistant
  • Sharing
    • Sharing Overview
    • Teamspace
    • Shared Notebook
    • Report
    • Public Link
    • Signed Embed
      • How to Set Up Signed Embed
  • Account Management
    • Account
    • Account Settings
  • Workspace & User Management
    • Workspace
  • User Management
    • Invitation
    • Group
  • Security
    • Security Overview
  • Audit logs
  • IP Access Control
  • Access control
    • Access Control Overview
    • Access Control for Workspace
    • Access Control for Resources
      • Access Control for Group
      • Access Control for Teamspace
      • Access Control for Notebook
      • Access Control for Connection
      • Access Control for Report
  • [Under Construction] Plan and Billing
    • Limit and usage
    • Downgrade and cancel
  • Best Practices
    • Advanced Control Structures in SQL
  • Other considerations
    • System requirements
Powered by GitBook

Reference

  • Privacy policy
  • Terms of service
  • JP Docs Site
On this page
  • Key Features
  • How to Set Up
  • Notes

Was this helpful?

  1. Sharing

Report

Convert a Notebook into a Report for sharing with Guests.

PreviousShared NotebookNextPublic Link

Last updated 4 months ago

Was this helpful?

Report is a specialized document derived from a Notebook designed to allow users only to view the content

By providing a snapshot of the data analysis, the Report prevents data corruption. It also allows for the broad distribution of important insights while controlling access to the original data in the Data Warehouse.

Key Features

  • Focus on Important Pages:

    • Specific pages can be selected.

  • Static and View-Only:

    • Report allows creators to share original data without worrying about it being altered. Viewers can access and review important information without altering the content. This ensures creators and viewers that the shared data remains intact and secure.

  • Guest Access:

    • Guest is a special free role that can only view the Report. They do not need access to the Notebook or Connection, making it possible to share with a broader range of users.

  • No Connection Role Required:

    • You can share aggregated statistical data and charts without granting access to the original data.

  • Options for Obtaining Query Results:

    • Allow re-execution of fixed SQL to access the latest data in the Warehouse.

    • SQL itself is fixed, but by embedding dynamic parameters, users can change the data they see per situation.

    • Embed data at the time to show only the necessary snapshot of data.

  • High Performance:

    • Data is pre-fetched and saved as a snapshot, resulting in faster display speeds.

How to Set Up

  • Open the Notebook

    • Open the notebook you want to share.

    • Click the “Share” button in the header and select “+creaete report”.

  • Choose Query Execution Option

    • Choose one option from the Query execution settings:

      1. Embed Fixed Results

        • Show viewers the fixed SQL results.

      2. Allow Fresh Execution

        • Refreshes data with the same SQL queries.

      3. Allow Explore and Parameter Editing

        • Explore embedded resources and refresh data with new parameter embedded SQL queries.

  • Select Pages

    • Choose the pages you want to publish.

  • Publish

    • Click the “Publish” button.

    • (The system will check in the background if you have the necessary permissions to publish the Notebook. Once verified, the Report creation is complete.)

  • Set Permissions for the Report

    • Open the report and enter the email addresses for Guests if you want to share the Report with them.

Notes

Operations related to reports, especially publishing, require complex role combinations. Please refer to the documentation:

Access Control for Report