Skip to content

Loading Custom Entities

If you have not reviewed the Getting Started page, please do so to understand the fundamentals of loading data.

Custom Entities represent a way to store data in VibeIQ that doesn't fit into the standard data model. Like all entity types, these are organized by typePath. It is especially important to get this field correct upon load, so that the data is not inadvertently duplicated onto another Custom Entity type.

Examples organizing Custom Entities by typePath:

  • "Vendor" as specified by typePath: custom-entity:vendor
  • "Colorway Reference" as specified by typePath: custom-entity:colorwayReference

To load data into each of Custom Entity sub-types, the correct typePath must be specified.

Required Config Properties

  • loadType: ['CUSTOM_ENTITY']
  • federatedId
  • typePath

Load Example

Config YAML / JSON

Please review the Creating a Loader Process to understand how to provide this Config example to the Loader.

loadType:
  - CUSTOM_ENTITY
federatedMappings:
  federatedId: "name"
conditionalColumns:
  - toProperty: "typePath"
    default: "custom-entity:colorwayReference"

{
  "loadType": [
    "CUSTOM_ENTITY"
  ],
  "federatedMappings": {
    "federatedId": "name"
  },
  "conditionalColumns": [
    {
      "toProperty": "typePath",
      "default": "custom-entity:colorwayReference"
    }
  ]
}