Dela via


Fuel Type in ESG data model

Base entity from which all Industry Data Model entities are derived.

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"4.3"stringsemantic version number of the entity

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBase entity from which all Industry Data Model entities are derived.
enA substance containing combustible used for generating heat.

Example: 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
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
attributeFuelType/(resolvedAttributes)/FuelTypeIdattribute

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

ParameterValueData typeExplanation
versionNumber"1.2.3"string

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

ParameterValueData typeExplanation
versionNumber"1.6.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 other identification values.

ParameterValueData typeExplanation
identifier"{898AA1D8-4112-48F5-B224-1259C20AF4DE}"stringThe 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.

ParameterValueData typeExplanation
name"Network"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFuel Type
entitya 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.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
FuelTypeId The unique identifier of a fuel type. FuelType
FuelTypeName The name of a fuel type. FuelType
FuelTypeDescription The description of a fuel type. FuelType
FuelEmissionFactorUnits (Category 3 document - Page 41) FuelType
FuelEmissionFactorUomId The fuel emission factor UOM. 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. FuelType
BiogenicEmissionFactor The percentage of the emission associated with the fuel type that is attributable to being biogenic. FuelType
FuelCategoryId The unique identifier of a Fuel Category. FuelType

FuelTypeId

The unique identifier of a fuel type.
First included in: FuelType (this entity)

Properties

NameValue
displayNameFuel Type ID
descriptionThe unique identifier of a fuel type.
isPrimaryKeytrue
dataFormatint32

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.

ParameterValueData typeExplanation
attributeFuelType/(resolvedAttributes)/FuelTypeIdattribute

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

ParameterValueData typeExplanation
identifier"{A1830A8A-95AC-433A-A42D-82750D45CE89}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFuel Type ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a fuel type.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

FuelTypeName

The name of a fuel type.
First included in: FuelType (this entity)

Properties

NameValue
displayNameFuel Type Name
descriptionThe name of a fuel type.
dataFormatstring
maximumLength256
isNullabletrue

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. 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 other identification values.

ParameterValueData typeExplanation
identifier"{72E27444-F344-45B8-888E-27493D856378}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFuel Type Name
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe name of a fuel type.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

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

FuelTypeDescription

The description of a fuel type.
First included in: FuelType (this entity)

Properties

NameValue
displayNameFuel Type Description
descriptionThe description of a fuel type.
dataFormatstring
maximumLength2048
isNullabletrue

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. 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 other identification values.

ParameterValueData typeExplanation
identifier"{2A4C029E-70B8-4D55-A971-5671047907E2}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFuel Type Description
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe description of a fuel type.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

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

FuelEmissionFactorUnits

(Category 3 document - Page 41)
First included in: FuelType (this entity)

Properties

NameValue
displayNameFuel Emission Factor Units
description

(Category 3 document - Page 41)

dataFormatint32
isNullabletrue

Traits

List of traits for the FuelEmissionFactorUnits 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 other identification values.

ParameterValueData typeExplanation
identifier"{49971413-52AA-46F3-955F-60C970D265AD}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFuel Emission Factor Units
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
en

(Category 3 document - Page 41)

entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

FuelEmissionFactorUomId

The fuel emission factor UOM.
First included in: FuelType (this entity)

Properties

NameValue
displayNameFuel Emission Factor UOM ID
descriptionThe fuel emission factor UOM.
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFuel Emission Factor UOM ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe fuel emission factor UOM.
entitya reference to the constant entity holding the list of localized text

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
UnitOfMeasure.cdm.json/UnitOfMeasureUnitOfMeasureId
entitya 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 other identification values.

ParameterValueData typeExplanation
identifier"{58E3EF37-76B9-4095-9BFC-E6DFE8BDE716}"stringThe 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: FuelType (this entity)

Properties

NameValue
displayNameBiogenic Emission Indicator
descriptionIndicates 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.

dataFormatboolean
isNullabletrue

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 other identification values.

ParameterValueData typeExplanation
identifier"{D51143EF-3BA1-4D4F-B93B-2D9FF2FE774B}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBiogenic Emission Indicator
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIndicates 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.

entitya 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: FuelType (this entity)

Properties

NameValue
displayNameBiogenic Emission Factor
descriptionThe percentage of the emission associated with the fuel type that is attributable to being biogenic.
dataFormatdecimal
isNullabletrue

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

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe 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 other identification values.

ParameterValueData typeExplanation
identifier"{F84F6E5C-A435-49D6-A14E-C5CE4B4C1844}"stringThe 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBiogenic Emission Factor
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe percentage of the emission associated with the fuel type that is attributable to being biogenic.
entitya 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: FuelType (this entity)

Properties

NameValue
displayNameFuel Category ID
descriptionThe unique identifier of a Fuel Category.
dataFormatint32
isNullabletrue

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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enFuel Category ID
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Fuel Category.
entitya reference to the constant entity holding the list of localized text

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
FuelCategory.cdm.json/FuelCategoryFuelCategoryId
entitya 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 other identification values.

ParameterValueData typeExplanation
identifier"{1C93F788-6667-4831-BF28-B43771D4B58B}"stringThe 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