Required attributes for the Cloud for Sustainability water data model (preview)

Microsoft Cloud for Sustainability Technical Summit May 2024

Important

Some or all of this functionality is available as part of a preview release. The content and the functionality are subject to change.

This article provides information about the required attributes and rules for the Microsoft Cloud for Sustainability water data model.

General rules

  • The Name value must always be unique.
  • The Origin Correlation ID value must be unique if specified. However, it isn't typically required.

Notation

The table that follows provides a partial list of the attributes in each entity. It includes only required attributes and attributes that influence the requirement of other attributes via logical dependency rules. The following notation is used in the Required? column:

Notation Meaning
Y Required
N Optional
<--<attribute> Required only if <attribute> is specified
Y | <attribute>... Required unless <attribute> is specified
Y <--<attribute> == <value> Required if <attribute> contains <value>

Entity/attribute rules

Entity Attribute Required?
Facility Water risk index N
Water basin N
Stored water Actual storage Y
Description N
Facility Y
Measurement date Y
Organizational unit N
Storage container ID N
Storage container type N
Total storage N
Unit Y
Water basin Major basin N
Minor basin N
Description N
Water instrument Water instrument type N
Description N
Water quality analysis Analysis method N
Description N
Laboratory comments N
Laboratory name N
Water quality characteristic Reference range lower limit N
Reference range unit Y
Reference range upper limit N
Reference range evidence N
Description N
Water quality characteristic type Description N
Water quality test result Water quality analysis N
Comments N
Description N
Measured value N
Precision N
Result status Y
Unit Y
Water quality characteristics Y
Water sample Y
Water quality test date Y
Water quantity Quantity Y
Transaction end date Y
Transaction start date Y
Evidence N
Unit Y
Water instrument N
Data quality type N
Description N
Facility Y
Industrial process type N
Organizational unit N
Water source N
Water transaction type Y
Water risk index Description N
Water stressed area Y
Water sample Collection date Y
Collection equipment N
Collection method N
Description N
Facility Y
Industrial process type N
Organizational unit N
Water source N
Water transaction type N
Water source Description N
Subtype N
Source type Y
Water quality type N

Other constraints

Water instrument configuration type

The value must be one of the values from the following enumeration:

  • Water quantity
  • Water quality

Water quality characteristic.Type

The value must be one of the values from the following enumeration:

  • Physical
  • Chemical
  • Biological

Water sample collection method

The value must be one of the values from the following enumeration:

  • Composite
  • Grab

Water source type

The value must be one of the values from the following enumeration:

  • Surface water
  • Ground water
  • Sea water
  • Produced water
  • Third party water

Water instrument configuration water transaction type

The value must be one of the values from the following enumeration:

  • Withdrawal
  • Discharge
  • Consumption
  • Recycled

Water source water quality type

The value must be one of the values from the following enumeration:

  • Fresh water
  • Other water

See also

Cloud for Sustainability water data model (preview) entity reference
Cloud for Sustainability water data model (preview) overview