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
"2.0.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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{CD38D346-B654-42EF-B5A6-16F1BDF2D781}"
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
"Sustainability"
string
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Party Water Quality
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.
The unique identifier of a Party.
First included in: Sustainability/esg-data-model/PartyWaterQuality (this entity)
Properties
Name
Value
displayName
Party ID
description
The unique identifier of a Party.
isPrimaryKey
true
dataFormat
int64
Traits
List of traits for the PartyId 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 attributes 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
Party 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 Party.
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{DD14E2AB-EFCC-494E-8046-CAC104FA8F5F}"
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.
is.linkedEntity.identifier
Marks the attributes 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
Water Utilization Type 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 Water Utilization Type.
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{ED33B025-5BDE-43BE-BD8E-B6AF0457D3D4}"
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.linkedEntity.identifier
Marks the attributes 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
Water Source Type 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 water source type.
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{7BC54975-239E-4ECD-8FF3-83404A7637F4}"
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.linkedEntity.identifier
Marks the attributes 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
Water Type 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 water type.
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{47E748BB-C42A-4B60-B528-E076CE0A60D6}"
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.linkedEntity.identifier
Marks the attributes 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
Sample Test Type 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 sample test type.
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{62BB2EB5-F5A4-4310-9DC6-9B92240EFDB4}"
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.linkedEntity.identifier
Marks the attributes 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
Metric Purpose 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 Metric Purpose.
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{085CBEFB-B76A-49A1-89A7-64B43B25B6C2}"
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.linkedEntity.identifier
Marks the attributes 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
Calculation Algorithm 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 calculation algorithm.
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{3FFF01F1-FEBE-4A54-8F61-BF4237AD8C45}"
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.
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.
Parameter
Value
Data type
Explanation
identifier
"{72689B80-122B-4BF3-8812-CF7F8E69CA7C}"
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
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 period start date.
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{038DEE73-E33A-4EDC-8695-40684CF7246D}"
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
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 period end date.
entity
a reference to the constant entity holding the list of localized text
The average value associated with the test type.
First included in: Sustainability/esg-data-model/PartyWaterQuality (this entity)
Properties
Name
Value
displayName
Test Type Average Value
description
The average value associated with the test type.
dataFormat
decimal
isNullable
true
Traits
List of traits for the TestTypeAverageValue attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter
Value
Data type
Explanation
precision
"22"
integer
the total number of significant digits
scale
"10"
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{F2BCE283-50C7-49F7-8603-97F38996F0CB}"
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
Test Type Average Value
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 average value associated with the test type.
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 minimum value associated with the test type.
First included in: Sustainability/esg-data-model/PartyWaterQuality (this entity)
Properties
Name
Value
displayName
Test Type Minimum Value
description
The minimum value associated with the test type.
dataFormat
decimal
isNullable
true
Traits
List of traits for the TestTypeMinimumValue attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter
Value
Data type
Explanation
precision
"22"
integer
the total number of significant digits
scale
"10"
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{A80602CE-4DA0-45A8-9349-18F34DF2074B}"
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
Test Type Minimum Value
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 minimum value associated with the test type.
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 maximum value associated with the test type.
First included in: Sustainability/esg-data-model/PartyWaterQuality (this entity)
Properties
Name
Value
displayName
Test Type Maximum Value
description
The maximum value associated with the test type.
dataFormat
decimal
isNullable
true
Traits
List of traits for the TestTypeMaximumValue attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter
Value
Data type
Explanation
precision
"22"
integer
the total number of significant digits
scale
"10"
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{370DD404-65DA-4DEA-9662-69373180E8E4}"
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
Test Type Maximum Value
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 maximum value associated with the test type.
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: Sustainability/esg-data-model/PartyWaterQuality (this entity)
Properties
Name
Value
displayName
Test Type Unit Of Measure ID
description
The unique identifier of a Unit Of Measure.
dataFormat
int32
isNullable
true
Traits
List of traits for the TestTypeUnitOfMeasureId 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
Test Type 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 attributes 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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{DA7E8B7C-8F8F-4A27-8099-7ECBC1CA20C9}"
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.
The number of sample tests that are included in this quality metric.
First included in: Sustainability/esg-data-model/PartyWaterQuality (this entity)
Properties
Name
Value
displayName
Number Of Sample Tests
description
The number of sample tests that are included in this quality metric.
dataFormat
int32
isNullable
true
Traits
List of traits for the NumberOfSampleTests 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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{E224754B-196E-46DF-A17F-53D079303AA5}"
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
Number Of Sample Tests
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 number of sample tests that are included in this quality metric.
entity
a reference to the constant entity holding the list of localized text
The percentage of the total water included in this quality metric that were sampled.
First included in: Sustainability/esg-data-model/PartyWaterQuality (this entity)
Properties
Name
Value
displayName
Water Sampled Percentage
description
The percentage of the total water included in this quality metric that were sampled.
dataFormat
decimal
isNullable
true
Traits
List of traits for the WaterSampledPercentage attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter
Value
Data type
Explanation
precision
"22"
integer
the total number of significant digits
scale
"10"
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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{BAECA28B-9029-4F67-80F8-C013B05B235E}"
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
Water Sampled Percentage
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 percentage of the total water included in this quality metric that were sampled.
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
A note, comment, or more information regarding the Party Water Quality.
First included in: Sustainability/esg-data-model/PartyWaterQuality (this entity)
Properties
Name
Value
displayName
Party Water Quality Note
description
A note, comment, or more information regarding the Party Water Quality.
dataFormat
string
maximumLength
2048
isNullable
true
Traits
List of traits for the PartyWaterQualityNote 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, and 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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{D301CDAE-F774-4366-8AB9-5483A796BA6E}"
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
Party Water Quality 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 more information regarding the Party Water Quality.
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, and Array of Byte is a Binary Object.