Moodle anbinden

Die Anbindung an Moodle besteht aus zwei Teilen:

1. LTI-Anbindung: Ask Alma wird als externes Tool registriert. Danach können Lehrende in ihren Kursen eine Aktivität Ask Alma anlegen und dabei einen Kursinhalt (Assistent, Quiz, Lernkarten oder Lernsession) auswählen. Studierende öffnen ihn anschließend direkt aus dem Kurs heraus.
2. Dateiimport: Ask Alma darf die Materialien eines Kurses aus Moodle lesen, damit Assistenten die Unterlagen des Kurses kennen. Dieser Teil ist optional und nutzt die Web-Service-API von Moodle, nicht LTI.

Sie benötigen für beide Teile Administrationsrechte in Moodle. Der letzte Schritt des Dateiimports findet im Admin-Dashboard von Ask Alma statt, dafür müssen Sie dort Administrator:in sein. Die Bezeichnungen der Menüpunkte entsprechen der deutschen Moodle-Oberfläche.

LTI-Anbindung

Dieses Kapitel beschreibt, wie Sie Ask Alma als externes Tool in Moodle registrieren, inklusive Deep Linking.

Ask Alma ist bei Ihnen bereits ohne Deep Linking eingerichtet?

Dann müssen Sie nicht bei Schritt 1 neu anfangen. Es genügt, Deep Linking nachträglich einzurichten.

1. Das Tool anlegen

Website-Administration → Plugins → Aktivitäten → Externes Tool → Tools verwalten → Tool manuell konfigurieren

Im Abschnitt Tool-Einstellungen tragen Sie ein:

Feld	Wert
Name des Tools	Ask Alma
Tool-URL	https://api.ask-alma.de/launch/
LTI-Version	LTI 1.3
Typ des öffentlichen Schlüssels	Keyset URL
Öffentliche Keyset-URL	https://api.ask-alma.de/jwks
Initiate Login URL	https://api.ask-alma.de/oidc/
Weiterleitungs-URI(s)	https://api.ask-alma.de/launch/
Unterstützt Deep Linking (Content-Item Message)	✓
Inhaltsauswahl-URL	leer lassen
Icon-URL (unter Mehr anzeigen …)	Link aus dem Logo-Konfigurator, optional
Sichere Icon-URL (unter Mehr anzeigen …)	derselbe Link

Die Optionen Öffentliche Keyset-URL und Öffentlicher Schlüssel schließen sich gegenseitig aus. Moodle zeigt nur das Feld, das zum gewählten Schlüsseltyp passt.

Weitere Felder wie Standard-Startcontainer und Tool-Konfiguration verwenden bestimmen, wie und wo Ask Alma in Moodle erscheint. Ask Alma macht dazu keine Vorgabe, wählen Sie hier, was zu Ihrer Installation passt.

2. Die Werte abholen, die Moodle vergibt

In der Liste der Tools erscheint das neue Tool Ask Alma. Das Symbol Konfigurationsdetails anzeigen öffnet ein Fenster mit sechs Werten:

Platform ID:                  https://moodle.example
Client ID:                    <von Moodle vergeben>
Deployment ID:                <von Moodle vergeben>
Public keyset URL:            https://moodle.example/mod/lti/certs.php
Access token URL:             https://moodle.example/mod/lti/token.php
Authentication request URL:   https://moodle.example/mod/lti/auth.php

https://moodle.example steht hier für die Adresse Ihrer Moodle-Installation. Kopieren Sie alle sechs Werte, sie werden im nächsten Schritt in Ask Alma eingetragen.

3. Werte an Ask Alma übermitteln

Schicken Sie die sechs Werte aus Schritt 2 an Ihre Ansprechperson bei Ask Alma und geben Sie an, dass sie zu dieser Moodle-Installation gehören. Ask Alma trägt die Werte ein und aktiviert damit das Tool.

4. Ausprobieren

Warten Sie die Rückmeldung von Ask Alma ab, dass das Tool aktiviert ist, bevor Sie testen.

1. Öffnen Sie einen Testkurs und schalten Sie Bearbeiten ein.
2. Wählen Sie Aktivität oder Material anlegen und dort Ask Alma.
3. Vergeben Sie einen Namen für die Aktivität und klicken Sie auf Speichern und anzeigen.

Ein Klick auf die Aktivität öffnet Ask Alma mit dem gewählten Kursinhalt.

Kursdateien

Sollen Assistenten auch die Materialien des Kurses kennen, richten Sie zusätzlich den Dateiimport ein. Dafür nutzt Ask Alma die Web-Service-API von Moodle, nicht LTI.

Hinweise zur LTI-Anbindung

Moodle muss Ask Alma erreichen. Die Öffentliche Keyset-URL ruft der Moodle-Server auf. Falls Ihr Server ausgehende Verbindungen nur eingeschränkt erlaubt, geben Sie die Adresse von Ask Alma frei.

Ein Tool, viele Kurse. Die Registrierung gilt für die gesamte Moodle-Installation. Lehrende müssen nichts weiter einrichten, sie wählen beim Anlegen einer Aktivität lediglich Ask Alma aus.

Dateiimport

Damit Assistenten die Unterlagen eines Kurses kennen, kann Ask Alma die Materialien des Kurses aus Moodle lesen. Ask Alma nutzt dafür die Web-Service-API von Moodle. Dieses Kapitel beschreibt, wie Sie die API freischalten, ein Zugriffstoken für Ask Alma erzeugen und es im Admin-Dashboard von Ask Alma hinterlegen.

Voraussetzung ist, dass Ask Alma bereits als externes Tool registriert ist. Ohne den Dateiimport funktioniert die Anbindung trotzdem, Assistenten haben dann lediglich keinen Zugriff auf die Kursdateien.

Wie der Zugriff funktioniert

Ask Alma fragt mit einem festen Token die Funktion core_course_get_contents für den Kurs ab, aus dem Ask Alma geöffnet wurde, und lädt die Dateien bei Bedarf über die zurückgegebenen Adressen. Das Token gehört einem eigenen Moodle-Account, den Sie in diesem Kapitel anlegen. Sie hinterlegen es selbst im Admin-Dashboard von Ask Alma, wo es verschlüsselt gespeichert wird.

1. Web-Services einschalten

Website-Administration → Allgemein → Zusatzoptionen → Webservices aktivieren

Feld	Wert
Webservices aktivieren	✓

Änderungen speichern.

2. Das REST-Protokoll aktivieren

Website-Administration → Server → Web-Services → Protokolle verwalten

Beim Protokoll REST das Auge-Symbol anklicken, sodass es aktiviert ist.

Änderungen speichern.

3. Einen Dienst anlegen

Website-Administration → Server → Web-Services → Externe Services → hinzufügen

Feld	Wert
Name	Ask Alma
Kurzname	ask_alma
Aktiviert	✓
Nur berechtigte Personen	✓
Dateien herunterladen	✓

Um Dateien herunterladen anzuzeigen, muss mehr anzeigen aufgeklappt werden.

Service hinzufügen.

4. Die Funktion zum Dienst hinzufügen

In der Liste der externen Dienste beim Dienst Ask Alma auf Funktionen klicken, dann Funktionen hinzufügen und diese Funktion auswählen:

• core_course_get_contents

Funktionen hinzufügen.

5. Einen Account für Ask Alma anlegen und autorisieren

Account anlegen

Website-Administration → Nutzer/innen → Nutzerkonten → Nutzer/in anlegen

Feld	Wert
Anmeldename	z. B. askalma
Authentifizierungsmethode	Manuelle Konten
Neues Passwort	ein sicheres, selbst gewähltes Passwort
Vorname / Nachname	z. B. Ask / Alma
E-Mail-Adresse	eine erreichbare Adresse, z. B. eine Funktionsadresse Ihrer Hochschule

Nutzer/in anlegen.

Eine Rolle für den Zugriff anlegen

Website-Administration → Nutzer/innen → Rechte → Rollen verwalten → Neue Rolle anlegen

Feld	Wert
Kurzbezeichnung der Rolle	ask_alma
Angepasster Rollenname	z. B. Ask Alma
Grundform der Rolle	Keine
Kontext-Typen, in welchen diese Rolle zugewiesen werden kann	System

Moodle zeigt danach die Liste aller Fähigkeiten der Rolle. Suchen Sie über das Feld Fähigkeit filtern nach den beiden folgenden Fähigkeiten und stellen Sie sie jeweils auf Erlauben:

• moodle/course:view
• webservice/rest:use

Neue Rolle erzeugen.

Die Rolle zuweisen

Website-Administration → Nutzer/innen → Rechte → Globale Rollen zuweisen

Die neu angelegte Rolle auswählen und den Account aus Account anlegen als Nutzer/in hinzufügen.

Für den Dienst autorisieren

Website-Administration → Server → Web-Services → Externe Services

In der Liste der externen Dienste bei Ask Alma auf Berechtigte Personen klicken. Den Account im Suchfeld suchen und auswählen.

6. Ein Token erzeugen

Website-Administration → Server → Web-Services → Token verwalten → Token erzeugen

Feld	Wert
Name	optional, z. B. Ask Alma
Nutzer/in	der Account aus Schritt 5
Service	Ask Alma
IP-Einschränkung	leer lassen
Gültig bis	deaktiviert lassen

Änderungen sichern.

Wichtig

Das Token wird nur einmal angezeigt. Kopieren Sie es jetzt.

7. Den Zugang in Ask Alma eintragen

Öffnen Sie Ask Alma aus Moodle heraus, klicken Sie unten links in der Seitenleiste auf Einstellungen & Hilfe und wählen Sie Administration. Der Eintrag ist nur für Administrator:innen sichtbar, also für Personen mit der LTI-Rolle Administrator in Moodle oder für in Ask Alma ernannte Administrator:innen.

Admin-Dashboard → Verwaltung → Lernplattform-Zugriffe → Hinzufügen

Im Dialog Lernplattform-Zugang hinzufügen tragen Sie ein:

Feld	Wert
Zugriffsart	Dateizugriff für Kursassistenten
Domain	die Basis-Adresse Ihrer Installation, z. B. https://moodle.example
API-Key	das Token aus Schritt 6

Das Token können Sie während der Eingabe über das Auge-Symbol (Wert anzeigen) prüfen. Nach dem Speichern zeigt Ask Alma es nicht mehr an.

Lernplattform-Zugang hinzufügen.

Der Dateiimport ist damit aktiv. Der Zugang erscheint in der Karte unter Zugriffsart als Dateizugriff für Kursassistenten. Wie Sie ihn später bearbeiten oder entfernen, beschreibt Verwaltung → Lernplattform-Zugriffe.

Hinweise zum Dateiimport

Kein Zugriff ohne Anlass. Ask Alma ruft nicht von sich aus oder in regelmäßigen Abständen Dateien oder Kursinformationen ab. Die Dateiliste eines Kurses wird nur abgerufen, wenn Lehrende dort einen Kursassistenten anlegen oder bearbeiten oder einen Lerninhalt erstellen, um ihnen die verfügbaren Dateien zur Auswahl anzuzeigen. Heruntergeladen wird eine Datei erst, wenn Lehrende sie dort aktiv auswählen.

Zugriff nur auf den aktuellen Kurs. Moodle übermittelt beim Öffnen die Kurs-ID des Kurses, aus dem heraus Ask Alma gestartet wurde, und nur für diesen einen Kurs fragt Ask Alma die Materialien ab. Andere Kurse werden nicht abgerufen.

Das Token gehört einem festen Account, nicht der Person, die Ask Alma öffnet. Wenn Sie den Account löschen oder ihm Rechte entziehen, wirkt sich das sofort auf den Dateiimport aus. Erzeugen Sie in Moodle ein neues Token, entfernen Sie den Zugang im Admin-Dashboard und legen Sie ihn mit dem neuen Token neu an, siehe Lernplattform-Zugriffe.

Das Token liegt verschlüsselt in Ask Alma. Ask Alma speichert Adresse und Token verschlüsselt und zeigt das Token nach dem Speichern nicht mehr an, auch nicht im Admin-Dashboard. Es wird ausschließlich für den Abruf der Kursmaterialien verwendet.