Water Use Type in ESG data model

Traits

Traits for this entity are listed below.

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 The type of water use. Ex: Conjunction water Consumptive water Consumption irrigation Multiple where: Conjunction Water-The integrated use of surface and subsurface water supplies and facilities, normally involving storage of surplus waters when available, for use during periods when water supplies are deficient. Consumptive Water-The quantity of water discharged to the atmosphere or incorporated in the products in the process of vegetative growth, food processing, industrial processes, or other uses. Consumption Irrigation-The quantity of water that is absorbed by the crop and transpired or used directly in the building of plant tissue together with that evaporated from the cropped area. Multiple-The conscientious management of the various renewable resources such as water, wood, forage, wildlife, and recreation resources, to obtain sustained yield of products and services in the combination that will best meet the needs of the public now and in the future.	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	WaterUseType/(resolvedAttributes)/WaterUseTypeId	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	"{69461729-A5E7-48C5-88BC-AA94E319FFF4}"	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 Water Use 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
WaterUseTypeId	The unique identifier of a water use type.	Sustainability/esg-data-model/WaterUseType
WaterUseTypeName	The name of a water use type.	Sustainability/esg-data-model/WaterUseType
WaterUseTypeDescription	The description of a water use type.	Sustainability/esg-data-model/WaterUseType

WaterUseTypeId

The unique identifier of a water use type. First included in: Sustainability/esg-data-model/WaterUseType (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 below.

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

Parameter	Value	Data type	Explanation
attribute	WaterUseType/(resolvedAttributes)/WaterUseTypeId	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	"{F727CC7C-6F05-4EA6-BBDB-BBB6C2CA5158}"	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 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

is.dataFormat.integer

WaterUseTypeName

The name of a water use type. First included in: Sustainability/esg-data-model/WaterUseType (this entity)

Properties

Name	Value
displayName	Water Use Type Name
description	The name of a water use type.
dataFormat	string
maximumLength	256
isNullable	true

Traits

List of traits for the WaterUseTypeName attribute are listed below.

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	"{C3DDAC61-2328-4D06-BE20-40FF792E2385}"	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 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 water use 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.

WaterUseTypeDescription

The description of a water use type. First included in: Sustainability/esg-data-model/WaterUseType (this entity)

Properties

Name	Value
displayName	Water Use Type Description
description	The description of a water use type.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the WaterUseTypeDescription attribute are listed below.

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	"{4B9AFC3C-E100-49DC-8075-F7645FB5C4F3}"	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 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 water use 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.