Entity Columns

Introduction

• A Entity Column is a configurable unit used to define the list of columns we want to show in certain wizard steps, specifically those of the PLANNING_TREE or PRODUCTS_ASSIGNMENT type.
• The columns have two types: static and metadata, displayed as separate tabs.

  • static: These represent the static properties of the table/tree item (document/planning/product). Currently, we support the following:

    • For planning step:
      • label: Label of the item.
      • printTemplateId: Template of the item.
      • pageTemplateId: Page template of the item.
      • identifier: Identifier of the item.
      • bucketId: Identifier of the planning bucket (supports only for planning items).
      • entityBucketLabel: Entity label of the planning bucket (supports only for planning items).
      • entityBucketId: Entity identifier of the planning bucket (supports only for planning items).
      • createdOn: Creation time of the item.
      • createdBy: User who created the item.
      • updatedOn: Last modification time the item.
      • updatedBy: Last user to modify the item.
    • For product assignment step:
      • assortmentName: Assortment name of the context.
      • country: Country from the context.
      • language: Language from the context.
      • well: Well from the context.
      • seq: Sequence of the item.
      • label: Label of the item.
      • id: Identifier of the item.
      • entityId: Entity identifier of the item.
      • entityLabel: Entity label of the item.
      • pageTemplateId: Page template of the item.
      • groupIdentifier: Group identifier of the item.
      • template: Template of the item.
      • previewImage: Preview image of the item.
      • createdOn: Creation time of the item.
      • createdBy: User who created the item.
      • updatedOn: Last modification time the item.
      • updatedBy: Last user to modify the item.

  • metadata: The content metadata we want to show as columns, mapped by a key.

• Supported column options:
  • required: Specifies whether the column is mandatory. Required columns cannot be hidden from the user.
  • needAsDefault: Specifies whether the column should be shown by default.

Configuration

ISON Configuration Details

Sample

<entityColumns>
  <entityColumn type="static" id="planning_static_columns">
    <columns>
      <column>
        <key>label</key>
        <required>true</required>
        <needAsDefault>true</needAsDefault>
      </column>
      <column>
        <key>identifier</key>
        <required>false</required>
        <needAsDefault>true</needAsDefault>
      </column>
      <column>
        <key>createdOn</key>
        <required>false</required>
        <needAsDefault>false</needAsDefault>
      </column>
      <column>
        <key>createdBy</key>
        <required>false</required>
        <needAsDefault>false</needAsDefault>
      </column>
      <column>
        <key>updatedOn</key>
        <required>false</required>
        <needAsDefault>false</needAsDefault>
      </column>
      <column>
        <key>updatedBy</key>
        <required>false</required>
        <needAsDefault>false</needAsDefault>
      </column>
    </columns>
  </entityColumn>
  <entityColumn type="metadata" id="planning_metadata_columns">
    <columns>
      <column>
        <key>content_metadata_key_1</key>
        <required>1</required>
        <needAsDefault>1</needAsDefault>
      </column>
    </columns>
  </entityColumn>
</entityColumns>

Explanation

• <entityColumns>: Wrapper element for Entity Column configuration.
  • <entityColumn>: The configurations for an individual entity column.
    • Attributes:
      • id: The unique ID of the Entity Column configuration. This attribute is required.
      • type: The type of Entity Column. Available option: static and metdata. This attribute is required.
  • Elements:
    • <columns>: Wrapper element for the list of columns.
      • <column>: Configuration for a specific column.
        • Elements:
          • <key>: Key of the column.
          • <required>: Enable/disable required feature. Default value is false if not configured.
          • <needAsDefault>: Enable/disable needAsDefault feature. Default value is false if not configured.