Document View for file connector JSON columns
For file connector columns that contain JSON content, you can use the JSON Mask generator to assign generators to individual JSON fields. To identify the fields, you use JSONPath expressions.
Another option is to use Document View, which allows you to view the structure of the JSON content and then assign generators to individual JSON fields.
Enabling Document View for a JSON column
For a JSON column, the Document View option is available from Privacy Hub, Database View, and Table View.
On the column configuration panel, to enable Document View, toggle Use Document View to the on position. When you enable document parsing:
The generator dropdown changes to an Open in Document View button.
If this is the first column that you enabled Document View for, then the Document View tab becomes visible.
Any existing generator assignment is discarded.
On Privacy Hub, in the protection status display, each JSON path is displayed as a separate column. In the Database Tables list, each JSON path is a separate entry.
Structural also runs a scan on the column to detect the JSON structure and identify sensitive fields.
Displaying Document View
On workspace management view, you use Document View to view the JSON structure.
Document View is only available when it is enabled for at least one JSON column.
Selecting the JSON column to configure
From the Column dropdown list, select the JSON column to configure. The dropdown contains the columns that have Document View enabled.
Selecting the type of view
From the View dropdown list, select the view to use for the selected column.
Hybrid view
Hybrid view provides a consolidated view of the schema across all of the rows.
For example, for an array, hybrid view contains a single entry with all of the possible fields.
Single view
Single view shows the structure for one row at a time. You can then page through up to 100 rows. For each row, you see the structure for that row.
For example, for an array, single view shows the actual array entries for each record.
Information in the field list
For each JSON field, Document View always displays:
The field name and data type.
The assigned generator.
An example value. In hybrid view, you can use the magnifying glass icon to display additional example values.
Hybrid view also displays a Field Freq column. Field Freq shows the percentage of rows that contain that permutation of field and type. For example, you might see that a field is Null 33% of the time and contains a numeric value 67% of the time. Or a field value is an Int32 value 3% of the time and an Int64 value 6% of the time. The percentages apply to the first 100 rows.
Toggling between source and preview data
The Preview toggle at the top right of Document View allows you to choose whether to display original source data or the transformed data. You can switch back and forth to see exactly how Tonic Structural transforms the data based on the field configuration.
By default, the Preview toggle is in the on position, and the displayed data reflects the assigned generators.
To display the original source data, toggle Preview to the off position.
Filtering Document View fields
In single view, you can filter by either a field name or a field value.
In hybrid view, you can filter by either field name or field properties.
Filtering single document view by field name or value
You can filter single view to only display fields that have specific text in either the field name or the field value.
To filter by value, toggle Search by Value to the on position.
After you select the filter type, in the search field, type text that is in the field name or value. As you type, Structural filters the list to only include fields that contain the filter text.
Filtering hybrid view by field name
To filter hybrid view by field name, in the search field, begin typing text that is in the field name. As you type, Structural filters the list to only include fields with names that include the filter text.
Filtering hybrid view by field properties
From the hybrid document view, you can filter the fields based on field properties.
To display the Filters panel, click Filters.
Searching for a filter
To search for a filter or a filter value, in the search field, start to type the value. The search looks for text in the individual settings.
Adding a filter
To add a filter, depending on the filter type, either check the checkbox or select a filter option. As you add filters, Structural applies them to the field list.
Above the list, Structural displays tags for the selected filters.
Clearing the selected filters
To clear all of the currently selected filters, click Clear All.
Filters panel filters
The Filters panel in hybrid view includes the following options.
At-risk JSON fields
An at-risk JSON field:
Is marked as sensitive
Is assigned the Passthrough generator.
To only display at-risk JSON fields, on the Filters panel, check At-Risk Field.
When you check At-Risk Field, Structural adds the following filters under Privacy Settings:
Sets the sensitivity filter to Sensitive.
Sets the protection status filter to Not protected.
Sensitivity
You can filter the JSON fields based on the field sensitivity.
On the Filters panel, under Privacy Settings, the sensitivity filter is by default set to All, which indicates to display both sensitive and non-sensitive JSON fields.
To only display sensitive JSON fields, click Sensitive.
To only display non-sensitive JSON fields, click Not sensitive.
Note that when you check At-risk Field, Structural automatically selects Sensitive.
Protection status
You can filter the JSON fields based on whether they have any generator other than Passthrough assigned.
On the Filters panel, under Privacy Settings, the field protection filter is by default set to All, which indicates to display both protected and not protected JSON fields.
To only display JSON fields that have an assigned generator, click Protected.
To only display JSON fields that do not have an assigned generator, click Not protected.
Note that when you check At-Risk Field, Structural automatically selects Not protected.
Recommended generators
When Structural detects that a JSON field is sensitive, it can also determine a recommended generator.
For example, when it detects a name value, it also recommends the Name generator.
You can filter the fields to display the fields that have recommended generators.
On the Filters panel, under Recommended Generators, check the checkbox next to the recommended generator for which to display the fields that have that recommendation.
Field data type
You can filter the fields by the field data type. For example, you might only display columns that contain either numeric or integer values.
To only display fields that have specific data types, on the Filters panel, under Database Data Types, check the checkbox for each data type to include.
The list of data types only includes data types that are present in the currently displayed fields and that are compatible with other applied filters.
To search for a specific data type, in the Filters search field, begin to type the data type.
Unresolved schema changes
When the structure of the JSON changes, you might need to update the configuration to reflect those changes. If you do not resolve the changes, then the data generation might fail.
To only display fields that have unresolved changes to the JSON structure, on the Filters panel, check Unresolved Schema Changes.
Sensitivity type
For detected sensitive fields, the sensitivity type indicates the type of data that was detected. Examples of sensitivity types include First Name, Address, and Email.
To only display fields that contain specific sensitivity types, on the Filters panel, under Sensitivity Type, check the checkbox for each sensitivity type to include.
The list of sensitivity types only includes sensitivity types that are present in the currently displayed fields.
To search for a specific sensitivity type, in the Filters search field, type the sensitivity type.
Sensitivity confidence
When the document scan identifies a value as belonging to a sensitivity type, it also determines how confident it is in that determination.
You can filter the columns based on the confidence level.
To only display columns that have a specific confidence level, on the Filters panel, under Sensitivity confidence, check the checkbox next to each confidence level to include.
Indicating whether a JSON field is sensitive
On the field configuration panel, the sensitivity toggle at the top right indicates whether the field is marked as sensitive.
To mark a field as sensitive, toggle the setting to the Sensitive position.
To mark a field as not sensitive, toggle the setting to the Not Sensitive position.
Assigning a generator to a JSON field
For each node, you assign a generator.
To assign a generator:
Click the generator value for the JSON field.
On the configuration panel, from the Generator Type dropdown list, select the generator. Other than the Conditional and Regex Mask generators, you cannot assign a composite generator to a JSON field.
Configure the generator options. For details about the available configuration options for each generator, go to the generator reference.
When you configure a generator in Document View:
You can only link to other JSON fields.
You can only enable self-consistency.
Last updated
Was this helpful?
