Lineage relationship mapping file format (IBM Knowledge Catalog)
You can define mappings in lineage relationship mapping files in a comma-separated value (CSV) file, which you can then import into the catalog.
Required permission
You must have this user permission:
- Access catalogs
You must have one of these user roles:
- Catalog admin
- Catalog editor
Syntax
The following syntax rules govern how to correctly define applications, stored procedure definitions, or files in the lineage relationship mapping files in CSV format. You can add a maximum of 10000 records in one file.
Column Headings
The following column headings are required and must be in the first row of the lineage relationship mapping file.
- Name
- Source Columns
- Target Columns
- Rule
- Function
- Specification Description
Don't change the names of the column headings. You can change the column order.
Source Columns, Target Columns
If the context of an asset is not in the catalog, that mapping is not imported into the catalog. By default, the value is searched by the asset resource key and its value in a CSV file must be the same as the one in the assets. The asset's resource key can be found in the About this asset side panel.
Specifying value
Specify asset values by using prefixes. All values are case-sensitive. If a value contains a comma (,) precede it with a backslash (\).
The asset value mustn't contain the following characters:
- Ellipsis (...)
- Double quotation marks (")
- Single quotation marks (')
- Other special characters
Blank spaces before or after an asset name or a resource key are not omitted.
| Searched value | Prefix | Example |
|---|---|---|
| Resource key | Default value | No need of a prefix. |
| Name | #NAME# |
#NAME#my_asset searches for assets with the name my asset. |
| Universally unique ID | #UUID# |
#UUID#abcdef-0123-abcde-12320 searches for assets with universally unique ID abcdef-0123-abcde-12320. |
| Asset type | #ASSET_TYPE# |
#ASSET_TYPE#data_asset searches only for data assets. |
| Column | #COLUMN# |
#COLUMN#my_column searches for a column of name my_column. |
Example
The following example shows a column of name my_column of an asset of data asset type with resource key 0000:0000:0000:0000:0000:aaaa:1111:1111|00000|AAAAA named my_asset.
0000:0000:0000:0000:0000:aaaa:1111:1111|00000|AAAAA#NAME#my_asset#ASSET_TYPE#data_asset#COLUMN#my_column
Rule
Text that describes the purpose or business reason of the mapping. For example, a rule might be Remove duplicate subscribers from billing list.
Function
Text that describes what the mapping does. For example, a function might be Compares subscriber names in 2 tables.
Specification Description
Text that describes the movement of data, the process in which this movement takes place, or additional information.
Special characters and language support
You can use these special characters:
- Commas: A comma (,) is the only accepted delimiter.
- Double quotation marks: The use and treatment of quotation marks (") varies according to the column.
| Column | Use or treatment of quotation marks |
|---|---|
| Source and Target Columns | Quotation marks are removed during import. |
| Rule and Function | If quotation marks occur in the text, they must be enclosed within quotation marks (" " "). |
| Specification Description | Quotation marks are required around the entire text of the field if the text includes nonalphanumeric characters, such as mathematical symbols or commas. |
Language support
The CSV file must be in UTF-8 or in ANSI encoding to be compatible with all languages.
You can type the values in any language, but do not change the names of the column headings.
Example
You need to create a CSV file to import lineage relationship mapping files into the catalog. The following example shows how a CSV file might look. The import file shows a mapping row between assets' specific columns. All assets that are listed in the Source Columns and in the Target Columns exist in the catalog.
Name,Source Columns,Target Columns,Rule,Function,Specification Description
Validate column with null data,0000:0000:0000:0000:0000:ffff:1111:1111|00000|BLUDB:/HRSALES/RECRUITMENT#COLUMN#ORGANIZATION_CODE,0000:0000:0000:0000:0000:ffff:2222:2222|11111|BLUDB:/HRSALES/RECRUITMENT_MEDIUM#COLUMN#RECRUITMENT_TYPE_CODE,Transform with checking for potential null values,Cubic transformation,Data in a product survey
Learn more
Parent topic: Importing lineage relationship mapping files