Hydrologic Formation Water Use 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	languageTag displayText en Base entity from which all Industry Data Model entities are derived. en The water use associated with the hydrologic formation during the associated period.	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	HydrologicFormationWaterUse/(resolvedAttributes)/PeriodStartTimestamp	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	"{C4B6058C-F043-48DE-A30C-D1F7B02E4BCE}"	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	"Water Management"	string

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Hydrologic Formation Water Use	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
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

Name	Value
displayName	Hydrologic Formation ID
description	The unique identifier of a Hydrologic Formation.
isPrimaryKey	true
dataFormat	int64

Traits

List of traits for the HydrologicFormationId 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.

Parameter	Value	Data type	Explanation
attribute	HydrologicFormationWaterUse/(resolvedAttributes)/HydrologicFormationId	attribute

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	entityReference attributeReference HydrologicFormation.cdm.json/HydrologicFormation HydrologicFormationId	entity	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 Hydrologic Formation 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 Hydrologic Formation.	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	"{F7657B2E-C79D-4287-B8CD-A58A9794F228}"	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.

PeriodStartTimestamp

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

Properties

Name	Value
displayName	Period Start Timestamp
description	The period start timestamp.
isPrimaryKey	true
dataFormat	dateTime

Traits

List of traits for the PeriodStartTimestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.identifiedBy
Names a specific identity attribute to use with an entity.

Parameter	Value	Data type	Explanation
attribute	HydrologicFormationWaterUse/(resolvedAttributes)/PeriodStartTimestamp	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	"{113E71CF-1228-4E12-999C-545D85986AC1}"	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 Timestamp	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 timestamp.	entity	a 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

Name	Value
displayName	Water Use Type ID
description	The unique identifier of a water use type.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the WaterUseTypeId 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	HydrologicFormationWaterUse/(resolvedAttributes)/WaterUseTypeId	attribute

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	entityReference attributeReference WaterUseType.cdm.json/WaterUseType WaterUseTypeId	entity	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 Use 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 use 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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{C04BBDB1-45B2-447E-B22C-42D8A3A9F441}"	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

PeriodEndTimestamp

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

Properties

Name	Value
displayName	Period End Timestamp
description	The period end timestamp.
dataFormat	dateTime
isNullable	true

Traits

List of traits for the PeriodEndTimestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
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	"{3EDA04DB-462E-4412-AE12-A8840E4BC6A3}"	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 Period End Timestamp	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 timestamp.	entity	a 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

Name	Value
displayName	Water Use Percentage
description	The percentage of water use.
dataFormat	decimal
isNullable	true

Traits

List of traits for the WaterUsePercentage 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	"8"	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	"{0B800ACE-4145-47C5-A59E-A1D5C8750241}"	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 Use 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 water use.	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

WaterUseQuantity

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

Properties

Name	Value
displayName	Water Use Quantity
description	The quantity of water use.
dataFormat	decimal
isNullable	true

Traits

List of traits for the WaterUseQuantity 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	"{5B2E49FD-9BA5-4EE3-BF8F-8EA078FC15DB}"	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 Use 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 water use.	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

WaterUseQuantityUomId

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

Properties

Name	Value
displayName	Water Use Quantity UOM ID
description	The unique identifier of a Unit Of Measure.
dataFormat	int32
isNullable	true

Traits

List of traits for the WaterUseQuantityUomId 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 Water Use Quantity UOM 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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference UnitOfMeasure.cdm.json/UnitOfMeasure UnitOfMeasureId	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	"{BBFE7DC1-9F65-41AA-857F-3643DE7B9826}"	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