Appearance
Glossary
Screen
| Term | Definition | Details |
|---|---|---|
| Global nav | The entry points to the main features and settings, at the left edge of the screen | Screen layout, Navigation |
| Header | The region at the top of the screen. Holds the title, action buttons, and more | Screen layout |
| Left sidebar | The region to the left of the main area. Holds lists, trees, filters, and more | Screen layout |
| Main area | The region at the center of the screen. Holds the main content for that screen | Screen layout |
| Right sidebar | The region to the right of the main area. Holds detail information, auxiliary panels, and more | Screen layout |
Feature status
Release status
| Term | Definition |
|---|---|
| Preview | A pre-release feature that isn't available to everyone and requires a request for access |
| Beta | A pre-release feature that's available to everyone but whose specification isn't finalized |
| Deprecated | A feature that will be removed in the future |
Availability
| Term | Definition |
|---|---|
| Optional feature | A feature whose availability depends on your contract |
Account
| Term | Definition | Details |
|---|---|---|
| Account | The unit you use to log in to Codatum. A single account is shared across workspaces | Account |
| Account settings | Settings scoped to your login account | Account settings |
| User | An account that belongs to a workspace. Includes members and guests | User |
| Member | A Workspace Owner, Workspace Editor, or Workspace Viewer | User |
| Guest | A workspace guest. Can only access limited resources | User |
| PAT | Personal access token | Personal Access Tokens |
Workspace and permissions
| Term | Definition | Details |
|---|---|---|
| Workspace | The unit for managing a set of resources and users together | Workspace |
| Resource | An object such as a notebook, connection, or teamspace | Permissions overview |
| Workspace role | A role that every user in a workspace is always assigned exactly one of | User, Permissions overview |
| Resource role | A role assigned to an individual resource | Permissions overview |
| Group | A unit for granting permissions to multiple users together | Group |
| Teamspace | An area where a specific team jointly manages notebooks and folders | Teamspace |
| Access scope | The framework that determines how permissions are evaluated, based on the type of root folder a resource belongs to | Access scope |
| Access level | A setting that determines who can use a connection | Access level |
| Additional notebook permissions | A feature for granting specific users or groups access to a notebook, separate from a folder's base permissions | Additional notebook permissions |
| Shared folder | The area where notebooks shared through additional notebook permissions appear for the recipient | Folders |
| Allowed domain | A setting that allows accounts with an email address at a specified domain to join | Invitations and joining |
| API key | Credentials tied to a workspace | API keys |
| Workspace policy | A setting that restricts public link creation or guest invitations at the workspace level | Workspace policy |
| Audit log | A record of important actions and system events | Audit log |
Data
| Term | Definition | Details |
|---|---|---|
| Connection | A connection setting for a data warehouse. The unit for running SQL and syncing table metadata | Connection |
| Demo connection | A sample connection for trying out the product. Its on-screen connection name is Demo Connection | Demo connection |
| Job label | Metadata that identifies the source of execution on the data warehouse side | Job label |
| Catalog | The feature that manages metadata for tables and saved queries | Catalog |
| Table metadata sync | The process that brings table and column metadata from a connection into the catalog | Table metadata sync |
| Annotation | A description and tags added to a table or column in the catalog (the on-screen labels are Description / Tags) | Annotation |
| Tag | A classification label defined at the workspace level and applied to tables, columns, queries, reports, and more | Tags |
| Query job | A unit of SQL execution history. Used as the basis for popularity and referenced in catalog details | Query jobs |
| Popularity | A relative score based on how often a query job is referenced | Popularity |
Analysis and sharing
| Term | Definition | Details |
|---|---|---|
| Quick search | Cross-search across notebooks, tables, and queries | Quick search |
| Query (saved query) | Saved SQL reused within a connection | Query |
| Notebook | Your workspace for analysis, bringing together SQL, charts, and text | Notebook |
| Doc page | A notebook page type using a flow-based block editor to lay out SQL, charts, text, and more vertically | Doc page |
| Grid page | A dashboard-style notebook page type that tiles charts and other content defined on doc pages | Grid page |
| SQL block | The unit for editing and running SQL, showing results, and creating charts within a notebook | SQL block |
| Chart | A feature that aggregates and processes SQL results and displays them as a graph or table | Chart |
| Dimension | The axis a chart uses to group data (shown on screen as X value, Label, Hierarchy, and similar) | Dimensions and metrics |
| Metric | The numeric value a chart aggregates (shown on screen as Y value and Value) | Dimensions and metrics |
| In-memory processing | Processing that builds chart data in the browser without issuing new SQL, used when the data source has 1,000 rows or fewer | In-memory processing |
| Frame | A feature that splits a chart into multiple charts based on the values in a specified column | Frame feature |
| Parameter | A mechanism that uses an input form at the top of the page and placeholders in SQL to repeat the same analysis with different values | Parameter |
| Explorer | A feature for filtering, aggregating, and pivoting SQL results or chart data sources through a GUI | Explorer |
| Comment | Discussion and feedback attached to the body of a notebook or report. Supports mentions | Comment |
| Snapshot | The content of a notebook at the time it was published, as shown through a report, public link, or signed embed | Sharing |
| Report | A feature for publishing and sharing a notebook, for example as read-only | Report |
| Public link | A feature that publishes a notebook's content as a snapshot at publish time and lets people view it without logging in | Public link |
| Signed embed | A feature that embeds a notebook's published content into an external site or app using an API key and token | Signed embed |
| Workflow | A feature that processes query or report steps on a schedule and connects them to follow-up actions such as notifications | Workflow |
| Template variable | A mechanism for embedding values such as the results of earlier steps into a workflow's body, prompts, or run conditions (using Liquid syntax) | Template variables |
| Codatum CLI | A CLI (cdm) for operating Codatum from a terminal, CI, or an AI agent | Codatum CLI |
AI
| Term | Definition | Details |
|---|---|---|
| AI agent | A feature that autonomously carries out data analysis and notebook creation and editing based on natural language instructions | AI agent |
| AI Assistant | A chat-based AI for creating SQL and charts and answering questions. A legacy feature slated to be replaced by the AI agent | AI Assistant |
| AI Analyst | A way (role) to launch the AI Assistant, for example from the / menu on a doc page | AI Assistant |
| AI Support | An AI Assistant role for answering questions about how to use Codatum | AI Assistant |
| AI profile | The unit of settings for the connection method, permissions, and fixed context used by the LLM for the AI agent and workflows | AI profile |
| Agent context | Context that the AI agent loads automatically (the .agent folder or page, or context from an AI profile) | Agent context |
| Agent connector | An external integration used by the AI agent (MCP or Direct API) | Agent connectors |