Fuel Type in ESG data model

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Base entity from which all ESG Data Model entities are derived. en A substance containing combustible used for generating heat. Ex: Biomass Agricultural residue Biochar Biodiesel Bioethanol Biogas Energy Crop - sugar cane Energy Crop -corn Forest Residue Gasohol Landfill gas Municipal wood waste Refuse-derived fuel Saw dust Syngas Urban waste Wood chips Woody biomass Coal Anthracite Bituminous Lignite Gas/Oil Oil - Type 1 Very Light Oils (Jet Fuels, Gasoline) Oil - Type 2 Light Oils (Diesel, No. 2 Fuel Oil, Light Crudes) Oil - Type 3 Medium Oils (Most Crude Oils) Oil - Type 4 Heavy Oils (Heavy Crude Oils, No. 6 Fuel Oil, Bunker C) Oil - No. 1 diesel fuel Oil - No. 2 diesel fuel Oil - No. 3 diesel fuel Oil - No. 4 residual fuel oil Oil - No. 5 Heavy fuel oil Oil - No. 6 Heavy fuel oil Natural Gas Liquid Natural Gas	entity	a reference to the constant entity holding the list of localized text

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

Parameter	Value	Data type	Explanation
attribute	FuelType/(resolvedAttributes)/FuelTypeId	attribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

Parameter	Value	Data type	Explanation
versionNumber	"1.2.3"	string

is.IDM.modelVersion
Semantic version number of the IDM.

Parameter	Value	Data type	Explanation
versionNumber	"2.0.0"	string

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{898AA1D8-4112-48F5-B224-1259C20AF4DE}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nativeTo.businessArea
The name of the business area from which the entity originates.

Parameter	Value	Data type	Explanation
name	"Network"	string

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Fuel Type	entity	a reference to the constant entity holding the list of localized text

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 restates 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
FuelTypeId	The unique identifier of a fuel type.	Sustainability/esg-data-model/FuelType
FuelTypeName	The name of a fuel type.	Sustainability/esg-data-model/FuelType
FuelTypeDescription	The description of a fuel type.	Sustainability/esg-data-model/FuelType
FuelEmissionFactor	(Category 3 document - Page 41)	Sustainability/esg-data-model/FuelType
FuelEmissionFactorUnitOfMeasureId	The fuel emission factor unit of measure.	Sustainability/esg-data-model/FuelType
BiogenicEmissionIndicator	Indicates whether the emissions related to the fuel type is considered biogenic or not. This flag should be used by organizations that classify an emission as either 100% biogenic or 0%. For organizations that wish to allocate a percentage of the emissions as being biogenic they should use the Biogenic Emission Factor to specify the percentage that is considered biogenic.	Sustainability/esg-data-model/FuelType
BiogenicEmissionFactor	The percentage of the emission associated with the fuel type that is attributable to being biogenic.	Sustainability/esg-data-model/FuelType
FuelCategoryId	The unique identifier of a Fuel Category.	Sustainability/esg-data-model/FuelType

FuelTypeId

The unique identifier of a fuel type. First included in: Sustainability/esg-data-model/FuelType (this entity)

Properties

Name	Value
displayName	Fuel Type ID
description	The unique identifier of a fuel type.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the FuelTypeId attribute are listed here.

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

Parameter	Value	Data type	Explanation
attribute	FuelType/(resolvedAttributes)/FuelTypeId	attribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{A1830A8A-95AC-433A-A42D-82750D45CE89}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Fuel Type ID	entity	a reference to the constant entity holding the list of localized text

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a fuel type.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

FuelTypeName

The name of a fuel type. First included in: Sustainability/esg-data-model/FuelType (this entity)

Properties

Name	Value
displayName	Fuel Type Name
description	The name of a fuel type.
dataFormat	string
maximumLength	256
isNullable	true

Traits

List of traits for the FuelTypeName attribute are listed here.

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, and Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{72E27444-F344-45B8-888E-27493D856378}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Fuel Type Name	entity	a reference to the constant entity holding the list of localized text

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 a fuel type.	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	"256"	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, and Array of Byte is a Binary Object.

FuelTypeDescription

The description of a fuel type. First included in: Sustainability/esg-data-model/FuelType (this entity)

Properties

Name	Value
displayName	Fuel Type Description
description	The description of a fuel type.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the FuelTypeDescription attribute are listed here.

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, and Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{2A4C029E-70B8-4D55-A971-5671047907E2}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Fuel Type Description	entity	a reference to the constant entity holding the list of localized text

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The description of a fuel type.	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	"2048"	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, and Array of Byte is a Binary Object.

FuelEmissionFactor

(Category 3 document - Page 41)
First included in: Sustainability/esg-data-model/FuelType (this entity)

Properties

Name	Value
displayName	Fuel Emission Factor
description	(Category 3 document - Page 41)
dataFormat	int32
isNullable	true

Traits

List of traits for the FuelEmissionFactor attribute are listed here.

is.dataFormat.integer
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{49971413-52AA-46F3-955F-60C970D265AD}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Fuel Emission Factor	entity	a reference to the constant entity holding the list of localized text

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en (Category 3 document - Page 41)	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

FuelEmissionFactorUnitOfMeasureId

The fuel emission factor unit of measure. First included in: Sustainability/esg-data-model/FuelType (this entity)

Properties

Name	Value
displayName	Fuel Emission Factor Unit Of Measure ID
description	The fuel emission factor unit of measure.
dataFormat	int32
isNullable	true

Traits

List of traits for the FuelEmissionFactorUnitOfMeasureId attribute are listed here.

is.dataFormat.integer
is.nullable
The attribute value can be set to NULL.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Fuel Emission Factor Unit Of Measure ID	entity	a reference to the constant entity holding the list of localized text

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The fuel emission factor unit of measure.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attributes 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 UnitOfMeasure.cdm.json/UnitOfMeasure UnitOfMeasureId	entity	a reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{58E3EF37-76B9-4095-9BFC-E6DFE8BDE716}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer

BiogenicEmissionIndicator

Indicates whether the emissions related to the fuel type is considered biogenic or not. This flag should be used by organizations that classify an emission as either 100% biogenic or 0%.

For organizations that wish to allocate a percentage of the emissions as being biogenic they should use the Biogenic Emission Factor to specify the percentage that is considered biogenic. First included in: Sustainability/esg-data-model/FuelType (this entity)

Properties

Name	Value
displayName	Biogenic Emission Indicator
description	Indicates whether the emissions related to the fuel type is considered biogenic or not. This flag should be used by organizations that classify an emission as either 100% biogenic or 0%. For organizations that wish to allocate a percentage of the emissions as being biogenic they should use the Biogenic Emission Factor to specify the percentage that is considered biogenic.
dataFormat	boolean
isNullable	true

Traits

List of traits for the BiogenicEmissionIndicator attribute are listed here.

is.dataFormat.boolean
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{D51143EF-3BA1-4D4F-B93B-2D9FF2FE774B}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Biogenic Emission Indicator	entity	a reference to the constant entity holding the list of localized text

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Indicates whether the emissions related to the fuel type is considered biogenic or not. This flag should be used by organizations that classify an emission as either 100% biogenic or 0%. For organizations that wish to allocate a percentage of the emissions as being biogenic they should use the Biogenic Emission Factor to specify the percentage that is considered biogenic.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.boolean

BiogenicEmissionFactor

The percentage of the emission associated with the fuel type that is attributable to being biogenic. First included in: Sustainability/esg-data-model/FuelType (this entity)

Properties

Name	Value
displayName	Biogenic Emission Factor
description	The percentage of the emission associated with the fuel type that is attributable to being biogenic.
dataFormat	decimal
isNullable	true

Traits

List of traits for the BiogenicEmissionFactor attribute are listed here.

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

Parameter	Value	Data type	Explanation
precision	"22"	integer	the total number of significant digits
scale	"10"	integer	the number of digits to the right of the decimal place

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{F84F6E5C-A435-49D6-A14E-C5CE4B4C1844}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Biogenic Emission Factor	entity	a reference to the constant entity holding the list of localized text

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The percentage of the emission associated with the fuel type that is attributable to being biogenic.	entity	a reference to the constant entity holding the list of localized text

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

FuelCategoryId

The unique identifier of a Fuel Category. First included in: Sustainability/esg-data-model/FuelType (this entity)

Properties

Name	Value
displayName	Fuel Category ID
description	The unique identifier of a Fuel Category.
dataFormat	int32
isNullable	true

Traits

List of traits for the FuelCategoryId attribute are listed here.

is.dataFormat.integer
is.nullable
The attribute value can be set to NULL.

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Fuel Category ID	entity	a reference to the constant entity holding the list of localized text

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en The unique identifier of a Fuel Category.	entity	a reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attributes 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 FuelCategory.cdm.json/FuelCategory FuelCategoryId	entity	a reference to the constant entity holding the list of entity references

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.

Parameter	Value	Data type	Explanation
identifier	"{1C93F788-6667-4831-BF28-B43771D4B58B}"	string	The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer