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

Die Version 3.3 der Plugins ist mit Moodle 3.2 kompatibel.

  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 übereinstimmt. D. h. für Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        Das Release "3.4.3" sollte mit Installationen von Moodle 3.4 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. Klonen des Git-Repositorys
      1. Greifen Sie auf den Tools-Ordner zu.

        cd [moodle location]/admin/tool

      2. Klonen des Repositorys
        • Mit SSH

          git clone [email protected]:blackboard-open-source/moodle-tool_ally ally

        • Mit HTTP

          git clone https://github.com/blackboard-open-source/moodle-tool_ally.git ally

      3. Checken Sie den entsprechenden Branch aus, d. h. für Moodle 3.4 ist dies MOODLE_34_STABLE

        git checkout MOODLE_34_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 übereinstimmt. D. h. für Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        Das Release "3.4.3" sollte mit Installationen von Moodle 3.4 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. Klonen des Git-Repositorys
      1. Greifen Sie auf den Filterordner zu.

        cd [moodle location]/filter

      2. Klonen des Repositorys
        • Mit SSH

          git clone [email protected]:blackboard-open-source/moodle-filter_ally ally

        • Mit HTTP

          git clone https://github.com/blackboard-open-source/moodle-filter_ally.git ally

      3. Checken Sie den entsprechenden Branch aus, d. h. für Moodle 3.4 ist dies MOODLE_34_STABLE

        git checkout MOODLE_34_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 übereinstimmt. D. h. für Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        Das Release "3.4.3" sollte mit Installationen von Moodle 3.4 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]:blackboard-open-source/moodle-report_allylti ally

        • Mit HTTP

          git clone https://github.com/blackboard-open-source/moodle-report_allylti.git ally

      3. Checken Sie den entsprechenden Branch aus, d. h. für Moodle 3.4 ist dies MOODLE_34_STABLE

        git checkout MOODLE_34_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 & gt; Plugins & gt; Administrator-Werkzeuge & gt; 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 über die IronBox-Freigabe zur Verfügung stellen. Dieser richtet Sie ein und gibt Ihnen per E-Mail Zugriff auf den Link. 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.
  4. Speichern Sie die Änderungen.

Ally-Einrichtungsbericht

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 Configure Courses


Configure courses

Go to your Ally Configuration page and turn Ally on for all courses or decide course-by-course. It's up to you.

  1. View how many of your courses use Ally.
  2. Turn Ally on or off for all existing courses. Decide ahead of time if you want it enabled for all future courses as well.
  3. Search for individual courses or filter all course by enabled, disabled, and term.
  4. Turn Ally on or off for individual courses.

Turn Ally on or off for a single course

When Ally is on, instructors and students benefit from the accessibility scores, instructor feedback and alternative formats that Ally provides.

The Institutional report is available for all courses. It doesn't matter if Ally is on or off in a course. The course appears in the Institutional report.

From Ally Configuration, find the course you want to update. Use the Search field and filters to search by course title, course ID and course code.

Select Enable or Disable under the Enabled column to turn Ally on or off.

  • Ally is off: Select Enable course UI integration to turn on
  • Ally is on: Select Disable course UI integration to turn off

Turn Ally on or off for all courses

Not sure if all courses are using Ally or not? At the top of the Ally Configuration page, see how many of your courses are currently using Ally.

When Ally is on, instructors and students benefit from the accessibility scores, instructor feedback and alternative formats that Ally provides.

The Institutional report is available for all courses. It doesn't matter if Ally is on or off in a course. The course appears in the Institutional report.

You can turn Ally on or off in every existing course from the Ally Configuration page. Select Disable/enable all courses and select Disable or Enable.

Select Enable in future courses if you want Ally automatically on in all new courses.

If you don't select this, new courses will not have Ally enabled. If you want Ally on at a later date, turn Ally on for single courses.

After you choose to disable or enable in all courses, you need to confirm your choice. Select Enable or Disable, depending on your choice. Select Cancel if you changed your mind and don't want to change anything.


Turn Ally on for all new courses only

When Ally is on, instructors and students benefit from the accessibility scores, instructor feedback and alternative formats that Ally provides.

The Institutional report is available for all courses. It doesn't matter if Ally is on or off in a course. The course appears in the Institutional report.

Select Enable in future courses if you want Ally automatically on in all new courses.

If you don't select this, new courses will not have Ally enabled. If you want Ally on at a later date, turn Ally on for single courses.

Ally Configure Help Settings


Configure Ally user help settings

Configure custom help messages that display in the Alternative formats and Instructor feedback modals. The custom help messages can be used to point students and instructors to existing institutional documentation, share contact information, and so on. The custom help content can be configured in the Ally Configuration UI, and uses the Markdown format to help provide a structured (and accessible) message.

When no custom message has been configured, the Help links point to these pages in Blackboard help:

  • Alternative formats: This page explains how and when the different alternative formats can be used
  • Instructor help: Everything instructors need to know about Ally in their courses
  1. Go to your Ally Configuration and select Help settings.
  2. Choose the default or custom help option for both the Instructor feedback help and Alternative formats help.
  3. If you choose the custom option, edit the Custom message.

    Use the Markdown format to help provide a structured (and accessible) message.

  4. Select Save changes.

Configure expert help

Give your instructors and students easy access to your team of accessibility experts. Enable expert help to add a way for your users to request more help directly from in the alternative formats and instructor feedback panels.

When a request is made, an email containing the help request and details about the current course, content item and user is sent to the email address you configure.

  1. Go to your Ally Configuration and select Help settings.
  2. Choose Provide custom help for both the Instructor feedback help and Alternative formats help.
  3. Select Enable expert help.
  4. Type the email address for your team of accessibility experts.
  5. Select Save changes.

The Ally API user for the Blackboard Learn integration needs to be given the "Administrator Panel (Users) > Users" or "system.user.view" permission to allow Ally to include the student name and email address in the help request email. The Ally API user for the Moodle integration needs to be given the “moodle/user:viewalldetails” permission to allow Ally to include the student name and email address in the help request email.

Request alternative formats help

Request instructor feedback help