Factor validation fields

Edit online

Field validation logic is applied when you create custom factors.

Table 1 describes the field validation logic that is applied when you create custom factors.

Table 1. Factor validation fields
Field Mandatory? Description
Action Mandatory
The valid values are:
  • CREATE: Create an emission factor. If you are using an old factor and would like to create a new one, make sure to delete the value in the Factor_Link column.
  • UPDATE: Update the factor with your changes. Make sure you do not delete the Factor_Link when you use UPDATE.
Organization Mandatory Do not edit or delete the value in this column. For both CREATE and UPDATE, every row must contain the name of your organization for the record to be processed.
Associate_Link Mandatory Similar to Organization, the Associate_Link ID must be entered in every row for both CREATE and UPDATE.
Factor_Link Mandatory This field is required only for rows where the Action field is set to UPDATE.
Country Optional This field is not required for global emission factors. This field is mandatory for Country, State, or City level factors.

The name of the field must exactly match the values in the IBM® ESG Suite database. A complete list of regions in Envizi ESG Suite can be downloaded from the Creating a custom factor topic.
State Optional

This field is not required for global or country level emission factors. The field is mandatory for State or City level factors.

The name of the field must exactly match the values in the Envizi ESG Suite database. A complete list of regions in Envizi ESG Suite can be downloaded from the Creating a custom factor topic.
City Optional

This field is not required for global, country, or state level emission factors. This field is mandatory for city level factors only.

The name of the field must exactly match the values in the Envizi ESG Suite database. A complete list of regions in Envizi ESG Suite can be downloaded from the Creating a custom factor topic.

Note: If you configured a custom region, you can find the name of that region by navigating to Admin > Custom Regions
Take note of the state and country as those fields are mandatory when providing the city.
Factor Set Mandatory  
Scope Mandatory

As Envizi ESG Suite contains a few data types that exist in more multiple GHG scopes, there is validation on this field.

Valid values include:
  • Scope 1
  • Scope 2
  • Scope 3
  • No Scope
  • Offsets
  • KPI
  • Building Attributes
  • Social Metrics
Data Type Mandatory The data type must be entered exactly as it is in Envizi ESG Suite and the correct scope must also be entered for validation.
Sub Type Optional

This is a rarely used function that can differentiate factors that exist within a data type, region, and factor set for the same time period. An example of this might be various grades of paper or transport fuel grades (92, 95, 98 octane).

If you want to use sub type, contact the Envizi ESG Suite support team.
Name Mandatory  
Description Optional This field is for your records only and there is no validation on this field.
Total CO2e(kgCO2e/unit) Optional This field is the value on which all emissions are calculated. If this value is omitted, then emissions are not be calculated for data linked to this factor.
CO2(kgCO2e/unit) Optional This value is only available in the Emissions Performance dashboard.
CH4(kgCO2e/unit) Optional This value is only available in the Emissions Performance dashboard.
Note: You may encounter an error if your file contains very small numbers that result in scientific notation, for example, 3.413E-05. To fix and avoid this error, format all columns that contain numeric values, where at least 1 value is shown as scientific notation, as 'number' with 8 decimals.
N2O(kgCO2e/unit) Optional This value is only available in the Emissions Performance dashboard.
BioCO2 Optional This value is only used in extract reports.
Indirect CO2e(kgCO2e/unit) Optional

This value is only available in the Emissions Performance dashboard.

This is also sometimes known as the Well-to-tank (WTT) conversion factor and refers to the upstream Scope 3 emissions associated with extraction, refining and transportation of the raw fuel sources before consumption in their intended activity. In the case of electricity, it can also refer to the downstream Scope 3 emissions associated with grid losses from transmission and distribution, that is, the energy loss that occurs in getting the electricity from the power plant to the organization that purchases it.
Energy(GJ)/unit Optional This value is needed to show energy in reports and dashboards. For example, if the factor being entered is measured in kWh, the conversion is 0.0036 GJ/kWh.
Mass(Kg)/unit Optional This value is needed to show mass in reports and dashboards. For example, if the factor being entered is measured in lbs, the conversion is 0.453592 kg/lbs.
Volume(L)/unit Optional This value is needed to show volume in reports and dashboards. For example, if the factor being entered is measured in m3, the conversion is 1000 L/m3.
Area(m2)/unit Optional This value is needed to show area in reports and dashboards.
Distance(m)/unit Optional This value is needed to show distance in reports and dashboards.
Effective_From Optional This is required to determine the starting effective period of the factor. If left blank the factor will apply for all time into the past.
Effective_To Optional This is required to determine the starting effective period of the factor. If left blank the factor will apply for all time into the future.
Published_From Optional This is required to determine the starting effective period of the factor according to when the factor was published. If left blank, the factor will apply for all time into the past. For more information, see the Assigning factors topic.

If your organization does not apply factors based on when they were published, then this field should contain the same value as Effective_From.
Published_To Optional This field is required to determine the starting effective period of the factor according to when the factor was published. If the field is blank, the factor will apply for all time into the future. For more information, see the Assigning factors topic.

If your organization does not apply factors based on when they were published, then this field should contain the same value as Effective_To.
Review_On Optional This field is for your records only and there is no validation on this field.
Factor_Source Optional This field is for your records only and there is no validation on this field.
Notes Optional This field is for your records only and there is no validation on this field.