Sustainability module in Cloud for Sustainability shared data model (SustainabilityModule)

Entity used to classify the data definitions.

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 specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	SustainabilityModule/(resolvedAttributes)/sustainabilitymoduleId	attribute

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

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

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

Parameter	Value	Data type	Explanation
groupList	attributeGroupReference /Sustainability /CloudforSustainabilitySharedDataModel /SustainabilityModule.cdm.json /SustainabilityModule/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 classify the data definitions.	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 module	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_sustainabilitymodule"	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
sustainabilitymoduleId	Unique identifier for entity instances	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule
createdOn	Date and time when the record was created.Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule
modifiedOn	Date and time when the record was modified.Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule
statecode	Status of the Sustainability Module	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule
statuscode	Reason for the status of the Sustainability Module	Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule
overriddenCreatedOn	Date and time that the record was migrated.Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule
timeZoneRuleVersionNumber	For internal use only.Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule
UTCConversionTimeZoneCode	Time zone code that was in use when the record was created.Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule
name	The name of the Module.Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule

sustainabilitymoduleId

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

Properties

Name	Value
displayName	Sustainability module
description	Unique identifier for entity instances
isPrimaryKey	true
dataFormat	guid
sourceName	msdyn_sustainabilitymoduleid

Traits

List of traits for the sustainabilitymoduleId 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 shoud 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 specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	SustainabilityModule/(resolvedAttributes)/sustainabilitymoduleId	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 module	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_sustainabilitymoduleid"	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 shoud 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/SustainabilityModule (this entity)

Properties

Name	Value
displayName	Created On
description	Date and time when the record was created.
dataFormat	dateTime
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	"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 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.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/SustainabilityModule (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 Module
First included in: Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule (this entity)

Properties

Name	Value
displayName	Status
description	Status of the Sustainability Module
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	SustainabilityModule/(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 Module	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 Module
First included in: Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule (this entity)

Properties

Name	Value
displayName	Status Reason
description	Reason for the status of the Sustainability Module
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 Module	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/SustainabilityModule (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/SustainabilityModule (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/SustainabilityModule (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 Module.
First included in: Sustainability\CloudforSustainabilitySharedDataModel/SustainabilityModule (this entity)

Properties

Name	Value
displayName	Name
description	The name of the Module.
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 shoud 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 Module.	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 shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object