For the complete documentation index, see llms.txt. This page is also available as Markdown.
Custom Instances
Manage instances of your custom entities.
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.
The Custom Instances node is not visible in Management Dashboard until you define it through the Custom Entity in the Management Dashboard Settings.
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.
Adding mixin columns to custom instances view
Browsing large custom instance lists
Custom Instances lists use cursor-based pagination so that browsing remains fast and predictable even when a custom entity has a very large number of records.
When you open a Custom Instances list:
Move between result pages with Previous and Next. You cannot jump directly to a specific page number.
The list does not show a total result count. Cursor-based pagination is optimized for stable navigation over large datasets rather than counting every matching record.
You can still change how many items appear on each page.
Pagination for custom instances
For developers integrating with Schema Service directly, see the following documentation:
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.
