Item Gtin in ESG data model
Base entity from which all Industry Data Model entities are derived.
Traits
Traits for this entity are listed here.
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "4.3" | string | semantic version number of the entity |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||||
|---|---|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.identifiedBy
Names a specific identity attribute to use with an entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | ItemGtin/(resolvedAttributes)/GlobalTradeItemNumber | attribute |
minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.2.3" | string |
is.IDM.modelVersion
Semantic version number of the IDM.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.6.0" | string |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{9FE4C1DF-4D53-4978-90F8-5EEE7C7CB220}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nativeTo.businessArea
The name of the business area from which the entity originates.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "Inventory" | string |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "resolved" | string | Possible values: logical, composition, resolved |
Attributes
| Name | Description | First Included in Instance |
|---|---|---|
| ItemSku | The Stock Keeping Unit identifier, which is typically used for inventory-related activities. | ItemGtin |
| GlobalTradeItemNumber | The Global Trade Item Number (GTIN) is an identifier for trade items that was developed by GS1.A GTIN can be assigned to only one brick. | ItemGtin |
| ItemGtinPeriodStartDate | The period start date for which the associated Item GTIN is valid. | ItemGtin |
| ItemGtinPeriodEndDate | The period end date for which the associated Item GTIN is valid. | ItemGtin |
| ItemGtinName | A note, comment or additional information regarding the Item GTIN. | ItemGtin |
| ItemGtinNote | A note, comment or additional information regarding the Item GTIN. | ItemGtin |
ItemSku
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
First included in: ItemGtin (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Item SKU |
| description | The Stock Keeping Unit identifier, which is typically used for inventory-related activities. |
| isPrimaryKey | true |
| dataFormat | string |
| maximumLength | 40 |
Traits
List of traits for the ItemSku attribute are listed here.
is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
is.identifiedBy
Names a specific identity attribute to use with an entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | ItemGtin/(resolvedAttributes)/ItemSku | attribute |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "40" | integer |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{B4EAC2FB-DADF-43B9-A496-53AA84105118}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
GlobalTradeItemNumber
The Global Trade Item Number (GTIN) is an identifier for trade items that was developed by GS1.
A GTIN can be assigned to only one brick.
First included in: ItemGtin (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Global Trade Item Number (GTIN) |
| description | The Global Trade Item Number (GTIN) is an identifier for trade items that was developed by GS1.
A GTIN can be assigned to only one brick. |
| isPrimaryKey | true |
| dataFormat | decimal |
Traits
List of traits for the GlobalTradeItemNumber attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "14" | integer | the total number of significant digits |
| scale | "0" | integer | the number of digits to the right of the decimal place |
is.identifiedBy
Names a specific identity attribute to use with an entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | ItemGtin/(resolvedAttributes)/GlobalTradeItemNumber | attribute |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{B8732E17-9C7A-4C01-864B-E0D122B8D5CB}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
ItemGtinPeriodStartDate
The period start date for which the associated Item GTIN is valid.
First included in: ItemGtin (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Item GTIN Period Start Date |
| description | The period start date for which the associated Item GTIN is valid. |
| isPrimaryKey | true |
| dataFormat | date |
Traits
List of traits for the ItemGtinPeriodStartDate attribute are listed here.
is.dataFormat.date
means.measurement.date
is.identifiedBy
Names a specific identity attribute to use with an entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | ItemGtin/(resolvedAttributes)/ItemGtinPeriodStartDate | attribute |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{DA0452A3-0ECA-453D-A86C-06F1840161CC}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.date
ItemGtinPeriodEndDate
The period end date for which the associated Item GTIN is valid.
First included in: ItemGtin (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Item GTIN Period End Date |
| description | The period end date for which the associated Item GTIN is valid. |
| dataFormat | date |
| isNullable | true |
Traits
List of traits for the ItemGtinPeriodEndDate attribute are listed here.
is.dataFormat.date
means.measurement.date
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{7703BBD4-DCEB-4AF5-AE50-8B8FB7E4BC3E}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.date
ItemGtinName
A note, comment or additional information regarding the Item GTIN.
First included in: ItemGtin (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Item GTIN Name |
| description | A note, comment or additional information regarding the Item GTIN. |
| dataFormat | string |
| maximumLength | 256 |
| isNullable | true |
Traits
List of traits for the ItemGtinName attribute are listed here.
is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{5B4CCAEA-88EE-4570-9270-05B40D5D4968}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "256" | integer |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
ItemGtinNote
A note, comment or additional information regarding the Item GTIN.
First included in: ItemGtin (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Item GTIN Note |
| description | A note, comment or additional information regarding the Item GTIN. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
Traits
List of traits for the ItemGtinNote attribute are listed here.
is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{553B1212-3834-4881-B044-52EAC9E84C60}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2048" | integer |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.