Mixin Schemas

Mixins are custom properties that you can define in Emporix to adapt the system to your specific needs.

Mixin Schemas

Emporix Commerce Engine provides an extensibility mechanism that allows you to customize the platform adjusting it to the customers needs. The mixin schemas concept allows you to easily extend the data model so that you can boost default objects with customer-specific fields.

• Looking for code tutorials? Check out Schema Service.

• Looking for API reference? Check out the Schema Service in the Emporix API Reference.

Purpose

To meet customer-specific requirements, it is sometimes necessary to extend the default entities and provide additional information. The mixin schemas feature offers a simple and centralized way of adding customized fields to different objects that provide more industry-specific context. The customized fields are displayed in the Management Dashboard and can be managed from there.

Overview video

The diagram shows in a nutshell how creating a schema works:

Features

Mixin schemas come with a few features that make the management of customized schemas easier:

Feature	Description
Management Dashboard support for all relevant entities	Manage the additional fields easily ensuring that the data is consistent.
Supported entities	Define and generate data schemas for the following entities: category, company, coupon, customer, customer address, order, price list, product, quote, return and custom entity.
Management Dashboard supported types	Add fields of the following types: array, boolean, date, date_time, decimal, enum, number, object, text, and time.
Upload of json files to create schemas	Define a schema with customized fields by uploading a json file that defines the data model you need. The json file is validated during the upload reducing the errors number.
Different versions per entity	Extend a basic schema by individual fields per entity and maintain valid versions of their schemas.
Unassign mixin schema	Control which mixin schemas are assigned to the entities to ensure consistency. With unassign feature, the backend users can define which version is the current one for which object.
Localization	Provide translations for the custom specific sections, descriptive fields and define if a field itself should be translated into multiple languages.

To learn about the service and see how it works, see the following documentation:

• Management Dashboard User Guide — Mixin Schema Guide
• Developer Guide — Schema Service Tutorial
• API Reference — Schema Service