> For the complete documentation index, see [llms.txt](https://docs.archibase.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.archibase.app/workspace-ui.md).

# Workspace UI

A signed-in workspace is a sidebar, a header, and a canvas. Panels open from the header and share the area under or beside the canvas.

![The workspace: sidebar, header breadcrumb, and canvas](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2F8Kr3oGhpNFck9uP9NSdX%2Fworkspace.png?alt=media)

### Panels

#### Sidebar

Projects, search, theme, settings, notifications, and the product tour. The add control creates a data model. The pencil on a project opens **Edit data model**.

![Sidebar with a project row](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FSSZNWnxaFx53bqtyj0tB%2Fsidebar.png?alt=media)

#### Canvas

Tables, columns, and relationships. Double-click a table name or a column to edit it in place. Schema and Logic sit at the bottom of the canvas.

![Canvas with tables and relationships](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FPtckowUVLWoXKvi95u8j%2Fcanvas.png?alt=media)

#### Editor

Schema, Lineage, and Query. Schema edits sync to the canvas. Lineage edits Deps. Query runs SQL for the open table.

![Schema editor](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2F5qcjeCtjJnxTbFIxAie7%2Fpanel-editor.png?alt=media)

#### Dictionary

Column dictionary for the open model. Team plan and higher. Shortcut: ⌘D or Ctrl+D.

![Dictionary panel](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FGz6yNcjmHOUpfI7i2PJp%2Fpanel-dictionary.png?alt=media)

#### Data preview

Rows for the selected table, or sample data and import actions when the table is empty in this browser. Pro plan and higher.

![Data preview panel](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FcsmCUkM9Oy2Sw4kZLuRh%2Fpanel-preview.png?alt=media)

#### Notebook

Project notes. Drag the header icon onto the canvas to drop a note. Team plan and higher. Shortcut: ⌘B or Ctrl+B.

![Notebook panel](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FrbpZDjWvelLl6cxjUNd1%2Fpanel-notebook.png?alt=media)

#### Ask

AI chat for the open model. Shortcut: ⌘A or Ctrl+A.

![Ask panel](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FgcYp0aLvrXxl4g5nJLhR%2Fpanel-ask.png?alt=media)

#### Model lineage

Conceptual, logical, and physical versions of the project. Open it from the project name in the breadcrumb, or with ⌘L or Ctrl+L. Pro plan and higher.

![Model lineage panel](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FvSnBX2jyv83y2ZgJFhAG%2Fpanel-lineage.png?alt=media)

### Breadcrumb

The header trail is the selection. Each crumb is an icon plus a name. The project crumb opens Model Lineage. Later crumbs follow what is selected in the sidebar or on the canvas.

| Crumb       | When it appears                                   |
| ----------- | ------------------------------------------------- |
| Project     | Always, for the open model. Shows the phase icon. |
| Diagram     | A parent diagram above this model.                |
| Shape       | The diagram shape this model hangs under.         |
| Schema      | A schema is selected.                             |
| Table       | A table is selected.                              |
| Field       | A column is selected.                             |
| Enum        | An enum is selected.                              |
| Enum value  | A value inside an enum is selected.               |
| Index       | An index is selected.                             |
| Table group | A table group is selected.                        |
| Ref         | A relationship is selected.                       |

![Project crumb](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FXaIOCPgWmdp1cV48aItd%2Fbreadcrumb-project.png?alt=media)

![Schema crumb](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FFPqYicnqPphSyXIW2BTI%2Fbreadcrumb-schema.png?alt=media)

![Table crumb](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2Ftvm0e8dywAF87XpK4a3W%2Fbreadcrumb-table.png?alt=media)

![Field crumb](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FBo4o4ejYi0yeLFLFGcXu%2Fbreadcrumb-field.png?alt=media)

A **view-only** badge on the trail means the model can be viewed and not edited.

### Edit modals

The pencil on a sidebar row opens the editor for that object. Table and column edits happen on the canvas.

#### Edit data model

Name, cardinality, default schema, and notes. Save writes the model. Delete data model removes it.

![Edit data model modal](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2F1aAA3oMs2fSwMx4XY689%2Fmodal-edit-model.png?alt=media)

#### Edit schema

Name, alias, and notes for one schema.

![Edit schema modal](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2F50TtF3abihclThbGP5hJ%2Fmodal-edit-schema.png?alt=media)

#### Edit table

Double-click a table header. Change the schema or the table name, or delete the table.

![Table header editor](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FduiFONMCHpYbEXDPpuSe%2Fedit-table-header.png?alt=media)

#### Edit column

Double-click a column. Change the name, type, and constraint icons (primary key, unique, not null, increment, and the rest).

![Column editor](https://2244512733-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwiX7W5UpK8S21sBy6kMN%2Fuploads%2FbSdlU0j0md2v4YEqk7YQ%2Fedit-field.png?alt=media)

#### Edit enum

The pencil on an enum row opens the same style of modal: name, values, and notes. The demo model used for these screenshots has no enum, so that modal is not pictured.

#### Edit diagram

The pencil on a diagram project opens **Edit diagram**: name and notes. It is the diagram counterpart of Edit data model.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.archibase.app/workspace-ui.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.