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
languageTag
displayText
en
Base entity from which all Industry Data Model entities are derived.
en
The BOM lists the items (materials) that are part of the item. BOMs are used to describe the structure of items from an engineering and production perspective. The most common approach to do so is to use the concept of "single level" bills of material. With this approach, the BOM for an item includes only the direct components (items) for that product. However, a component item might also have lower-level components, expressed through a single level bill of material for the component itself. This approach is very powerful, allowing the structure of extremely complex items to be expressed through a nested structure of as many single level BOMs as is necessary. The BOM is expressed through the Item Bill of Material that contains attributes pertinent to the general structure, combined with this Item Bill of Material Line. Each Item Bill of Material Line describes a component item that is part of the structure.
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.
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
"{5DB599D3-2252-45DF-AC47-15F8E4ED72B1}"
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
languageTag
displayText
en
Item Bill Of Material Line
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.
A specific item may have alternate bills of material. The Item Bill of Material ID identifies a specific bill of material within the context of a specific Item (SKU).
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
First included in: ItemBillOfMaterialLine (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.
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.
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
languageTag
displayText
en
Item SKU
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
languageTag
displayText
en
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
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
"{F789271A-2A45-40B1-96CD-49FCF9D81802}"
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.
A specific item may have alternate bills of material. The Item Bill of Material ID identifies a specific bill of material within the context of a specific Item (SKU).
First included in: ItemBillOfMaterialLine (this entity)
Properties
Name
Value
displayName
Item Bill of Material ID
description
A specific item may have alternate bills of material. The Item Bill of Material ID identifies a specific bill of material within the context of a specific Item (SKU).
isPrimaryKey
true
dataFormat
int64
Traits
List of traits for the ItemBillOfMaterialId attribute are listed here.
is.dataFormat.integer 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.identifiedBy
Names a specific identity attribute to use with an entity.
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.
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
languageTag
displayText
en
Item Bill of Material ID
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
languageTag
displayText
en
A specific item may have alternate bills of material. The Item Bill of Material ID identifies a specific bill of material within the context of a specific Item (SKU).
entity
a 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.
Parameter
Value
Data type
Explanation
identifier
"{B36ACB39-0686-4A59-842B-1B784A5FCEF7}"
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.integer 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.
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
First included in: ItemBillOfMaterialLine (this entity)
Properties
Name
Value
displayName
Component 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 ComponentItemSku 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.
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.
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
languageTag
displayText
en
Component Item SKU
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
languageTag
displayText
en
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
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
"{905B14E3-4AF5-4D86-87E3-440B5A78C93B}"
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.
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
"{835B6543-33EA-49FC-9992-02C6E41E622B}"
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
languageTag
displayText
en
Component Item Period Start Date
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
languageTag
displayText
en
The start date of this component being used in the bill of material.
entity
a reference to the constant entity holding the list of localized text
The Bill Of Material installation sequence of the associated Item.
First included in: ItemBillOfMaterialLine (this entity)
Properties
Name
Value
displayName
Item Installation Sequence
description
The Bill Of Material installation sequence of the associated Item.
dataFormat
int32
isNullable
true
Traits
List of traits for the ItemInstallationSequence attribute are listed here.
is.dataFormat.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
"{ADD2CF0B-1C39-4B2B-9D62-07B31BDCCBEA}"
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
languageTag
displayText
en
Item Installation Sequence
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
languageTag
displayText
en
The Bill Of Material installation sequence of the associated Item.
entity
a reference to the constant entity holding the list of localized text
The end date of this component being used in the bill of material.
First included in: ItemBillOfMaterialLine (this entity)
Properties
Name
Value
displayName
Component Item Period End Date
description
The end date of this component being used in the bill of material.
dataFormat
date
isNullable
true
Traits
List of traits for the ComponentItemPeriodEndDate 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
"{4AC0E7B5-EC30-433B-A8BA-0A0E61BB6467}"
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
languageTag
displayText
en
Component Item Period End Date
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
languageTag
displayText
en
The end date of this component being used in the bill of material.
entity
a reference to the constant entity holding the list of localized text
The quantity of Items associated with the BOM Level.
First included in: ItemBillOfMaterialLine (this entity)
Properties
Name
Value
displayName
BOM Quantity
description
The quantity of Items associated with the BOM Level.
dataFormat
decimal
isNullable
true
Traits
List of traits for the BomQuantity attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter
Value
Data type
Explanation
precision
"18"
integer
the total number of significant digits
scale
"2"
integer
the 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.
Parameter
Value
Data type
Explanation
identifier
"{92383C54-1529-4C7F-8658-C4EBC79B432B}"
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
languageTag
displayText
en
BOM Quantity
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
languageTag
displayText
en
The quantity of Items associated with the BOM Level.
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
The unique identifier of a Unit Of Measure.
First included in: ItemBillOfMaterialLine (this entity)
Properties
Name
Value
displayName
Unit Of Measure ID
description
The unique identifier of a Unit Of Measure.
dataFormat
int32
isNullable
true
Traits
List of traits for the UnitOfMeasureId attribute are listed here.
is.dataFormat.integer 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
languageTag
displayText
en
Unit Of Measure ID
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
languageTag
displayText
en
The unique identifier of a Unit Of Measure.
entity
a reference to the constant entity holding the list of localized text
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.
a reference to the constant entity holding the list of entity references
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
"{347F423A-F10B-464F-90F7-5F107714B677}"
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.
A note, comment or additional detail regarding the Product Bill of Material.
First included in: ItemBillOfMaterialLine (this entity)
Properties
Name
Value
displayName
Item Bill of Material Line Note
description
A note, comment or additional detail regarding the Product Bill of Material.
dataFormat
string
maximumLength
2048
isNullable
true
Traits
List of traits for the ItemBillOfMaterialLineNote 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
"{B4C7798A-CD49-4F2F-AD97-584EA1E9AB42}"
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
languageTag
displayText
en
Item Bill of Material Line Note
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
languageTag
displayText
en
A note, comment or additional detail regarding the Product Bill of Material.
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.