Purchased energy in Cloud for Sustainability energy data model (PurchasedEnergy)

Electric energy, measured in MWh, delivered by the utility to a customer in accordance with the signed agreement.

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

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

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

Parameter	Value	Data type	Explanation
attribute	PurchasedEnergy/(resolvedAttributes)/purchasedenergyId	attribute

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

Parameter	Value	Data type	Explanation
groupList	attributeGroupReference /Sustainability /CloudforSustainabilityEnergyDataModel /PurchasedEnergy.cdm.json/PurchasedEnergy /hasAttributes/attributesAddedAtThisScope	entity

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Electric energy, measured in MWh, delivered by the utility to a customer in accordance with the signed agreement.	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Purchased energy	entity	a 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.

Parameter	Value	Data type	Explanation
name	"msdyn_purchasedenergy"	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.

Parameter	Value	Data type	Explanation
level	"resolved"	string	Possible values: logical, composition, resolved

Attributes

Name	Description	First Included in Instance
purchasedenergyId	Unique identifier for entity instances	Sustainability\CloudforSustainabilityEnergyDataModel/PurchasedEnergy
datasourcetype	Type of source from where data is obtained (utility bills, sensors, BMS etc.).	Sustainability\CloudforSustainabilityEnergyDataModel/PurchasedEnergy
energycontract	Type of agreement to deliver purchased energy.	Sustainability\CloudforSustainabilityEnergyDataModel/PurchasedEnergy
energysource	Primary source used to generate the selected energy type.	Sustainability\CloudforSustainabilityEnergyDataModel/PurchasedEnergy

purchasedenergyId

Unique identifier for entity instances
First included in: Sustainability/SustainabilityEnergy/PurchasedEnergy (this entity)

Properties

Name	Value
displayName	Purchased energy
description	Unique identifier for entity instances
isPrimaryKey	true
dataFormat	guid
sourceName	msdyn_purchasedenergyid

Traits

List of traits for the purchasedenergyId 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

Parameter	Value	Data type	Explanation
attribute	PurchasedEnergy/(resolvedAttributes)/purchasedenergyId	attribute

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

Parameter	Value	Data type	Explanation
level	"systemrequired"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Unique identifier for entity instances	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Purchased energy	entity	a 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.

Parameter	Value	Data type	Explanation
name	"msdyn_purchasedenergyid"	string

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

Parameter	Value	Data type	Explanation
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

datasourcetype

Type of source from where data is obtained (utility bills, sensors, BMS etc.).
First included in: Sustainability/SustainabilityEnergy/PurchasedEnergy (this entity)

Properties

Name	Value
displayName	Data source type
description	Type of source from where data is obtained (utility bills, sensors, BMS etc.).
dataFormat	guid

Traits

List of traits for the datasourcetype 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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Type of source from where data is obtained (utility bills, sensors, BMS etc.).	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Data source type	entity	a 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

Parameter	Value	Data type	Explanation
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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference relationshipName /CloudforSustainabilitySharedDataModel/DataSourceType.cdm.json/DataSourceType datasourcetypeId	entity	a 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

energycontract

Type of agreement to deliver purchased energy.
First included in: Sustainability/SustainabilityEnergy/PurchasedEnergy (this entity)

Properties

Name	Value
displayName	Energy contract
description	Type of agreement to deliver purchased energy.
dataFormat	guid

Traits

List of traits for the energycontract 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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Type of agreement to deliver purchased energy.	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Energy contract	entity	a 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

Parameter	Value	Data type	Explanation
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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference relationshipName EnergyContract.cdm.json/EnergyContract energycontractId	entity	a 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

energysource

Primary source used to generate the selected energy type.
First included in: Sustainability/SustainabilityEnergy/PurchasedEnergy (this entity)

Properties

Name	Value
displayName	Energy Source
description	Primary source used to generate the selected energy type.
dataFormat	guid

Traits

List of traits for the energysource 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

Parameter	Value	Data type	Explanation
level	"none"	string	values can be: 'systemrequired', 'required', 'recommended', 'none'

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Primary source used to generate the selected energy type.	entity	a 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.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Energy Source	entity	a 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

Parameter	Value	Data type	Explanation
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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference relationshipName EnergySource.cdm.json/EnergySource energysourceId	entity	a 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