CSV file format for importing and exporting asset metadata

The CSV file for importing and exportig asset metadata details must conform to specific formatting rules.

Limitations

  • File encoding is UTF-8.

  • The maximum recommended size of a file is 10,000 rows.

  • You can specify columns definition only for data assets.

  • You can import and export data assets with custom attributes only if the attributes belong to a group. If you import or export such data assets anyway, the custom attributes fields are not included.

  • You must follow asset definition by its column definition.

  • Unexpected extra properties are included in the exported CSV file. Do not edit these properties.

     Asset Property: data_asset>>dataset
     Asset Property: data_asset>>mime_type
     Asset Property: data_asset>>properties>>name
     Asset Property: data_asset>>properties>>name
     Asset Property: data_asset>>semantic_description>>confidence
     Asset Property: data_asset>>semantic_description>>generated_date
     Asset Property: data_asset>>semantic_description>>generated_description
     Asset Property: data_asset>>semantic_description>>status
     Asset Property: discovered_asset>>connection_id
     Asset Property: discovered_asset>>connection_path
     Asset Property: discovered_asset>>discovery_id
     Asset Property: discovered_asset>>extended_metadata>>name
     Asset Property: discovered_asset>>extended_metadata>>name
     Asset Property: discovered_asset>>extended_metadata>>name
     Asset Property: discovered_asset>>first_imported_timestamp
     Asset Property: discovered_asset>>last_discovered_timestamp
     Asset Property: discovered_asset>>last_imported_timestamp
     Asset Property: discovered_asset>>last_job_action
     Asset Property: discovered_asset>>last_job_run_id
     Asset Property: discovered_asset>>metadata_import_id
     Asset Property: discovered_asset>>outdated_reason
     Asset Property: discovered_asset>>outdated_timestamp
     Asset Property: key_analyses>>fk_assigned
     Asset Property: key_analyses>>fk_assigned_as_pk
     Asset Property: key_analyses>>fk_defined
     Asset Property: key_analyses>>fk_defined_as_pk
     Asset Property: key_analyses>>fk_suggested
     Asset Property: key_analyses>>fk_suggested_as_pk
     Asset Property: key_analyses>>key_analysis_area_id
     Asset Property: key_analyses>>overlap_assigned
     Asset Property: key_analyses>>overlap_suggested
     Asset Property: key_analyses>>pk_assigned
     Asset Property: key_analyses>>pk_defined
     Asset Property: key_analyses>>pk_suggested
     Asset Property: metadata_enrichment_info>>MDE_instrumented
     Asset Property: term_assignment_profile>>attachment_id
     Asset Property: term_assignment_profile>>completed_date
     Asset Property: term_assignment_profile>>messages
     Asset Property: term_assignment_profile>>messages
     Asset Property: term_assignment_profile>>messages
     Asset Property: term_assignment_profile>>semexp_completed_date
     Asset Property: term_assignment_profile>>semexp_messages
     Asset Property: term_assignment_profile>>semexp_start_date
     Asset Property: term_assignment_profile>>semexp_status
     Asset Property: term_assignment_profile>>start_date
     Asset Property: term_assignment_profile>>status
    

Header row

The headers in the first row of the CSV file represent which properties are imported for the assets.

  • The header row must be the first row in the file and must not be repeated.
  • The header must include the mandatory headers.

Mandatory headers

The header row of the CSV file must include the following mandatory headers:

Name
Example: my_asset.
Type
All asset types are supported. Columns definition is supported only for the data_asset type.
Example: data_asset

Optional headers

To specify more detailed asset metadata, add appropriate optional headers to your CSV file.

Asset Resource Key
Uniquely identifies the asset in the catalog. Automatically included in every export CSV file.
Example: Test asset.
Schema
Available only for the data_asset asset type. To associate assets with an existing connection, you must provide Schema and Physical Table details.
Physical Table
Available only for the data_asset asset type. To associate assets with an existing connection, you must provide Schema and Physical Table details.
Table type
Available only for the data_asset asset type. Determines whether a data asset represents a table, view, alias, or query. Any value for the table type field is accepted.
Connection Name
Available only for the data_asset asset type.
Connection Resource Key
Available only for the data_asset asset type.

Owner

: Emails of the asset owners. Owners must be catalog collaborators. Multiple values are allowed.
Example: az@company.com

Description
Asset or column descriptions.
Example: This is a test asset.
Tag
Tags to identify assets or columns. Multiple values are allowed.
Example: tag1
Term
Assigned business terms. The business term must exist. Use the path format. Multiple values are allowed.
Example: AlexTestCategory>>sub category>>category one>>new term
Classification
Assigned classifications. Use the path format. Multiple values are allowed.
Example: AlexTestCategory>>sub category>>category>>new classification.
Data Class
Data class that is assigned to a column in a data asset. Use the path format. The root category [uncategorized] must always be present. A blank entry does not replace it.
Example: [uncategorized]>>Computer Host Name
Column Source Type
Column data type.
Example: varchar.
Column Size
Column data size.
Example: 1024
Column Type Nullable
If column type could be null, use a boolean.
Example: TRUE
Column Native Type
Column native data type.
Example, enum.
Asset Property
Asset custom property. Multi columns must have the attribute path in the header. The property is defined in the column, the value of the property in the row. For column names, "Asset property:" is used as the prefix. enum types path must end with name. Multiple values are allowed.
Example:
Column name: Asset Property: azub_group_test>>prop_ahhatx
Column value: value of prop1
Column Property
Column custom property. Multi columns must have the attribute path in the header. The property is defined in the column, the value of the property in the row. For column names, "Asset property:" is used as the prefix. enum types path must end with name. Multiple values are allowed.
Example:
Columns name: Column Property: col_group_zevkys>>prop_qblrui
Columns value: host1

Formatting category and attribute paths

  • You must specify the full category and attribute paths. If you do not specify the category, the default category is [uncategorized].

  • To delimit the category path and attribute path, use two greater than >> symbols between each level of the category or attribute hierarchy and between the category path or attribute path and the artifact name.

  • List the category hierarchy or attribute hierarchy from the top-level category name through the final category or attribute name, and separate each with the >> symbols.

    For example, to create a third level category or attribute, your Category field might look like this:

    myCategory1>>myCategory2>>myCategory3
    

    The root category [uncategorized] must always be present. A blank entry does not replace it. You can't specify the [uncategorized] category as a secondary category and it can't have subcategories.

Example metadata asset CSV file

Asset Resource Key,Name,Type,Schema,Physical Table,Table Type,Connection Name,Connection Resource Key,Owner,Owner,Description,Tag,Tag,Asset Property: Data use >> Can be used in marketing,"Asset Property:
Data use >> Can be used in product improvement",Term,Term,Term,Classification,Classification,Classification,Classification,Data Class,Column Source Type,Column Size,Column Type Nullable,Column Native Type,Column Property: Indicators >> Is sensitive,Column Property: Indicators >> Is trusted,"Column Property: Stakeholders >> QA
",Column Property: Stakeholders >> Subject Matter Experts,Column Property: Stakeholders >> Subject Matter Experts,Column Property: ungrouped property X
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,MORTGAGE_APPLICANTS,data_asset,BANKING,MORTGAGE_APPLICANTS,TABLE,Data Fabric Trial Db2 Warehouse,0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB,Mary Jones,Marketing User Group,Residential mortgage applicants,BANKING,Demo,YES,NO,Banking >> Mortgage Application,Banking >> Mortgage Applicant,Banking >> Bank Customer,[uncategorized] >> Personally Identifiable Information,>> Personal Information ,Sensitive Personal Information,High Importance,,,,,,,,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,ID,column,,,,,,,,customer id,,,,,Banking >> ID,,,,,,,>> Identifier,varchar,1024,TRUE,varchar,,,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,NAME,column,,,,,,,,Name of applicant,,,,,Mortgage Default Analysis >> Name,Banking >> Name,Information Governance >> Information Governance Classifications >> Business Classification,>> Personally Identifiable Information,,,,>> Person Name,varchar,1024,TRUE,varchar,Yes,Yes,Michal Sze,John Smith,Mary Jones,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,STREET_ADDRESS,column,,,,,,,,street address,,,,,,,,,,,,>> US Street Name,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,CITY,column,,,,,,,,city,,,,,,,,,,,,>> City,varchar,1024,TRUE,varchar,Yes,Yes,,,,blah
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,STATE,column,,,,,,,,state,,,,,,,,,,,,>> US State Name,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,STATE_CODE,column,,,,,,,,state code,,,,,,,,,,,,>> US State Code,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,ZIP_CODE,column,,,,,,,,postal or zip code,,,,,,,,,,,,,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,EMAIL_ADDRESS,column,,,,,,,,email address,,,,,,,,,,,,>> Email Address,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,PHONE_NUMBER,column,,,,,,,,home phone number,,,,,,,,,,,,>> US Phone Number,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/MORTGAGE_APPLICANTS,GENDER,column,,,,,,,,Gender identity,,,,,,,,,,,,>> Gender,varchar,1024,TRUE,enum(M;F),Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,MORTGAGE_APPLICANTS,data_asset,BANKING,MORTGAGE_APPLICANTS,,,,Mary Jones,Marketing User Group,Residential mortgage applicants,BANKING,Demo,YES,NO,Banking >> Mortgage Application,Banking >> Mortgage Applicant,Banking >> Bank Customer,[uncategorized] >> Personally Identifiable Information,>> Personal Information ,Sensitive Personal Information,High Importance,,,,,,,,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,ID,column,,,,,,,,customer id,,,,,Banking >> ID,,,,,,,>> Identifier,varchar,1024,TRUE,varchar,,,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,NAME,column,,,,,,,,Name of applicant,,,,,Mortgage Default Analysis >> Name,Banking >> Name,Information Governance >> Information Governance Classifications >> Business Classification,>> Personally Identifiable Information,,,,>> Person Name,varchar,1024,TRUE,varchar,Yes,Yes,Michal Sze,John Smith,Mary Jones,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,STREET_ADDRESS,column,,,,,,,,street address,,,,,,,,,,,,>> US Street Name,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,CITY,column,,,,,,,,city,,,,,,,,,,,,>> City,varchar,1024,TRUE,varchar,Yes,Yes,,,,blah
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,STATE,column,,,,,,,,state,,,,,,,,,,,,>> US State Name,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,STATE_CODE,column,,,,,,,,state code,,,,,,,,,,,,>> US State Code,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,ZIP_CODE,column,,,,,,,,postal or zip code,,,,,,,,,,,,,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,EMAIL_ADDRESS,column,,,,,,,,email address,,,,,,,,,,,,>> Email Address,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,PHONE_NUMBER,column,,,,,,,,home phone number,,,,,,,,,,,,>> US Phone Number,varchar,1024,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|IHUB:/BANKING/MORTGAGE_APPLICANTS,GENDER,column,,,,,,,,Gender identity,,,,,,,,,,,,>> Gender,varchar,1024,TRUE,enum(M;F),Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,CUSTOMER_LOYALTY,data_asset,BANKING,CUSTOMER_LOYALTY,,Data Fabric Trial Db2 Warehouse,0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB,John Smith,,Customer Loyalty table,CUSTOMER,,YES,YES,,,,,,,,,,,,,,,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,LOYALTY_NBR,column,,,,,,,,Loyalty number,,,,,,,,,,,,,integer,10,FALSE,integer,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,ORDER_YEAR,column,,,,,,,,Order year,,,,,,,,,,,,,smallint,5,TRUE,smallint,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,QUARTER,column,,,,,,,,Order quarter,,,,,,,,,,,,,varchar,2,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,MONTHS_AS_MEMBER,column,,,,,,,,Months as member,,,,,,,,,,,,,smallint,5,TRUE,smallint,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,LOYALTY_STATUS,column,,,,,,,,Status,,,,,,,,,,,,,varchar,15,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,PRODUCT_LINE,column,,,,,,,,Products,,,,,,,,,,,,,varchar,50,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,COUPON_RESPONSE,column,,,,,,,,Can receive coupons,,,,,,,,,,,,,varchar,20,TRUE,varchar,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,COUNT,column,,,,,,,,Count,,,,,,,,,,,,,smallint,5,TRUE,smallint,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,QUAITITY_SOLD,column,,,,,,,,Quantity sold,,,,,,,,,,,,,smallint,5,TRUE,smallint,Yes,Yes,,,,
0000:0000:0000:0000:0000:FFFF:3216:9DA3|50001|BLUDB:/BANKING/CUSTOMER_LOYALTY,UNIT_SALES_PRICE,column,,,,,,,,Unit sales price,,,,,,,,,,,,,decimal,8,TRUE,decimal,Yes,Yes,,,,
,SEFT Mortgage System,Application,,,,,,Mortgage Owners,,Mortgage application system for retail customers.,,,,,,,,,,,,,,,,,,,,,,
,Customer onboarding,Process,,,,,,Mortgage Owners,,Process to onboard new customers,,,,,,,,,,,,,,,,,,,,,,
,Sales results in 2023,bi_report,,,,,,Ben Smith,,Sales report from cognos,growth,,,,My category 1 >> My category 2 >> term 1,My category 1 >> My category 2 >> term 2,,My category 1 >> My category 2 >> classification 1,,,,,,,,,,,,,,

Learn more