Custom Instances

Custom Instance is a specific representation of a Custom Entity, which you can define as a data type in the Settings module. It is subordinate to the entity in both structure and context and it can only exist within the framework of its parent entity. Based on the entities you have configured, you can add instances of the entities type. For example, you have created a custom entity for a Car object. Now, based on the entity, you can create different instances of the Car type, for example a Sport Car.

Prerequisite for customizing the custom instances

The properties of custom instances depend on the mixin schema for the corresponding Custom Entity, which serves as the definition for all instances of the entity. To be able to create an instance, first create a custom entity and define its mixin schema with custom fields.

Adjusting the Custom Instances view

You can modify the default view to make the custom fields visible and searchable in the list view.

1

Open orchestration mode

Choose the orchestration icon.

2

Select mixin fields

Select the mixins that you want to add to the view and choose Save. As a result, your custom instance view is updated with the columns for the fields configured in your mixin schema.

Creating a custom instance

1

Choose to create a custom instance

Go to Custom Instances and choose Create New Custom Instance.

2

Provide the instance details

• In the General tab, add the ID and Name for the instance.

• The fields from the custom entity schema are automatically rendered in another tab named after the schema. Add values for the defined custom fields.

3

Save the instance

Choose Save to create an object in the system.

4

Add media

Saving the object activates the Media tab. Here, you can attach different files in relation to the instance. The supported types are PDF, JPG, PNG, CSV, DOCX, TXT. Choose the file from your device or drag and drop it to the drop area. Then upload the file using the Upload icon.

Reference types in custom instances

The custom entities schema supports adding fields that reference to other types in the system. This way, their instances can have one-to-one or one-to-many relationship to instances of other custom entities or certain Emporix entities, such as cart, category, customer, customer segment, legal entity, media, order, price list, and product.

When you create an instance of an entity that contains reference fields, you are able to select an entity or multiple entities (depending on the setup) from the dropdown list.

From the edit mode, you can directly navigate to the referenced instances to check their details, or use the convenient option to copy their IDs. Remove the referenced instance by choosing x in the selector bar or - icon next to the item on the list.