Agreement details in Cloud for Sustainability energy data model (AgreementDetails)
Binding agreement between the energy provider and the customer for the energy being sourced or procured.
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 | AgreementDetails/(resolvedAttributes)/agreementdetailsId | attribute |
means.entityState
the attribute represents the current state of the entity.
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | AgreementDetails/(resolvedAttributes)/statecode | attribute |
is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.
Parameter | Value | Data type | Explanation | ||
---|---|---|---|---|---|
groupList |
| entity |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| 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 |
| 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_agreementdetails" | 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
agreementdetailsId
Unique identifier for entity instances
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Agreement details |
description | Unique identifier for entity instances |
isPrimaryKey | true |
dataFormat | guid |
sourceName | msdyn_agreementdetailsid |
Traits
List of traits for the agreementdetailsId 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 | AgreementDetails/(resolvedAttributes)/agreementdetailsId | 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 |
| 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 |
| 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_agreementdetailsid" | 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
createdOn
Date and time when the record was created.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Created On |
description | Date and time when the record was created. |
dataFormat | dateTime |
isNullable | true |
sourceName | createdon |
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
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 |
| 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 |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "createdon" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "2" | integer |
is.dataFormat.time
is.dataFormat.date
modifiedOn
Date and time when the record was modified.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Modified On |
description | Date and time when the record was modified. |
dataFormat | dateTime |
isNullable | true |
sourceName | modifiedon |
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
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 |
| 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 |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "modifiedon" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "4" | integer |
is.dataFormat.time
is.dataFormat.date
statecode
Status of the Agreement details
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
displayName | Status | |||||||||
description | Status of the Agreement details | |||||||||
dataFormat | int32 | |||||||||
sourceName | statecode | |||||||||
valueConstrainedToList | true | |||||||||
defaultValue |
|
Traits
List of traits for the statecode 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
Parameter | Value | Data type | Explanation | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
means.entityState
the attribute represents the current state of the entity.
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | AgreementDetails/(resolvedAttributes)/statecode | 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 |
| 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 |
| 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 | "statecode" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "25" | integer |
is.dataFormat.integer
statuscode
Reason for the status of the Agreement details
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
displayName | Status Reason | ||||||||||||
description | Reason for the status of the Agreement details | ||||||||||||
dataFormat | int32 | ||||||||||||
isNullable | true | ||||||||||||
sourceName | statuscode | ||||||||||||
valueConstrainedToList | true | ||||||||||||
defaultValue |
|
Traits
List of traits for the statuscode 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
Parameter | Value | Data type | Explanation | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
is.correlatedWith
the attribute value is correlated with the sourceAttribute
Parameter | Value | Data type | Explanation |
---|---|---|---|
sourceAttribute | "statecode" | attributeName |
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 |
| 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 |
| 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 | "statuscode" | string |
is.nullable
The attribute value may be set to NULL.
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "27" | integer |
is.dataFormat.integer
importSequenceNumber
Sequence number of the import that created this record.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Import Sequence Number |
description | Sequence number of the import that created this record. |
dataFormat | int32 |
maximumValue | 2147483647 |
minimumValue | -2147483648 |
isNullable | true |
sourceName | importsequencenumber |
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
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 |
| 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 |
| 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 |
---|---|---|---|
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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "importsequencenumber" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "30" | integer |
is.dataFormat.integer
overriddenCreatedOn
Date and time that the record was migrated.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Record Created On |
description | Date and time that the record was migrated. |
dataFormat | date |
isNullable | true |
sourceName | overriddencreatedon |
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
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 |
| 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 |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "overriddencreatedon" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "31" | integer |
is.dataFormat.date
timeZoneRuleVersionNumber
For internal use only.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Time Zone Rule Version Number |
description | For internal use only. |
dataFormat | int32 |
maximumValue | 2147483647 |
minimumValue | -1 |
isNullable | true |
sourceName | timezoneruleversionnumber |
Traits
List of traits for the timeZoneRuleVersionNumber 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
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 |
| 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 |
| 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 |
---|---|---|---|
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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "timezoneruleversionnumber" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "32" | integer |
is.dataFormat.integer
UTCConversionTimeZoneCode
Time zone code that was in use when the record was created.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | UTC Conversion Time Zone Code |
description | Time zone code that was in use when the record was created. |
dataFormat | int32 |
maximumValue | 2147483647 |
minimumValue | -1 |
isNullable | true |
sourceName | utcconversiontimezonecode |
Traits
List of traits for the UTCConversionTimeZoneCode 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
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 |
| 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 |
| 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 |
---|---|---|---|
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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "utcconversiontimezonecode" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "33" | integer |
is.dataFormat.integer
name
Name
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Name |
description | Name |
dataFormat | string |
maximumLength | 100 |
isNullable | true |
sourceName | msdyn_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
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "applicationrequired" | 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 |
| 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 |
| 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 | "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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_name" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
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
basicattributes
These are basic attributes for renewable energy generation in the agreement
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Basic attributes |
description | These are basic attributes for renewable energy generation in the agreement |
dataFormat | string |
maximumLength | 200 |
isNullable | true |
sourceName | msdyn_basicattributes |
Traits
List of traits for the basicattributes 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
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 |
| 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 |
| 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 | "200" | 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_basicattributes" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "35" | 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
contractstructure
Details of the agreement with the renewable energy provider.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Contract structure |
description | Details of the agreement with the renewable energy provider. |
dataFormat | string |
maximumLength | 200 |
isNullable | true |
sourceName | msdyn_contractstructure |
Traits
List of traits for the contractstructure 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
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 |
| 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 |
| 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 | "200" | 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_contractstructure" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "36" | 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
contractterms
Duration of the agreement with the renewable energy provider.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Contract terms |
description | Duration of the agreement with the renewable energy provider. |
dataFormat | string |
maximumLength | 200 |
isNullable | true |
sourceName | msdyn_contractterms |
Traits
List of traits for the contractterms 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
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 |
| 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 |
| 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 | "200" | 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_contractterms" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
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
cost
Cost associated with activity data.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Cost |
description | Cost associated with activity data. |
dataFormat | decimal |
maximumValue | 100000000000 |
minimumValue | -100000000000 |
isNullable | true |
sourceName | msdyn_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
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 |
| 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 |
| 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 |
---|---|---|---|
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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_cost" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "38" | 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/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Cost unit |
description | Unit associated with the cost quantity. |
dataFormat | guid |
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
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 |
| 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 |
| 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 |
| 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
expirydate
End date of the power purchase agreement.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Expiry date |
description | End date of the power purchase agreement. |
dataFormat | dateTime |
isNullable | true |
sourceName | msdyn_expirydate |
Traits
List of traits for the expirydate 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
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "applicationrequired" | 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 |
| 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 |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_expirydate" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "40" | integer |
is.dataFormat.time
is.dataFormat.date
facilityid
Unique identifier for the facility associated with the purchased energy.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Facility |
description | Unique identifier for the facility associated with the purchased energy. |
dataFormat | guid |
Traits
List of traits for the facilityid 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 |
| 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 |
| 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 |
| 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
marketattributes
These are market specific attributes for renewable energy generation in the agreement.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Market attributes |
description | These are market specific attributes for renewable energy generation in the agreement. |
dataFormat | string |
maximumLength | 200 |
isNullable | true |
sourceName | msdyn_marketattributes |
Traits
List of traits for the marketattributes 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
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 |
| 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 |
| 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 | "200" | 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_marketattributes" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "42" | 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
Generic quantity field associated with activity entities.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Quantity |
description | Generic quantity field associated with activity entities. |
dataFormat | decimal |
maximumValue | 100000000000 |
minimumValue | -100000000000 |
isNullable | true |
sourceName | msdyn_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
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "applicationrequired" | 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 |
| 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 |
| 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 |
---|---|---|---|
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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_quantity" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "43" | integer |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
quantityunit
Unit associated with the quantity field
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Quantity unit |
description | Unit associated with the quantity field |
dataFormat | guid |
Traits
List of traits for the quantityunit 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 | "applicationrequired" | 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 |
| 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 |
| 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 |
| 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
settlementlocation
Trading hub, pricing node, zone, or other location at which your project will settle financially.)
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Settlement location |
description | Trading hub, pricing node, zone, or other location at which your project will settle financially.) |
dataFormat | string |
maximumLength | 100 |
isNullable | true |
sourceName | msdyn_settlementlocation |
Traits
List of traits for the settlementlocation 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
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 |
| 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 |
| 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 | "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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_settlementlocation" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "45" | 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
startdate
Start date of the power purchase agreement.
First included in: Sustainability/SustainabilityEnergy/AgreementDetails (this entity)
Properties
Name | Value |
---|---|
displayName | Start date |
description | Start date of the power purchase agreement. |
dataFormat | dateTime |
isNullable | true |
sourceName | msdyn_startdate |
Traits
List of traits for the startdate 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
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "applicationrequired" | 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 |
| 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 |
| entity | a 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msdyn_startdate" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "46" | integer |
is.dataFormat.time
is.dataFormat.date