Hydrologic Formation Water Use in ESG data model

The water use associated with the hydrologic formation during the associated period.

Traits

This entity has the following traits:

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

ParameterValueData typeExplanation
attributeHydrologicFormationWaterUse/(resolvedAttributes)/PeriodStartTimestampattribute

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.4.0"string

is.nativeTo.businessArea
The name of the business area from which the entity originates.

ParameterValueData typeExplanation
name"Hydro Power Generation"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enHydrologic Formation Water Use
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 water use associated with the hydrologic formation during the associated period.
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 re-states 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
HydrologicFormationId The unique identifier of a Hydrologic Formation. HydrologicFormationWaterUse
PeriodStartTimestamp The period start timestamp. HydrologicFormationWaterUse
WaterUseTypeId The unique identifier of a water use type. HydrologicFormationWaterUse
PeriodEndTimestamp The period end timestamp. HydrologicFormationWaterUse
WaterUsePercentage The percentage of water use. HydrologicFormationWaterUse
WaterUseQuantity The quantity of water use. HydrologicFormationWaterUse
WaterUseQuantityUomId The unique identifier of a Unit Of Measure. HydrologicFormationWaterUse

HydrologicFormationId

The unique identifier of a Hydrologic Formation.
First included in: HydrologicFormationWaterUse (this entity)

Properties

NameValue
displayNameHydrologic Formation ID
descriptionThe unique identifier of a Hydrologic Formation.
isPrimaryKeytrue
dataFormatint64

Traits

The HydrologicFormationId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
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

ParameterValueData typeExplanation
attributeHydrologicFormationWaterUse/(resolvedAttributes)/HydrologicFormationIdattribute

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
HydrologicFormation.cdm.json/HydrologicFormationHydrologicFormationId
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
enHydrologic Formation 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 Hydrologic Formation.
entitya 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.

PeriodStartTimestamp

The period start timestamp.
First included in: HydrologicFormationWaterUse (this entity)

Properties

NameValue
displayNamePeriod Start Timestamp
descriptionThe period start timestamp.
isPrimaryKeytrue
dataFormatdateTime

Traits

The PeriodStartTimestamp attribute has the following traits:

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
attributeHydrologicFormationWaterUse/(resolvedAttributes)/PeriodStartTimestampattribute

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPeriod Start Timestamp
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 period start timestamp.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

WaterUseTypeId

The unique identifier of a water use type.
First included in: HydrologicFormationWaterUse (this entity)

Properties

NameValue
displayNameWater Use Type ID
descriptionThe unique identifier of a water use type.
isPrimaryKeytrue
dataFormatint32

Traits

The WaterUseTypeId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeHydrologicFormationWaterUse/(resolvedAttributes)/WaterUseTypeIdattribute

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
WaterUseType.cdm.json/WaterUseTypeWaterUseTypeId
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
enWater Use Type 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 water use type.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

PeriodEndTimestamp

The period end timestamp.
First included in: HydrologicFormationWaterUse (this entity)

Properties

NameValue
displayNamePeriod End Timestamp
descriptionThe period end timestamp.
dataFormatdateTime
isNullabletrue

Traits

The PeriodEndTimestamp attribute has the following traits:

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.nullable
The attribute value may be set to NULL.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPeriod End Timestamp
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 period end timestamp.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

WaterUsePercentage

The percentage of water use.
First included in: HydrologicFormationWaterUse (this entity)

Properties

NameValue
displayNameWater Use Percentage
descriptionThe percentage of water use.
dataFormatdecimal
isNullabletrue

Traits

The WaterUsePercentage attribute has the following traits:

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"8"integerthe number of digits to the right of the decimal place

is.nullable
The attribute value may be set to NULL.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater Use Percentage
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 percentage of water use.
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

WaterUseQuantity

The quantity of water use.
First included in: HydrologicFormationWaterUse (this entity)

Properties

NameValue
displayNameWater Use Quantity
descriptionThe quantity of water use.
dataFormatdecimal
isNullabletrue

Traits

The WaterUseQuantity attribute has the following traits:

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

is.nullable
The attribute value may be set to NULL.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater Use 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 quantity of water use.
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

WaterUseQuantityUomId

The unique identifier of a Unit Of Measure.
First included in: HydrologicFormationWaterUse (this entity)

Properties

NameValue
displayNameWater Use Quantity UOM ID
descriptionThe unique identifier of a Unit Of Measure.
dataFormatint32
isNullabletrue

Traits

The WaterUseQuantityUomId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.nullable
The attribute value may be set to NULL.

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater Use Quantity UOM 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 Unit Of Measure.
entitya 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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
UnitOfMeasure.cdm.json/UnitOfMeasureUnitOfMeasureId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.integer