Water quantity in Cloud for Sustainability water data model (WaterQuantity)

Stores the actual quantity information from water transactions within the organization.

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

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

ParameterValueData typeExplanation
attributeWaterQuantity/(resolvedAttributes)/waterquantityIdattribute

is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.

ParameterValueData typeExplanation
groupList
attributeGroupReference
/Sustainability
/CloudforSustainabilityWaterDataModel
/WaterQuantity.cdm.json/WaterQuantity
/hasAttributes/attributesAddedAtThisScope
entity

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStores the actual quantity information from water transactions within the organization.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater quantity
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_waterquantity"string

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
waterquantityId Unique identifier for entity instances. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
TTLInSeconds Time to live in seconds. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
partitionId Logical partition identifier. A logical partition consists of a set of records with same partition ID. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
createdOn Date and time when the record was created. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
modifiedOn Date and time when the record was modified. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
importSequenceNumber Sequence number of the import that created this record. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
overriddenCreatedOn Date and time that the record was migrated. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
name The name of the custom entity. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
activityentityname Internal reference used to map an entity to the corresponding record. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
activityid Internal reference used to map the entity to the corresponding record. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
activityname Category or reference data used for reporting purposes and populated during the calculation process. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
description Optional field to describe the entity. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
cost Cost associated with water diversion. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
costunit Unit associated with the cost quantity. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
origincorrelationid Optional field to store source unique identifier values for the entity. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
quantity Indicates the actual quantity of water that was part of the transaction. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
transactionenddate Indicates the date and time at which the transaction recording ended. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
transactionstartdate Indicates the date and time at which the transaction recording started. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
evidence Optional field to indicate the origin for the water quantity data. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
unit Indicates the unit of measurement for the water transaction. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
waterinstrument Describes the corresponding water instrument for which the water quantity information is being recorded. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
dataqualitytype Description of the data quality that identifies whether the data is metered, measured, or estimated. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
facility Indicates the facility mapped to the water instrument. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
industrialprocesstype Indicates the process for which the water instrument is being used. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
organizationalunit Indicates the organizational unit where the water instrument is located. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
watersource Indicates the source from which the water enters or leaves the instrument. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
watertransactiontype Indicates the type of transaction related to water flow, such as withdrawal, discharge, consumption, or recycled. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
customdimension Field where Custom Dimension values are stored in JSON format. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
reportingdate Date used to parameterize reports. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
source Lookup to external source activity. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity
parentsource Lookup to parent source activity. Sustainability\CloudforSustainabilityWaterDataModel/WaterQuantity

waterquantityId

Unique identifier for entity instances.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameWater quantity
descriptionUnique identifier for entity instances.
isPrimaryKeytrue
dataFormatguid
sourceNamemsdyn_waterquantityid

Traits

List of traits for the waterquantityId 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeWaterQuantity/(resolvedAttributes)/waterquantityIdattribute

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"systemrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnique identifier for entity instances.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater quantity
entitya reference to the constant entity holding the list of localized text

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_waterquantityid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"1"integer

is.dataFormat.guid
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

TTLInSeconds

Time to live in seconds.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameTime to live
descriptionTime to live in seconds.
dataFormatint32
maximumValue2147483647
minimumValue1
isNullabletrue
sourceNamettlinseconds

Traits

List of traits for the TTLInSeconds attribute are listed below.

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTime to live in seconds.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTime to live
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"1"decimal
maximumValue"2147483647"decimal

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"ttlinseconds"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"2"integer

is.dataFormat.integer

partitionId

Logical partition identifier. A logical partition consists of a set of records with same partition ID.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNamePartition Id
descriptionLogical partition identifier. A logical partition consists of a set of records with same partition ID.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamepartitionid

Traits

List of traits for the partitionId 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, Array of Byte is a Binary Object

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLogical partition identifier. A logical partition consists of a set of records with same partition ID.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPartition Id
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"partitionid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"3"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

createdOn

Date and time when the record was created.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameCreated On
descriptionDate and time when the record was created.
dataFormatdateTime
isNullabletrue
sourceNamecreatedon

Traits

List of traits for the createdOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the record was created.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCreated On
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"createdon"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"4"integer

is.dataFormat.time
is.dataFormat.date

modifiedOn

Date and time when the record was modified.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameModified On
descriptionDate and time when the record was modified.
dataFormatdateTime
isNullabletrue
sourceNamemodifiedon

Traits

List of traits for the modifiedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time when the record was modified.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enModified On
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"modifiedon"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"6"integer

is.dataFormat.time
is.dataFormat.date

importSequenceNumber

Sequence number of the import that created this record.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameImport Sequence Number
descriptionSequence number of the import that created this record.
dataFormatint32
maximumValue2147483647
minimumValue-2147483648
isNullabletrue
sourceNameimportsequencenumber

Traits

List of traits for the importSequenceNumber attribute are listed below.

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSequence number of the import that created this record.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enImport Sequence Number
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-2147483648"decimal
maximumValue"2147483647"decimal

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"importsequencenumber"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"28"integer

is.dataFormat.integer

overriddenCreatedOn

Date and time that the record was migrated.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameRecord Created On
descriptionDate and time that the record was migrated.
dataFormatdate
isNullabletrue
sourceNameoverriddencreatedon

Traits

List of traits for the overriddenCreatedOn attribute are listed below.

is.dataFormat.date
means.measurement.date
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate and time that the record was migrated.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecord Created On
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"overriddencreatedon"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"29"integer

is.dataFormat.date

name

The name of the custom entity.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameName
descriptionThe name of the custom entity.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsdyn_name

Traits

List of traits for the name 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, Array of Byte is a Binary Object

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"applicationrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe name of the custom entity.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enName
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_name"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"30"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

activityentityname

Internal reference used to map an entity to the corresponding record.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameActivity entity name (Deprecated)
descriptionInternal reference used to map an entity to the corresponding record.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsdyn_activityentityname

Traits

List of traits for the activityentityname 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, Array of Byte is a Binary Object

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInternal reference used to map an entity to the corresponding record.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActivity entity name (Deprecated)
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_activityentityname"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"31"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

activityid

Internal reference used to map the entity to the corresponding record.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameActivity ID (Deprecated)
descriptionInternal reference used to map the entity to the corresponding record.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsdyn_activityid

Traits

List of traits for the activityid 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, Array of Byte is a Binary Object

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enInternal reference used to map the entity to the corresponding record.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActivity ID (Deprecated)
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_activityid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"32"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

activityname

Category or reference data used for reporting purposes and populated during the calculation process.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameActivity type
descriptionCategory or reference data used for reporting purposes and populated during the calculation process.
dataFormatstring
maximumLength255
isNullabletrue
sourceNamemsdyn_activityname

Traits

List of traits for the activityname 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, Array of Byte is a Binary Object

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCategory or reference data used for reporting purposes and populated during the calculation process.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enActivity type
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"255"integer

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_activityname"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"33"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

description

Optional field to describe the entity.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameDescription
descriptionOptional field to describe the entity.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsdyn_description

Traits

List of traits for the description 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, Array of Byte is a Binary Object

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOptional field to describe the entity.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescription
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_description"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"34"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

cost

Cost associated with water diversion.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameCost
descriptionCost associated with water diversion.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamemsdyn_cost

Traits

List of traits for the cost attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCost associated with water diversion.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCost
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-100000000000"decimal
maximumValue"100000000000"decimal

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_cost"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"35"integer

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

costunit

Unit associated with the cost quantity.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameCost unit
descriptionUnit associated with the cost quantity.
dataFormatguid

Traits

List of traits for the costunit 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnit associated with the cost quantity.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCost unit
entitya reference to the constant entity holding the list of localized text

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReferencerelationshipName
/CloudforSustainabilitySharedDataModel/Unit.cdm.json/UnitunitId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
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

origincorrelationid

Optional field to store source unique identifier values for the entity.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameOrigin correlation id
descriptionOptional field to store source unique identifier values for the entity.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsdyn_origincorrelationid

Traits

List of traits for the origincorrelationid 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, Array of Byte is a Binary Object

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOptional field to store source unique identifier values for the entity.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrigin correlation id
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_origincorrelationid"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"37"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

quantity

Indicates the actual quantity of water that was part of the transaction.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameQuantity
descriptionIndicates the actual quantity of water that was part of the transaction.
dataFormatdecimal
maximumValue100000000000
minimumValue-100000000000
isNullabletrue
sourceNamemsdyn_quantity

Traits

List of traits for the quantity attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"applicationrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the actual quantity of water that was part of the transaction.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enQuantity
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
minimumValue"-100000000000"decimal
maximumValue"100000000000"decimal

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_quantity"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"38"integer

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

transactionenddate

Indicates the date and time at which the transaction recording ended.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameTransaction end date
descriptionIndicates the date and time at which the transaction recording ended.
dataFormatdateTime
isNullabletrue
sourceNamemsdyn_transactionenddate

Traits

List of traits for the transactionenddate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"applicationrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the date and time at which the transaction recording ended.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTransaction end date
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_transactionenddate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"39"integer

is.dataFormat.time
is.dataFormat.date

transactionstartdate

Indicates the date and time at which the transaction recording started.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameTransaction start date
descriptionIndicates the date and time at which the transaction recording started.
dataFormatdateTime
isNullabletrue
sourceNamemsdyn_transactionstartdate

Traits

List of traits for the transactionstartdate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"applicationrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the date and time at which the transaction recording started.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTransaction start date
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_transactionstartdate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"40"integer

is.dataFormat.time
is.dataFormat.date

evidence

Optional field to indicate the origin for the water quantity data.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameEvidence
descriptionOptional field to indicate the origin for the water quantity data.
dataFormatstring
maximumLength100
isNullabletrue
sourceNamemsdyn_evidence

Traits

List of traits for the evidence 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, Array of Byte is a Binary Object

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOptional field to indicate the origin for the water quantity data.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEvidence
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"100"integer

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_evidence"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"41"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

unit

Indicates the unit of measurement for the water transaction.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameUnit
descriptionIndicates the unit of measurement for the water transaction.
dataFormatguid

Traits

List of traits for the unit 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"applicationrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the unit of measurement for the water transaction.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enUnit
entitya reference to the constant entity holding the list of localized text

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReferencerelationshipName
/CloudforSustainabilitySharedDataModel/Unit.cdm.json/UnitunitId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
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

waterinstrument

Describes the corresponding water instrument for which the water quantity information is being recorded.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameWater instrument
descriptionDescribes the corresponding water instrument for which the water quantity information is being recorded.
dataFormatguid

Traits

List of traits for the waterinstrument 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescribes the corresponding water instrument for which the water quantity information is being recorded.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater instrument
entitya reference to the constant entity holding the list of localized text

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReferencerelationshipName
WaterInstrument.cdm.json/WaterInstrumentwaterinstrumentId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
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

dataqualitytype

Description of the data quality that identifies whether the data is metered, measured, or estimated.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameData quality type
descriptionDescription of the data quality that identifies whether the data is metered, measured, or estimated.
dataFormatint32
isNullabletrue
sourceNamemsdyn_dataqualitytype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enActual700610000
enEstimated700610001
enMetered700610002
enOther700610003

Traits

List of traits for the dataqualitytype attribute are listed below.

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enActual700610000
enEstimated700610001
enMetered700610002
enOther700610003
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDescription of the data quality that identifies whether the data is metered, measured, or estimated.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enData quality type
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_dataqualitytype"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"44"integer

is.dataFormat.integer

facility

Indicates the facility mapped to the water instrument.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameFacility
descriptionIndicates the facility mapped to the water instrument.
dataFormatguid

Traits

List of traits for the facility 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"applicationrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the facility mapped to the water instrument.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFacility
entitya reference to the constant entity holding the list of localized text

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReferencerelationshipName
/CloudforSustainabilitySharedDataModel/Facility.cdm.json/FacilityfacilityId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
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

industrialprocesstype

Indicates the process for which the water instrument is being used.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameIndustrial process type
descriptionIndicates the process for which the water instrument is being used.
dataFormatguid

Traits

List of traits for the industrialprocesstype 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the process for which the water instrument is being used.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndustrial process type
entitya reference to the constant entity holding the list of localized text

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReferencerelationshipName
/CloudforSustainabilitySharedDataModel/IndustrialProcessType.cdm.json/IndustrialProcessTypeindustrialprocesstypeId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
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

organizationalunit

Indicates the organizational unit where the water instrument is located.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameOrganizational unit
descriptionIndicates the organizational unit where the water instrument is located.
dataFormatguid

Traits

List of traits for the organizationalunit 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the organizational unit where the water instrument is located.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enOrganizational unit
entitya reference to the constant entity holding the list of localized text

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReferencerelationshipName
/CloudforSustainabilitySharedDataModel/OrganizationalUnit.cdm.json/OrganizationalUnitsustainabilityorganizationalunitId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
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

watersource

Indicates the source from which the water enters or leaves the instrument.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameWater source
descriptionIndicates the source from which the water enters or leaves the instrument.
dataFormatguid

Traits

List of traits for the watersource 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the source from which the water enters or leaves the instrument.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater source
entitya reference to the constant entity holding the list of localized text

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReferencerelationshipName
WaterSource.cdm.json/WaterSourcewatersourceId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
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

watertransactiontype

Indicates the type of transaction related to water flow, such as withdrawal, discharge, consumption, or recycled.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameWater transaction type
descriptionIndicates the type of transaction related to water flow, such as withdrawal, discharge, consumption, or recycled.
dataFormatint32
isNullabletrue
sourceNamemsdyn_watertransactiontype
valueConstrainedToListtrue
defaultValue
languageTagdisplayTextattributeValue
enWithdrawal700610000
enDischarge700610001
enConsumption700610002
enRecycled700610003

Traits

List of traits for the watertransactiontype attribute are listed below.

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
does.haveDefault
An attribute has a default value

ParameterValueData typeExplanation
default
languageTagdisplayTextattributeValue
enWithdrawal700610000
enDischarge700610001
enConsumption700610002
enRecycled700610003
any

is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"applicationrequired"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates the type of transaction related to water flow, such as withdrawal, discharge, consumption, or recycled.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enWater transaction type
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_watertransactiontype"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"50"integer

is.dataFormat.integer

customdimension

Field where Custom Dimension values are stored in JSON format.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameCustom Dimension
descriptionField where Custom Dimension values are stored in JSON format.
dataFormatstring
maximumLength1048576
isNullabletrue
sourceNamemsdyn_customdimension

Traits

List of traits for the customdimension 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, Array of Byte is a Binary Object

is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enField where Custom Dimension values are stored in JSON format.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCustom Dimension
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"1048576"integer

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_customdimension"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"52"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

reportingdate

Date used to parameterize reports.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameReporting date
descriptionDate used to parameterize reports.
dataFormatdateTime
isNullabletrue
sourceNamemsdyn_reportingdate

Traits

List of traits for the reportingdate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDate used to parameterize reports.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enReporting date
entitya reference to the constant entity holding the list of localized text

is.nullable
The attribute value may be set to NULL.

is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.

ParameterValueData typeExplanation
name"msdyn_reportingdate"string

is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.

ParameterValueData typeExplanation
ordinal"53"integer

is.dataFormat.time
is.dataFormat.date

source

Lookup to external source activity.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameSource
descriptionLookup to external source activity.
dataFormatguid

Traits

List of traits for the source 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLookup to external source activity.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSource
entitya reference to the constant entity holding the list of localized text

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReferencerelationshipName
/CloudforSustainabilitySharedDataModel/FacilityCapacity.cdm.json/FacilityCapacityfacilitycapacityId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
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

parentsource

Lookup to parent source activity.
First included in: Sustainability/SustainabilityWater/WaterQuantity (this entity)

Properties

NameValue
displayNameParent source
descriptionLookup to parent source activity.
dataFormatguid

Traits

List of traits for the parentsource 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, Array of Byte is a Binary Object

is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics

ParameterValueData typeExplanation
level"none"stringvalues can be: 'systemrequired', 'required', 'recommended', 'none'

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLookup to parent source activity.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enParent source
entitya reference to the constant entity holding the list of localized text

is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications

ParameterValueData typeExplanation
style"single"string

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReferencerelationshipName
WaterQuantity.cdm.json/WaterQuantitywaterquantityId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.guid
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