Step-by-Step Guide

Technical Guide

QualityLink provides the technical infrastructure to create joint catalogues of learning opportunities. This is a foundational part of a European University Alliance’s virtual inter-university campus and addresses use case 1 (“Discover”) of the European Higher Education Interoperability Framework (HEIF).

As a technical implementer, you’ll be connecting your institution’s learning opportunities to Europe-wide platforms using standard, interoperable formats. This guide provides the technical specifications, implementation options, and step-by-step instructions you need to get your data live.

What are the implementation options?

QualityLink’s modular architecture provides different options for each of the three main layers. The options can be freely combined with each other, i.e. you can choose different approaches for each layer and also combine different approaches within one alliance.

Illustration showing the implementation options at all three layers - Publish: ELM, OOAPI, Edu-API, OCCAPI - Aggregate: hosted instance, own instance or custom aggregator - Public catalogue: hosted platform, own instance of QualityLink platform or custom catalogue
1. Publish information
  1. European Learning Model (ELM) format: you can serve a file with RDF data using the ELM ontology and aligned with the QualityLink application profile.

    Requirements: see the QualityLink application profile

    Validation: use the SHACL validator at https://shacl-play.sparna.fr/play/validate – upload your dataset or enter URL under “Input Data”, select “URL” under “Shapes” and enter https://specs.quality-link.eu/resources/ontology-shacl.ttl

    Benefits: ELM offers maximum semantic richness and direct alignment with European standards; you can generate or export ELM from existing systems

  2. API Implementation: you can implement OOAPI, Edu-API or OCCAPI endpoints to provide course data.

    Requirements: implement at least the required endpoints as specified in the Data Exchange Specification

    Benefits: you can use existing API infrastructure or expose data real-time from existing systems; all data is normalised to ELM during aggregation

NB: you can use one or several standards within an alliance. Even if different alliance members use different standards, all aggregated data is converted to ELM.

2. Aggregate data

There are three deployment options in terms of data aggregation:

  1. Hosted QualityLink aggregator: the QualityLink consortium hosts an aggregator that European higher education institutions or alliancse may freely use.

    ✓ Benefits: this option allows immediate deployment without infrastructure investment; we recommend this option for getting started.

    ✗ Limitations: you have some options to customise the aggregation process and schedule, but cannot adapt the software directly.

  2. Self-deployed aggregator: you can run your own instance of the QualityLink aggregator software since it is open source.

    ✓ Benefits: you can have full control over the aggregation process without any external dependencies and you can customise the software if needed.

    ✗ Limitations: this option requires additional technical expertise and additional resources for infrastructure and maintenance.

  3. Custom aggregator: you can build your own aggregator based on the technical specifications.

    ✓ Benefits: this option allows maximum flexibility and can cater for specific requirements that the QualityLink aggregator cannot meet; it gives full ownership and can be integrated with existing systems.

    ✗ Limitations: this option requires significant own development effort and resources for infrastructure and maintenance.

NB: You can always change from the hosted aggregator to one of the other options at a later stage if needed.

3. Public joint catalogue

There are three approaches how you can publish your joint catalogue:

  1. QualityLink platform: you can use a filtered view of the Europe-wide platform

    ✓ Benefits: this option can be used quickly and immediately once your data is aggregated; as it does not require any own infrastructure or development this is a good option to get started.

    ✗ Limitations: this option only works with the hosted QualityLink aggregator; customisation and alliance branding are limited.

  2. Self-deployed catalogue: you can deploy the QualityLink platform yourself, as it is open source

    ✓ Benefits: this option can be deployed easily on your own infrastructure/private cloud; you can customise the user experience and branding according to your needs.

    ✗ Limitations: it requires some technical expertise and resources for infrastructure and maintenance; customisations require additional development work.

  3. Bespoke development: you can develop and deploy your own public catalogue frontend.

    ✓ Benefits: this option works with all aggregation options and allows full customisation; you could use the API of the QualityLink aggregator or a custom API of your own aggregator.

    ✗ Limitations: this option implies significant development effort and requires resources for development, infrastructure and maintenance.

What are the practical steps?
  1. Publish your learning opportunities data in a supported format: ELM, OOAPI, Edu-API or OCCAPI. See the Data Exchange Specification for details.
  2. Create a manifest file: this is a JSON or YAML file that indicates the type and location of your data source. You can also configure how frequently your data will be refreshed and whether any authentication is necessary. See the Data Source Discovery Specification for details.
  3. Check your domain search order: go to the QualityLink dashboard (launch in September 2025) and review the domain search order for your institution. You will need to place/link the manifest file under/from one of these domains.
  4. Place the manifest file: you have two options where to place the manifest file.
    1. At one of the URLs:
      https://YOUR.DOMAIN/.well-known/quality-link-manifest
      https://YOUR.DOMAIN/.well-known/quality-link-manifest.json

      https://YOUR.DOMAIN/.well-known/quality-link-manifest.yaml
    2. At another URL and to create a DNS TXT record under one of the searched domains, using the value:
      v=qldiscover1; m=https://YOUR.OTHER.DOMAIN/SOME/PATH/…
  5. Trigger aggregation: return to the QualityLink dashboard (launch in September 2025) and trigger aggregation for the first time. The dashboard also allows you to verify that manifest file was found and interpreted correctly.
  6. Lean back and relax: your learning opportunities now appear in the QualityLink pilot platform (launch in the autumn of 2025).