The Custom Entities module is where you can create and manage objects with unique identifiers and attributes. Custom entities allow you to define objects tailored to your needs, enabling you to build a data model that meets your business requirements.
Creating a custom entity
1
Choose to create an entity
Go to Settings -> Custom Entities and choose Create New Custom Entity.
2
Provide the entity details
Add the ID and Name for your entity and choose Save.
The ID must be capitalized.
As a result, the entity is added to the custom entities list and it's also visible in the Custom Instances node in the Management Dashboard.
3
Add custom schema
To add a mixin schema to the custom entity, choose Go To Mixin and then Add New Mixin Schema.
4
Define custom fields
Select the Entity for the mixin schema and add its Name. You can also provide the Key value and a JSON file for the schema. If you don't upload the JSON schema file, add the mixin values in the Fields tab.
Custom entities support references to other entities. Within a custom entity, you can establish one-to-one or one-to-many relationships to any CUSTOM ENTITY, but also to Emporix types such as CART, CATEGORY, CUSTOMER, CUSTOMER_SEGMENTS, LEGAL ENTITY, MEDIA, ORDER, PRICE_LIST, and PRODUCT. To achieve that, you need to define a mixin schema with reference to other type.
5
Save your configuration
Save your changes.
Now, you can start creating your custom instance based on the entity and the mixin schema.
To learn how to work with mixins, see the Mixin Schemas guide and to learn about custom instances, see Custom Instances guide.
