USER MANUALS

Workspaces

The workspaces are spaces that allow you to work in a single Virtual DataPort server like if you have several Virtual DataPort servers. In a workspace, the users can create, edit, remove, and test elements without affecting other users.

The workspaces are a VCS feature based on Git branches. In the server there always exists a special workspace called “Main workspace” that is associated with the Git branch defined in the VCS global configuration. When you create a workspace, the server creates a branch from it, and it has the same metadata as the main workspace.

When you create a workspace, you must select the databases that you want to include. In the workspaces you can only do modifications in the elements of those databases. These changes are not visible in other workspaces. If there are changes in these databases in other workspaces, they are not visible in this workspace. You cannot modify elements of databases that were not included in the workspace, they are read-only.

You can manage the workspaces from the Workspaces tab of the VCS Management dialog. In this tab you can create workspaces, remove them, change their description, and see information about them.

With the drop-down menu of the left bottom, you can see the workspace you are connected to and do operations related to it. You can push, pull, and merge changes; create workspaces and connect to them.

Workspaces management

Creating a Workspace

Only global administrators and users with the role manage_workspaces can create workspaces.

You can create a workspace from the “Workspaces” tab of the VCS Management dialog and from the drop-down menu on the left bottom of the server explorer.

Create workspace from the drop-down menu or Workspace management wizard
Create workspace dialog

When you create a workspace, the wizard shows these options:

  • Name: the name of the workspace.

  • New branch name: it is the name of the branch that will be created in the Git repositories.

  • Create from: you can create the workspace from the main workspace or from an existing branch.

    • Main workspace: the workspace will be created with the current data of the server. In the field Databases to include select the databases that you want to include in the workspace. You must select the databases with elements that you want to modify. When you are working in the workspace, you cannot modify the elements of the databases that do not belong to the workspace. You can only include databases with VCS enabled. You cannot include two or more databases that point to the same remote database name.

    • Other (Advanced): the workspace will be created with the content of the branch selected in the drop-down Existent branch.

  • Description: you can write an optional description of the workspace.

Remove a Workspace

You can remove a workspace from the “Workspaces” tab of the VCS Management dialog. To do this, select the workspaces you want to remove and click on the Remove button.

Only global administrators or users with the role manage_workspaces can remove workspaces. This does not remove the remote branch. If you are connected to a workspace, you cannot remove it.

Edit a Workspace

Only global administrators or users with the role manage_workspaces can edit workspaces.

You can edit a workspace to include more databases. This is useful if you create a workspace but after the creation you realize that you need to make changes in databases that were not included when it was created.

You can also edit the description.

To edit a workspace, select a workspace and click on Edit button.

Privileges

Only global administrators and users with the role manage_workspaces can create, remove, and edit workspaces.

When you create a workspace, it includes all the users, roles and privileges defined in the main workspace and they will be part of the workspace. This means that if you modify the users, roles, or the privileges in the main workspace, they will not be considered in the workspace and vice versa. The users, roles and privileges are elements under the version control system, so their changes are treated like other global elements.

The users can only see the workspaces in which there is at least one database on which the user has WRITE or CREATE privileges.

Add feedback