Mikroapps

Integration von Canvas LMS

Mit der Canvas LMS-Integration können Benutzer Kurse anzeigen, Kursankündigungen erstellen, die Kurseinschreibung verwalten und Noten von Kursteilnehmern anzeigen.

  • Als Kursteilnehmer können Sie Kurse und die zugehörigen Details anzeigen.
  • Als Kursleiter können Sie Kursankündigungen erstellen, Kursteilnehmer anzeigen und hinzufügen und die Noten der Kursteilnehmer anzeigen.

Senden Sie uns Ihr Feedback! Bitte geben Sie Feedback zu dieser Integrationsvorlage. Unser Team überprüft unser zugehöriges Forum täglich auf gemeldete Probleme.

Ausführliche Details zu vorkonfigurierten Mikroapps für Canvas LMS finden Sie unter Verwenden von Canvas LMS-Mikroapps.

Prüfung der Voraussetzungen

Nach dem Einrichten dieser Integration mit Canvas LMS benötigen Sie diese Artefakte, um die Integration in Citrix Workspace-Mikroapps hinzuzufügen:

  • Basis-URL: https://{host_name}.com
  • Autorisierungs-URL: https://{host_name}.com/login/oauth2/auth
  • Token-URL: https://{host_name}.com/login/oauth2/token
  • Client-ID: Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt.
  • Geheimer Clientschlüssel: Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird.

Hinweis:

Sofern verfügbar, sollten Sie stets OAuth 2.0 zur Dienstauthentifizierung verwenden. OAuth 2.0 stellt sicher, dass Ihre Integration höchste Sicherheitsansprüche mit Ihrer konfigurierten Mikroapp erfüllt.

Konfigurieren Sie in Citrix Gateway die Unterstützung für Single Sign-On für Canvas LMS, damit Benutzer sich nur einmal anmelden und ihre Anmeldeinformationen nicht erneut eingeben müssen. Weitere Hinweise zum Konfigurieren von SSO finden Sie unter Citrix Gateway Service.

Aktivieren von APIs

Canvas-APIs sind standardmäßig aktiviert. Sie benötigen ein Canvas-Partnerkonto, um auf die APIs zugreifen zu können. Die Anzahl an API-Anforderungen, die an bestimmte Ressourcen gestellt werden können, ist begrenzt. Wir empfehlen daher ein API-Drosselungslimit, wie in diesem Artikel beschrieben: https://canvas.instructure.com/doc/api/file.throttling.html.

Erstellen eines neuen Dienstkontos

Für die Integration ist ein regulärer Zugriff auf Ihre Canvas LMS-Instanz erforderlich. Wir empfehlen daher, ein dediziertes Benutzerkonto zu erstellen. Dieses Konto muss über die folgenden Berechtigungen verfügen: Volle Administratorrechte.

Es wird empfohlen, ein Canvas Partner-Konto zu haben: https://www.instructure.com/canvas/become-partner.

Konfigurieren des OAuth-Servers

Konfigurieren Sie den OAuth-Server so, dass Daten über die Canvas-Integration gelesen werden.

  1. Melden Sie sich bei https://{host_name}.com/accounts als Administrator an.
  2. Wählen Sie das Konto aus, das Sie integrieren möchten.
  3. Wählen Sie Developer Keys und dann + Developer Key.
  4. Wählen Sie + API Key und füllen Sie die erforderlichen Felder aus, einschließlich Schlüsselname, E-Mail des Besitzers und Umleitungs-URIs.
  5. Geben Sie im Feld “Redirect URL” folgende autorisierte Umleitungs-URLs für die App ein:https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  6. Geben Sie für “Client Credentials Audience” den Wert “Canvas” ein und klicken Sie auf Save.
  7. Wählen Sie für “State” die Einstellung EIN.
  8. Kopieren Sie die Werte für ClientID und Secret aus den Details. Sie verwenden diese Details für die Dienstauthentifizierung, wenn Sie die Integration konfigurieren.

Konfigurieren des OAuth-Client

Konfigurieren Sie den OAuth-Client so, dass Daten über die Canvas-Integration zurückgeschrieben werden.

  1. Melden Sie sich bei https://{host_name}.com/accounts als Administrator an.
  2. Wählen Sie das Konto aus, das Sie integrieren möchten.
  3. Wählen Sie Developer Keys und dann + Developer Key.
  4. Wählen Sie + API Key und füllen Sie die erforderlichen Felder aus, einschließlich Schlüsselname, E-Mail des Besitzers und Umleitungs-URIs.
  5. Geben Sie im Feld “Redirect URL” folgende autorisierte Umleitungs-URLs für die App ein:https://{yourmicroappserverurl}/admin/api/gwsc/auth/serviceAction/callback
  6. Geben Sie für “Client Credentials Audience” den Wert “Canvas” ein und klicken Sie auf Save.
  7. Wählen Sie für “State” die Einstellung EIN.
  8. Kopieren Sie die Werte für ClientID und Secret aus den Details. Sie verwenden diese Details für die Dienstaktionsauthentifizierung, wenn Sie die Integration konfigurieren.

Hinzufügen der Integration zu Citrix Workspace-Mikroapps

Fügen Sie die Canvas LMS-Integration zu Citrix Workspace-Mikroapps hinzu, um eine Verbindung zu Ihrer Anwendung herzustellen. Dadurch werden vorkonfigurierte Mikroapps mit Benachrichtigungen und Aktionen bereitgestellt, die in Ihrem Workspace sofort einsatzbereit sind.

Führen Sie folgende Schritte aus:

  1. Wählen Sie auf der Seite Mikroappintegrationen die Optionen Neue Integration hinzufügen und Neue Integration aus Citrix-Vorlagen hinzufügen.
  2. Wählen Sie die Canvas LMS-Kachel.
  3. Geben Sie einen Namen für die Integration ein.
  4. Geben Sie Connectorparameter ein:

    • Geben Sie die Basis-URL https://{host_name}.com der Instanz ein:
    • Wählen Sie ein Symbol für die Integration aus der Symbolbibliothek aus, oder belassen Sie das Standardsymbol.
  5. Wählen Sie unter Dienstauthentifizierung im Menü Authentifizierungsmethode die Option OAuth 2.0 und geben Sie die Authentifizierungsdetails ein. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen. Generieren Sie über das Sicherheitsprotokoll OAuth 2.0 einen Anforderungs-/Autorisierungstoken zum delegierten Zugriff. Sofern verfügbar, sollten Sie stets OAuth 2.0 zur Dienstauthentifizierung verwenden. OAuth 2.0 stellt sicher, dass Ihre Integration höchste Sicherheitsansprüche mit Ihrer konfigurierten Mikroapp erfüllt.

    1. Wählen Sie im Menü Gewährungstyp die Option Autorisierungscode.
    2. Die Autorisierungs-URL ist vorausgefüllt: https://{host_name}.com/login/oauth2/auth.
    3. Die Token-URL ist vorausgefüllt: https://{host_name}.com/login/oauth2/token.
    4. Geben Sie Ihre Client-ID ein. Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie erfassen diesen Wert beim Konfigurieren des OAuth-Servers.
    5. Geben Sie Ihren geheimen Clientschlüssel ein. Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird. Sie erfassen diesen Wert beim Konfigurieren des OAuth-Servers.
  6. Aktivieren Sie unter Dienstaktionsauthentifizierung die Umschaltfläche Separate Benutzerauthentifizierung in Aktionen verwenden. Mit der Dienstaktionsauthentifizierung authentifizieren Sie sich auf der Dienstaktionsebene. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen.

    1. Wählen Sie im Menü Authentifizierungsmethode die Option OAuth 2.0 und geben Sie die Authentifizierungsdetails ein.
    2. Wählen Sie im Menü Gewährungstyp die Option Autorisierungscode.
    3. Die Autorisierungs-URL ist vorausgefüllt: https://{host_name}.com/login/oauth2/auth.
    4. Die Token-URL ist vorausgefüllt: https://{host_name}.com/login/oauth2/token.
    5. Geben Sie Ihre Client-ID ein. Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie haben diesen Wert beim Konfigurieren des OAuth-Clients erfasst.
    6. Geben Sie Ihren geheimen Clientschlüssel ein. Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird. Sie haben diesen Wert beim Konfigurieren des OAuth-Clients erfasst.
  7. Aktivieren Sie die Umschaltfläche Anforderungsratenlimit. Geben Sie für Anzahl der Anforderungen den Wert 500 und für Zeitintervall den Wert 1 Minute ein.
  8. Lassen Sie das Feld Anforderungstimeout leer.
  9. (Optional) Aktivieren Sie die Umschaltfläche Protokollierung, um 24-Stunden-Protokolle für Supportzwecke zu erstellen.
  10. Wählen Sie dann Speichern.

Konfigurieren von Dienstaktionsparametern

Nachdem Sie die obige Vorlage konfiguriert haben, müssen Sie eine Dienstaktion korrekt konfigurieren. Aktualisieren Sie für die Mikroapp Meine Noten die host_name auf der Schaltfläche In Canvas anzeigen der Seite Meine Noten.

Führen Sie folgende Schritte aus:

  1. Navigieren Sie auf der Seite “Mikroappintegrationen” zur Canvas LMS-Integration und wählen Sie die Mikroapp Meine Noten.
  2. Wählen Sie Seitenund dann die Seite Meine Noten.
  3. Wählen Sie im Seitengenerator das Schaltflächenelement In Canvas anzeigen und dann im rechten Fensterbereich die Registerkarte Aktionen.
  4. Wählen Sie unter Aktionen die Option Gehe zu URL.
  5. Ersetzen Sie im Feld URL-Vorlage host_name durch den Hostnamen Ihrer Instanz. Dieses Formular wird verwendet: https://{host_name}/courses/\{\{id\}\}/grades
  6. Wenn Sie fertig sind, verlassen Sie den Bildschirm. Änderungen werden automatisch für den Generator gespeichert.

Bearbeiten von Tabellenattributen

Um die Konfiguration der Integration abzuschließen, müssen Sie den Datentyp der Endpunkte ändern, wie in der folgenden Liste angegeben. Für jeden Endpunkt, der in der folgenden Tabelle aufgeführt ist, müssen Sie den Datentyp im Menü für das angegebene Attribut ändern.

Tabelle Spalte Datentyp
Zuweisungen points_possible Binär
Zuweisungen Beschreibung Binär
Noten current_grade Binär

Führen Sie folgende Schritte aus:

  1. Wählen Sie auf der Seite Mikroappintegrationen das Menü neben der Canvas LMS-Integration und wählen Sie Bearbeiten. Der Bildschirm Laden von Daten wird geöffnet. Wenn das Fenster nicht angezeigt wird, wählen Sie in der linken Navigationsspalte die Option Laden von Daten.
  2. Wählen Sie für jeden Endpunkt das Menü neben dem Endpunkt und dann Bearbeiten.
  3. Scrollen Sie im Bildschirm Datenendpunkt bearbeiten zum Ende der Seite. Wählen Sie in der Tabelle unter Datenstruktur das Bleistiftsymbol, um die Tabelle zu bearbeiten.
  4. Ändern Sie im Bildschirm Tabellenattribute bearbeiten den Datentyp, indem Sie den neuen Wert aus dem Menü auswählen. Wählen Sie für jede Änderung, die für jeden Endpunkt vorgenommen wurde, Speichern und dann Übernehmen.
  5. Wiederholen Sie den Vorgang für die übrigen Datenendpunkte.

Sie können nun die erste Datensynchronisierung festlegen und ausführen. Vollständige Informationen zu Synchronisierungsregeln, zeitlich fehlgeschlagenen Synchronisierungen und zu Vetoregeln finden Sie unter Synchronisieren von Daten.

Hinweis:

Wir empfehlen als Synchronisierungsintervall, alle 8 Stunden eine vollständige Synchronisierung und stündlich eine inkrementelle Synchronisierung durchzuführen.

Weitere Informationen zu API-Endpunkten und Tabellenentitäten finden Sie unter Canvas LMS-Connectorspezifikationen.

Hinweis:

Aufgrund der Begrenzung von API-Aufrufen werden bei der inkrementellen Synchronisierung nur Ankündigungenerfasst. Die übrigen Endpunkte werden im Rahmen der vollständigen Synchronisierung ausgelöst.

Verwenden von Canvas LMS-Mikroapps

Vorhandene Anwendungsintegrationen werden mit vorkonfigurierten Mikroapps geliefert. Beginnen Sie mit diesen Mikroapps und passen Sie sie an Ihre Erfordernisse an.

Kursankündigung erstellen: Zum Erstellen von Kursankündigungen durch Kursleiter.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Kursankündigung erstellen” Formular zum Erstellen einer Ankündigung für einen Kurs, mit folgenden Details: Kurs (Dropdownmenü für Kurse), Titel, Nachricht und Veröffentlichungsdatum.

Meine Kurse: Anzeige von Kursankündigungen, Zuweisungen und Kursdateien.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Benachrichtigung: Kurseinladung Wenn ein Teilnehmer zu einem Kurs eingeladen wird, erhält er eine Benachrichtigung.
Benachrichtigung “Ankündigung eines neuen Kurses” Wenn eine neue Ankündigung für einen Kurs vorliegt, erhalten die beim Kurs angemeldeten Teilnehmer eine Benachrichtigung.
Benachrichtigung: Neue Ankündigung (Zukunft) Wenn eine neue Kursankündigung mit Veröffentlichungsdatum in der Zukunft vorliegt , erhalten die im Kurs angemeldeten Teilnehmer eine Benachrichtigung.
Seite “Einladung annehmen/ablehnen” Schreibgeschützte Ansicht einer Kurseinladung mit Optionen für Annehmen oder Ablehnen.
Seite “Kursliste” Ermöglicht Benutzern die Anzeige einer Liste der Kurse, bei denen sie angemeldet sind.
Seite “Kursdetails” Ermöglicht Benutzern die Anzeige einer Liste von Ankündigungen und Dateien für einen Kurs.
Seite “Ankündigungsdetails” Ermöglicht Benutzern die Anzeige der Kursankündigung mit Details.
Seite “Zuweisungsdetails” Ermöglicht Benutzern die Anzeige einer Zuweisung mit Details.
Seite “Dateidetails” Ermöglicht Benutzern das Anzeigen und Herunterladen von Dateien.

Meine Noten: Anzeige der Noten für Kursteilnehmer.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Benachrichtigung “Neue Noten” Wenn neue Noten für einen Kurs veröffentlicht werden, erhalten die beim Kurs angemeldeten Teilnehmer eine Benachrichtigung.
Seite “Kursliste” Ermöglicht Benutzern die Anzeige einer Liste der Kurse, bei denen sie angemeldet sind.
Seite “Meine Noten” Ermöglicht Benutzern eine Notenanzeige für den ausgewählten Kurs.

Ansicht des Lehrenden: Ansicht für Kursleiter zum Anzeigen und Hinzufügen von Teilnehmern und Anzeigen von Teilnehmerdetails.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Kursliste” Ermöglicht Lehrern die Anzeige einer Liste der verfügbaren Kurse.
Seite “Mitglieder auflisten” Ermöglicht Lehrern die Anzeige einer Liste aller angemeldeten Teilnehmer für einen Kurs; mit der Schaltfläche Hinzufügen zum Aufrufen der Seite Benutzer hinzufügen.
Seite “Teilnehmerdetails” Ermöglicht Kursleitern die Anzeige von Noten und anderen Details für die Teilnehmer eines Kurses.
Seite “Benutzer hinzufügen” Ermöglicht Kursleitern das Hinzufügen eines Teilnehmers zum ausgewählten Kurs.
Integration von Canvas LMS