TenantDynamicEntityTemplate

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 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 TenantDynamicEntityTemplate {
  id: String
  tenantId: String
  businessUnitGroupId: String
  correlationId: String
  status: DynamicEntityTemplateStatus!
  name: String
  description: String
  groupId: String
  baseTemplateId: String
  baseTemplateVersion: String
  parentId: String
  created: DateTime!
  createdBy: String
  modified: DateTime!
  modifiedBy: String
  entityProperties: [EntityAdditionalProperties]
  isHiiRetailServiceRequirement: Boolean!
  requiresItemCategory: Boolean!
  itemCategoryId: String
  revision: Long!
}

Fields

TenantDynamicEntityTemplate.id ● String scalar

The ID for the tenant template.

TenantDynamicEntityTemplate.tenantId ● String scalar

The ID of the tenant.

TenantDynamicEntityTemplate.businessUnitGroupId ● String scalar

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

TenantDynamicEntityTemplate.correlationId ● String scalar

ID for tracing an entity and/or a group of sub entities through the application.

TenantDynamicEntityTemplate.status ● DynamicEntityTemplateStatus! non-null enum

The status of the template.

TenantDynamicEntityTemplate.name ● String scalar

The name of the template.

TenantDynamicEntityTemplate.description ● String scalar

A description of the properties in this template and their intended use.

TenantDynamicEntityTemplate.groupId ● 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".

TenantDynamicEntityTemplate.baseTemplateId ● String scalar

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

TenantDynamicEntityTemplate.baseTemplateVersion ● String scalar

The version of the base template this template refers to.

TenantDynamicEntityTemplate.parentId ● String scalar

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

TenantDynamicEntityTemplate.created ● DateTime! non-null scalar

When the object was first created.

TenantDynamicEntityTemplate.createdBy ● String scalar

Who created the object.

TenantDynamicEntityTemplate.modified ● DateTime! non-null scalar

When the object was modified.

TenantDynamicEntityTemplate.modifiedBy ● String scalar

Who created or modified the object.

TenantDynamicEntityTemplate.entityProperties ● [EntityAdditionalProperties] list object

The list of additional properties per entity.

TenantDynamicEntityTemplate.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.

TenantDynamicEntityTemplate.requiresItemCategory ● Boolean! non-null scalar

If set to true the UI must FORCE the user to select an Item Category that this template applies to.

TenantDynamicEntityTemplate.itemCategoryId ● String scalar

The ID of the Item Category that this template applies to.

TenantDynamicEntityTemplate.revision ● Long! non-null scalar

The version of the template. Must be updated when there is a change to the entity. An ever-increasing Long.

Returned By

tenantDynamicEntityTemplate query

Member Of

TenantDynamicEntityTemplatesConnection object ● TenantDynamicEntityTemplatesEdge object