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 Bill Of Material (BOM) used to create the item. The BOM lists the items (materials) that are part of the item. BOMs are used to describe the structure of products 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 for that item. 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 this Item Bill of Material that contains attributes pertinent to the general structure, combined with it's dependent entity called Item Bill of Material Line, which describes the component items that comprise 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
"{F7232F9A-5A65-4D6D-AD0C-32DBEB343FF4}"
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
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).
A Bill of Material might be valid for only a specific period of time. It could be superseded by a different bill of material. This is the start date for that period of time.
A Bill of Material might be valid for only a specific period of time. It could be superseded by a different bill of material. This is the end date for that period of time.
The Stock Keeping Unit identifier, which is typically used for inventory-related activities.
First included in: ItemBillOfMaterial (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
"{03481623-A4AB-4AD9-B177-085213D21AEA}"
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: ItemBillOfMaterial (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.
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
"{BCD82148-5A92-4C42-AA00-2E8C09959141}"
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
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
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.
Indicates whether the material is the primary bill of material.
First included in: ItemBillOfMaterial (this entity)
Properties
Name
Value
displayName
Primary Bill of Material Indicator
description
Indicates whether the material is the primary bill of material.
dataFormat
boolean
isNullable
true
Traits
List of traits for the PrimaryBillOfMaterialIndicator attribute are listed here.
is.dataFormat.boolean 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
"{6878200F-34DC-421F-92FB-7D9A62A0ED74}"
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
Primary Bill of Material Indicator
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
Indicates whether the material is the primary bill of material.
entity
a reference to the constant entity holding the list of localized text
The Bill of Material level for the associated Item/BOM components.
First included in: ItemBillOfMaterial (this entity)
Properties
Name
Value
displayName
BOM Level Number
description
The Bill of Material level for the associated Item/BOM components.
dataFormat
int32
Traits
List of traits for the BomLevelNumber 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
"{FB4934F0-4F51-4E9A-997C-80FD540C2661}"
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
BOM Level Number
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 level for the associated Item/BOM components.
entity
a reference to the constant entity holding the list of localized text
The Engineering Specification Number that addresses the associated BOM/Item Level.
First included in: ItemBillOfMaterial (this entity)
Properties
Name
Value
displayName
Engineering Specification Number
description
The Engineering Specification Number that addresses the associated BOM/Item Level.
dataFormat
int32
isNullable
true
Traits
List of traits for the EngineeringSpecificationNumber 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
"{B4317ED0-5A2C-4E8D-BD3D-02BE267BB8A3}"
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
Engineering Specification Number
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 Engineering Specification Number that addresses the associated BOM/Item Level.
entity
a reference to the constant entity holding the list of localized text
A Bill of Material might be valid for only a specific period of time. It could be superseded by a different bill of material. This is the start date for that period of time.
First included in: ItemBillOfMaterial (this entity)
Properties
Name
Value
displayName
Item Bill of Material Period Start Date
description
A Bill of Material might be valid for only a specific period of time. It could be superseded by a different bill of material. This is the start date for that period of time.
dataFormat
date
isNullable
true
Traits
List of traits for the ItemBillOfMaterialPeriodStartDate 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
"{521F9729-E9CB-439F-B046-D9AEC6F7C77E}"
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 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
A Bill of Material might be valid for only a specific period of time. It could be superseded by a different bill of material. This is the start date for that period of time.
entity
a reference to the constant entity holding the list of localized text
A Bill of Material might be valid for only a specific period of time. It could be superseded by a different bill of material. This is the end date for that period of time.
First included in: ItemBillOfMaterial (this entity)
Properties
Name
Value
displayName
Item Bill of Material Period End Date
description
A Bill of Material might be valid for only a specific period of time. It could be superseded by a different bill of material. This is the end date for that period of time.
dataFormat
date
isNullable
true
Traits
List of traits for the ItemBillOfMaterialPeriodEndDate 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
"{17C11FBA-D624-4303-B72C-5CB46C8857D2}"
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 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
A Bill of Material might be valid for only a specific period of time. It could be superseded by a different bill of material. This is the end date for that period of time.
entity
a reference to the constant entity holding the list of localized text
A note, comment or additional detail regarding the Item Bill of Material.
First included in: ItemBillOfMaterial (this entity)
Properties
Name
Value
displayName
Item Bill of Material Note
description
A note, comment or additional detail regarding the Item Bill of Material.
dataFormat
string
maximumLength
2048
isNullable
true
Traits
List of traits for the ItemBillOfMaterialNote 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
"{251267BB-4A30-450B-A2B3-D54D716D44A0}"
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 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 Item 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.