Ally-Tools, -Filter und -Plugins für Berichte installieren

Ally ist mit mehreren Hosting-Optionen und -Themen von Moodle kompatibel. Folgende Versionen und Themen werden in Ally unterstützt:

Moodle 3.11.x

  • Snap
  • Boost
  • Clean
  • Mehr

Moodle 4.0.x

  • Snap
  • Boost

Moodle 4.1.x

  • Snap
  • Boost

Moodle 4.2.x

  • Snap
  • Boost

Moodle 4.3.x

  • Snap
  • Boost


Ally-Plugin für 4.1 OpenLMS-Umgebungen
OpenLMS wird seine Umgebungen in den kommenden Wartungsfenstern auf die Version 4.1 aktualisieren. Siehe OpenLMS EDU-Versionszeitplan. Das Ally-Plugin für Version 4.1 wird nach Ausführung der Wartungsfenster verfügbar sein und sollte in der OpenLMS-Plugin-Matrix verfügbar sein.


Ally funktioniert mit Moodle-Versionen vor 3.10.x, wobei Bugfixes jedoch nicht unterstützt werden. Wir empfehlen Ihnen, Ihre Moodle-Version zu aktualisieren. Anleitungen finden Sie unter Moodle-Versionsunterstützung. 

Hinweis: Andere nicht erwähnte Versionen oder Themen werden von Ally nicht unterstützt.

Um Ally mit Moodle in selbst gehosteten Umgebungen zu konfigurieren, konfigurieren Sie die folgenden Plugins:

  • Ally-Administratortools
  • Ally-Filter
  • Ally-Bericht-LTI

Von OpenLMS bereitgestellte Umgebungen sind bereits in Ally integriert. 

Konfigurationsschritte

  1. Laden Sie die erforderliche Version des Ally-Admin-Tools von GitHub herunter oder klonen Sie sie.

    1. Herunterladen als ZIP-Datei
      1. Ändern Sie bei Bedarf die Branch-Version.

      2. Überprüfen Sie Datei "version.php", um zu überprüfen, ob die erforderliche Versionsnummer und das Release von Moodle mit Ihrer Moodle-Version übereinstimmen. D. h. Moodle 3.11

        $plugin->release = '3.11.6';

        $plugin->requires = 2021051700;

        Das Release "3.11.6" sollte mit Installationen von Moodle 3.11 funktionieren. Wenn diese Parameter nicht mit Ihrer Moodle-Installation übereinstimmen, müssen Sie den Branch eventuell erneut ändern.

        Weitere Informationen zu den entsprechenden Moodle-Versionen und Versionsnummern

      3. Laden Sie das Repository über „Clone or download > Download ZIP“ (Klonen oder herunterladen > ZIP herunterladen) herunter
    2. Git-Repository wird geklont

      1. Greifen Sie auf den Tools-Ordner zu.

        cd [moodle location]/admin/tool

      2. Klonen des Repositorys

        • Mit SSH

          git clone [email protected]:anthology-ally/moodle-tool_ally ally

        • Mit HTTP

          git clone https://github.com/anthology-ally/moodle-tool_ally.git ally

      3. Überprüfen Sie die entsprechende Branch-Version, d. h. für Moodle 3.11 ist es MOODLE_311_STABLE

        git checkout MOODLE_311_STABLE

        Das Auschecken des Branch kann auch zum Erhalt von Aktualisierungen verwendet werden. Wenn Sie Ihre Moodle-Installation aktualisiert haben, können Sie einfach den entsprechenden Branch auschecken. Wenn der Branch nicht gefunden wird, ist Ihr Repo möglicherweise veraltet. Dies kann durch Abrufen behoben werden:

        git fetch

  2. Laden Sie die erforderliche Version des Ally-Filters von GitHub herunter oder klonen Sie sie.

    1. Herunterladen als ZIP-Datei
      1. Ändern Sie bei Bedarf die Branch-Version.

      2. Überprüfen Sie Datei "version.php", um zu überprüfen, ob die erforderliche Versionsnummer und das Release von Moodle mit Ihrer Moodle-Version übereinstimmen. D. h. Moodle 3.11

        $plugin->release = '3.11.6';

        $plugin->requires = 2021051700;

        Das Release "3.11.6" sollte mit Installationen von Moodle 3.11 funktionieren. Wenn diese Parameter nicht mit Ihrer Moodle-Installation übereinstimmen, müssen Sie den Branch eventuell erneut ändern.

        Weitere Informationen zu den entsprechenden Moodle-Versionen und Versionsnummern

      3. Laden Sie das Repository über „Clone or download > Download ZIP“ (Klonen oder herunterladen > ZIP herunterladen) herunter
    2. Git-Repository wird geklont

      1. Greifen Sie auf den Filterordner zu.

        cd [moodle location]/filter

      2. Klonen des Repositorys

        • Mit SSH

          git clone [email protected]:anthology-ally/moodle-filter_ally ally

        • Mit HTTP

          git clone https://github.com/anthology-ally/moodle-filter_ally.git ally

      3. Überprüfen Sie die entsprechende Branch-Version, d. h. für Moodle 3.11 ist es MOODLE_311_STABLE

        git checkout MOODLE_311_STABLE

        Das Auschecken des Branch kann auch zum Erhalt von Aktualisierungen verwendet werden. Wenn Sie Ihre Moodle-Installation aktualisiert haben, können Sie einfach den entsprechenden Branch auschecken. Wenn der Branch nicht gefunden wird, ist Ihr Repo möglicherweise veraltet. Dies kann durch Abrufen behoben werden:

        git fetch

  3. Laden Sie die erforderliche Version des Ally-Bericht-LTI-Tools von GitHub herunter oder klonen Sie sie.

    1. Herunterladen als ZIP-Datei
      1. Ändern Sie bei Bedarf die Branch-Version.

      2. Überprüfen Sie Datei "version.php", um zu überprüfen, ob die erforderliche Versionsnummer und das Release von Moodle mit Ihrer Moodle-Version übereinstimmen. D. h. Moodle 3.11

        $plugin->release = '3.11.6';

        $plugin->requires = 2021051700;

        Das Release "3.11.6" sollte mit Installationen von Moodle 3.11 funktionieren. Wenn diese Parameter nicht mit Ihrer Moodle-Installation übereinstimmen, müssen Sie den Branch eventuell erneut ändern.

        Weitere Informationen zu den entsprechenden Moodle-Versionen und Versionsnummern

      3. Laden Sie das Repository über „Clone or download > Download ZIP“ (Klonen oder herunterladen > ZIP herunterladen) herunter
    2. Git-Repository wird geklont

      1. Greifen Sie auf den Berichte-Ordner zu.

        cd [moodle location]/report

      2. Klonen des Repositorys

        • Mit SSH

          git clone [email protected]:anthology-ally/moodle-report_allylti ally

        • Mit HTTP

          git clone https://github.com/anthology-ally/moodle-report_allylti.git ally

      3. Überprüfen Sie die entsprechende Branch-Version, d. h. für Moodle 3.11 ist es MOODLE_311_STABLE

        git checkout MOODLE_311_STABLE

        Das Auschecken des Branch kann auch zum Erhalt von Aktualisierungen verwendet werden. Wenn Sie Ihre Moodle-Installation aktualisiert haben, können Sie einfach den entsprechenden Branch auschecken. Wenn der Branch nicht gefunden wird, ist Ihr Repo möglicherweise veraltet. Dies kann durch Abrufen behoben werden:

        git fetch

  4. Überprüfen Sie die Ordnerstruktur.

    Das Administrator-Tool-Verzeichnis muss ally benannt werden. Es sollte den folgenden Pfad haben:

    [yourmoodledir]/admin/tool/ally

    Das Filterverzeichnis muss ally benannt werden. Es sollte den folgenden Pfad haben:

    [yourmoodledir]/filter/ally

    Das Berichtsverzeichnis muss allylti benannt werden. Es sollte den folgenden Pfad haben:

    [yourmoodledir]/report/allylti

  5. Vergewissern Sie sich, dass jeder Ordner und sein Inhalt von Ihrem Webserver gelesen werden kann.
  6. Melden Sie sich als Administratoren an Ihrer Moodle-Website an und öffnen Sie die Administrator-Seite. Hierdurch sollte eine Überprüfung auf neue Plugins erfolgen und es sollte eine Option zum Aktualisieren der Moodle-Datenbank angezeigt werden. Klicken Sie darauf, um die Plugins zu installieren.
  7. Navigieren Sie nach der Installation der Plugins zu Systemadministration > Plugins > Administrator-Werkzeuge > Ally.

  8. Wählen Sie die Option zum automatischen Konfigurieren des Ally-Webservice.

    Auf dem nächsten Bildschirm wird ein Webservice-Token und eine URL zum Testen des Ally-Webservice angezeigt.

    Diese URL muss direkt über das Internet zugänglich sein, damit Ally sie verwenden kann.

    Wenn dies erfolgreich ist, müssen Sie den Ally-Webservice-Token und den Webservice-Link kopieren und ihn Ihrem Ally Technical Consultant oder Support Engineer zur Verfügung stellen. Er wird sich mit Ihnen in Verbindung setzen, sobald er seinerseits alles eingerichtet hat, und er stellt Ihnen den Schlüssel ('key'), das Geheimnis ('secret'), die Start-URL ('launch URL'), die URL für Datei-Updates ('file updates URL') und die Client-ID ('client id') zur Verfügung.

    Wenn Ihre Moodle-Instanz benutzerdefinierte Felder für Benutzerkonten verwendet, melden Sie sich als der Ally-Webservice-Benutzer an, der von der automatischen Konfiguration des Plugins erstellt wird, um sicherzustellen, dass diese benutzerdefinierten Felder ausgefüllt und gespeichert werden.

Konfigurieren des Moodle-Plugins

Der Ally Technical Consult erstellt den Ally-Client über das Moodle-Webservice-Token, das im vorherigen Abschnitt generiert wurde, und stellt Ihnen die Details für die Konfiguration des Ally-Plugins zur Verfügung.

  1. Melden Sie sich als Moodle-Administrator an.
  2. Unter Website-Administration Wählen Sie Plugins und Administrator-Tools. Wählen Sie Ally-Konfiguration.
  3. Geben Sie die folgenden Informationen ein

    • Inhaltsersteller: Die Benutzerrollen, die Inhaltsersteller sind. Muss Folgendes sein: Manager, Kursersteller, Trainer (Standardeinstellungen).

      Dies ändert sich in der Regel nicht. Ändern Sie dies nicht, ohne sich zuvor mit dem Ally Technical Consultant abzusprechen.

    • Schlüssel: Der LTI-Schlüssel, der Ihnen vom Ally Technical Consultant bereitgestellt wurde.
    • Secret: Das LTI-Secret, das Ihnen vom Ally Technical Consultant bereitgestellt wurde.
    • Start-URL: Die LTI-Start-URL, die Ihnen vom Ally Technical Consultant bereitgestellt wurde.
    • Datei-Update-URL: Die Datei-Update-/Event-URL, die Ihnen vom Ally Technical Consultant bereitgestellt wurde. https://[AllyEnvironment].ally.ac/api/v1/events
    • Client-ID: Die Client-ID, die Ihnen vom Ally Technical Consultant bereitgestellt wurde.
    • Protokollbereich: Leicht
  4. Speichern Sie die Änderungen.

Ally-Institutionsbericht

Nachdem das Ally-Plugin konfiguriert wurde, können Sie auf den Ally-Institutionsbericht zugreifen.

Dieser Bericht enthält erst dann Daten, wenn die Kurssynchronisierung in Ally durchgeführt wurde und der anfängliche Bericht erstellt wurde.

Um auf den Ally-Institutionsbericht zuzugreifen, gehen Sie zu Website-Administration und wählen Sie Berichte. Wählen Sie Barrierefreiheit aus.

Mehr zum Ally-Institutionsbericht

Ally-Filter

Wenn Sie bereit sind, die Download-Option für die Ally-Bewertung der Barrierefreiheit und die alternative Version in Moodle verfügbar zu machen, müssen Sie den Ally-Filter aktivieren.

Aktivieren des Ally-Filters

  1. Wählen Sie in Website-Administration die Option Plugins und Plugin-Übersicht.
  2. Gehen Sie zum Abschnitt Textfilter und aktivieren Sie den Ally-Filter.
  3. Verschieben Sie den Ally-Filter an die oberste Position in der Liste Filter.

Auf die Benutzeroberfläche für die Ally-Konfiguration zugreifen

Bei der Einrichtung erhalten Sie Anweisungen dazu, wie Sie die Ally-Konfiguration aufrufen. Wenn Sie die Seite nicht aufrufen können, senden Sie eine Anfrage an Behind The Blackboard.

Ally für Kurse konfigurieren

Kurse konfigurieren

Aktivieren Sie auf der Seite Ally-Konfiguration Ally für alle Kurse oder für einzelne Kurse. Ganz wie Sie möchten!

  1. Zeigen Sie die Anzahl Ihrer Kurse an, die Ally verwenden.
  2. Sie können Ally für alle vorhandenen Kurse aktivieren oder deaktivieren. Entscheiden Sie sich rechtzeitig, wenn Ally auch für alle zukünftigen Kurse aktiviert werden soll.
  3. Suchen Sie nach einzelnen Kursen oder filtern Sie alle Kurse nach „Aktiviert“, „Deaktiviert“ und „Kursabschnitt“.
  4. Sie können Ally für alle vorhandenen Kurse aktivieren oder deaktivieren.

Ally für einen einzelnen Kurs aktivieren oder deaktivieren

Wenn Ally aktiviert ist, profitieren Dozenten und Teilnehmer von den Bewertungen der Barrierefreiheit, vom Dozentenfeedback und von den durch Ally bereitgestellten Alternativformaten.

Der Einrichtungsbericht ist für alle Kurse verfügbar. Dabei spielt es keine Rolle, ob Ally in einem Kurs aktiviert ist oder nicht. Der Kurs erscheint im Einrichtungsbericht.

Suchen Sie auf der Seite Ally-Konfiguration den Kurs, den Sie aktualisieren möchten. Im Feld Suchen können Sie anhand von Filtern nach Kurstitel, Kurs-ID und Kurscode suchen.

Wählen Sie in der Spalte Aktiviert die Option Aktivieren oder Deaktivieren, um Ally zu aktivieren bzw. zu deaktivieren.

  • Ally ist deaktiviert: Wählen Sie die Option Integration der Kurs-UI aktivieren, um
    zu aktivieren
  • Ally ist aktiviert: Wählen Sie die Option Integration der Kurs-UI deaktivieren, um
    zu deaktivieren

Ally für alle Kurse aktivieren oder deaktivieren

Wissen Sie nicht, ob Ally in allen Kursen verwendet wird? Oben auf der Seite "Ally-Konfiguration" wird angezeigt, wie viele Kurse zurzeit Ally nutzen.

Wenn Ally aktiviert ist, profitieren Dozenten und Teilnehmer von den Bewertungen der Barrierefreiheit, vom Dozentenfeedback und von den durch Ally bereitgestellten Alternativformaten.

Der Einrichtungsbericht ist für alle Kurse verfügbar. Dabei spielt es keine Rolle, ob Ally in einem Kurs aktiviert ist oder nicht. Der Kurs erscheint im Einrichtungsbericht.

Sie können Ally für jeden vorhandenen Kurs auf der Seite Ally-Konfiguration aktivieren oder deaktivieren. Wählen Sie Alle Kurse deaktivieren/aktivieren und anschließend Deaktivieren oder Aktivieren.

Wählen Sie In zukünftigen Kursen aktivieren, wenn Ally automatisch in allen neuen Kursen aktiviert sein soll.

Wenn Sie diese Option nicht aktivieren, ist Ally in neuen Kursen nicht aktiviert. Wenn Sie Ally zu einem späteren Zeitpunkt aktivieren möchten, aktivieren Sie Ally für einzelne Kurse.

Nachdem Sie für jeden Kurs die Entscheidung über die Aktivierung bzw. Deaktivierung getroffen haben, müssen Sie die Entscheidung bestätigen. Wählen Sie je nach Auswahl Aktivieren oder Deaktivieren. Wählen Sie Abbrechen, wenn Sie es sich anders überlegt haben und doch nichts ändern möchten.

Ally nur für alle neuen Kurse aktivieren

Wenn Ally aktiviert ist, profitieren Dozenten und Teilnehmer von den Bewertungen der Barrierefreiheit, vom Dozentenfeedback und von den durch Ally bereitgestellten Alternativformaten.

Der Einrichtungsbericht ist für alle Kurse verfügbar. Dabei spielt es keine Rolle, ob Ally in einem Kurs aktiviert ist oder nicht. Der Kurs erscheint im Einrichtungsbericht.

Wählen Sie In zukünftigen Kursen aktivieren, wenn Ally automatisch in allen neuen Kursen aktiviert sein soll.

Wenn Sie diese Option nicht aktivieren, ist Ally in neuen Kursen nicht aktiviert. Wenn Sie Ally zu einem späteren Zeitpunkt aktivieren möchten, aktivieren Sie Ally für einzelne Kurse.

Ally-Hilfeeinstellungen konfigurieren

Konfigurieren der Einstellungen für die Ally-Benutzerhilfe

Konfigurieren Sie eigene Hilfemeldungen, die in den Modulen Alternative Formate und Kursleiterfeedback angezeigt werden. Die benutzerdefinierten Hilfemeldungen können verwendet werden, um Teilnehmer und Kursleiter auf vorhandene institutionelle Dokumente zu verweisen, Kontaktinformationen zu teilen usw. Wenn keine benutzerdefinierte Nachricht konfiguriert wurde, verweisen die Hilfe-Links auf diese Seiten in der Blackboard-Hilfe:

  • Alternative Formate Auf dieser Seite wird erläutert, wie und wann die verschiedenen alternativen Formate verwendet werden können.
  • Kursleiter-Hilfe Alles, was Kursleiter über Ally in ihren Kursen wissen müssen

Der benutzerdefinierte Hilfe-Inhalt kann in der Benutzeroberfläche für die Ally-Konfiguration konfiguriert werden und verwendet das Markdown-Format, um eine strukturierte und barrierefreie Meldung bereitzustellen.

  1. Gehen Sie zur Ally-Konfiguration und wählen Sie Hilfe-Einstellungen aus.
  2. Wählen Sie die standardmäßige oder benutzerdefinierte Option für die Kursleiterfeedback-Hilfe und die Hilfe zu alternativen Formaten.
  3. Wenn Sie die benutzerdefinierte Option auswählen, bearbeiten Sie die benutzerdefinierte Nachricht.

    Verwenden Sie das Markdown-Format, um eine strukturierte (und barrierefreie) Nachricht bereitzustellen.

  4. Wählen Sie Änderungen speichern aus.

Expertenhilfe konfigurieren

Stellen Sie Ihren Kursleitern und Teilnehmern einfachen Zugang zu Ihrem Team von Barrierefreiheitsexperten bereit. Aktivieren Sie Expertenhilfe, um Ihren Benutzern die Möglichkeit zu geben, direkt Hilfe zu den alternativen Formaten und zu den Kursleiterfeedback-Feldern anzufordern.

Wenn eine Anfrage gestellt wird, wird eine E-Mail mit der Hilfeanfrage und den Details über den aktuellen Kurs, das Inhaltselement und den Benutzer an die von Ihnen konfigurierte E-Mail-Adresse gesendet.

  1. Gehen Sie zur Ally-Konfiguration und wählen Sie Hilfe-Einstellungen aus.
  2. Wählen Sie für die Kursleiterfeedback-Hilfe und die Hilfe zu alternativen Formaten Benutzerdefiniertes Feedback bereitstellen aus.
  3. Wählen Sie Expertenhilfe aktivieren aus.
  4. Geben Sie die E-Mail-Adresse Ihres Expertenteams für Barrierefreiheit ein.
  5. Wählen Sie Änderungen speichern aus.

Sie müssen dem Ally-API-Benutzer für die Blackboard Learn-Integration die Berechtigung „Administration (Benutzer) > Benutzer“ oder „system.user.view“ zuweisen, damit Ally den Namen und die E-Mail-Adresse des Teilnehmers in die Hilfeanfrage-E-Mail einfügen kann. Sie müssen dem Ally-API-Benutzer für die Moodle-Integration die Berechtigung „moodle/user:viewalldetails“ zuweisen, damit Ally den Namen und die E-Mail-Adresse des Teilnehmers in die Hilfeanfrage-E-Mail einfügen kann.

Ally-Funktionen anpassen

Flags für Ally-Funktionen anpassen

Sie können einige Funktionen aktivieren bzw. deaktivieren, um Ally entsprechend den Wünschen Ihrer Institution anzupassen.

Legen Sie in der Ally-Konfiguration fest, welche Funktionen aktiviert werden sollen.

  1. Gehen Sie zur Ally-Konfiguration und wählen Sie Funktionen aus.
  2. Suchen Sie nach der Funktion, die Sie aktivieren bzw. deaktivieren möchten, und wählen Sie sie aus.
    • Generierung von alternativen Beschreibungen für Bilder durch KI: Wenn Bilder keinen Alternativtext enthalten, können Kursleiter den KI-Alternativtext-Assistenten nutzen, um mühelos Vorschläge zu generieren. Durch die Aktivierung dieser Funktion erklären Sie sich mit unseren Nutzungsbedingungen einverstanden. Detaillierte Informationen zu den Risiken und Einschränkungen dieser Funktion finden Sie in unserem Transparenzhinweis.
    • Alternatives Format – Immersive Reader: Schüler können die Leseerfahrung mit dieser Online-Funktion verbessern.
    • Alternatives Format – Übersetzte Version: Teilnehmer können ein übersetztes alternatives Format einer Originaldatei herunterladen.
    • Alternatives BeeLine Reader-Format: Teilnehmer können ein alternatives BeeLine Reader-Format herunterladen.
    • Bewertungsindikatoren für Administratoren in allen Kursen: Administratoren können die Ally-Bewertungen der Barrierefreiheit in allen Kursen sehen, einschließlich Kursen, in denen Ally nicht in der Benutzeroberfläche der Ally-Konfiguration aktiviert ist. Auf diese Weise können sie Probleme beheben, ohne Ally im Kurs aktivieren zu müssen.

    • Dieses Funktionsflag ist für D2L Brightspace, Instructure Canvas, Moodle und Schoology verfügbar.

    • Auf das Feedback des Kursleiters über den Institutionsbericht zugreifen: Gewähren Sie Administratoren, Diensten für Teilnehmer mit Behinderungen und Kursgestaltern Zugriff auf das Feedback des Kursleiters.
    • Feedback des Kursleiters für WYSIWYG-Inhalte (Rich Text Editor-Inhalte): Kursleiter und Administratoren können auf Feedback zu Inhalten zugreifen, die in Ihrem LMS-WYSIWYG-Editor erstellt wurden. Setzen Sie ein Häkchen im Kontrollkästchen „Auch die im LMS integrierte Prüffunktion aktivieren“, um beide Barrierefreiheitsprüfungen zu aktivieren. 

    • Weitere Informationen zur WYSIWYG-Barrierefreiheit für Kursleiter

      Dieses Funktionsflag deaktiviert das Kursleiterfeedback oder Quick Fixes für HTML Dateien, die in D2L Brightspace hochgeladen oder erstellt wurden.

    • Integration von Ally-Daten in Impact by Instructure (ehemals EesySoft): Institutionen mit einer Impact by Instructure-Lizenz können eine detailliertere Überwachung der Interaktionen in dem Modul „Alternative Formate“, im Feedback des Kursleiters und im Bericht zur Kursbarrierefreiheit ermöglichen. Institutionen können diese Daten für Akzeptanzberichte und Kampagnen in Impact by Instructure nutzen. Die Impact by Instructure-Integration ist standardmäßig deaktiviert.

      Für diese Integration ist eine Impact by Instructure-Lizenz erforderlich.

  3. Wählen Sie Aktivieren oder Deaktivieren aus, um die Funktion zu aktivieren bzw. zu deaktivieren.