SustnUomConversion

Represents information about the unit of measure (UOM) conversion for the custom fuel types defined by a customer in an org.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

SustnUomConversion components have the suffix sustnUomConversion and are stored in the sustnUomConversions folder.

Version

SustnUomConversion components are available in API version 57.0 and later.

Special Access Rules

The Net Zero Cloud permission set license is required to access this object along with the user access for carbon accounting and org access for custom fuels and UOMs.

Fields

Field Name Description
conversionFactor

Field Type: double

Description:

Required.

The conversion factor that's used to convert values from one unit of measure to another for the fuel type.

fuelType

Field Type: string

Description:

The name of the fuel type.

Possible values are:
  • AutogasLPG
  • Biodiesel
  • Biomass
  • CityGas
  • CompressedNaturalGasCNG
  • Cooling
  • Diesel
  • Electricity
  • Ethanol
  • FuelOil
  • Gasoline
  • Heat
  • HeavyOil
  • ITElectricity
  • JetFuel
  • Kerosene
  • LightOil
  • LiquidNaturalGasLNG
  • MobileDiesel
  • NaturalGas
  • Propane
  • Refrigerant
  • Steam
isProtected

Field Type: boolean

Description: An auto-generated value that doesn’t impact the behavior of the metadata type.

The default value is false.

masterLabel

Field Type: string

Description: A user-friendly name for SustnUomConversion, which is defined when the SustnUomConversion is created.

sourceUom

Field Type: string

Description:

Required.

The source unit of measure for the fuel type.

Possible values are:
  • 1000m3
  • GJ
  • GWh
  • Kiloliters
  • Liters
  • MJ
  • MMBtu
  • MWh
  • Therms
  • Tonnes
  • UkGallons
  • UsGallons
  • ccf
  • kG
  • kWh
  • kcal
  • lbs
  • longTons
  • m3
  • shortTons
targetUom

Field Type: string

Description:

Required.

The target unit of measure for the fuel type.

uomsKey

Field Type: string

Description: The key associated with a unit of measure for the fuel type.

Declarative Metadata Sample Definition

The following is an example of a SustnUomConversion component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SustnUomConversion xmlns="http://soap.sforce.com/2006/04/metadata">
3    <conversionFactor>0.9</conversionFactor>
4    <fuelType>Diesel</fuelType>
5    <isProtected>false</isProtected>
6    <masterLabel>KG_Liters</masterLabel>
7    <sourceUom>KG</sourceUom>
8    <targetUom>Liters</targetUom>
9    <uomsKey>uomsKey</uomsKey>
10</SustnUomConversion>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fullName>Pkg</fullName>
4    <types>
5        <members>US_UK_Gallons</members>
6        <members>Therms_kWh</members>
7        <members>KG_Liters</members>
8        <name>SustnUomConversion</name>
9    </types>
10    <version>57.0</version>
11</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.