Compartir a través de


Warehouse Item Balance 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

ParameterValueData typeExplanation
versionNumber"4.3"stringsemantic version number of the entity

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBase entity from which all Industry Data Model entities are derived.
enThe on-hand balance for the associated timestamp.

The quantity of an item shown in the inventory records as being physically in stock.

The unit of measure for the Item Balance is represented by ITEM.Standard Quantity Unit Of Measure ID.

entitya reference to the constant entity holding the list of localized text

is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeWarehouseItemBalance/(resolvedAttributes)/Timestampattribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

ParameterValueData typeExplanation
versionNumber"1.2.3"string

is.IDM.modelVersion
Semantic version number of the IDM.

ParameterValueData typeExplanation
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.

ParameterValueData typeExplanation
identifier"{499BBE12-2284-4E3E-AE30-EB72115DF57A}"stringThe 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.

ParameterValueData typeExplanation
name"Inventory"string

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWarehouse Item Balance
entitya 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.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
WarehouseId The unique identifier of a Warehouse. WarehouseItemBalance
ItemSku The Stock Keeping Unit identifier, which is typically used for inventory-related activities. WarehouseItemBalance
Timestamp The timestamp that the associated information is reported, recorded or effective as-of. WarehouseItemBalance
PlannedItemQuantity The planned Item on-hand balance for the associated period. WarehouseItemBalance
ActualItemQuantity The actual Item on-hand balance for the associated period. WarehouseItemBalance

WarehouseId

The unique identifier of a Warehouse.
First included in: WarehouseItemBalance (this entity)

Properties

NameValue
displayNameWarehouse ID
descriptionThe unique identifier of a Warehouse.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the WarehouseId attribute are listed here.

is.dataFormat.integer
is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeWarehouseItemBalance/(resolvedAttributes)/WarehouseIdattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
Warehouse.cdm.json/WarehouseWarehouseId
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWarehouse ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Warehouse.
entitya reference to the constant entity holding the list of localized text

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.

ParameterValueData typeExplanation
identifier"{A1C15724-45C5-40BB-AF8C-12A48C47C06A}"stringThe 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.integer

ItemSku

The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
First included in: WarehouseItemBalance (this entity)

Properties

NameValue
displayNameItem SKU
descriptionThe Stock Keeping Unit identifier, which is typically used for inventory-related activities.
isPrimaryKeytrue
dataFormatstring
maximumLength40

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.

ParameterValueData typeExplanation
attributeWarehouseItemBalance/(resolvedAttributes)/ItemSkuattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
Item.cdm.json/ItemItemSku
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enItem SKU
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe Stock Keeping Unit identifier, which is typically used for inventory-related activities.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
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.

ParameterValueData typeExplanation
identifier"{365DBAE7-BFFE-4B6C-9D98-ABC64DB8C870}"stringThe 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.

Timestamp

The timestamp that the associated information is reported, recorded or effective as-of.
First included in: WarehouseItemBalance (this entity)

Properties

NameValue
displayNameTimestamp
descriptionThe timestamp that the associated information is reported, recorded or effective as-of.
isPrimaryKeytrue
dataFormatdateTime

Traits

List of traits for the Timestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeWarehouseItemBalance/(resolvedAttributes)/Timestampattribute

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.

ParameterValueData typeExplanation
identifier"{C114A365-903B-4DF5-B39B-4A89E13E0E86}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTimestamp
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe timestamp that the associated information is reported, recorded or effective as-of.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

PlannedItemQuantity

The planned Item on-hand balance for the associated period.
First included in: WarehouseItemBalance (this entity)

Properties

NameValue
displayNamePlanned Item Quantity
descriptionThe planned Item on-hand balance for the associated period.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the PlannedItemQuantity attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe number of digits to the right of the decimal place

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.

ParameterValueData typeExplanation
identifier"{9503B085-EA09-4DE6-9BED-BCA05087073E}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPlanned Item Quantity
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe planned Item on-hand balance for the associated period.
entitya 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

ActualItemQuantity

The actual Item on-hand balance for the associated period.
First included in: WarehouseItemBalance (this entity)

Properties

NameValue
displayNameActual Item Quantity
descriptionThe actual Item on-hand balance for the associated period.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the ActualItemQuantity attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"2"integerthe number of digits to the right of the decimal place

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.

ParameterValueData typeExplanation
identifier"{249BDEDE-7964-4BB4-A388-5DFF7B4A997D}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActual Item Quantity
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe actual Item on-hand balance for the associated period.
entitya 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