Loading Custom Entities¶
The custom-entities loader is able to load new custom-entities and update existing custom-entities. The loader is not able to delete a custom-entity. If the custom-entity's federatedId is already in use we update the existing custom-entity, and if its a new federatedId we create a new custom-entity.
The custom-entities loader is only capable of loading a custom-entity, therefore we cannot have multiple load types when loading custom-entity data.
Required properties for loading Custom Entities:¶
federatedId
typePath
name
Loader Configuration:¶
To load custom-entities the configuration file will need to have the loadType set to CUSTOM_ENTITY
.
In the following example we would have a CSV file with the column 'name' and whatever else is available on the custom-entity's type.
Since we set the typePath to custom-entity:colorwayReference
, all of the entities in the load file will be created as a colorwayReference.
This assumes there is a custom-entity subtype named colorwayReference.
loadType:
- CUSTOM_ENTITY
federatedMappings:
federatedId: "name"
conditionalColumns:
-
toProperty: "typePath"
default: "custom-entity:colorwayReference"