Custom Entities

Add custom entities to extend MD.

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.

Custom entities view in MD

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.

Custom entities instances view

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.

Adding custom entity schema

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.

Importing and exporting custom entities

You can export a custom entity together with its mixin schemas and import it in another context. For example, you can import it into another tenant or use it in a Partner Library component, such as a value stream or an AI agent.

To export a single custom entity, choose the Export icon next to that entity. This downloads a JSON file with the entity definition. If the entity references another entity, the referenced entity is automatically included in the export so the data model remains consistent.

You can also export multiple custom entities at once into a single JSON file. Select the entities in the list and choose the Export icon in the top bar. This approach is recommended when importing entities into Partner Library, because using one JSON file helps prevent duplicate entries.

Exporting multiple custom entities

To import a custom entity definition, in the Custom Entities view, choose the Import icon. Select or drag and drop the JSON file from your device to trigger its import. The custom entity or entities are automatically added to the custom entities list.

Import icon

Emporix allows importing only custom entities with a valid export data, so only the previously exported entities can be imported.