Material 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 | Material/(resolvedAttributes)/MaterialId | 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 | "{0D032BFB-FDB3-4F20-BD4C-64B6FBB8B9A6}" | 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 |
---|---|---|
MaterialId | The unique identifier of a material. | Material |
MaterialName | The name of a material. | Material |
MaterialDescription | The description of a material. | Material |
MaterialTypeId | The unique identifier of a material type. | Material |
CorrosiveQualityId | The unique identifier of a corrosive quality. | Material |
DiverseOriginMaterialIndicator | Indicates that the material is a diverse origin material.3.1.12diverse originrefers to materials that are not isolated together or the result of the same synthetic processEXAMPLE Material derived from the root and flower of the same plant would be defined as two substances since are not physically connected. Material isolated from the stem and leaf of plant which are physically connected would be a single substance.NOTE Basis upon which a material is defined as a single substance or as multiple substances. Material isolated from non-contiguous part of a biological matrix would be defined as separate substances. | Material |
MultiSubstanceMaterialIndicator | 3.52multi-substance materialsingle substances or specified substances of diverse origin that are brought together and do not undergo a chemical transformationEXAMPLE Materials such as human insulin isophane, simethicone, aluminum lakes, nicotine polacrilex, and phosphate buffered saline are all multi-substance ingredients.Note 1 to entry: Each substance part of the multi-substance material is a parent substance of the multi-substance material and should be registered first. The multi-substance material is captured at the Specified Substance Group 1 information level. | Material |
MaterialNote | A note, comment or additional information regarding the material. | Material |
MaterialId
The unique identifier of a material.
First included in: Material (this entity)
Properties
Name | Value |
---|---|
displayName | Material ID |
description | The unique identifier of a material. |
isPrimaryKey | true |
dataFormat | int32 |
Traits
List of traits for the MaterialId attribute are listed here.
is.dataFormat.integer
is.identifiedBy
Names a specific identity attribute to use with an entity.
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | Material/(resolvedAttributes)/MaterialId | 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 | "{49CBDD23-6325-4B35-B0C4-353CDC732DE5}" | 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.integer
MaterialName
The name of a material.
First included in: Material (this entity)
Properties
Name | Value |
---|---|
displayName | Material Name |
description | The name of a material. |
dataFormat | string |
maximumLength | 256 |
isNullable | true |
Traits
List of traits for the MaterialName 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 | "{0DC4F7B0-8FCC-4DE7-B14F-74BE27239A7D}" | 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.
MaterialDescription
The description of a material.
First included in: Material (this entity)
Properties
Name | Value |
---|---|
displayName | Material Description |
description | The description of a material. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the MaterialDescription 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 | "{28E0DC82-FD38-40C8-8183-877B9460B9D1}" | 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.
MaterialTypeId
The unique identifier of a material type.
First included in: Material (this entity)
Properties
Name | Value |
---|---|
displayName | Material Type ID |
description | The unique identifier of a material type. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the MaterialTypeId 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 |
| 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.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 |
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 | "{04B43402-E086-4BE7-AD85-D734C4848B87}" | 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
CorrosiveQualityId
The unique identifier of a corrosive quality.
First included in: Material (this entity)
Properties
Name | Value |
---|---|
displayName | Corrosive Quality ID |
description | The unique identifier of a corrosive quality. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the CorrosiveQualityId 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 | "{09DB8C3B-1BE6-4E8F-A40F-16C164B4F329}" | 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.integer
DiverseOriginMaterialIndicator
Indicates that the material is a diverse origin material.
3.1.12
diverse origin
refers to materials that are not isolated together or the result of the same synthetic process
EXAMPLE Material derived from the root and flower of the same plant would be defined as two substances since are not physically connected. Material isolated from the stem and leaf of plant which are physically connected would be a single substance.
NOTE Basis upon which a material is defined as a single substance or as multiple substances. Material isolated from non-contiguous part of a biological matrix would be defined as separate substances.
First included in: Material (this entity)
Properties
Name | Value |
---|---|
displayName | Diverse Origin Material Indicator |
description | Indicates that the material is a diverse origin material.
3.1.12 diverse origin refers to materials that are not isolated together or the result of the same synthetic process EXAMPLE Material derived from the root and flower of the same plant would be defined as two substances since are not physically connected. Material isolated from the stem and leaf of plant which are physically connected would be a single substance. NOTE Basis upon which a material is defined as a single substance or as multiple substances. Material isolated from non-contiguous part of a biological matrix would be defined as separate substances. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the DiverseOriginMaterialIndicator 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 | "{040160C7-F9A9-4711-95C4-0A3BB45AF7D7}" | 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.boolean
MultiSubstanceMaterialIndicator
3.52
multi-substance material single substances or specified substances of diverse origin that are brought together and do not undergo a chemical transformation
EXAMPLE Materials such as human insulin isophane, simethicone, aluminum lakes, nicotine polacrilex, and phosphate buffered saline are all multi-substance ingredients
.
Note 1 to entry: Each substance part of the multi-substance material is a parent substance of the multi-substance material and should be registered first. The multi-substance material is captured at the Specified Substance Group 1 information level.
First included in: Material (this entity)
Properties
Name | Value |
---|---|
displayName | Multi-Substance Material Indicator |
description | 3.52
multi-substance material single substances or specified substances of diverse origin that are brought together and do not undergo a chemical transformation EXAMPLE Materials such as human insulin isophane, simethicone, aluminum lakes, nicotine polacrilex, and phosphate buffered saline are all multi-substance ingredients . Note 1 to entry: Each substance part of the multi-substance material is a parent substance of the multi-substance material and should be registered first. The multi-substance material is captured at the Specified Substance Group 1 information level. |
dataFormat | boolean |
isNullable | true |
Traits
List of traits for the MultiSubstanceMaterialIndicator 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 | "{3C60BDA5-4CE9-4687-B3EF-25A88A5E0C85}" | 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.boolean
MaterialNote
A note, comment or additional information regarding the material.
First included in: Material (this entity)
Properties
Name | Value |
---|---|
displayName | Material Note |
description | A note, comment or additional information regarding the material. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the MaterialNote 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 | "{330DCFE2-0D24-4269-AB9F-600DDD4CA59D}" | 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.