# Introduction

> Codatum Docs

## Table of Contents

### Guide

- [Screen layout](https://docs.codatum.com/guide/screen-layout.md): The regions that make up the Codatum screen (global nav, header, left sidebar, main area, right sidebar)
- [Navigation](https://docs.codatum.com/guide/navigation.md): The global nav menu structure and how it leads to each feature

### Features

#### Quick search

- [Overview](https://docs.codatum.com/features/quick-search/overview.md): Search across notebooks, tables, and queries

#### Connection

- [Overview](https://docs.codatum.com/features/connection/overview.md): Connection settings for your warehouse, and the unit for running SQL and syncing metadata
- [Job label](https://docs.codatum.com/features/connection/job-label.md): Metadata that identifies the source of SQL on the warehouse side

##### Warehouses

- [BigQuery](https://docs.codatum.com/features/connection/warehouses/bigquery.md): Setting up a BigQuery connection
- [Snowflake](https://docs.codatum.com/features/connection/warehouses/snowflake.md): Setting up a Snowflake connection (key pair authentication)
- [Redshift](https://docs.codatum.com/features/connection/warehouses/redshift.md): Setting up an Amazon Redshift connection
- [Databricks](https://docs.codatum.com/features/connection/warehouses/databricks.md): Setting up a Databricks connection

#### Catalog

- [Overview](https://docs.codatum.com/features/catalog/overview.md): Manage metadata for tables and saved queries
- [Table metadata sync](https://docs.codatum.com/features/catalog/metadata-sync.md): Syncing table and column metadata from connections into the catalog
- [Annotation](https://docs.codatum.com/features/catalog/annotation.md): Adding descriptions and tags to tables and columns

#### Query

- [Overview](https://docs.codatum.com/features/saved-query/overview.md): SQL you save and reuse per connection

#### Notebook

- [Overview](https://docs.codatum.com/features/notebook/overview.md): Real-time collaborative editing, page types, and key features of notebooks
- [Explorer](https://docs.codatum.com/features/notebook/explorer.md): A feature for filtering, aggregating, and pivoting run results without writing SQL, and connecting the results to charts or SQL blocks
- [Inline table](https://docs.codatum.com/features/notebook/inline-table.md): Edit small tables in a notebook as a sheet or CSV, and reference them from SQL
- [Comment](https://docs.codatum.com/features/notebook/comment.md): Collaboration through comments and mentions on notebooks and reports
- [Version](https://docs.codatum.com/features/notebook/version.md): Automatic and manual notebook versions
- [Export and import](https://docs.codatum.com/features/notebook/export.md): Exporting notebooks and importing selected pages
- [Folder](https://docs.codatum.com/features/notebook/folder.md): Notebook placement and access scope
- [FAQ](https://docs.codatum.com/features/notebook/faq.md): Frequently asked questions about notebooks

##### Doc page

- [Overview](https://docs.codatum.com/features/notebook/doc-page/overview.md): A flow-based notebook page type
- [SQL block](https://docs.codatum.com/features/notebook/doc-page/sql-block.md): The unit for editing and running SQL within a notebook

##### Grid page

- [Overview](https://docs.codatum.com/features/notebook/grid-page/overview.md): A page for arranging charts and other components as tiles
- [Cross filter](https://docs.codatum.com/features/notebook/grid-page/cross-filter.md): Synchronize filtering of charts and tables on a grid page using keys

##### Parameter

- [Overview](https://docs.codatum.com/features/notebook/parameter/overview.md): Parameter scope and embedding values in SQL
- [Types and data types](https://docs.codatum.com/features/notebook/parameter/types.md): Parameter types and zero values
- [Usage patterns in SQL](https://docs.codatum.com/features/notebook/parameter/sql-patterns.md): How to write filters and branches based on parameter values
- [Escaping and dynamic references](https://docs.codatum.com/features/notebook/parameter/escape-and-dynamic-reference.md): Escaping of parameter values and dynamic generation of identifiers
- [Relative dates](https://docs.codatum.com/features/notebook/parameter/relative-date.md): Relative date defaults for date parameters
- [Generating dynamic options](https://docs.codatum.com/features/notebook/parameter/dynamic-options.md): How to build options for select-type parameters
- [Specifying values from a URL](https://docs.codatum.com/features/notebook/parameter/url.md): Specifying parameter values through URL query parameters

##### Chart

- [Overview](https://docs.codatum.com/features/notebook/chart/overview.md): Overview of the chart feature, which aggregates and processes SQL results into graphs and tables
- [Big Number](https://docs.codatum.com/features/notebook/chart/big-number.md): A chart that displays a key indicator as text or a gauge
- [KPI Chart](https://docs.codatum.com/features/notebook/chart/kpi-chart.md): A chart for viewing the latest metric alongside its time-series trend and past values
- [XY Chart](https://docs.codatum.com/features/notebook/chart/xy-chart.md): A two-dimensional chart that aggregates a Y-axis value against X-axis items
- [Radial Chart](https://docs.codatum.com/features/notebook/chart/radial-chart.md): A chart that visualizes composition ratios or comparisons between items
- [XYZ Chart](https://docs.codatum.com/features/notebook/chart/xyz-chart.md): A chart that aggregates a Z-axis value against X-axis and Y-axis items
- [Hierarchy Chart](https://docs.codatum.com/features/notebook/chart/hierarchy-chart.md): A chart that visualizes hierarchical data
- [Graph Chart](https://docs.codatum.com/features/notebook/chart/graph-chart.md): A chart that visualizes relationships or transitions between items
- [Funnel Chart](https://docs.codatum.com/features/notebook/chart/funnel-chart.md): A chart that visualizes changes in a step-by-step process
- [Waterfall Chart](https://docs.codatum.com/features/notebook/chart/waterfall-chart.md): A chart that shows the cumulative increase and decrease of items
- [Table Chart](https://docs.codatum.com/features/notebook/chart/table-chart.md): A table chart showing raw or aggregated data
- [Pivot Table](https://docs.codatum.com/features/notebook/chart/pivot-table.md): A two-dimensional cross-tabulation table
- [Text Panel](https://docs.codatum.com/features/notebook/chart/text-panel.md): A panel that displays the first value of a selected column
- [Map Chart](https://docs.codatum.com/features/notebook/chart/map-chart.md): A chart that displays data on a map using latitude/longitude, geohash, geocode, or GeoJSON
- [Word Cloud](https://docs.codatum.com/features/notebook/chart/word-cloud.md): A chart that visually shows the frequency or importance of keywords

###### Concepts

- [Overview](https://docs.codatum.com/features/notebook/chart/concept/overview.md): Overview of how charts are rendered and how data modeling works
- [Dimensions and metrics](https://docs.codatum.com/features/notebook/chart/concept/dimension-metrics.md): Units of aggregation, aggregation methods, and date processing for charts
- [Filter, sort, and limit](https://docs.codatum.com/features/notebook/chart/concept/filter-sort-limit.md): Source filter, sort, row limit, and the difference between group by and frame

###### Common settings

- [Overview](https://docs.codatum.com/features/notebook/chart/common-settings/overview.md): Display settings shared across charts, such as frame, value formatting, and analytics display
- [Frame](https://docs.codatum.com/features/notebook/chart/common-settings/frame.md): A frame that splits a chart's display by a column's value
- [Value formatting](https://docs.codatum.com/features/notebook/chart/common-settings/value-format.md): The formatter used for numbers and dates in charts
- [Reference lines, trends, and statistics](https://docs.codatum.com/features/notebook/chart/common-settings/analytics.md): Reference lines, trends, and statistics available on XY Chart and XYZ Chart

##### Sharing

- [Overview](https://docs.codatum.com/features/notebook/sharing/overview.md): Ways to share a notebook (permissions, report, public link, signed embed)

###### Additional notebook permissions

- [Overview](https://docs.codatum.com/features/notebook/sharing/additional-permissions/overview.md): Add permissions for teamspace and private notebooks to specific users or groups

###### Report

- [Overview](https://docs.codatum.com/features/notebook/sharing/report/overview.md): Publishing a notebook as a report and sharing it with members and guests

###### Public link

- [Overview](https://docs.codatum.com/features/notebook/sharing/public-link/overview.md): Creating, sharing, and managing public links that publish a notebook without requiring login

###### Signed embed

- [Overview](https://docs.codatum.com/features/notebook/sharing/signed-embed/overview.md): Signed embed for embedding a notebook into an external app with an API key and token
- [Integration steps](https://docs.codatum.com/features/notebook/sharing/signed-embed/integration.md): Publishing a signed embed, the token issuance API, and integrating with the Embed SDK
- [Token issuance API](https://docs.codatum.com/features/notebook/sharing/signed-embed/issue-token.md): The issueToken API for issuing signed embed tokens
- [Multi-tenant](https://docs.codatum.com/features/notebook/sharing/signed-embed/multi-tenant.md): Configuring a signed embed to isolate data per tenant using server-side parameters
- [Use cases](https://docs.codatum.com/features/notebook/sharing/signed-embed/use-case.md): Design examples for isolating data per tenant with a signed embed
- [FAQ](https://docs.codatum.com/features/notebook/sharing/signed-embed/faq.md): Frequently asked questions about signed embed

#### Workflow

- [Overview](https://docs.codatum.com/features/workflow/overview.md): Scheduled runs and automation through steps
- [Steps](https://docs.codatum.com/features/workflow/steps.md): Actions and settings you can add to a workflow
- [Template variables](https://docs.codatum.com/features/workflow/template-variables.md): Inserting variables and writing execute-if conditions
- [Use cases](https://docs.codatum.com/features/workflow/use-case.md): Practical examples using Workflow

#### AI Agent

- [Overview](https://docs.codatum.com/features/ai-agent/overview.md): An AI agent that performs data analysis and notebook operations from natural language
- [Routines](https://docs.codatum.com/features/ai-agent/routines.md): Schedule recurring AI agent tasks and review their results.
- [Agent context](https://docs.codatum.com/features/ai-agent/agent-context.md): Preparing context that the AI agent loads automatically

#### AI Assistant

- [Overview](https://docs.codatum.com/features/ai-assistant/overview.md): A chat-based AI Assistant for creating SQL and charts and answering questions (deprecated; new provisioning discontinued)

#### Codatum CLI

- [Overview](https://docs.codatum.com/features/cli/overview.md): A CLI for operating Codatum from your terminal

### Workspace

- [Overview](https://docs.codatum.com/workspace/overview.md): The unit for managing resources, and the settings menu structure

#### Administration

- [General](https://docs.codatum.com/workspace/administration/basic.md): Managing workspace name, icon, and allowed domains, and viewing organization details
- [Users](https://docs.codatum.com/workspace/administration/user.md): Members, guests, workspace roles, and registered sign-in methods
- [Group](https://docs.codatum.com/workspace/administration/group.md): A unit for granting permissions to a group of users
- [Invitations and joining](https://docs.codatum.com/workspace/administration/invite.md): Email invitations, invite links, allowed domains, and guest invitations from reports
- [Teamspace](https://docs.codatum.com/workspace/administration/teamspace.md): An area for specific members to co-manage notebooks
- [Notebook theme](https://docs.codatum.com/workspace/administration/theme.md): The visual theme for a notebook's appearance

#### Access and security

- [Workspace policy](https://docs.codatum.com/workspace/access-and-security/policy.md): Policies for public links, Codatum CLI, and guest invitations
- [Audit logs](https://docs.codatum.com/workspace/access-and-security/audit-log.md): Records of important operations and system events
- [Service account](https://docs.codatum.com/workspace/access-and-security/service-account.md): Create accounts that aren't tied to any user, and grant them workspace roles and permissions on resources
- [API key](https://docs.codatum.com/workspace/access-and-security/api-key.md): API keys tied to a workspace
- [Personal Access Tokens](https://docs.codatum.com/workspace/access-and-security/pat.md): List and management of personal access tokens within a workspace
- [Security](https://docs.codatum.com/workspace/access-and-security/security.md): Controlling IP access control and multi-factor authentication

#### Data management

- [Connection](https://docs.codatum.com/workspace/data-management/connection.md): Connection settings to a data warehouse. See the Connection feature for details
- [Tag](https://docs.codatum.com/workspace/data-management/tag.md): Tag definitions and types within a workspace

#### Codatum AI

- [AI profile](https://docs.codatum.com/workspace/codatum-ai/ai-profile.md): Settings for the model, permissions, and context the AI agent uses
- [Agent usage](https://docs.codatum.com/workspace/codatum-ai/agent-usage.md): Check AI agent session and token usage

#### External integrations

- [Agent connectors](https://docs.codatum.com/workspace/external-integrations/agent-connectors.md): Connections to external services used by AI agents, MCP clients, and inline tables
- [MCP clients](https://docs.codatum.com/workspace/external-integrations/mcp.md): Connecting MCP clients to Codatum and managing OAuth scopes and connections
- [Slack integration](https://docs.codatum.com/workspace/external-integrations/slack.md): Connecting Slack workspaces to Codatum to send notifications and ask the AI agent from Slack

### Permissions

- [Overview](https://docs.codatum.com/permissions/overview.md): How permissions work, evaluation rules, and control methods
- [Workspace permissions](https://docs.codatum.com/permissions/workspace.md): Permissions for operations determined by the workspace role alone

#### Permissions by resource

- [Group](https://docs.codatum.com/permissions/resources/group.md): Group resource roles and operations
- [Connection](https://docs.codatum.com/permissions/resources/connection.md): Connection permissions based on access level and resource role
- [Teamspace](https://docs.codatum.com/permissions/resources/teamspace.md): Teamspace resource roles and operations
- [Notebook](https://docs.codatum.com/permissions/resources/notebook.md): Notebook permissions based on access scope and sharing settings
- [Report](https://docs.codatum.com/permissions/resources/report.md): Report viewing permission, guest sharing, and conditions for publishing
- [Query](https://docs.codatum.com/permissions/resources/query.md): Saved query permissions, derived from connection permissions
- [Catalog](https://docs.codatum.com/permissions/resources/catalog.md): Catalog permissions, derived from connection permissions
- [Workflow](https://docs.codatum.com/permissions/resources/workflow.md): Workflow permissions based on owner assignment and workspace role

### Account

- [Overview](https://docs.codatum.com/account/overview.md): What an account is, its relationship to users, and account settings
- [Sign-up](https://docs.codatum.com/account/signup.md): Creating a new account and what happens after you sign up

#### Account settings

- [General](https://docs.codatum.com/account/settings/basic.md): Account profile, theme, and language settings
- [Sign-in & security](https://docs.codatum.com/account/settings/login.md): Account authentication methods and multi-factor authentication
- [SQL editor preferences](https://docs.codatum.com/account/settings/editor.md): Display, autocomplete, and tooltip settings for the SQL editor
- [Keyboard shortcuts](https://docs.codatum.com/account/settings/keyboard-shortcut.md): Viewing and changing keyboard shortcuts
- [Notification preferences](https://docs.codatum.com/account/settings/notification.md): In-app and email notification settings
- [Personal Access Tokens](https://docs.codatum.com/account/settings/pat.md): Creating and managing the personal access tokens you issue
- [Connector authentication](https://docs.codatum.com/account/settings/connector-authentication.md): Manage personal credentials used with agent connectors

### Organization

- [Overview](https://docs.codatum.com/organization/overview.md): How organizations relate to workspaces, organization owners, and organization settings

#### Organization settings

- [General](https://docs.codatum.com/organization/settings/general.md): Viewing and editing the organization ID, organization name, and country
- [Members](https://docs.codatum.com/organization/settings/members.md): Listing, inviting, and removing organization owners
- [Workspaces](https://docs.codatum.com/organization/settings/workspaces.md): Listing, creating, and joining workspaces that belong to the organization
- [Domains](https://docs.codatum.com/organization/settings/domains.md): How organization owners claim a domain and prove ownership with a DNS TXT record

### Reference

- [Limits](https://docs.codatum.com/reference/limits.md): A list of the numeric limits documented here
- [Glossary](https://docs.codatum.com/reference/glossary.md): A glossary of Codatum terms with links to the detailed specifications
- [System requirements](https://docs.codatum.com/reference/requirements.md): Recommended OS and browsers, and known browser extension issues

### Other

- [Introduction](https://docs.codatum.com/index.md): An overview of Codatum, which connects to a DWH to run, visualize, and share SQL, and a guide to the documentation