Entity Columns

Introduction

An Entity Column is a reusable configuration that defines which columns are available in wizard steps that display entities in a table or tree.

Currently, Entity Columns are supported by the following wizard steps:

• PLANNING_TREE
• PRODUCTS_ASSIGNMENT

An Entity Column configuration allows administrators to:

• Configure which columns are available.
• Define which columns are displayed by default.
• Prevent important columns from being hidden.
• Configure editable metadata columns (PLANNING_TREE step only).

Entity Columns are grouped into two categories:

• Static columns – Built-in properties of an entity.
• Metadata columns – Content metadata associated with an entity.

Supported Columns

Static Columns

Static columns represent built-in properties of an entity.

PLANNING_TREE step (Bucket)

Column	Description
label	Label of the item.
printTemplateId	Print template of the item.
pageTemplateId	Page template of the item.
identifier	Identifier of the item.
bucketId	Identifier of the planning bucket.
entityBucketLabel	Label of the planning bucket entity.
entityBucketId	Identifier of the planning bucket entity.
createdOn	Creation timestamp.
createdBy	User who created the item.
updatedOn	Last modification timestamp.
updatedBy	User who last modified the item.

PRODUCTS_ASSIGNMENT step (Planning)

Column	Description
assortmentName	Assortment name.
country	Country of the context.
language	Language of the context.
well	Well of the context.
seq	Sequence number.
label	Label of the entity.
id	Identifier of the tree node.
entityId	Identifier of the underlying entity.
entityLabel	Label of the underlying entity.
pageTemplateId	Page template.
groupIdentifier	Group identifier.
template	Template name.
previewImage	Preview image.
createdOn	Creation timestamp.
createdBy	User who created the entity.
updatedOn	Last modification timestamp.
updatedBy	User who last modified the entity.

Metadata Columns

Metadata columns display content metadata.

The available metadata depends on the wizard step.

Wizard Step	Metadata Source
PLANNING_TREE	Planning content metadata
PRODUCTS_ASSIGNMENT	Bucket content metadata

Each metadata column is identified by its entity ID.

In the PLANNING_TREE step a cmdKey can be configured to specify which metadata value should be displayed. If no cmdKey is configured, the first available content metadata value is used. In the PRODUCTS_ASSIGNMENT the first available content metadata value is used.

Viewing Options

Entity Columns support two viewing options.

Option	Description
required	The column is always displayed and cannot be hidden by the user.
needAsDefault	The column is displayed by default but the user may hide it later.

Editing Metadata

Editing is supported only for metadata columns in the PLANNING_TREE step.

The following options are available.

Option	Description
editable	Enables editing of the metadata value.
required	Requires a value before the user can save changes.
needAsDefault	The column is displayed by default but the user may hide it later.
cmdKey	Defines which metadata value is read and updated.
editableEntities	Restricts editing to specific bucket entities of planned content. Semicolon-separated.

ContentMetadata is not always relevant for every planning item, and the entity model has no way to limit it to a specific bucket. Use editableEntities to make this column's ContentMetadata editable only for the planned buckets you list. If editableEntities is not configured, editing is allowed for all planning items.

The editor is automatically selected based on the configured content metadata type (for example, text field, checkbox, or combobox). For the detail guideline for configuring the content metadata type, see How-To Configure Content Metadata Editor

Configuration

Sample Configuration

<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_1</key>
        <required>true</required>
        <needAsDefault>true</needAsDefault>
        <editable>true</editable>
        <cmdKey>cover</cmdKey>
        <editableEntities>bucket_entity_1;bucket_entity_2</editableEntities>
      </column>
    </columns>
  </entityColumn>
</entityColumns>

Configuration Elements

<entityColumns>

Root element for all Entity Column configurations.

<entityColumn>

Defines an individual Entity Column configuration.

Attributes

Attribute	Required	Description
id	Yes	Unique identifier of the Entity Column configuration.
type	Yes	Column type. Supported values: static, metadata.

<column>

Defines a single column.

Element	Required	Description
key	Yes	Column identifier. For metadata columns, this is the metadata entity ID.
required	No	Makes the column mandatory and prevents users from hiding it. Default: false.
needAsDefault	No	Displays the column by default. Default: false.
editable	No	Enables editing of the metadata value. Only supported for metadata columns. Only apply for PLANNING_TREE step.
cmdKey	No	Metadata key used for reading and writing values. Required when editing is enabled. Only apply for PLANNING_TREE step.
editableEntities	No	Semicolon-separated list of bucket entity IDs that are allowed to edit this metadata. If omitted, all planning items are editable. Only apply for PLANNING_TREE step.