Top.Mail.Ru
Workspaces
CTRL+K

Workspaces

In this article
  • Workspaces
  • Workspace Actions
  • Adding a Workspace
  • Workspace Context Menu
  • Workspace Export
  • Workspace Import
  • Workspace Duplication
  • Workspace Deletion

A workspace is a container for elements of the Business Analytics module and related modules, as well as for managing them. You can add the following to a workspace:

Workspace setup

The workspace includes the following tabs:

You can search for workspace elements in the upper-left corner.

Workspace Actions

Adding a Workspace

To add a workspace, click Add.

Workspace creation

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

  • Name — a unique workspace 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
  • Description
  • Tags — create new or select from the list of available tags
  • Package — for importing a workspace from a ZIP archive

After entering the data, click Add.

Workspace creation window

The Database name field is filled in automatically, but the name can be changed if needed. If the database name is unique, the system creates a workspace with that name.

Tags can be assigned to a workspace. To do so, click the Tags field, select existing tags from the drop-down list, or create new ones.

To add a new tag, type its name and press Enter. Tags may be separated with commas.

Tag color is set by default. To change the color, go to tag settings.

To create tags when adding a workspace, the user must have the Tag settings privilege with the C operation. If this privilege is not granted, tag creation is unavailable, and the user can only assign existing tags to the workspace.

After adding a workspace—or by clicking on an existing one—the Control Panel tab opens.

Workspace Context Menu

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

Workspace context menu

The following actions are available in the context menu:

  • Edit — navigates to the workspace
  • Home — displays the list of groups or allows creating a new group and adding the workspace to it (via the + New group button)
  • Move — displays the list of folders to which the workspace can be moved. Available only if at least one folder exists
  • Remove from Favorites — available only if the workspace is in Favorites
  • Export
  • Duplicate
  • General — opens the modal window for editing general workspace information. In this window, you can:
    • Change the name
    • Move the workspace to a folder or to Workspaces without folders
    • View the connected storage
    • View the database name
    • Edit the description
  • Delete
Note

Some of the above actions can also be performed by dragging the workspace card—for example, moving the workspace, adding it to Favorites, or deleting it.

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, and import an existing workspace into any created one
  • Write access to a specific workspace—to export and duplicate only that workspace, and import an existing workspace into it

Workspace Export

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

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

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

Important

Unpublished script versions in the workspace are not exported.

Workspace Import

An imported workspace and all its elements (except scripts) are read-only. To make scripts visible in the workspace, you need to unpack the package in the Packages tab.

A workspace configuration can be imported in two ways: during the creation of a new workspace or into an already existing workspace.

Import During New Workspace Creation

When creating a workspace, upload a ZIP archive containing the configuration. If the configuration includes connections, a setup window appears on the left side of the screen. Connections are required for scripts included in the workspace configuration. If connections are not configured, some workspace functionality may not work.

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

Connections configured

Note
  • It is not possible to upload an archive that is corrupted or does not contain a workspace configuration.
  • It is not possible to upload a workspace configuration containing dashboards, scripts, connections, or processes whose names conflict with those already present in the target workspace.

Import into an Existing Workspace

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

Importing a workspace into an existing one

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 on packages, see the Packages page.

Important

Imported workspaces do not contain data from tables used in the Data Model. Widgets relying on table data will not be displayed.

Workspace Duplication

Workspace duplication preserves data from the original 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
Important

Unpublished script versions in the workspace are not duplicated.

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

In the duplication modal window, specify:

  • A unique name (by default, the original workspace name with an ordinal number in parentheses)
  • The folder to duplicate the workspace into (optional)
  • Database name
  • Storage connection type (by default, the connection used in the original workspace)
  • Description (optional)

Once all required data is entered, click Duplicate.

The user is automatically granted modification rights to 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 the workspace is deleted
  • If the server is unavailable, confirming deletion removes workspace metadata, but the database itself remains intact

Was the article helpful?

Yes
No
Previous
Business Intelligence
We use cookies to improve our website for you.