Skip to content

Workbench

Overview

The Workbench is the project-level home for connecting to a data source, scanning its structure, reviewing what was found, and generating DATAMIMIC artifacts from the result. It brings relational databases, MongoDB, and object storage together under one entry point.

Open it from the top navigation via Workbench.

The Workbench adapts to the selected environment β€” its Mode is derived from the environment type:

Environment type Workbench mode What it does
Database (SQL) Database Metadata-driven scope planning, weighting, schema-drift visibility, and synthetic / anonymize / ML generation. This is the Database View, now hosted inside the Workbench.
MongoDB Mongo Scan a collection, review the inferred fields, and generate a model.
Object storage Object Storage Scan CSV, JSON, or Parquet objects, review the inferred fields, and generate a model.

What changed in 3.5.0

The Database View is now part of the Workbench (Database mode) for SQL environments β€” it is the same metadata-driven flow, reached through the Workbench rather than as a separate view. The Workbench also adds two new modes, Mongo and Object Storage, so scanning is no longer limited to relational databases.

Create the matching environment first under Settings β†’ Environments.

Database mode (SQL environments)

For a database environment, the Workbench opens the Database View: scope selection (Zone 1), the Planning, Weighting, and Schema history tabs, subset dependency preflight, and the Create Synthetic, Create Anonymize, and Create ML actions.

Database mode: Zone 1 scope selection
Zone 1 β€” Scope: pick the tables to include; "in scope" vs "out of scope" counts update as you plan the subset
Database mode: Planning tab with subset preflight
Planning: review columns, run the subset dependency preflight, then launch Create Synthetic / Anonymize / ML
Database mode: Schema history tab
Schema history: baseline and selection snapshots track schema drift (tables/columns added, removed, or changed)

This is the same flow documented in detail under Database View; it is now reached through the Workbench instead of as a standalone view.

Mongo mode (MongoDB collections)

Workbench Mongo Review tab
Review tab: each scanned field shows its inferred type, a generator recommendation, and a PII flag (here gender is flagged at 0.98)
  • Left pane β€” browse databases and collections (use Root / Up and the search box), then Select a collection as the scan target. Sampling Controls offer Sample limit (1–100000) and Max nesting depth (1–20); Scan collection runs the scan and persists a snapshot.
  • Right pane β€” three tabs over the scan result:
    • Review β€” the active snapshot's fields with inferred type, a generator recommendation (for example, scan generator=StringGenerator), and a Mark PII control. Select fields, search, and Save selection to persist the generation scope.
    • History β€” persisted snapshots with timestamp, field count, warnings, and status; Use scan loads one back into Review.
    • Generate β€” the Create File β†’ Generate model from scan dialog, where you pick a Mirror model (structural mirror) or a DATAMIMIC model (full model assembled from the scan and your selections), set a file name, and Create it into the project.
Workbench Mongo History tab
History: persisted scan snapshots; "Use scan" loads one back into Review
Workbench Generate model dialog
Generate: "Generate model from scan" β€” choose a Mirror or DATAMIMIC model

Object Storage mode (CSV / JSON / Parquet)

Workbench Object Storage mode
Object Storage mode: browse and select CSV / JSON / Parquet files, then Scan file; Review, History, and Generate work as in Mongo mode

Object Storage mode works like Mongo mode, with a few specifics:

  • Browse supported CSV, JSON, and Parquet files.
  • Sampling Controls add Max partition bytes (≀2 GiB) for Parquet inputs.
  • Scan a single file with Scan file, or a directory as a Parquet dataset.
  • Review, History, and Generate behave as in Mongo mode.

Scan steps in TaskView

Workbench browse, scan, and generation run as background data-source tasks, visible in Tasks:

  • DS-BROWSE β€” browse a source location (databases, collections, directories, or files).
  • DS-SCAN β€” scan the selected table, collection, or object into a snapshot.
  • SCAN-GEN-MOD β€” generate a model from a persisted scan snapshot.
Workbench data-source tasks in TaskView
Workbench activity appears in TaskView as DS-BROWSE, DS-SCAN, and SCAN-GEN-MOD tasks

Typical Flow (Mongo and Object Storage)

  1. Select a Mongo or Object Storage environment.
  2. Browse to the collection or object and Select it.
  3. Set the sampling controls, then run the scan.
  4. In Review, refine fields, mark PII, and Save selection.
  5. Optionally switch snapshots from History.
  6. Generate a Mirror or DATAMIMIC model and open it in the Editor.

For SQL databases, follow the planning, weighting, and generation flow in Database View.

Note

Scans are sampled and persisted as snapshots β€” re-scan to refresh. Field selections and PII marks are saved with the snapshot and feed the generated model.