Sustainability data definition in Cloud for Sustainability shared data model (SustainabilityDataDefinition)

Entity used to define the data definitions for entities across Carbon, Waste and Water.

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	SustainabilityDataDefinition/(resolvedAttributes)/sustainabilitydatadefinitionId	attribute

means.entityState
the attribute represents the current state of the entity.

Parameter	Value	Data type	Explanation
attribute	SustainabilityDataDefinition/(resolvedAttributes)/statecode	attribute

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

Parameter	Value	Data type	Explanation
groupList	attributeGroupReference /Sustainability /CloudforSustainabilitySharedDataModel /SustainabilityDataDefinition.cdm.json /SustainabilityDataDefinition/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 Entity used to define the data definitions for entities across Carbon, Waste and Water.	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 Sustainability data definition	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_sustainabilitydatadefinition"	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
sustainabilitydatadefinitionId	Unique identifier for entity instances	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
createdOn	Date and time when the record was created.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
modifiedOn	Date and time when the record was modified.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
statecode	Status of the Sustainability Data Definition	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
statuscode	Reason for the status of the Sustainability Data Definition	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
overriddenCreatedOn	Date and time that the record was migrated.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
timeZoneRuleVersionNumber	For internal use only.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
UTCConversionTimeZoneCode	Time zone code that was in use when the record was created.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
name	The name of the data definition.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
activitytypedatafield	Optional description that provides additional detail about the entity or attribute.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
definitiondetailfieldname	Definition detail field name	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
description	Optional description that provides additional detail about the record.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
duplicaterules	Defines rules for detecting duplicate records during ingestion.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
entitylogicalname	Logical name of entity described in the data definition.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
isactive	Flag to identify the state of being active of the data.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
module	Module to which data definition belongs to.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
queryviewid	Id of the main view for this data definition.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
requiredfieldrules	List of fields to hide during ingestion.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
uxviewid	Unique identifier associated to the main view used by the UI.	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition
subcategory	Lookup value for data definition subcategory	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition

sustainabilitydatadefinitionId

Unique identifier for entity instances
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Sustainability data definition
description	Unique identifier for entity instances
isPrimaryKey	true
dataFormat	guid
sourceName	msdyn_sustainabilitydatadefinitionid

Traits

List of traits for the sustainabilitydatadefinitionId 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	SustainabilityDataDefinition/(resolvedAttributes)/sustainabilitydatadefinitionId	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 Sustainability data definition	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_sustainabilitydatadefinitionid"	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/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (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	languageTag displayText en Date and time when the record was created.	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 Created On	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/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (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	languageTag displayText en Date and time when the record was modified.	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 Modified On	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 Sustainability Data Definition
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Status
description	Status of the Sustainability Data Definition
dataFormat	int32
sourceName	statecode
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue en Active 0 en Inactive 1

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	languageTag displayText attributeValue en Active 0 en Inactive 1	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	SustainabilityDataDefinition/(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	languageTag displayText en Status of the Sustainability Data Definition	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 Status	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 Sustainability Data Definition
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Status Reason
description	Reason for the status of the Sustainability Data Definition
dataFormat	int32
isNullable	true
sourceName	statuscode
valueConstrainedToList	true
defaultValue	languageTag displayText attributeValue correlatedValue en Active 1 1 en Inactive 2 2

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	languageTag displayText attributeValue correlatedValue en Active 1 1 en Inactive 2 2	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	languageTag displayText en Reason for the status of the Sustainability Data Definition	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 Status Reason	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

overriddenCreatedOn

Date and time that the record was migrated.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (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	languageTag displayText en Date and time that the record was migrated.	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 Record Created On	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/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (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	languageTag displayText en For internal use only.	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 Time Zone Rule Version Number	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/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (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	languageTag displayText en Time zone code that was in use when the record was created.	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 UTC Conversion Time Zone Code	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

The name of the data definition.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Name
description	The name of the data definition.
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	languageTag displayText en The name of the data definition.	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 Name	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

activitytypedatafield

Optional description that provides additional detail about the entity or attribute.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Activity type data field
description	Optional description that provides additional detail about the entity or attribute.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msdyn_activitytypedatafield

Traits

List of traits for the activitytypedatafield 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	languageTag displayText en Optional description that provides additional detail about the entity or attribute.	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 Activity type data field	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_activitytypedatafield"	string

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

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

definitiondetailfieldname

Definition detail field name
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Definition detail field name
description	Definition detail field name
dataFormat	string
maximumLength	250
isNullable	true
sourceName	msdyn_definitiondetailfieldname

Traits

List of traits for the definitiondetailfieldname 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	languageTag displayText en Definition detail field name	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 Definition detail field name	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	"250"	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_definitiondetailfieldname"	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

description

Optional description that provides additional detail about the record.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Description
description	Optional description that provides additional detail about the record.
dataFormat	string
maximumLength	2000
isNullable	true
sourceName	msdyn_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

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 Optional description that provides additional detail about the record.	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 Description	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	"2000"	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_description"	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.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

duplicaterules

Defines rules for detecting duplicate records during ingestion.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Duplicate rules
description	Defines rules for detecting duplicate records during ingestion.
dataFormat	string
maximumLength	2000
isNullable	true
sourceName	msdyn_duplicaterules

Traits

List of traits for the duplicaterules 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	languageTag displayText en Defines rules for detecting duplicate records during ingestion.	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 Duplicate rules	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	"2000"	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_duplicaterules"	string

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

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

entitylogicalname

Logical name of entity described in the data definition.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Entity logical name
description	Logical name of entity described in the data definition.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msdyn_entitylogicalname

Traits

List of traits for the entitylogicalname 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	languageTag displayText en Logical name of entity described in the data definition.	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 Entity logical name	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_entitylogicalname"	string

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

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

isactive

Flag to identify the state of being active of the data.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Is active
description	Flag to identify the state of being active of the data.
dataFormat	boolean
isNullable	true
sourceName	msdyn_isactive

Traits

List of traits for the isactive attribute are listed below.

is.dataFormat.boolean
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 Flag to identify the state of being active of the data.	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 Is active	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_isactive"	string

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

Parameter	Value	Data type	Explanation
ordinal	"49"	integer

is.dataFormat.boolean

module

Module to which data definition belongs to.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Module
description	Module to which data definition belongs to.
dataFormat	guid

Traits

List of traits for the module 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	languageTag displayText en Module to which data definition belongs to.	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 Module	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 SustainabilityModule.cdm.json/SustainabilityModule sustainabilitymoduleId	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

queryviewid

Id of the main view for this data definition.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Query view Id
description	Id of the main view for this data definition.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msdyn_queryviewid

Traits

List of traits for the queryviewid 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	languageTag displayText en Id of the main view for this data definition.	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 Query view Id	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_queryviewid"	string

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

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

requiredfieldrules

List of fields to hide during ingestion.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Required field rules
description	List of fields to hide during ingestion.
dataFormat	string
maximumLength	4000
isNullable	true
sourceName	msdyn_requiredfieldrules

Traits

List of traits for the requiredfieldrules 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	languageTag displayText en List of fields to hide during ingestion.	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 Required field rules	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	"4000"	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_requiredfieldrules"	string

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

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

uxviewid

Unique identifier associated to the main view used by the UI.
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	UX view Id
description	Unique identifier associated to the main view used by the UI.
dataFormat	string
maximumLength	100
isNullable	true
sourceName	msdyn_uxviewid

Traits

List of traits for the uxviewid 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	languageTag displayText en Unique identifier associated to the main view used by the UI.	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 UX view Id	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_uxviewid"	string

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

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

subcategory

Lookup value for data definition subcategory
First included in: Sustainability/CloudforSustainabilitySharedDataModel/SustainabilityDataDefinition (this entity)

Properties

Name	Value
displayName	Subcategory
description	Lookup value for data definition subcategory
dataFormat	guid

Traits

List of traits for the subcategory 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 Lookup value for data definition subcategory	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 Subcategory	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 SustainabilityDataDefinitionSubcategory.cdm.json/SustainabilityDataDefinitionSubcategory sustainabilitydatadefinitionsubcategoryId	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