LogoLogo
Release notesAPI docsDocs homeStructural CloudTonic.ai
  • Tonic Structural User Guide
  • About Tonic Structural
    • Structural data generation workflow
    • Structural deployment types
    • Structural implementation roles
    • Structural license plans
  • Logging into Structural for the first time
  • Getting started with the Structural free trial
  • Managing your user account
  • Frequently Asked Questions
  • Tutorial videos
  • Creating and managing workspaces
    • Managing workspaces
      • Viewing your list of workspaces
      • Creating, editing, or deleting a workspace
      • Workspace configuration settings
        • Workspace identification and connection type
        • Data connection settings
        • Configuring secrets managers for database connections
        • Data generation settings
        • Enabling and configuring upsert
        • Writing output to Tonic Ephemeral
        • Writing output to a container repository
        • Advanced workspace overrides
      • About the workspace management view
      • About workspace inheritance
      • Assigning tags to a workspace
      • Exporting and importing the workspace configuration
    • Managing access to workspaces
      • Sharing workspace access
      • Transferring ownership of a workspace
    • Viewing workspace jobs and job details
  • Configuring data generation
    • Privacy Hub
    • Database View
      • Viewing and configuring tables
      • Viewing the column list
      • Displaying sample data for a column
      • Configuring an individual column
      • Configuring multiple columns
      • Identifying similar columns
      • Commenting on columns
    • Table View
    • Working with document-based data
      • Performing scans on collections
      • Using Collection View
    • Identifying sensitive data
      • Running the Structural sensitivity scan
      • Manually indicating whether a column is sensitive
      • Built-in sensitivity types that Structural detects
      • Creating and managing custom sensitivity rules
    • Table modes
    • Generator information
      • Generator summary
      • Generator reference
        • Address
        • Algebraic
        • Alphanumeric String Key
        • Array Character Scramble
        • Array JSON Mask
        • Array Regex Mask
        • ASCII Key
        • Business Name
        • Categorical
        • Character Scramble
        • Character Substitution
        • Company Name
        • Conditional
        • Constant
        • Continuous
        • Cross Table Sum
        • CSV Mask
        • Custom Categorical
        • Date Truncation
        • Email
        • Event Timestamps
        • File Name
        • Find and Replace
        • FNR
        • Geo
        • HIPAA Address
        • Hostname
        • HStore Mask
        • HTML Mask
        • Integer Key
        • International Address
        • IP Address
        • JSON Mask
        • MAC Address
        • Mongo ObjectId Key
        • Name
        • Noise Generator
        • Null
        • Numeric String Key
        • Passthrough
        • Phone
        • Random Boolean
        • Random Double
        • Random Hash
        • Random Integer
        • Random Timestamp
        • Random UUID
        • Regex Mask
        • Sequential Integer
        • Shipping Container
        • SIN
        • SSN
        • Struct Mask
        • Timestamp Shift Generator
        • Unique Email
        • URL
        • UUID Key
        • XML Mask
      • Generator characteristics
        • Enabling consistency
        • Linking generators
        • Differential privacy
        • Partitioning a column
        • Data-free generators
        • Supporting uniqueness constraints
        • Format-preserving encryption (FPE)
      • Generator types
        • Composite generators
        • Primary key generators
    • Generator assignment and configuration
      • Reviewing and applying recommended generators
      • Assigning and configuring generators
      • Document View for file connector JSON columns
      • Generator hints and tips
      • Managing generator presets
      • Configuring and using Structural data encryption
      • Custom value processors
    • Subsetting data
      • About subsetting
      • Using table filtering for data warehouses and Spark-based data connectors
      • Viewing the current subsetting configuration
      • Subsetting and foreign keys
      • Configuring subsetting
      • Viewing and managing configuration inheritance
      • Viewing the subset creation steps
      • Viewing previous subsetting data generation runs
      • Generating cohesive subset data from related databases
      • Other subsetting hints and tips
    • Viewing and adding foreign keys
    • Viewing and resolving schema changes
    • Tracking changes to workspaces, generator presets, and sensitivity rules
    • Using the Privacy Report to verify data protection
  • Running data generation
    • Running data generation jobs
      • Types of data generation
      • Data generation process
      • Running data generation manually
      • Scheduling data generation
      • Issues that prevent data generation
    • Managing data generation performance
    • Viewing and downloading container artifacts
    • Post-job scripts
    • Webhooks
  • Installing and Administering Structural
    • Structural architecture
    • Using Structural securely
    • Deploying a self-hosted Structural instance
      • Deployment checklist
      • System requirements
      • Deploying with Docker Compose
      • Deploying on Kubernetes with Helm
      • Enabling the option to write output data to a container repository
        • Setting up a Kubernetes cluster to use to write output data to a container repository
        • Required access to write destination data to a container repository
      • Entering and updating your license key
      • Setting up host integration
      • Working with the application database
      • Setting up a secret
      • Setting a custom certificate
    • Using Structural Cloud
      • Structural Cloud notes
      • Setting up and managing a Structural Cloud pay-as-you-go subscription
      • Structural Cloud onboarding
    • Managing user access to Structural
      • Structural organizations
      • Determining whether users can create accounts
      • Creating a new account in an existing organization
      • Single sign-on (SSO)
        • Structural user authentication with SSO
        • Enabling and configuring SSO on Structural Cloud
        • Synchronizing SSO groups with Structural
        • Viewing the list of SSO groups in Tonic Structural
        • AWS IAM Identity Center
        • Duo
        • GitHub
        • Google
        • Keycloak
        • Microsoft Entra ID (previously Azure Active Directory)
        • Okta
        • OpenID Connect (OIDC)
        • SAML
      • Managing Structural users
      • Managing permissions
        • About permission sets
        • Built-in permission sets
        • Available permissions
        • Viewing the lists of global and workspace permission sets
        • Configuring custom permission sets
        • Selecting default permission sets
        • Configuring access to global permission sets
        • Setting initial access to all global permissions
        • Granting Account Admin access for a Structural Cloud organization
    • Structural monitoring and logging
      • Monitoring Structural services
      • Performing health checks
      • Downloading the usage report
      • Tracking user access and permissions
      • Redacted and diagnostic (unredacted) logs
      • Data that Tonic.ai collects
      • Verifying and enabling telemetry sharing
    • Configuring environment settings
    • Updating Structural
  • Connecting to your data
    • About data connectors
    • Overview for database administrators
    • Data connector summary
    • Amazon DynamoDB
      • System requirements and limitations for DynamoDB
      • Structural differences and limitations with DynamoDB
      • Before you create a DynamoDB workspace
      • Configuring DynamoDB workspace data connections
    • Amazon EMR
      • Structural process overview for Amazon EMR
      • System requirements for Amazon EMR
      • Structural differences and limitations with Amazon EMR
      • Before you create an Amazon EMR workspace
        • Creating IAM roles for Structural and Amazon EMR
        • Creating Athena workgroups
        • Configuration for cross-account setups
      • Configuring Amazon EMR workspace data connections
    • Amazon Redshift
      • Structural process overview for Amazon Redshift
      • Structural differences and limitations with Amazon Redshift
      • Before you create an Amazon Redshift workspace
        • Required AWS instance profile permissions for Amazon Redshift
        • Setting up the AWS Lambda role for Amazon Redshift
        • AWS KMS permissions for Amazon SQS message encryption
        • Amazon Redshift-specific Structural environment settings
        • Source and destination database permissions for Amazon Redshift
      • Configuring Amazon Redshift workspace data connections
    • Databricks
      • Structural process overview for Databricks
      • System requirements for Databricks
      • Structural differences and limitations with Databricks
      • Before you create a Databricks workspace
        • Granting access to storage
        • Setting up your Databricks cluster
        • Configuring the destination database schema creation
      • Configuring Databricks workspace data connections
    • Db2 for LUW
      • System requirements for Db2 for LUW
      • Structural differences and limitations with Db2 for LUW
      • Before you create a Db2 for LUW workspace
      • Configuring Db2 for LUW workspace data connections
    • File connector
      • Overview of the file connector process
      • Supported file and content types
      • Structural differences and limitations with the file connector
      • Before you create a file connector workspace
      • Configuring the file connector storage type and output options
      • Managing file groups in a file connector workspace
      • Downloading generated file connector files
    • Google BigQuery
      • Structural differences and limitations with Google BigQuery
      • Before you create a Google BigQuery workspace
      • Configuring Google BigQuery workspace data connections
      • Resolving schema changes for de-identified views
    • MongoDB
      • System requirements for MongoDB
      • Structural differences and limitations with MongoDB
      • Configuring MongoDB workspace data connections
      • Other MongoDB hints and tips
    • MySQL
      • System requirements for MySQL
      • Before you create a MySQL workspace
      • Configuring MySQL workspace data connections
    • Oracle
      • Known limitations for Oracle schema objects
      • System requirements for Oracle
      • Structural differences and limitations with Oracle
      • Before you create an Oracle workspace
      • Configuring Oracle workspace data connections
    • PostgreSQL
      • System requirements for PostgreSQL
      • Before you create a PostgreSQL workspace
      • Configuring PostgreSQL workspace data connections
    • Salesforce
      • System requirements for Salesforce
      • Structural differences and limitations with Salesforce
      • Before you create a Salesforce workspace
      • Configuring Salesforce workspace data connections
    • Snowflake on AWS
      • Structural process overviews for Snowflake on AWS
      • Structural differences and limitations with Snowflake on AWS
      • Before you create a Snowflake on AWS workspace
        • Required AWS instance profile permissions for Snowflake on AWS
        • Other configuration for Lambda processing
        • Source and destination database permissions for Snowflake on AWS
        • Configuring whether Structural creates the Snowflake on AWS destination database schema
      • Configuring Snowflake on AWS workspace data connections
    • Snowflake on Azure
      • Structural process overview for Snowflake on Azure
      • Structural differences and limitations with Snowflake on Azure
      • Before you create a Snowflake on Azure workspace
      • Configuring Snowflake on Azure workspace data connections
    • Spark SDK
      • Structural process overview for the Spark SDK
      • Structural differences and limitations with the Spark SDK
      • Configuring Spark SDK workspace data connections
      • Using Spark to run de-identification of the data
    • SQL Server
      • System requirements for SQL Server
      • Before you create a SQL Server workspace
      • Configuring SQL Server workspace data connections
    • Yugabyte
      • System requirements for Yugabyte
      • Structural differences and limitations with Yugabyte
      • Before you create a Yugabyte workspace
      • Configuring Yugabyte workspace data connections
      • Troubleshooting Yugabyte data generation issues
  • Using the Structural API
    • About the Structural API
    • Getting an API token
    • Getting the workspace ID
    • Using the Structural API to perform tasks
      • Configure environment settings
      • Manage generator presets
        • Retrieving the list of generator presets
        • Structure of a generator preset
        • Creating a custom generator preset
        • Updating an existing generator preset
        • Deleting a generator preset
      • Manage custom sensitivity rules
      • Create a workspace
      • Connect to source and destination data
      • Manage file groups in a file connector workspace
      • Assign table modes and filters to source database tables
      • Set column sensitivity
      • Assign generators to columns
        • Getting the generator IDs and available metadata
        • Updating generator configurations
        • Structure of a generator assignment
        • Generator API reference
          • Address (AddressGenerator)
          • Algebraic (AlgebraicGenerator)
          • Alphanumeric String Key (AlphaNumericPkGenerator)
          • Array Character Scramble (ArrayTextMaskGenerator)
          • Array JSON Mask (ArrayJsonMaskGenerator)
          • Array Regex Mask (ArrayRegexMaskGenerator)
          • ASCII Key (AsciiPkGenerator)
          • Business Name (BusinessNameGenerator)
          • Categorical (CategoricalGenerator)
          • Character Scramble (TextMaskGenerator)
          • Character Substitution (StringMaskGenerator)
          • Company Name (CompanyNameGenerator)
          • Conditional (ConditionalGenerator)
          • Constant (ConstantGenerator)
          • Continuous (GaussianGenerator)
          • Cross Table Sum (CrossTableAggregateGenerator)
          • CSV Mask (CsvMaskGenerator)
          • Custom Categorical (CustomCategoricalGenerator)
          • Date Truncation (DateTruncationGenerator)
          • Email (EmailGenerator)
          • Event Timestamps (EventGenerator)
          • File Name (FileNameGenerator)
          • Find and Replace (FindAndReplaceGenerator)
          • FNR (FnrGenerator)
          • Geo (GeoGenerator)
          • HIPAA Address (HipaaAddressGenerator)
          • Hostname (HostnameGenerator)
          • HStore Mask (HStoreMaskGenerator)
          • HTML Mask (HtmlMaskGenerator)
          • Integer Key (IntegerPkGenerator)
          • International Address (InternationalAddressGenerator)
          • IP Address (IPAddressGenerator)
          • JSON Mask (JsonMaskGenerator)
          • MAC Address (MACAddressGenerator)
          • Mongo ObjectId Key (ObjectIdPkGenerator)
          • Name (NameGenerator)
          • Noise Generator (NoiseGenerator)
          • Null (NullGenerator)
          • Numeric String Key (NumericStringPkGenerator)
          • Passthrough (PassthroughGenerator)
          • Phone (USPhoneNumberGenerator)
          • Random Boolean (RandomBooleanGenerator)
          • Random Double (RandomDoubleGenerator)
          • Random Hash (RandomStringGenerator)
          • Random Integer (RandomIntegerGenerator)
          • Random Timestamp (RandomTimestampGenerator)
          • Random UUID (UUIDGenerator)
          • Regex Mask (RegexMaskGenerator)
          • Sequential Integer (UniqueIntegerGenerator)
          • Shipping Container (ShippingContainerGenerator)
          • SIN (SINGenerator)
          • SSN (SsnGenerator)
          • Struct Mask (StructMaskGenerator)
          • Timestamp Shift (TimestampShiftGenerator)
          • Unique Email (UniqueEmailGenerator)
          • URL (UrlGenerator)
          • UUID Key (UuidPkGenerator)
          • XML Mask (XmlMaskGenerator)
      • Configure subsetting
      • Check for and resolve schema changes
      • Run data generation jobs
      • Schedule data generation jobs
    • Example script: Starting a data generation job
    • Example script: Polling for a job status and creating a Docker package
Powered by GitBook
On this page
  • About the Privacy Report
  • Privacy status and privacy ranking
  • Privacy status
  • Privacy ranking
  • Privacy Report .csv file content
  • Schema
  • Data sensitivity
  • Protection
  • Privacy
  • Privacy Report privacy ranking charts
  • Viewing privacy status information on the job details view
  • Downloading a Privacy Report file
  • Downloading a report based on the current configuration
  • Downloading a report for a specific data generation job

Was this helpful?

Export as PDF
  1. Configuring data generation

Using the Privacy Report to verify data protection

Required license: Enterprise

Required workspace permission: Download Privacy Report (to download the report)

About the Privacy Report

In Tonic Structural, data privacy measures how well data is protected based on the applied generator and the generator configuration.

The Privacy Report captures details about the level of data protection for the data in a workspace.

As you configure the data protection, you can use a preview Privacy Report as a checkpoint to review the generators that you applied or to look for at-risk data.

You can export the preview from Structural before you run a generation, to increase your confidence or to confirm that the de-identification configuration is complete.

Every time you run a data generation job, Structural creates a Privacy Report to reflect the protection level at the time that the job ran.

The Privacy Report consists of the following:

  • A .csv list of columns that includes column properties, privacy status, and privacy ranking.

  • A set of charts that summarizes the privacy rankings for the columns.

Privacy status and privacy ranking

The Privacy Report includes the privacy status and the privacy ranking.

Privacy status

The privacy status reflects:

  • Whether a column is sensitive.

  • Whether a generator other than Passthrough is applied.

  • Whether the column is included in the destination data.

The possible values for privacy status are:

  • At-Risk - The column is sensitive, but has Passthrough as the assigned generator.

  • Protected - The column has a generator other than Passthrough assigned. A protected column could be either sensitive or not sensitive.

  • Non-Sensitive - The column is not sensitive, and has Passthrough as the assigned generator.

  • Not Included - The column is not included in the destination database. For example, for a truncated table, the columns are not included.

Privacy ranking

Privacy ranking indicates the level of protection for a column based on the assigned generator and the generator configuration. Privacy ranking does not consider whether the column is sensitive or not sensitive.

The privacy ranking for a column can be a number from 1 to 6. 1 indicates the highest level of data privacy, and 6 the lowest level.

The ranking is based on the following attributes:

  • Whether the generator uses differential privacy.

  • Whether the generator is data-free.

  • Whether the generator has consistency enabled.

  • Whether the generator transforms all of the data in the column.

The following table describes the rankings, and shows how generator attributes correspond to the rankings.

Ranking and description
Differential privacy
Data-free
Consistent
All data transformed

1

The generator is data-free and irreversible.

There is no way to uncover information about the original data from the output data.

Examples: Random Boolean, Random Integer, Constant, Null

True

True

False

True

2

Uses the original data in a way that obscures the original data points.

Changing individual data points in the original data does not change the output data.

However, the shape of the output data can provide information about the input data.

Examples: Continuous and Categorical generators, when set to differentially private

True

False

False

True

3

Uses the underlying data in a way that cannot be reversed, but can identify values that exist in the original data.

Example: Categorical generator, when not set to differentially private

False

False

False

True

4

Data is transformed in a secure way but with consistent values, which can introduce a slight risk.

For example, someone who knows the source data and the frequency of the source values might be able to connect the source and destination values.

Examples: Name generator with consistency, Integer Key generator with consistency

False

False

True

True

5

Data might be unprotected.

Primarily applies to generators that have sub-fields, where there is always a chance that the data is not protected.

Examples: HTML Mask, JSON Mask, Regex Mask, XML Mask

False

False

True or False

Maybe - might be only partially transformed

6

Data is not protected. The Passthrough generator is applied.

False

False

Not applicable

False

Privacy Report .csv file content

The Privacy Report .csv file contains summary statistics and column level details. The table is also included in the downloadable PDF that contains the privacy ranking charts.

Here is a stylized version of the report that shows the column groupings:

The fields for each row in the Privacy Report fall into the following categories.

Schema

The Privacy Report includes all of the schema detail that is viewable in the Structural application, such as in Database View and Table View. The schema in the source matches the destination.

The schema information is contained in the following columns:

  • Schema - Schema name from the source database.

  • Table - Table name from the source database.

  • Column - Column name from the source database.

  • DataType - Data type that is detected in the source database.

Data sensitivity

Data sensitivity reflects attributes such as:

  • Whether the data includes personally identifiable information (PII).

  • Whether the data is regulated by law.

  • Whether the data is business confidential.

It affects decisions on how to protect the data.

During the sensitivity scan, Structural identifies suspected sensitive columns. You can also manually indicate that a column is sensitive or not sensitive.

The data sensitivity information is contained in the following columns:

  • Tonic Detected Sensitivity - Indicates whether the Structural sensitivity scan identified the column as sensitive. This does not include columns identified by a custom sensitivity rule.

    • TRUE indicates that Structural identified the column as sensitive.

    • FALSE indicates that Structural did not identify the column as sensitive.

  • Current Sensitivity - Indicates whether the column is currently identified as sensitive.

    • TRUE indicates that the column is currently identified as sensitive. This includes columns that matched a custom sensitivity rule.

    • FALSE indicates that the column is currently identified as not sensitive.

    Except for columns that a custom sensitivity rule detected, if you did not change the sensitivity manually, then Current Sensitivity matches Tonic Detected Sensitivity.

  • SensitiveType - For columns that Structural identifies as sensitive, the detected sensitivity type. For example, Structural detects a column of type Address that might be sensitive. For fields that a custom sensitivity rule detected, SensitiveType is Custom. For columns that you manually identify as sensitive, SensitiveType is Manual.

  • CustomSensitivityType - For columns that a custom sensitivity rule detected, contains the name of the custom sensitivity rule.

Protection

The protection section of the Privacy Report provides key details about how the masking transformations protect the data.

The protection information is contained in the following columns:

  • ProtectionType - Indicates the level of protection that is provided by the assigned generator and generator configuration. The possible protection type values are:

    • Masked - Applied to columns that have a generator other than Passthrough assigned. The selected generator provides some protection against viewing source data. If both IsDifferentiallyPrivate and IsDataFree are FALSE, then ColumnPrivacyStatus is Masked. Consistency decreases the protection level. If consistency is enabled, then ColumnPrivacyStatus is Masked.

    • Anonymized - Applied to columns for which the assigned generators and the generator configuration are guaranteed against reverse engineering. The assigned generator either uses differential privacy, or is considered data-free, where the output data is completely unlinked from the source data. The assigned generator does not have consistency enabled.

  • IsDataFree - Indicates whether the assigned generator uses the underlying data. If the output data is completely unlinked to the source data, the generator is considered data-free, with a high degree of protection.

Privacy

Privacy indicates how well the protection measures actually protect the source data.

The privacy information is included in the following columns:

Privacy Report privacy ranking charts

The Privacy Report privacy ranking charts summarize the privacy ranking values for the workspace data.

The privacy ranking charts are provided in a downloadable PDF file. The file also includes the Privacy Report table, which contains the same content as the .csv file.

The first page of the file contains definitions of the privacy ranking values.

The PDF then contains two sets of charts:

  • The first set of charts summarizes the privacy ranking values for all columns. It includes all of the privacy rankings from 1-6.

  • The second set of charts summarizes the privacy ranking values for columns that have an assigned generator. It does not include privacy ranking 6, which is assigned to columns that do not have an assigned generator.

Each set of charts contains:

  • A donut chart that displays the number of columns and the relative number of columns with each privacy ranking.

  • A bar chart that shows the number of columns with each privacy ranking.

  • For each privacy ranking, a summary that includes:

    • The percentage of columns with that ranking.

    • The number of columns with that ranking.

Viewing privacy status information on the job details view

On the job details view, the Privacy Report tab summarizes the privacy status for the columns that are included in the destination data. It does not reflect columns that were excluded, such as columns in truncated tables.

It shows the number of columns that are At-Risk, Protected, and Not Sensitive.

Downloading a Privacy Report file

Downloading a report based on the current configuration

From Privacy Hub and the workspace download menu, you can download a Privacy Report .csv or PDF file that reflects the current workspace configuration.

These reports indicate how well your data would be protected if you generated data with that configuration.

From the workspace management view, click the download icon, then:

  • To download the Privacy Report PDF file, click Download Privacy Report PDF.

  • To download the Privacy Report .csv file, click Download Privacy Report CSV.

From Privacy Hub, click Reports and Logs, then:

  • To download the Privacy Report .csv file, click Privacy Report CSV.

  • To download the Privacy Report PDF file, click Privacy Report PDF.

Downloading a report for a specific data generation job

From the job details view for a data generation job, you can download a Privacy Report .csv or PDF file that reflects the workspace configuration at the time of data generation.

These reports indicate how well your data was protected by that configuration.

On the job details view, to display the download options, click Reports and Logs.

In the menu:

  • To download the Privacy Report .csv file, click Privacy Report CSV.

  • To download the Privacy Report PDF file, click Privacy Report PDF.

Last updated 3 months ago

Was this helpful?

TableMode - The that is currently applied to the table.

Structural protect sensitive information while maintaining the usefulness of the data for data consumers.

Generator - The generator that is currently applied to the column. For information about how each generator transforms data, go to the .

IsDifferentiallyPrivate - Indicates whether the assigned generator supports and whether differential privacy is enabled. Differential privacy guarantees the highest level of privacy, and eliminates the ability to re-identify the data. TRUE indicates that both of these are true. FALSE indicates that either the assigned generator does not support differential privacy, or that differential privacy is not enabled.

IsConsistent - Indicates whether consistency is enabled for a given column. This is also set to true if the generator is always consistent. ensures that a given input always results in the same output. It retains data utility, but provides a lower level of protection. When consistency is on, ColumnPrivacyStatus is Masked instead of Anonymized. For more information, go to .

ConsistencyColumn - In some cases, a column is configured to be another column. If the consistency is to another column, then ConsistencyColumn contains the name of that column.

ColumnPrivacyStatus - The of the column. Reflects whether a generator is applied, whether the column is sensitive, and whether the column is included in the destination database.

ColumnPrivacyRank - The of the column. Reflects the applied generator and the generator configuration. Does not reflect whether the column is sensitive or included.

table mode
generators
Generator reference
differential privacy
Consistency
Privacy Status
privacy status
privacy ranking
consistent to
Example Privacy Report with the column groups labeled
Privacy Report charts that show privacy rankings for all columns and for masked columns
Privacy Report tab on the job details page
Download menu for a workspace
Reports and Logs menu on Privacy Hub
Reports and Logs menu for a data generation job