Overview
The Collibra - Project Custom Fields set adds a Collibra Publishing section to every Validatar test. Test owners use it to choose which tests the Collibra Data Source Template publishes to Collibra as Data Quality Rules, what Collibra calls each rule, which quality dimension classifies it, and which Collibra asset it governs.
Marketplace: Collibra - Project Custom Fields
These are project custom fields, so they appear on tests in every project. The fields that hold Collibra metadata in the Validatar catalog are a separate set, Collibra Catalog Custom Fields. Both are part of the Collibra Integration.
Import this set before you publish tests to Collibra. The publish test writes to two of these fields, and those writes fail when the fields do not exist.
Fields
All five fields sit in one section, Collibra Publishing, on the Test object type.
| Field | Reference key | Type | Purpose |
|---|---|---|---|
| Publish to Collibra | collibra_publish |
Dropdown: Yes, No | Yes publishes the test as a Data Quality Rule, No keeps it out. With Publish Tests set to All tests, blank also publishes |
| Collibra Rule Name | collibra_rule_name |
Short text | The name Collibra shows for the test's rule. Blank uses the test's Validatar name |
| Collibra Dimension | collibra_dimension |
Short text | The Collibra Data Quality Dimension that classifies the rule. Blank uses the test's Validatar quality dimension, through the template's Dimension Map |
| Collibra Target Asset ID | collibra_target_asset_id |
Short text | The Collibra asset the rule governs. The publish test fills it with the test's column or table; set a column's asset id to show the result on that column |
| Collibra Rule Asset ID | collibra_rule_asset_id |
Short text | The rule's asset id in Collibra, filled by the publish test |
How publishing uses the fields
Individual tests are published only when the Collibra data source's Publish Scope is Trust + Dimensions + Tests, its default. At the narrower scopes Validatar publishes one rule per table, or per table and dimension, and these fields change nothing.
Publish Tests on the Collibra data source decides what a blank Publish to Collibra means:
- All tests (the default) publishes every test on a matched table unless it is set to No.
- Opted-in tests publishes only tests set to Yes.
When a test is set to No after it was published, its rule is deleted on the next run, or marked Obsolete when the data source's Retired Rules is Mark Obsolete.
The publish test fills Collibra Target Asset ID and Collibra Rule Asset ID each time it publishes with Dry Run off. A test linked to exactly one column in Validatar governs that column's asset; any other test governs its table. To place a table-level test on a column, set Collibra Target Asset ID to the column's asset id, which the Collibra metadata script stores in the column's Collibra Column Asset ID field. The Push Test Result to Collibra test action reads Collibra Target Asset ID to find where the result goes, and skips a test whose field is still empty.
Collibra Dimension takes a dimension name as Collibra has it, for example Conformity. A name with no Data Quality Dimension asset in Collibra publishes the rule without a dimension, and the publish test's row says so.
Import the fields
You need the Global Custom Metadata Admin role, or Global Admin.
From the marketplace (recommended)
- In Validatar, open Marketplace and find Collibra - Project Custom Fields.
- Choose Get, then Import Directly. Validatar opens Settings > Project Custom Fields with an Import Custom Fields panel on the right.
- In the list of object types on the left, open Test. Import All adds the panel's sections to the object type that is open, so make sure it is Test.
- Choose Import All, then Save.
- Check that the Test page now has a Collibra Publishing section with the five fields above.
From the downloaded file
- Choose Get, then Download XML.
- In Settings > Project Custom Fields, open Test, choose Import, select the file and choose Next.
- Choose Import All, then Save.
Note: Choose Import All once. A second Import All adds the section again, and the page will not save until you remove the copy.
To create the fields by hand instead, add a section named Collibra Publishing on the Test object type with the names, reference keys, types and options in the table above, as described in Configuring Custom Fields. The reference keys must match exactly, because the template finds the fields by key.
Related
- Collibra Integration
- Collibra Data Source Template
- Collibra Catalog Custom Fields
- Collibra Setup for Validatar
Note: The field set has been imported from the Validatar marketplace into a Validatar instance. There, with a built-in sample Collibra instance, the publish test wrote Collibra Target Asset ID and Collibra Rule Asset ID back to each published test and left the test set to No untouched. It has not yet been used against a live Collibra instance, so expect small adjustments after your first live run.