Mikroapps

Integration von Blackboard Learn

Mit der Blackboard Learn-Integration können Sie sich für einen neuen Kurs registrieren, den Kurs und zugehörige Details als Kursteilnehmer anzeigen oder als Kursleiter eine Kursankündigung erstellen und Kursteilnehmer und Abschlüsse anzeigen.

Hinweis:

Senden Sie uns Ihr Feedback! Wir freuen uns über Ihr 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 Blackboard Learn finden Sie unter Verwenden von Blackboard Learn-Mikroapps.

Prüfung der Voraussetzungen

Sie benötigen folgende Angaben, um die Integration in Citrix Workspace-Mikroapps hinzuzufügen:

  • Basis-URL: https://{host_name}.com
  • Autorisierungs-URL: https://{host_name}.com/learn/api/public/v1/oauth2/authorizationcode
  • Token-URL: https://{host_name}.com/learn/api/public/v1/oauth2/token
  • Client-ID: Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie erfassen dies als Anwendungsschlüssel beim Konfigurieren des OAuth-Servers.
  • Geheimer Clientschlüssel: Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird. Sie erfassen dies als geheimen Clientschlüssel beim Konfigurieren des OAuth-Client.

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, 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 https://docs.citrix.com/en-us/citrix-gateway-service/.

Erstellen eines Benutzerkontos

Für die Integration ist ein regulärer Zugriff auf Ihre Blackboard-Instanz erforderlich. Wir empfehlen, ein dediziertes Benutzerkonto zu erstellen: Blackboard Partner-Konto https://docs.blackboard.com/partners/become-a-partner.

Die folgenden Berechtigungen sind erforderlich: Volle Administratorrechte.

API-Zugriff

Blackboard-APIs sind standardmäßig aktiviert. Für den Zugriff benötigen wir entweder ein “Blackboard Developer AMI” oder “Blackboard Partner-Konto”. Die Anzahl an API-Anforderungen, die an bestimmte Ressourcen gestellt werden können, ist begrenzt. Wir empfehlen, folgende Informationen zu überprüfen: https://docs.blackboard.com/learn/rest/admin/groups-quotas-rates

Wichtig

Das Paginierungslimit ist auf 100 festgelegt. Administratoren können dieses Limit je nach API auf bis zu 200 erweitern.

Der Blackboard Learn-Entwicklerserver unterstützt bis zu 10.000 API-Aufrufe/Site/24 Stunden.

Der Blackboard Learn-Produktionsserver unterstützt bis zu 75.000 API-Aufrufe/Site/24 Stunden.

Aufgrund der Begrenzung von API-Aufrufen werden bei der inkrementellen Synchronisierung nur Kursmitgliedschaften und Kursankündigungen erfasst. Die übrigen Endpunkte werden im Rahmen der vollständigen Synchronisierung ausgelöst.

Konfigurieren des OAuth-Servers

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

  1. Melden Sie sich bei https://developer.blackboard.com/ an.
  2. Wählen Sie My Apps und klicken Sie auf das Pluszeichen (+), um eine neue App zu erstellen. Oder navigieren Sie zu: https://developer.blackboard.com/portal/applications/create.
  3. Füllen Sie die erforderlichen Felder aus und wählen Sie Register application and generate API key.
  4. Kopieren und speichern Sie die angezeigten Werte für Application ID, Application Key und Secret. Verwenden Sie diese Details für die Dienstauthentifizierung, während Sie die Integration konfigurieren.
  5. Melden Sie sich als Administrator bei der Blackboard Learn-Anwendung an.
  6. Navigieren Sie zu System Admin.
  7. Wählen Sie REST API Integrations unter der Tabelle Integrations.
  8. Wählen Sie Integration erstellen.
  9. Füllen Sie die erforderlichen Felder aus:

    1. Fügen Sie die Application ID ein, die Sie weiter oben in Schritt 4 ausgewählt haben.
    2. Geben Sie Ihren Administrator-Benutzernamen in das Feld Learn User ein.
    3. Wählen Sie Yes für End User Access und Authorized To Act As User.

Konfigurieren des OAuth-Client

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

  1. Melden Sie sich bei https://developer.blackboard.com/ an.
  2. Wählen Sie My Apps und klicken Sie auf das Pluszeichen (+), um eine neue App zu erstellen. Oder navigieren Sie zu: https://developer.blackboard.com/portal/applications/create.
  3. Füllen Sie die erforderlichen Felder aus und wählen Sie Register application and generate API key.
  4. Kopieren und speichern Sie die angezeigten Werte für Application ID, Application Key und Secret. Verwenden Sie diese Details für die Dienstaktionsauthentifizierung, während Sie die Integration konfigurieren.
  5. Melden Sie sich als Administrator bei der Blackboard Learn-Anwendung an.
  6. Navigieren Sie zu System Admin.
  7. Wählen Sie REST API Integrations unter der Tabelle Integrations.
  8. Wählen Sie Integration erstellen.
  9. Füllen Sie die erforderlichen Felder aus:

    1. Fügen Sie die Application ID ein, die Sie weiter oben in Schritt 4 ausgewählt haben.
    2. Geben Sie Ihren Administrator-Benutzernamen in das Feld Learn User ein.
    3. Wählen Sie Yes für End User Access und Authorized To Act As User.

Hinzufügen der Integration zu Citrix Workspace-Mikroapps

Fügen Sie die Blackboard Learn-Integration zu Citrix Workspace-Mikroapps hinzu, um eine Verbindung zu Ihrer Anwendung herzustellen. Die Authentifizierungsoptionen sind vorausgewählt. Stellen Sie sicher, dass diese Optionen ausgewählt sind, wenn Sie den Vorgang abschließen. Dadurch werden vorkonfigurierte Mikroapps mit Benachrichtigungen und Aktionen bereitgestellt, die in Ihrem Workspace sofort einsatzbereit sind.

Führen Sie die folgenden 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 Blackboard Learn-Kachel.
  3. Geben Sie einen Integrationsnamen ein.
  4. Geben Sie Connectorparameter ein.
    • Geben Sie die Basis-URL 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 füllen Sie die Authentifizierungsdetails aus. 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 Clientanmeldeinformationen.
    2. Wählen Sie im Menü Tokenautorisierung die Option Autorisierungsheader.
    3. Die Token-URL ist vorausgefüllt: https://{host_name}.com/learn/api/public/v1/oauth2/token
    4. Stellen Sie sicher, dass Folgendes als Bereich eingegeben ist: read
    5. Geben Sie Ihre Client-ID ein. Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie erfassen dies als Anwendungsschlüssel beim Konfigurieren des OAuth-Servers.
    6. Geben Sie Ihren geheimen Clientschlüssel ein. Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird. Sie erfassen dies als geheimen Clientschlüssel 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ü Tokenautorisierung die Option Autorisierungsheader.
    3. Die Autorisierungs-URL ist vorausgefüllt: https://{host_name}.com/learn/api/public/v1/oauth2/authorizationcode
    4. Die Token-URL ist vorausgefüllt: https://{host_name}.com/learn/api/public/v1/oauth2/token
    5. Stellen Sie sicher, dass Folgendes als Bereich eingegeben ist: write
    6. Geben Sie Ihre Client-ID ein. Die Client-ID ist die Zeichenfolge, die die eindeutigen Angaben des Autorisierungsservers zur Clientregistrierung darstellt. Sie erfassen dies als Anwendungsschlüssel beim Konfigurieren des OAuth-Client.
    7. Geben Sie Ihren geheimen Clientschlüssel ein. Der geheime Clientschlüssel ist eine eindeutige Zeichenfolge, die beim Einrichten der Zielanwendungsintegration ausgegeben wird. Sie erfassen dies als geheimen Clientschlüssel beim Konfigurieren des OAuth-Client.
  7. Die Umschaltfläche Anforderungsratenlimit aktivieren ist aktiviert. Belassen Sie für Anzahl der Anforderungen den Wert 60 und für Zeitintervall den Wert 1 Minute.
  8. Das Anforderungstimeout ist auf 120 voreingestellt.
  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 Blackboard anzeigen der Seite Meine Noten.

Führen Sie die folgenden Schritte aus:

  1. Navigieren Sie auf der Seite Mikroappintegrationen zur Blackboard Learn-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 Blackboard 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}/webapps/bb-social-learning-BBLEARN/execute/mybb?cmd=display&toolId=MyGradesOnMyBb_____MyGradesTool

    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 unten aufgeführten Endpunkte ändern.

Führen Sie die folgenden Schritte aus:

  1. Wählen Sie auf der Seite Mikroappintegrationen das Menü neben der Blackboard Learn-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. Für jeden Endpoint, der in der folgenden Tabelle aufgeführt ist, müssen Sie den Datentyp im Menü für das angegebene Attribut ändern.

    Endpunkt Attribut Datentypänderung
    Kursankündigungen Textkörper Binär
    Benutzernoten Punktzahl anzeigen Doppelt
    Punktzahl für Note Mögliche Punktzahl Doppelt
  3. Wählen Sie für jeden Endpunkt das Menü neben dem Endpunkt und dann Bearbeiten.
  4. 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.
  5. Ä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.
  6. 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.

Weitere Informationen zu API-Endpunkten und Tabellenentitäten finden Sie unter Blackboard Learn-Connectorspezifikationen.

Hinweise:

Das Paginierungslimit ist auf 100 festgelegt. Administratoren können dieses Limit je nach API auf bis zu 200 erweitern.

Aufgrund der Begrenzung von API-Aufrufen werden bei der inkrementellen Synchronisierung nur Kursmitgliedschaften und Kursankündigungen erfasst. Die übrigen Endpunkte werden im Rahmen der vollständigen Synchronisierung ausgelöst.

Verwenden von Blackboard Learn-Mikroapps

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

Hinweis

Für die Mikroapp “Meine Noten” muss ein Administrator den “host_name” auf der Schaltfläche In Blackboard anzeigen der Seite Meine Noten aktualisieren. Vollständige Schritte hierfür finden Sie unter Konfigurieren von Dienstaktionsparametern.

Kursanmeldung: Anmeldung für einen Kurs.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Benachrichtigung: Neuer Kurs - Anmeldung Registrierte Teilnehmer erhalten nach der Kursanmeldung eine Benachrichtigung.
Seite “Kursanmeldungsdetails” Schreibgeschützte Ansicht der selbst gebuchten Kurse mit Kursdetails und Angaben zum Kursleiter.
Seite “Kursliste” Liste der verfügbaren Kurse.
Seite “Kursdetails” Anzeige von Kursdetails, Kursleitern und einer Option zur Schnellanmeldung.

Kursankündigung erstellen: Hiermit können Kursleiter eine Ankündigung für einen Kurs erstellen.

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.

Kursleiteransicht: Hiermit können Kursleiter Teilnehmer und Noten anzeigen.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Seite “Kursdetails” Kursleiteransicht einer Liste der verfügbaren Kurse.
Seite “Teilnehmerdetails” Kursleiteransicht einer Liste der bei einem Kurs angemeldeten Teilnehmer.
Seite “Notendetails” Kursleiteransicht der Noten bestimmter Kursteilnehmer.

Meine Kurse: Anzeige von Kursankündigungen und Anlagen für einen Kurs

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Benachrichtigung “Ankündigung eines neuen Kurses” Wenn eine neue Ankündigung vorliegt, erhalten die beim Kurs angemeldeten Teilnehmer eine Benachrichtigung.
Seite “Kursankündigungsdetails” Schreibgeschützte Ansicht neuer Ankündigungen für einen Kurs mit Details.
Seite “Meine Kurse” Liste aller Kurse, bei denen der Benutzer angemeldet ist.
Seite “Kursdetails” Liste von Ankündigungen und Anlagen für einen Kurs.
Seite “Ankündigungsdetails” Anzeige einer Kursankündigung und zugehöriger Details.
Seite “Anlagendetails” Anzeige und möglicher Download einer Anlage.

Meine Noten: Anzeige von Noten für Kursteilnehmer.

Benachrichtigung oder Seite Workflows für Anwendungsfälle
Benachrichtigung “Neue Noten” Wenn eine neue Note veröffentlicht wurde, erhalten die beim Kurs angemeldeten Teilnehmer eine Benachrichtigung.
Seite “Meine Noten” Ermöglicht Teilnehmern die Notenansicht durch Auswahl des Kurses.