xAPI Registry

About the registry

This registry is an open, reliable source for xAPI definitions, maintained and extended by the community. It grew out of the registry of the Learning Technologies Research Group (Informatik 9) at RWTH Aachen University and is continued in the OmiLAXR ecosystem.

All definitions live as JSON files in the definitions repository. This site is built from it on every change. The file path is part of the IRI: https://omilaxr-ecosystem.github.io/xapi/definitions/<context>/<type>/<name>. Renaming or moving a file therefore changes the IRI and breaks existing statements.

Rules for definitions

  • Contexts are folders. Each one contains subfolders for the xAPI vocabulary: verbs, activities, extensions.
  • Contexts should provide semantic clarity, but not become overly specific.
  • Definitions are JSON files with at least name and description as language maps.
  • English (en-US) is the common denominator and fallback. Further languages are welcome.
  • Reference existing, similar or identical definitions elsewhere with exactMatch, closeMatch or relatedMatch, following the xAPI profile syntax.
  • Enriching definitions with further meta information is encouraged; this site shows every field.

Contributing

Fork the repository, add or change definition files and open a pull request. See CONTRIBUTING.md for the conventions and docs/concept.md (German) for the background of the project.

For machines

Why GitHub

Since version 2.0.0 the registry lives entirely on GitHub: the definitions in a public repository, this website on GitHub Pages. An identifier has to outlive projects, funding periods and server contracts, and this setup is more durable than a server run by a single institute:

  • No server of our own has to be operated, updated or paid for. The website is static and rebuilt from the repository on every change.
  • Every change to a definition is versioned and publicly traceable, down to the commit that introduced it.
  • Anyone can fork or mirror the repository. The definitions stay available even if this site is moved.
  • Maintenance does not depend on one person or institution; new maintainers only need access to the repository.

The IRIs therefore use the address of this site, https://omilaxr-ecosystem.github.io/xapi/. Definitions that existed before kept their former IRI under https://xapi.elearn.rwth-aachen.de/ as an exactMatch, so statements recorded with the former IRIs can still be mapped.

Origin and citation

The registry was started by the Learning Technologies Research Group at RWTH Aachen University. The original registry is hosted at xapi.elearn.rwth-aachen.de. The concept and the surrounding learning analytics infrastructure are described in the following paper. Please cite it if you use the registry in your research:

Heinemann, B., Ehlenz, M., Görzen, S., & Schroeder, U. (2022). xAPI Made Easy: A Learning Analytics Infrastructure for Interdisciplinary Projects. International Journal of Online and Biomedical Engineering (iJOE), 18(14), 99–113. https://doi.org/10.3991/ijoe.v18i14.35079

Acknowledgement

We thank everyone at the Learning Technologies Research Group (Informatik 9) of RWTH Aachen University who created the original registry, its concept and its definitions. The development of the original registry was partially funded there by the Federal Ministry of Education and Research (BMBF) in the joint project Open Digital Lab 4 you (grant no. 16DHB2114).

Über die Registry

Diese Registry ist eine offene, zuverlässige Quelle für xAPI-Definitionen, die gemeinsam von der Community gepflegt und erweitert wird. Sie ging aus der Registry des Lehr- und Forschungsgebiets Informatik 9 der RWTH Aachen hervor und wird im OmiLAXR-Ecosystem weitergeführt.

Alle Definitionen liegen als JSON-Dateien im Definitions-Repository. Diese Seite wird bei jeder Änderung daraus gebaut. Der Dateipfad ist Teil der IRI: https://omilaxr-ecosystem.github.io/xapi/definitions/<kontext>/<typ>/<name>. Wer eine Datei umbenennt oder verschiebt, ändert also die IRI, und bestehende Statements passen nicht mehr.

Regeln für Definitionen

  • Kontexte sind Ordner. Jeder enthält Unterordner für das xAPI-Vokabular: verbs, activities, extensions.
  • Kontexte sollen semantische Eindeutigkeit herstellen, aber nicht übermäßig spezifisch werden.
  • Definitionen sind JSON-Dateien mit mindestens name und description als Language Map.
  • Englisch (en-US) ist der gemeinsame Nenner und Fallback. Weitere Sprachen sind willkommen.
  • Vorhandene, ähnliche oder gleiche Definitionen an anderer Stelle werden mit exactMatch, closeMatch oder relatedMatch referenziert, wie in der xAPI-Profile-Syntax vorgesehen.
  • Weitere Meta-Informationen sind erwünscht; diese Seite zeigt jedes Feld an.

Mitwirken

Das Repository forken, Definitionsdateien hinzufügen oder ändern und einen Pull Request öffnen. Die Konventionen beschreibt die CONTRIBUTING.de.md, den Hintergrund des Projekts docs/concept.md.

Für Maschinen

Warum GitHub

Seit Version 2.0.0 liegt die Registry vollständig auf GitHub: die Definitionen in einem öffentlichen Repository, diese Website auf GitHub Pages. Ein Identifier muss Projekte, Förderperioden und Serververträge überdauern, und dieser Aufbau ist langlebiger als ein Server, den ein einzelnes Institut betreibt:

  • Es muss kein eigener Server betrieben, aktualisiert oder bezahlt werden. Die Website ist statisch und wird bei jeder Änderung aus dem Repository neu gebaut.
  • Jede Änderung an einer Definition ist versioniert und öffentlich nachvollziehbar, bis hin zum Commit, der sie eingeführt hat.
  • Jede und jeder kann das Repository forken oder spiegeln. Die Definitionen bleiben verfügbar, auch wenn diese Seite umzieht.
  • Die Pflege hängt nicht an einer Person oder Einrichtung; neue Maintainer brauchen nur Zugriff auf das Repository.

Die IRIs verwenden deshalb die Adresse dieser Seite, https://omilaxr-ecosystem.github.io/xapi/. Bereits vorhandene Definitionen behalten ihre frühere IRI unter https://xapi.elearn.rwth-aachen.de/ als exactMatch, damit Statements mit den früheren IRIs weiterhin zugeordnet werden können.

Herkunft und Zitieren

Die Registry wurde vom Lehr- und Forschungsgebiet Learning Technologies der RWTH Aachen ins Leben gerufen. Die ursprüngliche Registry liegt unter xapi.elearn.rwth-aachen.de. Das Konzept und die zugehörige Learning-Analytics-Infrastruktur beschreibt das folgende Paper. Bitte zitiere es, wenn du die Registry in deiner Forschung verwendest:

Heinemann, B., Ehlenz, M., Görzen, S., & Schroeder, U. (2022). xAPI Made Easy: A Learning Analytics Infrastructure for Interdisciplinary Projects. International Journal of Online and Biomedical Engineering (iJOE), 18(14), 99–113. https://doi.org/10.3991/ijoe.v18i14.35079

Danksagung

Wir danken allen Beteiligten am Lehr- und Forschungsgebiet Informatik 9 (Learning Technologies) der RWTH Aachen, die die ursprüngliche Registry, ihr Konzept und ihre Definitionen erarbeitet haben. Die Entwicklung der ursprünglichen Registry wurde dort teilweise vom Bundesministerium für Bildung und Forschung im Verbundprojekt Open Digital Lab 4 you gefördert (Förderkennzeichen 16DHB2114).