Workspace and Repositories

Owned by Tino Pförtner
Last updated: Aug 09, 2024
5 min read

 

Concepts

Workspace: the workspace is a folder on your hard drive that contains internal data about connections to a repository and the projects that you have imported from this repository.

Repository: the repository is a database that contains the actual files of the projects. If you connect to an existing repository, you can then import its contained projects.

Kindly note that workspaces are user (or workstation) specific, i.e., they are not designed to be shared by multiple users. Any attempt to do so will result in an error. Collaboration under SOX relies on the concept of sharing access to a central repository.

 

There are two types of repositories:

  • Local repository: this is stored locally on your computer. This option is an easy way to test SOX but it does not allow you to share or access data or catalogs from/with users on other computers (except using import/export).

  • Remote repository: this is stored on a central server, allowing parallel multi-user access and data sharing. This configuration requires installation of a SOX server, e.g., by your system administrator.

Each workspace is associated with exactly one repository. You can create multiple workspaces on your
computer corresponding to multiple repository connections. Whenever you want to connect to another
repository, you have to switch to another workspace. It is possible to have several workspaces for the same repository, if there are a lot of projects stored in the repository and you only want to import specific projects.

To review details regarding your current workspace, hover your mouse over the bottom right corner of the SOX status bar.

Further particulars are available after clicking on user@repository in the status bar:


How do I…?

Creating a Local Repository

  1. Select a workspace directory (optionally, check the box provided to make your choice the future default).

  2. Click Launch.

  3. Select the Create a new local repository radio button.

  4. Click Next.

  5. Enter a name for your new local repository.

  6. Click Finish.

  7. Enter your credentials (User ID and password). Optionally, check the box provided if you want the system to remember your password.

  8. Click OK.

Outcome: Your connection was created, and SOX launched. You will see the Welcome screen.

If in step 2 you defined a default workspace, it is possible to revert this step by going through Preferences > SOX > Workspace. By checking the box highlighted in the screenshot below, you will be asked again to select your workspace at SOX startup.

 

Connecting to A Central Repository

  1. Select a workspace directory (optionally, tick the box provided to make your choice the future default).

  2. Click Launch.

  3. Select the Connect to an existing remote repository radio button.

  4. Click Next.

  5. Enter in the Host field the relevant IP address.

  6. Enter the Port number.

  7. Select your remote repository.

  8. Click Finish.

  9. Enter your credentials (User ID and password). Optionally, check the box provided if you want the system to remember your password.

Outcome: Your connection was created, and SOX launched. You will see the Welcome screen.