Codatum Docs

Appearance

Notebook ​

A notebook is your workspace for data analysis. You can bring SQL, charts, and text together in a single document, with real-time collaborative editing. Access it from the global nav > Notebooks.

A notebook consists of multiple pages. Use a doc page for analysis work, and a grid page for dashboard layouts. You can also use section dividers in the page list.

See notebook permissions for details on permissions.

With real-time collaborative editing, the content of a notebook (SQL, charts, text, and so on) is synced between users who have the same page open. See Parameter for how parameters and run results are synced. To keep parameter operations independent per user, use Version or Report.

Key features ​

Creating and managing notebooks ​

Creating ​

You can create a notebook in either of the following ways.

  1. Open the global nav > Notebooks, then select Create notebook or Create from template.
  2. In the folder tree in the left sidebar, open Add notebook or folder and select New notebook. You can also use a template or import a file from the same menu.

On the top screen, you can find notebooks using the Recently viewed, Created by me, Starred, and Active tabs.

Creating from a template ​

Create from template lets you create a new notebook from one of the available notebook templates. Templates are listed by category. After reviewing a template, select Create from template / Create to create the notebook.

Adding pages ​

In the page list at the top of the left sidebar inside a notebook, select Add > Page to add a page.

TypeDescription
Doc pageA flow-based document format for placing SQL, charts, text, and more.
Grid pageArranges charts defined on doc pages as a dashboard.
Section dividerUsed to divide the page list. It has no body content.

You can Rename, Duplicate page, or Delete a page from that page's menu.

Notebook operations ​

From the menu in the header inside a notebook, you can perform the following operations.

From the list view, you can move, delete, and star notebooks.

Lock ​

Lock is a feature that prevents accidental edits to a notebook. Switch the state from the ⋯ (horizontal three-dot icon) > Lock notebook menu in the header inside a notebook. Changing this setting requires edit permission on the notebook. You can't change the lock state of a notebook you can only access through sharing.

StateDescription
UnlockedEverything can be edited.
Query onlyOnly parameter changes and SQL execution are allowed.
LockedOnly comments are allowed.

When the state is Query only or Locked, enabling Temporarily unlock lets you remove the lock for yourself only. The lock is automatically restored when you close or reload the notebook.

Dependencies ​

Open Show dependencies to see a diagram of the SQL blocks and parameters in the notebook, along with their reference relationships. You can also open the same diagram from the menu of a SQL block, a grid component, or a parameter.

Use this to trace references between SQL blocks (SQL chains) and parameter reference chains. See SQL block for details on references between SQL blocks.

Constraints ​

  • You can't edit a notebook once its size exceeds 10MB (see Limits).
  • The maximum number of notebooks depends on your contract (see Limits; you can check this from the global nav > Workspace settings > Usage).

Permissions ​

See Notebook for the conditions for each operation. Whether SQL can be run is determined by permissions on the target connection, not by notebook permissions.

© Codatum Inc.