Workspaces

Workspaces is the system section for interacting with workspaces. To open the section, while on the home page of the system, click the section button.

The section displays workspace categories, a folder list, and workspace cards.

Workspace Categories

The system includes several workspace categories:

• All workspaces: this category displays all workspaces available to the user
• Workspaces without folders: this category displays workspaces that are not added to any folder
• Favorites: this category displays workspaces that the user has added to favorites
• Trash: this category displays workspaces that the user has deleted from the system. From the trash, you can restore workspaces or delete them permanently

Search for workspaces is available in all sections and folders. To find a workspace, use the search bar.

Folder List

The folder list displays all folders available to the user.

To create a folder, click + New folder, specify a unique name, and click Add.

The created folder opens. You can add workspaces and subfolders to it in several ways:

• Click the + icon button next to the workspace name and select the required option
• Click the + Add button in the upper right corner and select the required option
• While in another section or folder, click a workspace card and, holding the left mouse button, drag the workspace into the desired folder

While in a folder that contains workspaces and/or subfolders, you can navigate between them by clicking the corresponding cards.

The following actions are available in the folder context menu:

• Move: click to see a list of folders into which you can move the selected folder. This action is available if the system contains at least two folders
• Rename
• Delete: when deleting a folder, it is moved to the trash. All subfolders and workspaces contained in it are also deleted

To create a subfolder, drag one folder onto another using the mouse. The number of folder nesting levels is unlimited.

If a folder contains subfolders, an arrow appears to the left of its name and icon. Click it to expand the folder hierarchy.

You can navigate between folder levels either via the list or by clicking the name of the desired folder in the top navigation bar.

Workspace Actions

Adding a Workspace

To add a workspace, click + Add.

In the modal window that opens, fill in the following fields:

• Unique name
• Folder (available if at least one folder has been created. If left blank, the workspace is created in the Workspaces without folders section)
• Storage connection (select from the list of available connections. If only one database server is available, the Storage connection field is not displayed)
• Database name
• Tags
• Description
• Package (for importing a workspace in ZIP archive format)

When all required data is entered, click Add.

The Database name field is filled in automatically, but you can change the name if necessary. If the database name is unique, the system creates a workspace with this name.

After adding a workspace or clicking on it, the Control Panel tab opens.

Workspace Context Menu

To open the workspace context menu, right-click the workspace card.

The following actions are available:

• Edit: clicking navigates to the workspace
• To the main page: click to see a list of groups or create a new group and add the workspace to it (the + New group button)
• Move: click to see a list of folders into which you can move the workspace. This action is available if at least one folder has been added
• Remove from favorites: available if the workspace has been added to favorites
• Export
• Duplicate
• General: click to open the modal window for editing basic workspace information. In this window, you can:
  • Change the name
  • Move the workspace to a folder or to workspaces without folders
  • View which storage the workspace is connected to
  • View the database name
  • Edit the description
• Delete

You can also import a workspace configuration into the system.

To export and duplicate workspaces, the user must have the Workspace privilege with the E operation and:

• The W operation to export and duplicate all workspaces, as well as import a ready-made workspace into any created one
• Write access to a specific workspace to export and duplicate only that workspace, as well as import a ready-made workspace into it

Workspace Export

When exporting a workspace, an archive containing its configuration is created. The archive name matches the name of the exported workspace. The archive includes the following data:

• Dashboards
• Scripts
• Connections (without settings)
• Packages
• Data model:
  • Tables (without data)
  • Links
  • Processes
  • Global indicators

To export a workspace configuration, go to the home page, right-click the required workspace, and select Export.

Workspace Import

An imported workspace and all its elements, except scripts, are available for reading. To display scripts in the workspace, you must unpack the package in the Packages tab.

You can import a workspace configuration in two ways: when creating a new workspace or into an already created workspace.

Import when Creating a New Workspace

When creating a workspace, upload a ZIP archive with the configuration. If the uploaded configuration contains connections, a window for configuring them opens on the left side of the screen. Connections are required for scripts contained in the workspace configuration to function. If connections are not configured, some features in the workspace may not work.

Fill in the required fields for each connection. The User name and Password fields contain the values used in the exported workspace. The Continue button becomes active after all connections are configured.

Import into an Already Created Workspace

To import a workspace configuration into an already created workspace, go to the Packages tab and click + Add.

In the modal window that opens, click the Import configuration field and select a ZIP archive with the workspace configuration or drag the archive into the field. Click Import.

For more information about working with packages, see the Packages page.

Workspace Duplication

Duplicating a workspace allows you to preserve data from the source workspace in its copy. The following data is copied:

• Dashboards
• Scripts
• Connections
• Data model
• Access settings (only for the user who created the copy)
• Packages
• Workspace description

To duplicate a workspace, right-click it and select Duplicate.

In the workspace duplication modal window, specify:

• A unique name (by default, the source workspace name with a sequential number in parentheses)
• The folder into which you want to duplicate the workspace (optional)
• Database name
• Storage connection type (by default, the connection used in the source workspace)
• Description (optional)

When all required data is entered, click Duplicate.

The user automatically gains the ability to modify the duplicated workspace.

Workspace Deletion

When deleting a workspace, the system checks the connection to the ClickHouse server:

• If the server is available, all data associated with this workspace is deleted
• If the server is unavailable, upon confirmation of deletion, workspace information is erased, but the database remains