What does it mean to implement ?

This page outlines the technical considerations for platforms joining the UK Food Data Collaboration Commons.

There are other considerations for partners in the FDC Commons:

  • We require partner organisations to align with the values outlined in our Vision and Mission, listed on our About page.
  • We also invite all platform partners to consider whether they’d be willing (and have capacity) to participate in our Governance circle.
  1. Background

The UK Food Data Collaboration project aims to leverage the work of the (French-initiated) Data Food Consortium (DFC) project. This project is defining an interoperability web standard for short supply chain food data.

The documentation of the DFC standard, including information on its evolution and documentation of various decisions that have been taken along the way is available on gitbook: https://datafoodconsortium.gitbook.io/dfc-standard-documentation/ 

A lot of useful information relating to the DFC project and standard are available on their GitHub homepage.

  • Ontology

The Data Food Consortium has defined an ontology that we align to. The DFC ontology provides a general knowledge framework that maps the concepts used within Short Foodchain Systems in a machine readable format. It is a more logically rigorous form than an application Model but for our purposes it can be thought of as similar.

It is not necessary to understand the ontology in order to implement. 

However, if you’d like to take a look, the technical details of the ontology are available here:

  • The source of truth for the ontology is the DFC Github repository. Files are also published (on release) to the DFC website: https://docs.datafoodconsortium.org/ontology/  
  • The latest pre-release/development version can be found in the NextOntology branch. Consult with the FDC team to confirm which branch of the ontology you need, as they correspond to difference versions of the standard.
  • Taxonomies (product type, units etc…) can be found in a separate repository. They can also be viewed/edited on the DFC site, using the SHowVOC tool.
  • If you need to enhance/enrich any of the Taxonomies, you can propose changes through the Vocbench tool.

Some useful tools for viewing/understanding ontologies:

  • Prototype

The Data Food Consortium have also built a prototype, this facilitates product data testing for platforms and is currently the primary interface between the systems – as per the DFC standard

In the longer term it is intended that any member of the Data Commons will be able to directly push reads and changes (record create, update and delete statements), for the data they own and control, to all other platforms within the Commons, via a JSON-LD API that conforms to the DFC ontology. 

The prototype provides an intermediary step to facilitate systems debugging their interfaces and further development of the standard. The prototype is published under an MIT licence and code is available on github. The current instance of the prototype is available here: https://proto.datafoodconsortium.org/ 

  1. FDC Phase 1 

There are 3 major technical steps in Phase 1 (the currently funded phase) of the FDC project:

  • Interface the platforms with an Open ID Connect (OIDC) provider: currently the DFC project manages a realm on the Les Communs (website in French) Keycloak server.
    • This involves implementing OIDC interface technology within the platform. Further information on this can be found here, briefly:
      • Your platform will need to be authorised to connect to the DFC realm of Les Communs and supplied with a client id & secret.
      • Other configuration required to connect to the DFC OIDC realm can be found here.
      • Within FDC we are utlising signed JWT tokens in the authorization header.
      • Your platform will need to integrate Open ID Connect functionality.
        • You will need to support the following:
          • Authentication & Authorization Flows
          • Logout Flows
          • Refresh Token Flow
          • Secure storage of Access & Refresh Tokens
      • A good primer for OIDC can be found here. Also more detail on Oauth flows (including Refresh Flow) here.
      • There are supported libraries in all major programming languages & web application frameworks. A list of certified OIDC libraries can be found on the website here, and there are some uncertified libraries also available. Care should be taken to ensure any library selected supports all required functionality.
  • A producer or hub user on your platform will need to be able to either:
    • Login & set-up a hub/supplier account with a Les Communs ID, or
    • Link an existing producer/hub account to an OIDC account provided by Les Communs.
    • It is not necessary for shoppers/customers to have access to the OIDC logins or a Les Communs account. Although if you wish to support that on your platform, that’s fine.
  • Users must also be able to opt out of data sharing via the FDC.
    • This requirement would be supported by using the link/delink existing accounts on your platform strategy outlined above.
  • In addition FDC Commons Governance requires all platforms to have the ability to exclude individual users from the Commons (in cases of extreme or repeated breaches of Commons Rules). The FDC does not seek to control who can or cannot use individual platforms, however we have a duty to protect the integrity of the Commons.
    • This could take the form of a superadmin override that allows you to restrict access to the OIDC functionality/account linking.
    • If you wish to allow users to create accounts with Les Communs IDs, it may be more complex to implement these controls whilst continuing to allow banned users to access your platform.
    • This functionality potentially overlaps with the functionality required for the planned pilot roll-outs to specific geographic areas/subsets of users.
  • Create and publish a CRUD API for Products (Supplied Products and Catalog Items in DFC terms) data utilising the DFC JSON-LD standard (example here).
    • Including:
      ❇ A bulk GET of all Products (for all Enterprises linked to a User)
      ❇ Create an individual Product (for a specific Enterprise and User)
      ❇ Read an individual Product (for a specific Enterprise and User)
      ❇ Update an individual Product (for a specific Enterprise and User)
      ❇ Delete an individual Product (for a specific Enterprise and User) 
    • The API will need to be authenticated against an OIDC user, and access control managed so that only products controlled by that user are visible/updateable.
    • The API responsiveness will need to be within agreed timeliness and availability criteria (these are to be agreed with Tech Partners).
    • An example API specification for DFC endpoints is available here.This is currently a work in progress and covers more than is required for this phase of work, contact FDC for clarification.
  • Exposure (and consumption) of Product data from anywhere else in the Food Data Collaboration Commons within the platform’s shopfront.
    • Enabling querying of DFC Product data from other platforms
    • Displaying that data in the shopfront of your platform
    • Ensuring any caching (for performance) is managed, esp. within checkout processes such that only up to date stock is sold from any source platform.
    • Ensuring any stock updates (sales and returns) are pushed to the source platform within the commons in a timely manner (SLA’s will be agreed within the Technical working group).
  • To prove integrations are working, we currently use the DFC Prototype. Your test server will need to interface with this prototype to verify your API is working correctly.
    • You will need to provide the URL for your bulk product GET endpoint, we will configure Keycloak access and provide the Client ID & Secret.
    • The prototype will bulk import product data from your platform.
    • Products can be edited and manually linked to products from other platforms.
    • The prototype can push data updates to platforms (e.g. a linked product can have description and/or stock updates pushed to align multiple platforms)
  • The UK-FDC Platforms are currently implementing standard version v1.9:  
  • The Data Food Consortium have developed a Connector Tool – which utilises Acceleo to generate code libraries to facilitate implementation of the DFC Ontology as a Model within applications. See a short (and old) demo here.
  • This library allows an application to access the DFC structures as any other model object – create and populate instances of the various classes in the ontology and output as JSON-LD, compliant with the DFC standard. It is recommended platforms implement utlising these libraries.
    • Currently releases include:
    • Other languages would be implementable (using a code generator) with development costs (typically 1-2 days) being borne by the associated project.
    • Tutorials on utilising these tools will follow soon and pacakges will be published on appropriate code repositories (e.g. NPM, Rubygems etc…)

Implementation

The FDC project is currently funded to perform several pilots within the UK. The first pilot is with Hodmedods, testing our advanced Orders functionality (beyond the scope outlined here) within Shopify. The second pilot will involve linking Shopify Producer stores with Open Food Network hubs for integrated Ordering.

A further, regional pilot is still to be confirmed. This has implications for platforms – specifically they must be able to turn on/off the DFC functionality (or access to it) for specific regions/hubs/users.

Conclusion

So, a brief overview of the journey…

  • Implement the Open ID Connect functionality to enable your platform to authenticate across the commons
  • Expose your data in a REST API that fits the DFC Standard
  • Consume the same data from other platforms in your shopfront
  • Test this functionality using the DFC Prototype
  • Engae with our pilots

We hope you’re inspired to join us on this journey. We anticipate more complexity and will update this (and other documents) with more accurate information based on our findings and failures as we progress. We believe this digital infrastructure has the potential to change the face of local food systems in the UK (and beyond) – if you agree please get in touch.