Water Metric Type in ESG data model

The type of water metric being measured.

Example:

  • Total volume generated
  • Total volume treated
  • Total volume used
  • Average volume generated
  • Average volume treated
  • Average Volume used
  • Number of overflows
  • Total discharged via sewer overflow
  • Water savings from efficiency measures
  • Number of water disconnections
  • number of disconnections due to non-payment
  • Number of customers reconnecting water
  • Average water bill
  • Number of customers enrolled in CAP program
  • CAP program discounts
  • Total number of customers

Traits

This entity has the following traits:

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

ParameterValueData typeExplanation
attributeWaterMetricType/(resolvedAttributes)/WaterMetricTypeIdattribute

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"Oil & Gas Upstream - Water Management"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater Metric Type
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 type of water metric being measured.

Example:

  • Total volume generated
  • Total volume treated
  • Total volume used
  • Average volume generated
  • Average volume treated
  • Average Volume used
  • Number of overflows
  • Total discharged via sewer overflow
  • Water savings from efficiency measures
  • Number of water disconnections
  • number of disconnections due to non-payment
  • Number of customers reconnecting water
  • Average water bill
  • Number of customers enrolled in CAP program
  • CAP program discounts
  • Total number of customers
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
WaterMetricTypeId The unique identifier of a wtype. WaterMetricType
WaterMetricTypeName The name of a Water Metric Type. WaterMetricType
WaterMetricTypeDescription The description of a Water Metric Type. WaterMetricType

WaterMetricTypeId

The unique identifier of a wtype.
First included in: WaterMetricType (this entity)

Properties

NameValue
displayNameWater Metric Type ID
descriptionThe unique identifier of a wtype.
isPrimaryKeytrue
dataFormatint32

Traits

The WaterMetricTypeId 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
attributeWaterMetricType/(resolvedAttributes)/WaterMetricTypeIdattribute

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater Metric 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 wtype.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

WaterMetricTypeName

The name of a Water Metric Type.
First included in: WaterMetricType (this entity)

Properties

NameValue
displayNameWater Metric Type Name
descriptionThe name of a Water Metric Type.
dataFormatstring
maximumLength256
isNullabletrue

Traits

The WaterMetricTypeName attribute has the following traits:

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

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 Metric Type Name
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 name of a Water Metric Type.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
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

WaterMetricTypeDescription

The description of a Water Metric Type.
First included in: WaterMetricType (this entity)

Properties

NameValue
displayNameWater Metric Type Description
descriptionThe description of a Water Metric Type.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

The WaterMetricTypeDescription attribute has the following traits:

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

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 Metric Type Description
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 description of a Water Metric Type.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
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