/
Integrations-Guide nach Anwendungsfällen

Integrations-Guide nach Anwendungsfällen

Micromate lässt sich in ein beliebiges, webbasiertes System integrieren. Dazu werden werden die folgenden Komponenten benötigt:

  • Micromate Public API
    Ermöglicht die Synchronisation der Lernenden im Hintergrund sowie das Aktivieren und Deaktivieren von Lerninhalten über Tags.

  • Micromate Widget
    Anzeige von Micromate als Widget im zu integrierenden System.

Zusätzlich ist es möglich über die Widget API das Micromate Widget von der Webseite, in die Micromate integriert wird, zu steuern.

Begriffsdefinition

Begriff

Definition

Begriff

Definition

LMS

LMS steht für das Learning Management System in welches Micromate integriert werden kann.

Micromate kann natürlich auch in jedes andere System (z.B. ein Intranet) integriert werden.

Kurs

Eine Lerneinheit im LMS, zu welcher ein Lernender zugewiesen werden kann. Ein Kurs entspricht einer Lerngruppe in Micromate.

Die Verknüpfung zwischen dem Kurs im LMS und der Micromate Lerngruppe erfolgt über die ID der Lerngruppe in Micromate.

Lernender

Eine Person welche im LMS arbeitet und dort über Micromate lernen soll.

Organisation

Jedes Unternehmen das Micromate einsetzt hat eine eigene Organisation innerhalb Micromate. Dadurch kann Micromate sicherstellen, dass die Daten der einzelnen Unternehmen voneinander getrennt werden.

Anwendungsfälle

Für eine vollständige Integration, müssen die folgenden Anwendungsfälle abgedeckt werden:

Micromate für Lernende aktivieren

Anwendungsfall

Umsetzung

Lernender wird im LMS einem Kurs zugewiesen

  1. Überprüfung ob Lernender bei Micromate existiert https://docs.micromate.ai/public-api/#/default/get_organization__organizationId__learner_by_email

  2. Lernender erstellen und der Micromate Organisation zuweisen https://docs.micromate.ai/public-api/#/default/put_organization__organizationId__learner

  3. Lernender der Micromate Lerngruppe, welche zu dem Kurs gehört, zuweisen https://docs.micromate.ai/public-api/#/default/put_organization__organizationId__learning_groups__learningGroupId__learner

Micromate wird im LMS für einen Kurs aktiviert.

Für jeden bereits existierenden Lernenden im Kurs müssen die folgenden Aktionen ausgeführt werden:

  1. Überprüfung ob Lernender bei Micromate existiert https://docs.micromate.ai/public-api/#/default/get_organization__organizationId__learner_by_email

  2. Lernender erstellen und der Micromate Organisation zuweisen https://docs.micromate.ai/public-api/#/default/put_organization__organizationId__learner

  3. Lernender der Micromate Lerngruppe, welche zu dem Kurs gehört, zuweisen https://docs.micromate.ai/public-api/#/default/put_organization__organizationId__learning_groups__learningGroupId__learner

Micromate für Lernende deaktivieren

Anwendungsfall

Umsetzung

Anwendungsfall

Umsetzung

Lernender wird im LMS aus einem Kurs entfernt

  1. Lernender aus der Micromate Lerngruppe entfernen https://docs.micromate.ai/public-api/#/default/delete_organization__organizationId__learning_groups__learningGroupId__learner

Micromate wird im LMS für einen Kurs deaktiviert

Für jeden Lernenden im Kurs muss die folgende Aktion ausgeführt werden:

  1. Lernender aus der Micromate Lerngruppe entfernen https://docs.micromate.ai/public-api/#/default/delete_organization__organizationId__learning_groups__learningGroupId__learner

Lernender wird im LMS entfernt.

  1. Lernender bei Micromate deaktivieren https://docs.micromate.ai/public-api/#/default/delete_organization__organizationId__learner

Darstellung von Micromate

Anwendungsfall

Umsetzung

Micromate im LMS darstellen

  1. Access Token für den Benutzer abfragen https://docs.micromate.ai/public-api/#/default/get_organization__organizationId__learner_token

Mit der Abfrage des Tokens müssen aktuell noch die folgenden Benutzerinformationen mitgesendet werden:

  • Vorname

  • Nachname

  • E-Mail

  • Sprache (locale)

In einer kommenden Version der MIcromate API wird diese Schnittstelle angepasst, dass diese Informationen einmalig beim Erstellen des Benutzers angegeben werden müssen und bei der Abfrage des Tokens nur noch die E-Mail-Adresse des Benutzers benötigt wird.

  1. Widget in LMS integrieren und Access Token übergeben: Widget in Webapplikation integrieren

 

Erweiterungen

Die Micromate Public API sowie die Widget API ermöglichen zusätzliche Anwendungsfälle. z.B. ist es möglich für den Lernenden zusätzliche Lerninhalte freizuschalten, eine Lernsession zu einem spezifischen Lernpaket zu starten oder einfach das Widget auf einem gewünschten Tab zu öffnen:

Management von Lerninhalten

Anwendungsfall

Umsetzung

Lernender hat einen Teil des Kurses abgeschlossen und soll damit Zugriff auf zusätzliche Micromate Lerninhalte erhalten.

  1. Tag aktivieren https://docs.micromate.ai/public-api/#/default/put_organization__organizationId__learning_groups__learningGroupId__learning_packages__learningPackageId__learner__learnerEmail__tag_activate

Ein bereits abgeschlossener Teil des Kurses wird dem lernenden aberkannt.

Somit soll ihm auch der Zugriff auf den zusätzlichen Lerninhalt in MIcromate entzogen werden.

  1. Tag deaktivierenhttps://docs.micromate.ai/public-api/#/default/put_organization__organizationId__learning_groups__learningGroupId__learning_packages__learningPackageId__learner__learnerEmail__tag_deactivate

Anzeige von Micromate

Anwendungsfall

Umsetzung

Der Lernende soll innerhalb von einem Kurs direkt mit dem Lernen eines kursspezifischen Lernpaketes beginnen können.

  1. Verwendung der Methode “selectLearningPackageAndOpenWidget(…) der Widget API

Dem Lernenden soll die Möglichkeit gegeben werden mit einem Klick im LMS direkt auf die Rangliste/Badges-Ansicht von Micromate zu springen.

Über die Widget API kann das Micromate Widget gesteuert werden:

  1. Aufruf von “switchTab(…)” mit dem gewünschten Tab

  2. Aufruf von “openWidget()” um das Widget zu öffnen