Skip to main content

Content Entities

Introduction​

  • An Entity is a configurable unit designed to define and manage Content Entities, which are especially useful when configuring a Table. These entities serve as building blocks, helping manage how data is organized and referenced in tables.

Configuration​

All Entities configurations are stored and maintained in the ISON configuration. This file holds the necessary metadata that defines each entity's characteristics and behavior.

ISON Configuration Details​

The configuration of an Entity within the ISON file follows a standardized format. Below is an example of how an Entity is typically structured.

Sample ISON Configuration​

<entities>
    <entity id="entity_1">
        <name>entity_1_entity_id</name>
        <type>TEXT</type>
        <valuePlaceholder>entity_1_value_placeholder</valuePlaceholder>
    </entity>
</entities>

Explanation of Configuration Elements​

  • <entities>: This is the parent or wrapper element that holds the configuration of all entities.

  • <entity>: Each <entity> element contains the configuration settings for an individual Entity.

Attributes:​
  • id: This attribute assigns a unique identifier to the Entity. The ID must match the one configured in the associated Table Column. This is a mandatory attribute.
Elements:​
  • <name>: Defines the entity identifier. This field is required.
  • <type>: Specifies the type of content the entity holds. The possible values are:
    • TEXT
    • KEY_VALUE
    • MEDIA_ASSET
    • PRICE
    • LINK
    • CONTENT_METADATA
  • <valuePlaceholder>: Specifies the placeholder for the entity value. It supports language-dependent. For example: "The value of the entity is {{value}}." This element is required for correctly categorizing the entity's content.