Skip to main content Skip to complementary content

Extended business metadata import support for XLS import of custom field values

Qlik Catalog supports population of custom source, entity, and field (column) property values through Excel spreadsheet import.

Note that each additional custom property added in the spreadsheet must also correlate to a pre-created custom source, entity, or field property in Qlik Catalog (user-created custom property—for PUT/propDef/v1/save payload examples, refer to: Sample Payloads for Custom Properties: PUT /propDef/v1/save). The values for the custom properties will be mapped to the correct object level(s) in the spreadsheet (i.e., If source and entity names are provided in the spreadsheet, and the entity level property has been created, the value will be inserted as the entity property).

As in the case of regular business metadata import, a few rules apply:

  • Values must be entered for Business Name column in the spreadsheet: null values for these fields are not allowed.
  • Values must be entered for every existing parent object level (i.e., entity-level properties must specify source and entity, field-level properties specify source, entity, field).
  • Custom business metadata columns must appear in columns to the left of the Tag columns.
  • Columns must be defined in the spreadsheet in the following order: Source, Entity, Field, Business Name, Business Description, Technical Description, Name_First_Custom_Property, Name_Second_Custom_Property..., then optional tag columns named Tag 1, Tag 2, and so on.

Spreadsheet column order must be defined exactly as shown

Upon upload the values in the XLS spreadsheet are imported and display at the appropriate custom property level.

Upload a Business Metadata file

Selected spreadsheet displays in import buisness metadata modal

Values display on the Properties Modal for the defined Source, Entity, and Field level for this example.

Values from Import Display in Properties

Sample Payloads for Custom Properties: PUT /propDef/v1/save

Payload for Custom Source Property (example)

{

  "id": null,

  "name": "NewMD1",

  "displayName": "NewMD1",

  "description": "New Source Prop",

  "type": "STRING",

  "defaultValue": "",

  "editable": true,

  "nullable": true,

  "applicableClasses": [

    "com.nvs.core.model.meta.DataSource"

  ],

  "propertyCategoryMembers": [

   "Source Props", "Default Source Props"

  ],

  "required": false

}

 

Payload for Custom Entity Property (example)

{

  "id": null,

  "name": "NewMD1",

  "displayName": "New MD1",

  "description": "New Entity Prop",

  "type": "STRING",

  "defaultValue": "",

  "editable": true,

  "nullable": true,

  "applicableClasses": [

    "com.nvs.core.model.meta.DataEntity"

  ],

  "propertyCategoryMembers": [

    "Entity Props", "Default Entity Props"

  ],

  "required": false

}

 

Payload for Custom Field Property (example)

{

  "id": null,

  "name": "NewMD1",

  "displayName": "NewMD1",

  "description": "New Field Prop",

  "type": "STRING",

  "defaultValue": "",

  "editable": true,

  "nullable": true,

  "applicableClasses": [

    "com.nvs.core.model.meta.DataField"

  ],

  "propertyCategoryMembers": [

   "Field Props", "JDBC Field Props"

  ],

  "required": false

}

 

Custom properties display at defined object level

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!