Workspace Menu

Think of your workspace as the container for all of the information required to generate your protected data. This includes the connection details to your source and destination databases, all the transformations that you're applying to your dataset, any subsetting configurations, flags on columns that have been identified as potentially containing sensitive information and snapshots of your schema for automatic schema change detection.

The Workspace Menu

The workspace menu bar at the top of the window is available across all components of the Tonic platform:

  1. The selector displays which workspace is active and allows you to change to a different workspace

  2. Edit the current workspace settings (see section below)

  3. Copy the current workspace into a new workspace

  4. Delete the current workspace

  5. Import a workspace JSON file

  6. Export a workspace JSON file

  7. Create a new workspace

Workspace settings

When you create a new workspace or edit the settings for the current workspace it brings up the Edit Workspace menu:

  1. Change the name of the current workspace

  2. Toggle between the connection details for the source and the destination database

  3. Select the type of database that you're connecting

    Note: We support nearly all relational databases with minimal integration effort and currently Tonic requires that the source and destination databases are the same type. Please contact [email protected] if you don't see the database you want to connect to in the drop down or if you'd like to transfer between database types.

  4. If you don't have foreign key relationships defined in your source database's schema, or you want to augment/override the existing relationships, you can optionally upload a JSON file that defines these relationships. The file should take the following format:

    [
    {
    "fk_schema": "public",
    "fk_table": "paystubs",
    "fk_columns": ["employee_id"],
    "target_schema": "public",
    "target_table": "employees",
    "target_columns": ["id"]
    },
    ...
    ]

    To help you quickly find these foreign keys in a large dataset, we have an open source project that uses fuzzy matching on column names to find possible relationships: https://github.com/TonicAI/fk_detect‚Äč

  5. Tonic supports generating data in place for some database types. When this option is selected, only a source database is required. Keep in mind that the data will be modified directly on your source database and you need to be careful with your user permissions to make sure that access to this database is turned off before data has been generated. This has the benefit of being faster in a majority of cases, however, it irrevocably changes your source database. Only use this option if you have an easily restorable backup of your source database in case of data loss.

  6. This area is where you specify your connection details. The inputs change depending on the database type selected.

  7. By default SSL is turned on. We strongly recommend not turning SSL off.

  8. Tonic can be connected to an SSH Bastion for additional security.

  9. We highly recommend that once you've configured your connection you test the connection. If successful a green toast notification will appear, if unsuccessful an error message will appear next to the Test Connection button (see below)

Tonic does not create the output database. You must first create the output database before connecting.