Sharing Overview

Overview of the methods for sharing Notebooks.

Notebook contents can be shared with other users and externally in the following ways:

1. Granting notebook permissions

   • Change the base permissions of the notebook

     • Base permissions for notebooks are determined by the (root) folder where the notebook is stored:

       • Workspace: All members in the workspace can access

       • Teamspace: Members belonging to the teamspace can access

       • Private: Only the notebook owner can access

     • Base permissions can be changed by moving the notebook to a different folder

   • Set the additional permissions of the notebook

     • By setting additional permissions, you can share notebooks with specific members or groups within the workspace

     • Notebooks in Workspace folders are already shared with the entire workspace, so additional permissions cannot be set

   • Share notebooks with specific users or groups within the workspace

2. Creating and sharing snapshots from notebooks

   • Report: Convert notebooks to reports and share with users in the workspace, including workspace guests

   • Public Link: Make it publicly accessible on the internet to anyone who knows the URL

   • Signed Embed: Integrate into external applications and share with users of those applications

Summary of Differences in Each Sharing Methods

Method	Editable	Query execution	Parameter	Explorer	Embeddable	Guest access	Login required	Connection required	API auth required
Permission Granting	true	Yes	Yes (values shared)	Yes	true	false	true	true	false
Report	false	Selectable	Selectable (values per user)	Selectable	true	true	true	false	false
Public Link	false	No	No	No	true	true	false	false	false
Signed Embed	false	Selectable	Selectable (values per user)	Selectable	true	false	false	false	true

• Editable: Indicates if users can edit the notebook.

• Query Execution: Shows whether query execution is possible.

• Parameter: Indicates whether parameters are enabled and specifies if parameters are shared or user-specific.

• Embeddable: Determines if content can be embedded in other platforms using HTML iframes.

• Guest access: Indicates if Workspace Guests can access the shared content.

• Login required: Shows if login to Codatum is required to access the content.

• Connection required: Indicates if connection permissions are required to execute queries and view results.

• API auth required: Indicates if API authentication is required to access the content.

Guidelines for Choosing a Sharing Method

Choose the appropriate sharing method according to the situation. For example:

Permission Granting

• For collaborative notebook editing

Report

• When you don't want to share notebook changes in real-time

  • If you want to make parameter changes separately, consider using the notebook's version feature

• When sharing with members in the workspace who don't have connection permissions

• When you want to share only specific notebook contents without sharing other workspace data

  • Invite users as Workspace Guests and grant viewing permissions

Public Link

• For marketing purposes when you want to share with a large audience

  • Embedding in blogs

  • Sharing on social media like Twitter

• When you want to embed data in internal tools like Notion

  • Consider using Reports if you want to enforce login

Signed Embed

• When you want to integrate into external applications and share with users of those applications

• When you want to allow access only to users authenticated through your company's authentication system