Schema

Input

Type: Blank Node


An Input used during the Cycle or Transformation. Each Input must be unique, and the fields which determine uniqueness are defined in the inputs field of the Cycle or Transformation.


Field Type Required Definition
term Term Yes

A reference to the Term describing the Input.

description string No

A description of the Input.

value array[number|null] No

The quantity of the Input. If an average, it should always be the mean. Can be a single number (array of length one) or an array of numbers with associated dates (e.g., representing an application schedule).

sd array[number|null] No

The standard deviation of value.

min array[number|null] No

The minimum of value.

max array[number|null] No

The maximum of value.

statsDefinition string No

What the descriptive statistics (sd, min, max, and value) are calculated across, or whether they are simulated or the output of a model. spatial refers to descriptive statistics calculated across spatial units (e.g., pixels) within a region or country. time refers to descriptive statistics calculated across units of time (e.g., hours).

Possible values are: sites, cycles, replications, other observations, time, spatial, regions, simulated, modelled

observations array[number|null] No

The number of observations the descriptive statistics are calculated over, if different from the numberOfCycles specified in Cycle.

dates array[string] No

A corresponding array to value, representing the dates of the Inputs in ISO 8601 format (YYYY-MM-DD, YYYY-MM, YYYY, --MM-DD, or --MM).

startDate string No

For Inputs over periods different to Cycle, the start date of the Input (if different from the start date of the Cycle) in ISO 8601 format (YYYY-MM-DD).

endDate string No

For Inputs over periods different to Cycle, the end date of the Input (if different from the end date of the Cycle) in ISO 8601 format (YYYY-MM-DD).

inputDuration number No

The duration of the Input in days.

methodClassification string No

A classification of the method used to acquire or estimate the term and value. Overrides the defaultMethodClassification specified in the Cycle. methodClassification should be specified separately for properties (see Property) and transport (see Transport).

  • physical measurement means the amount is quantified using weighing, volume measurement, metering, chemical methods, or other physical approaches.
  • verified survey data means the data are initially collected through surveys; all or a subset of the data are verified using physical methods; and erroneous survey data are discarded or corrected.
  • non-verified survey data means the data are collected through surveys that have not been subjected to verification.
  • modelled means a previously calibrated model is used to estimate this data point from other data points describing this Cycle.
  • estimated with assumptions means a documented assumption is used to estimate this data point from other data points describing this Cycle.
  • consistent external sources means the data are taken from external datasets referring to different producers/enterprises:
    • Using the same technology (defined as the same System or the same key Practices as those specified in the Cycle);
    • At the same date (defined as occurring within the startDate and endDate of the Cycle); and
    • In the same region or country.
    Modelling or assumptions may have also been used to transform these data.
  • inconsistent external sources means the data are taken from external datasets referring to different producers/enterprises:
    • Using a different technology (defined as a different System or using different key Practices to those specified in the Cycle);
    • At a different date (defined as occurring within the startDate and endDate of the Cycle); or
    • In a different region or country.
    Modelling or assumptions may have also been used to transform these data.
  • expert opinion means the data have been estimated by experts in the field.
  • unsourced assumption means the data do not have a clear source and/or are based on assumptions only.

Possible values are: physical measurement, verified survey data, non-verified survey data, modelled, estimated with assumptions, consistent external sources, inconsistent external sources, expert opinion, unsourced assumption

methodClassificationDescription string No

A justification of the methodClassification used. If the data were estimated with assumptions this field should also describe the assumptions. This is a required field if methodClassification is specified.

model Term No

A reference to the Term describing the model used to estimate these data.

modelDescription string No

A free text field, describing the model used to estimate these data.

isAnimalFeed boolean No

true if this Input is fed to animals. A required field for Inputs which could potentially be animal feed (defined as Inputs of termType = crop, liveAnimal, animalProduct, or liveAquaticSpecies in animal production Cycles).

fromCycle boolean No

A required field for Inputs into Transformations only. true if this Input is a Product from the Cycle. false if this Input was added at the Transformation stage only (e.g., diesel used to power a grain dryer) or false if this Input is a Product from a previous Transformation.

price number No

The price paid for this Input. The price should be expressed per the units defined in the term, for example per "kg active ingredient". The currency must be specified.

priceSd number No

The standard deviation of price.

priceMin number No

The minimum of price.

priceMax number No

The maximum of price.

priceStatsDefinition string No

What the descriptive statistics for price are calculated across.

Possible values are: cycles, time, cycles and time

cost number No

The total cost of this Input (price x quantity), expressed as a positive value. The currency must be specified.

costSd number No

The standard deviation of cost.

costMin number No

The minimum of cost.

costMax number No

The maximum of cost.

costStatsDefinition string No

What the descriptive statistics for cost are calculated across.

Possible values are: cycles, time, cycles and time

currency string No

The three letter currency code in ISO 4217 format.

operation Term No

A reference to the Term describing the operation associated with this input (e.g., for the Input diesel the operation could be Soil decompaction, machine unspecified).

country Term No

The country where this Input came from.

region Term No

The region where this Input came from.

impactAssessment ImpactAssessment No

A reference to the node containing environmental impact data related to producing this product and transporting it to the Site.

impactAssessmentIsProxy boolean No

The impactAssessment referred to represents data from the actual supply chain (e.g., data from the actual supplying farm or the supplying feed mill). Set to false
The impactAssessment referred to is a proxy for the actual supply chain (e.g., global or regional average data). Set to true

Required if impactAssessment is specified.

source Source No

A reference to the Source of these data, if different from the defaultSource of the Cycle.

properties List[Property] No

A list of Properties of the Input, which would override any default properties specified in the term.

properties cannot be duplicated. The following fields determine whether a Property is unique: term.@id, key.@id

transport List[Transport] No

A list of Transport stages to bring this Input to the Cycle.

transport cannot be duplicated. The following fields determine whether a Transport is unique: term.@id, value, distance


Internal Properties

The following properties are automatically set when data are uploaded to the Hestia platform. If they are included in a file which is uploaded, they will be overwritten.

Field Type Definition
@type string Input
schemaVersion string

The version of the schema when these data were created.

added array[string]

A list of fields that have been added to the original dataset.

addedVersion array[string]

A list of versions of the model used to add these fields.

updated array[string]

A list of fields that have been updated on the original dataset.

updatedVersion array[string]

A list of versions of the model used to update these fields.

aggregated array[string]

A list of fields that have been 'aggregated' using data from multiple Cycles.

aggregatedVersion array[string]

A list of versions of the aggregation engine corresponding to each aggregated field.


Example 1