Skip to main content

Packages & Entities

The model has 47 entities in 14 packages. Each package corresponds to a clause of the Recommendation (8.1 – 8.14), and each entity to an entry of its Annex A. Every entity page of the reference lists the attributes with their types, the property of the ontology each one is bound to, the constraints and an example.

How the entities relate​

Foreign keys are named <entity>Id. The main containment structure:

Organization
├─ User ── AccessAssignment ── Role access per farm, optionally time-limited
├─ Worker a person who works, with or without an account
└─ Farm
├─ Site barns, silos, farmyards …
├─ Field ── Region GeoJSON boundaries; regions nest
│ ├─ CultivationPeriod ── Activity ── ActivityResource, InputOutput
│ ├─ Stand perennial plantings
│ └─ CroppingPlanEntry ── CroppingPlan
├─ Task ─────────────▶ Activity planned work → work carried out
├─ Machine ── MaintenanceRecord
├─ AnimalGroup ── Animal, AnimalEvent, FeedRation
├─ Device ── Observation sensors; Data ── File for datasets
├─ StorageLocation ── StockMovement ── Lot ── Product
└─ Budget, Certification, RegulatoryReport

Across the whole model:

  • ProcessingService → ProcessingJob → Result — the provenance of automatic work
  • AuditLog — the append-only record of changes
  • CodeMapping — canonical concept ↔ code of an external scheme

A few structural ideas are worth knowing before reading the tables:

  • Regions are the unit of work. A Field always has exactly one default region whose geometry corresponds to the field (rule V05). Cultivation periods, stands, plan entries, observations and activities attach to regions, and regions may nest through parentRegionId.
  • Planning and execution are separate. CroppingPlanEntry and Task say what is intended; CultivationPeriod and Activity say what happened. The ValueType enumeration (PLANNED, ACTUAL, ESTIMATION, PREDICTION) does the same for individual values.
  • Polymorphic references are exclusive. Observation, Data, InputOutput, Economics, AnimalEvent, ActivityResource and ProcessingJobInput can attach to several kinds of parent; exactly one reference is set (rule V03).
  • Automatic work is accountable. Every run of a service is a ProcessingJob. Records the run creates are marked SERVICE, DEVICE or IMPORT in originType and carry createdByJobId, so the service responsible follows from the job (ProcessingJob.serviceId).
  • Time series stay outside. High-frequency data lives in a time-series or SensorThings service; a Device points there with sensorThingsUrl.
  • Derived views are computed, never stored — stock levels, gross margin, nutrient balance, animal performance indicators, crop rotation (see Rules & state models).

The packages​

P1 · Party, Users and Access​

Clause 8.1 of the Recommendation. Multi-tenancy, roles and access, personnel master data.

EntityRepresentsReference page
OrganizationA legal entity: farm business, cooperative, contractor, adviser, laboratory, authority … — the top-level container within a deploymentOrganization
UserA person with an account; the e-mail address is the login identityUser
WorkerA person who works on the holding, with or without a system accountWorker
AddressThe postal address of an organization or a farmAddress
RoleA named set of permissions for role-based access controlRole
AccessAssignmentGrants a role to a user for one farm, optionally limited in timeAccessAssignment

P2 · Farm and Sites​

Clause 8.2 of the Recommendation. Holding structure, built and technical locations.

EntityRepresentsReference page
FarmAn agricultural operation; the main container and the unit access rights are assigned toFarm
SiteA built or technical location: barn, greenhouse, silo, farmyard, shed …Site

P3 · Fields and Geospatial Data​

Clause 8.3 of the Recommendation. Field boundaries, management zones, spatial reference.

EntityRepresentsReference page
FieldA contiguous parcel of land with a GeoJSON boundaryField
RegionA defined area within a field — the default region, management zones, experimental plots or areas with particular characteristicsRegion

P4 · Cropping Planning and Cultivation​

Clause 8.4 of the Recommendation. Crop planning, crop rotation, perennial plantings, cultivation cycles.

EntityRepresentsReference page
CroppingPlanA versioned cropping plan for a harvest yearCroppingPlan
CroppingPlanEntryThe crop intended on a regionCroppingPlanEntry
StandA perennial planting such as an orchard or a vineyardStand
CultivationPeriodThe cultivation of a crop on a region over a period of timeCultivationPeriod

P5 · Work and Operations Management​

Clause 8.5 of the Recommendation. Work orders, field record keeping, resource deployment, working time.

EntityRepresentsReference page
TaskWork that is planned or ordered and not yet carried outTask
ActivityAn operation that has been carried out: tillage, sowing, application, harvest …Activity
ActivityResourceA machine or a person deployed in an activityActivityResource
TimeRecordWorking time, including absence and leaveTimeRecord

P6 · Products and Inventory​

Clause 8.6 of the Recommendation. Inputs and produce, lots, stock movements, traceability.

EntityRepresentsReference page
ProductMaster data of an input or of produceProduct
StorageLocationA place at which products are heldStorageLocation
LotA quantity of a product treated as one traceable unitLot
StockMovementA movement of stock; stock levels are derived from itStockMovement

P7 · Machinery and Equipment​

Clause 8.7 of the Recommendation. Fleet management, machine identity, maintenance.

EntityRepresentsReference page
MachineA machine or an implementMachine
MaintenanceRecordMaintenance, inspection or repair of a machineMaintenanceRecord

P8 · Animal Husbandry​

Clause 8.8 of the Recommendation. Herd and animal management, animal events, feeding.

EntityRepresentsReference page
AnimalAn individual animalAnimal
AnimalGroupA herd, a group or the occupancy of a penAnimalGroup
AnimalEventAn occurrence relating to an animal or a groupAnimalEvent
FeedRationA planned ration for a group of animalsFeedRation
FeedRationComponentOne component of a rationFeedRationComponent

P9 · Observations and Data​

Clause 8.9 of the Recommendation. Sensors, weather, measurements, datasets and files.

EntityRepresentsReference page
DeviceA sensor, equipment or a station, described as a Thing (W3C WoT)Device
ObservationThe value of an observed property for a feature of interest at a stated timeObservation
DataA container for a dataset or a data stream — imagery, laboratory reports, yield maps …Data
DataTypeAn extensible categorization of datasetsDataType
FileA single file belonging to a datasetFile

P10 · Economics​

Clause 8.10 of the Recommendation. Quantities, monetary valuation, budgets, gross margin.

EntityRepresentsReference page
InputOutputA quantity consumed or producedInputOutput
EconomicsA monetary value attached to a quantity, a stock movement or a deployed resourceEconomics
BudgetPlanned values for a scope and a periodBudget

P11 · Compliance and Audit​

Clause 8.11 of the Recommendation. Regulatory reporting, certification, change history.

EntityRepresentsReference page
RegulatoryReportA versioned report generated from operational data for an authority or certification bodyRegulatoryReport
CertificationA certification held by the holdingCertification
AuditLogAppend-only record of changes to records — read-only through the APIAuditLog

P12 · Data Processing and Decision Support​

Clause 8.12 of the Recommendation. Processing services and runs, analytics, decision support, provenance anchor.

EntityRepresentsReference page
ServiceCatalogueA registry of available processing servicesServiceCatalogue
ProcessingServiceA service that can be invoked to process dataProcessingService
ProcessingJobOne run of a service — the reference point of provenanceProcessingJob
ProcessingJobInputThe data processed by a runProcessingJobInput
ResultThe output of a runResult

P13 · Sustainability​

Clause 8.13 of the Recommendation. Environmental and sustainability indicators, monitoring, reporting and verification.

EntityRepresentsReference page
SustainabilityIndicatorA sustainability indicator for a farm, field, region, cultivation period, animal group or product lotSustainabilityIndicator

P14 · Semantics and Interoperability​

Clause 8.14 of the Recommendation. Binding of canonical concepts to external code systems.

EntityRepresentsReference page
CodeMappingThe correspondence between a canonical concept and a code of an external schemeCodeMapping

Keys that identify a record in the real world​

Besides the UUID, some entities have a business key that must be unique (violations are refused as duplicate-key, see Errors).

EntityUniqueScope
Useremailthe deployment
FarmfarmNumberthe deployment, where set
Fieldnamewithin farmId
Regionexactly one default regionper fieldId (rule V05)
AnimalofficialIdwithin externalProvider, i.e. the official numbering scheme
LotlotNumberwithin productId, together with the origin reference for own production
ProductregistrationNumberthe authorisation scheme concerned
CodeMappingconceptUri, externalScheme, externalCodethe deployment; at most one mapping per concept and scheme is isPreferred

See it in action​