Installation von Ally-Tools, -Filtern und -Plugins für Berichte

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 und öffnen Sie die Einstellungsseite für das Ally-Admin-Tool. (Website-Administration > Plugins > Administrator-Werkzeuge > Ally)
  2. 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.
  3. 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.