Canvas anbinden

Die Anbindung an Canvas besteht aus zwei Teilen:

1. LTI-Anbindung: Ask Alma wird über Apps registriert und installiert. Danach können Lehrende in ihren Kursen ein Modul-Element oder eine Aufgabe mit 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 Canvas lesen, damit Assistenten die Unterlagen des Kurses kennen. Dieser Teil ist optional und nutzt die REST-API von Canvas, nicht LTI.

Sie benötigen für beide Teile Administrationsrechte auf dem Canvas-Konto (oder auf dem Sub-Account bzw. Kurs, in dem Sie Ask Alma einrichten). Der letzte Schritt des Dateiimports findet im Admin-Dashboard von Ask Alma statt, dafür müssen Sie dort Administrator:in sein. Die Verwaltung ist in Canvas auch bei deutscher Oberfläche teilweise englisch beschriftet. Die Anleitung verwendet an diesen Stellen die englischen Bezeichnungen.

LTI-Anbindung

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.

Bei Ihnen heißt es noch „Developer Keys"?

Ältere Canvas-Installationen registrieren LTI-Tools noch über Admin → Developer Keys → + Developer Key → + LTI Key, mit einer separaten Installation über Apps im Anschluss. Die Feldwerte aus dieser Anleitung gelten dort unverändert, nur der Weg dorthin ist ein anderer.

1. Ask Alma registrieren und installieren

Admin → Ihre Einrichtung → Apps → Verwalten → Eine neue App installieren

Canvas öffnet einen mehrstufigen Assistenten. Wählen Sie zu Beginn:

Feld	Wert
LTI Version	1.3
Installationsmethode	Manuell
App-Name	Ask Alma

Weiter

Registrierung

Hier tragen Sie die Adressen ein, über die Canvas mit Ask Alma spricht: die Initiierungs-URL für OpenID Connect leitet den Login-Vorgang ein, die Weiterleitungs-URIs sind die erlaubten Rückgabeadressen danach, und die Ziel-Link-URI ist die Adresse, die beim eigentlichen Start geöffnet wird. Bei Ask Alma sind Weiterleitungs- und Ziel-Link-URI identisch.

Feld	Wert
Weiterleitungs-URIs	https://api.ask-alma.de/launch/
Standardmäßige Ziel-Link-URI	https://api.ask-alma.de/launch/
Initiierungs-URL für OpenID Connect	https://api.ask-alma.de/oidc/
JWK-Methode	Öffentliches JWK. (URL)
JWK-URL	https://api.ask-alma.de/jwks
Domäne	leer lassen
Benutzerdefinierte Felder	leer lassen

Weiter

Berechtigungen

Im folgenden Dialog müssen folgende Berechtigungen aktiviert werden:

• Kann im Notenbuch, das mit dem Tool verknüpft ist, Daten zu Aufgaben erstellen und anzeigen
• Kann im Notenbuch, das mit dem Tool verknüpft ist, Daten zu Aufgaben anzeigen
• Kann Abgabeergebnisse für mit dem Tool verknüpfte Aufgaben erstellen und aktualisieren
• Kann die Abgabedaten für die mit dem Tool verbundenen Aufgaben anzeigen
• Kann die mit dem Tool verbundenen LTI-Registrierungen anzeigen
• Kann den Inhalt der Seite anzeigen, von der aus das Tool gestartet wurde

Weiter

Gemeinsame Nutzung von Daten

Dieser Schritt legt fest, welche Nutzerdaten Canvas beim Start an Ask Alma überträgt.

Feld	Wert
Mit der App geteilte Benutzerdaten	Keine (Anonymisiert)

Weiter

Platzierungen

Platzierungen bestimmen, an welchen Stellen in Canvas Ask Alma erscheint. Wir empfehlen, folgende zu aktivieren:

Placement	Wirkung
Globale Navigation	Ask Alma erscheint in der globalen Navigation.
Kursnavigation	Ask Alma ist in der Kursnavigation sichtbar.
Modulmenü (Modal)	Erlaubt das Einfügen einzelner Kursinhalte (Assistenten, Quizze, Lernkarten, Lernsessions) als Modul-Elemente.

Möchten Sie Ask Alma auch in anderen Bereichen von Canvas verfügbar machen, können Sie weitere Platzierungen aktivieren.

Weiter

URIs überschreiben

Im folgenden Dialog können Sie die URIs aus der Registrierung überschreiben. Wir empfehlen, die Werte unverändert zu lassen. Besteht bei einer Platzierung die Möglichkeit, zwischen LtiResourceLinkRequest und LtiDeepLinkingRequest zu wählen, wählen Sie LtiDeepLinkingRequest.

Weiter

Spitzname

In diesem Dialog können Sie Anzeigenamen und Beschreibung für die App festlegen. Sie können für jede Platzierung einen eigenen Namen vergeben.

Weiter

Symbol-URLs

Sie können für Platzierungen mit Symbolen (z. B. Globale Navigation) ein eigenes Symbol hinterlegen. Wir empfehlen, die Symbol-URLs aus dem Logo-Konfigurator zu verwenden.

Weiter

Überprüfen

Überprüfen Sie die Angaben und schließen Sie mit App installieren ab. Ask Alma ist damit registriert und installiert. Die Installation gilt für das gesamte Konto, wenn Sie von Admin → Ihre Einrichtung → Apps aus gestartet sind, oder nur für den jeweiligen Sub-Account bzw. Kurs, wenn Sie dort gestartet sind.

2. Die Werte abholen, die Canvas vergibt

Öffnen Sie in der Liste der Apps erneut den Eintrag Ask Alma. Dort finden Sie zwei Werte, die Sie im nächsten Schritt an Ask Alma übermitteln:

Wert	Wo er steht
Client ID	Admin → Ihre Einrichtung → Apps → Verwalten → Ask Alma, Klick auf Client-ID kopieren
Deployment ID	Admin → Ihre Einrichtung → Apps → Verwalten → Ask Alma → Installiert in Ihre Einrichtung, Bereitstellungs-ID kopieren

3. Werte an Ask Alma übermitteln

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

4. Ask Alma verfügbar machen

Wählen Sie den Stift-Button bei Ask Alma und stellen Sie den Status auf Verfügbar. Damit ist die Anbindung inklusive Deep Linking eingerichtet und Lehrende können Kursinhalte direkt in ihre Kurse einbinden.

5. Ausprobieren

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

1. Öffnen Sie einen Testkurs und wählen Sie Module → Modul erstellen.
2. Im neu erstellten Modul klicken Sie auf das Drei-Punkte-Menü und wählen Ask Alma.
3. Canvas öffnet die Auswahlseite von Ask Alma. Wählen Sie einen Kursinhalt (Assistent, Quiz, Lernkarten oder Lernsession) aus oder erstellen Sie einen neuen Assistenten und bestätigen Sie.
4. Das Modul-Element liegt jetzt im Kurs.

Ein Klick auf das Element öffnet Ask Alma mit dem gewählten Kursinhalt. Damit ist die Anbindung inklusive Deep Linking eingerichtet.

Kursdateien

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

Häufige Probleme

Symptom	Ursache
Das Element lässt sich öffnen, aber beim Anlegen endet das Bestätigen der Auswahl mit einem Fehler	Der Canvas-Server kann die Public JWK URL nicht erreichen. Prüfen Sie Ihre Netzwerkkonfiguration.
Ask Alma meldet beim Öffnen einen Fehler zur Registrierung oder Plattform	Client ID oder Deployment ID stimmen nicht mit den Werten aus Schritt 2 überein. Kontaktieren Sie Ihren Ansprechpartner bei Ask Alma.
Die Auswahlseite von Ask Alma erscheint nicht	Message Type des Placements steht nicht auf LtiDeepLinkingRequest.

Hinweise zur LTI-Anbindung

Canvas muss Ask Alma erreichen. Die Public JWK URL ruft der Canvas-Server auf. Bei gehostetem Canvas ist das in der Regel korrekt konfiguriert. Bei einer eigenen Installation hinter Firewall oder Proxy muss die Adresse von Ask Alma für ausgehende Verbindungen freigegeben sein.

Eine Registrierung, viele Kurse. Ist Ask Alma kontoweit installiert, gilt die Registrierung für das gesamte Konto. Lehrende müssen dann nichts weiter einrichten, sie wählen beim Anlegen eines Elements lediglich Ask Alma aus.

Dateiimport

Damit Assistenten die Unterlagen eines Kurses kennen, kann Ask Alma die Materialien des Kurses aus Canvas lesen. Ask Alma nutzt dafür die REST-API von Canvas. Dieses Kapitel beschreibt, wie Sie einen Account mit Leserechten anlegen und ein Zugriffstoken für Ask Alma erzeugen.

Voraussetzung ist, dass Ask Alma bereits als App installiert 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 Zugriffstoken die Ordner und Dateien des Kurses 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 Canvas-Account, den Sie in diesem Kapitel anlegen. Was Ask Alma sehen kann, entscheidet sich an den Rechten dieses Accounts.

1. Einen Account für Ask Alma anlegen

Admin → Ihre Einrichtung → Personen → + Personen

Feld	Wert
Vollständiger Name	z. B. Ask Alma
E-Mail	eine erreichbare Adresse, z. B. eine Funktionsadresse Ihrer Hochschule

Canvas schickt an diese Adresse die Einladung, mit der Sie das Passwort des Accounts setzen. Sie brauchen den Zugang in Schritt 3, denn das Token muss von diesem Account selbst erzeugt werden. Ein Admin-Account funktioniert ebenfalls, ein eigener Account mit möglichst wenigen Rechten ist aber vorzuziehen.

2. Dem Account Leserechte geben

Der Account braucht Lesezugriff auf die Dateien der Kurse, aus denen Ask Alma geöffnet wird. Kontoweit geht das mit einer eigenen Kontorolle:

Admin → Ihre Einrichtung → Berechtigungen → Kontorollen → + Rolle hinzufügen

Feld	Wert
Rollenname	z. B. Ask Alma

Erlauben Sie der neuen Rolle anschließend nur die Berechtigung Kursinhalt - anzeigen (englisch Course Content - view). Das ist das Recht, an dem Canvas entscheidet, ob ein Kontomitglied einen Kurs lesen darf. Ein eigenes Leserecht für Dateien gibt es nicht, die Berechtigungen zu Kursdateien sind Schreibrechte und werden nicht gebraucht.

Tragen Sie den Account dann unter Admin → Ihre Einrichtung → Einstellungen → Admins → + Konto-Admins mit dieser Rolle ein.

Alternative: je Kurs einschreiben

Statt einer Kontorolle können Sie den Account in jedem betroffenen Kurs unter Personen → + Personen mit der Rolle Lehrer oder Designer einschreiben. Die Rolle Student reicht nicht, sie sieht keine verborgenen Dateien und keine Dateien in unveröffentlichten Ordnern. Bei vielen Kursen ist die Kontorolle der einfachere Weg.

3. Ein Zugriffstoken erzeugen

Melden Sie sich mit dem Account aus Schritt 1 in Canvas an:

Konto → Einstellungen → Approved Integrations → + Neuer Zugriffstoken

Feld	Wert
Zweck	Ask Alma
Läuft ab	leer lassen

Wichtig

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

Ein so erzeugtes Token hat keine Einschränkung auf bestimmte Scopes. Erzwingt Ihre Einrichtung Scopes über Developer Keys, braucht das Token die Scopes url:GET|/api/v1/courses/:course_id/files und url:GET|/api/v1/courses/:course_id/folders.

4. Den Zugang in Ask Alma eintragen

Öffnen Sie Ask Alma aus Canvas 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 Canvas 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://canvas.example
Zugriffstoken	das Token aus Schritt 3

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. Canvas übermittelt beim Öffnen die Kennung des Kurses, aus dem heraus Ask Alma gestartet wurde, und nur für diesen einen Kurs fragt Ask Alma die Dateien ab. Andere Kurse werden nicht abgerufen.

Das Token gehört einem festen Account, nicht der Person, die Ask Alma öffnet. Ask Alma sieht damit alle Dateien, die dieser Account sehen darf, auch solche, die für Studierende verborgen sind. Wenn Sie den Account löschen oder ihm Rechte entziehen, wirkt sich das sofort auf den Dateiimport aus. Erzeugen Sie 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.

Eigene Installation. Die Adressen, unter denen Canvas Dateien zum Download bereitstellt, verwenden die in Canvas konfigurierte Domain. Bei einer selbst betriebenen Installation muss sie mit der Domain übereinstimmen, die Sie im Admin-Dashboard hinterlegen, sonst kommt zwar die Dateiliste, aber kein Download zustande.