Hydrologic Formation Metric Type in ESG data model

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 ESG Data Model entities are derived. en A type of hydrologic formation metric. Ex: Period Total Discharge Period Mean Discharge Highest Period Mean Lowest Period Mean Highest Daily Mean Lowest Daily Mean Maximum Peak Flow Period Runoff Net Water Demand Net Water Use Ground Water Specific Storage where: Period Total Discharge The sum of the daily mean values of discharge for the period. Period Mean Discharge The arithmetic mean for the individual daily mean discharges for the period noted or for the designated period. Highest Period Mean The maximum annual mean discharge occurring for the designated period. Lowest Period Mean The minimum annual mean discharge occurring for the designated period. Highest Daily Mean The maximum daily mean discharge for the year or for the designated period. Lowest Daily Mean The minimum daily mean discharge for the year or for the designated period. Maximum Peak Flow The maximum instantaneous peak discharge occurring for the designated period. Period Runoff The total quantity of water in runoff for a drainage area for the period. Net Water Demand The amount of water needed in an irrigation or water service area to meet all requirements. It's the sum of Evapotranspiration of Applied Water (ETAW) in an area, the Irrecoverable Losses from the distribution system, and the outflow leaving the irrigation area. It excludes, however, the water reused in the area. Sometimes used interchangeably with Net Water Use. Net Water Use Refers to water withdrawals plus or minus water transfers. In most areas, the net water use and water withdrawals are equal. However, in areas involved in water transfers (imports and exports), the net water use represents the actual amount of water used regardless of the amount of water actually withdrawn. Sometimes used interchangeably with Net Water Demand. Ground Water Specific Storage The amount of water released from or taken into storage per unit volume of a porous medium per unit change in head.	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	HydrologicFormationMetricType/(resolvedAttributes)/HydrologicFormationMetricTypeId	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	"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	"{302C1F74-FD9E-43CB-B234-9132929C3A41}"	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 Metric Type	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
HydrologicFormationMetricTypeId	The unique identifier of a hydrologic formation metric type.	Sustainability/esg-data-model/HydrologicFormationMetricType
HydrologicFormationMetricTypeName	The name of a hydrologic formation metric type.	Sustainability/esg-data-model/HydrologicFormationMetricType
HydrologicFormationMetricTypeDescription	The description of a hydrologic formation metric type.	Sustainability/esg-data-model/HydrologicFormationMetricType

HydrologicFormationMetricTypeId

The unique identifier of a hydrologic formation metric type. First included in: Sustainability/esg-data-model/HydrologicFormationMetricType (this entity)

Properties

Name	Value
displayName	Hydrologic Formation Metric Type ID
description	The unique identifier of a hydrologic formation metric type.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the HydrologicFormationMetricTypeId 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	HydrologicFormationMetricType/(resolvedAttributes)/HydrologicFormationMetricTypeId	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 more identification values.

Parameter	Value	Data type	Explanation
identifier	"{027BFA8A-2E72-41AE-8A04-F058CACFE7B1}"	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 Hydrologic Formation Metric 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 hydrologic formation metric type.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

HydrologicFormationMetricTypeName

The name of a hydrologic formation metric type. First included in: Sustainability/esg-data-model/HydrologicFormationMetricType (this entity)

Properties

Name	Value
displayName	Hydrologic Formation Metric Type Name
description	The name of a hydrologic formation metric type.
dataFormat	string
maximumLength	256
isNullable	true

Traits

List of traits for the HydrologicFormationMetricTypeName 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	"{FC375AFC-D7AF-4C66-902A-1C737E433635}"	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 Hydrologic Formation Metric Type Name	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 name of a hydrologic formation metric type.	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, and Array of Byte is a Binary Object.

HydrologicFormationMetricTypeDescription

The description of a hydrologic formation metric type. First included in: Sustainability/esg-data-model/HydrologicFormationMetricType (this entity)

Properties

Name	Value
displayName	Hydrologic Formation Metric Type Description
description	The description of a hydrologic formation metric type.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the HydrologicFormationMetricTypeDescription 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	"{9BAECDD5-05E2-42FA-8ED8-9CD9A2E6D26A}"	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 Hydrologic Formation Metric Type Description	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 description of a hydrologic formation metric type.	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.