Cycle>Product

Product


Type:Blank Node


A Product created during a Cycle or Transformation. Each Product must be unique, and the fields which determine uniqueness are defined in the products field of the Cycle or Transformation.


FieldTypeRequiredDefinition
term
TermYes

A reference to the Term describing the Product.

This field has additional validation rules when set:

  • the term.termType must have one of the following values: animalProduct, crop, aquaticCrop, cropResidue, electricity, feedFoodAdditive, forage, fuel, liveAnimal, liveAquaticSpecies, excreta, organicFertiliser, inorganicFertiliser, biochar, otherOrganicChemical, otherInorganicChemical, processingAid, processedFood, seed, soilAmendment, substrate, material, waste.

description
stringNo

A short description of the Product.

variety
stringNo

The variety (cultivar) of a crop or breed of animal. Standardised variety names are defined in external glossaries, such as the OECD, GEVES, PLUTO, or CPVO glossaries.

value
array[number|null]No

The quantity of the Product. 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., for multiple harvests in one Cycle. For crops, value should always be per harvest or per year, following FAOSTAT conventions.

distribution
array[number]|array[array[number]]No

An array of up to 1000 random samples from the posterior distribution of valuedates field.

sd
array[number|null]No

The standard deviation of value.

This field has additional validation rules when set:

  • statsDefinition must also be set.

min
array[number|null]No

The minimum of value.

This field has additional validation rules when set:

  • statsDefinition must also be set.

max
array[number|null]No

The maximum of value.

This field has additional validation rules when set:

  • statsDefinition must also be set.

statsDefinition
stringNo

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, animals, other observations, time, spatial, regions, simulated, modelled

This field has additional validation rules when set:

  • one of the following must be valid:
    • value must also be set.
    • min must also be set.
    • max must also be set.
    • sd must also be set.

observations
array[number|null]No

The number of observations the descriptive statistics are calculated over.

dates
array[string]No

A corresponding array to value, representing the dates of the Products in ISO 8601 format (YYYY-MM-DD, YYYY-MM, YYYY, --MM-DD, --MM, or YYYY-MM-DDTHH:mm:ssZ).

startDate
stringNo

For Products created over periods, the start date of the Product if different from the start date of the Cycle in ISO 8601 format (YYYY-MM-DD, YYYY-MM, or YYYY).

endDate
stringNo

For Products created over periods, the end date of the Product if different from the end date of the Cycle in ISO 8601 format (YYYY-MM-DD, YYYY-MM, or YYYY).

methodClassification
stringNo

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

This field has additional validation rules when set:

  • methodClassificationDescription must also be set.

methodClassificationDescription
stringNo

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
TermNo

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

This field has additional validation rules when set:

  • the model.termType must have one of the following values: model.

modelDescription
stringNo

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

fate
stringNo

The fate of the Product. Use Transformations where possible to represent the conversion of one Product into another.

Possible values are: sold, sold to export market, sold to domestic market, sold for breeding, sold for fattening, sold for slaughter, home consumption, fodder, bedding, breeding, saved for seeds, processing, burnt for fuel, burnt, anaerobic digestion, composted, used as fertiliser, used as soil amendment, used as mulch

price
numberNo

The sale price of this Product. The price should be expressed per the units defined in the term, for example per "kg liveweight". The currency must be specified.

This field has additional validation rules when set:

  • currency must also be set.

priceSd
numberNo

The standard deviation of price.

This field has additional validation rules when set:

  • priceStatsDefinition must also be set.

priceMin
numberNo

The minimum of price.

This field has additional validation rules when set:

  • priceStatsDefinition must also be set.

priceMax
numberNo

The maximum of price.

This field has additional validation rules when set:

  • priceStatsDefinition must also be set.

priceStatsDefinition
stringNo

What the descriptive statistics for price are calculated across.

Possible values are: cycles, time, cycles and time

revenue
numberNo

The total revenue (price x quantity) of this Product. The currency must be specified.

This field has additional validation rules when set:

  • currency must also be set.

revenueSd
numberNo

The standard deviation of revenue.

This field has additional validation rules when set:

  • revenueStatsDefinition must also be set.

revenueMin
numberNo

The minimum of revenue.

This field has additional validation rules when set:

  • revenueStatsDefinition must also be set.

revenueMax
numberNo

The maximum of revenue.

This field has additional validation rules when set:

  • revenueStatsDefinition must also be set.

revenueStatsDefinition
stringNo

What the descriptive statistics for revenue are calculated across.

Possible values are: cycles, time, cycles and time

currency
stringNo

The three letter currency code in ISO 4217 format.

economicValueShare
numberNo

The economic value (typically revenue) of this Product, divided by the total economic value of all Products, expressed as a percentage.

primary
booleanNo

Where the are multiple products, whether this product is the primary product. Defaults to true if there is only one product or if economicValueShare > 50.

source
SourceNo

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

otherSources
List[Source]No

A list of references to any other sources of these data.

properties
List[Property]No

A list of Properties of the Product, which would override any default properties specified in the term. For crops, dry matter is a default property of the Term and can be changed by adding dry matter here.

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

transport
List[Transport]No

A list of Transport stages to take this Product to the final location within the Site. For example, the Transport required to take harvested crops from the field to the barn where they are stored before being sold.

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.

FieldTypeDefinition
@context

The location of the JSON-LD context file.

@id

The unique ID assigned to the Node by HESTIA.

@type

Product

percentile10th
number

The 10th percentile of value.

percentile90th
number

The 90th percentile of value.

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.

revenueRatio
number

The ratio of the total revenue (adjusted price x <\code>quantity) of this Product compared to the Product that is the focus of the aggregation. The adjusted price is the price of the Product divided by the price of the Product that is the focus of an aggregation.


Example 1

{
  "@type": "Product",
  "term": {
    "@id": "wheatGrain",
    "@type": "Term",
    "name": "Wheat, grain",
    "units": "kg",
    "termType": "crop"
  },
  "value": [
    7282
  ],
  "economicValueShare": 94.8,
  "properties": [
    {
      "@type": "Property",
      "term": {
        "@id": "dryMatter",
        "@type": "Term",
        "name": "Dry matter",
        "units": "%",
        "termType": "property"
      },
      "value": 80
    }
  ]
}