DynamicEntityTemplate

Dynamic Entity Template is a structure to facilitate the setup of entities to comply with the expectations of surrounding services and UIs.

It allows a tenant to define the mandatory and optional properties of an entity, which need to be presented to a user in a UI, for example.

The dynamic entity can exist as a BASE_TEMPLATE or a TENANT_TEMPLATE. A BASE_TEMPLATE is for Extenda Retail only, while a TENANT_TEMPLATE is a copy of the BASE_TEMPLATE that can be modified and saved as a tenant-specific version.

Some BASE_TEMPLATES contain properties that are not editable by the tenant because they reference internal Hii Retail requirements and cannot be modified. Others refer to domain areas or functionalities that the tenant has or wants to have, and are only best-practice recommendations from Extenda Retail. These can be modified and/or extended as required by the tenant.

type DynamicEntityTemplate {
  id: String
  correlationId: String
  tenantId: String
  businessUnitGroupId: String
  name: String
  description: String
  group: String
  baseTemplateId: String
  baseTemplateVersion: String
  parentId: String
  revision: Long!
  created: DateTime!
  createdBy: String
  modified: DateTime!
  modifiedBy: String
  status: DynamicEntityTemplateStatus!
  type: DynamicEntityTemplateType!
  version: String
  requiresItemCategory: Boolean!
  isHiiRetailServiceRequirement: Boolean!
  entityProperties: [EntityAdditionalProperties]
}

Fields

DynamicEntityTemplate.id ● String scalar

Id for the entity. Either external or internal.

DynamicEntityTemplate.correlationId ● String scalar

ID for tracing an entity through the system.

DynamicEntityTemplate.tenantId ● String scalar

The ID of the tenant/customer that owns this information.

DynamicEntityTemplate.businessUnitGroupId ● String scalar

The ID of the group in the Business Unit Group hierarchy where the template applies.

DynamicEntityTemplate.name ● String scalar

The name of the entity. This general property can replace the previous ArticleName, StoreName, CampaignName, etc.

DynamicEntityTemplate.description ● String scalar

The description of the entity.

DynamicEntityTemplate.group ● String scalar

Optional grouping for use in a frontend application. This property can be used to group templates that belong together under the same "tab".

DynamicEntityTemplate.baseTemplateId ● String scalar

Reference to the base template from which this template was copied.

DynamicEntityTemplate.baseTemplateVersion ● String scalar

The version of the base template this template refers to.

DynamicEntityTemplate.parentId ● String scalar

Reference to a parent template to build and maintain a hierarchical structure of templates.

DynamicEntityTemplate.revision ● Long! non-null scalar

Contains evergrowing number used to validate the version of an entity.

DynamicEntityTemplate.created ● DateTime! non-null scalar

When the object was first created.

DynamicEntityTemplate.createdBy ● String scalar

The ID of who created the object.

DynamicEntityTemplate.modified ● DateTime! non-null scalar

When the object was modified. Will be updated along with the Revision property.

DynamicEntityTemplate.modifiedBy ● String scalar

The ID of who created or modified the object.

DynamicEntityTemplate.status ● DynamicEntityTemplateStatus! non-null enum

The status of the template.

DynamicEntityTemplate.type ● DynamicEntityTemplateType! non-null enum

The type of the template.

DynamicEntityTemplate.version ● String scalar

The public version used in announcements and notifications about changes to BASE_TEMPLATE type templates.

DynamicEntityTemplate.requiresItemCategory ● Boolean! non-null scalar

Specifies if an Item Category should be used together with this template.

DynamicEntityTemplate.isHiiRetailServiceRequirement ● Boolean! non-null scalar

Specifies if these properties are required by an internal Hii Retail service or integration and cannot be modified by the tenant.

DynamicEntityTemplate.entityProperties ● [EntityAdditionalProperties] list object

List of additional properties per entity type.

Returned By

dynamicEntityTemplate query

Member Of

BaseDynamicEntityTemplatesConnection object ● BaseDynamicEntityTemplatesEdge object ● TenantDynamicEntityTemplatesConnection object ● TenantDynamicEntityTemplatesEdge object