Ally-tools, filters en plugins voor rapporten installeren

De 3.3-versies van de plugins zijn compatibel met Moodle 3.2.

  1. Download of kloon de benodigde versie van de Ally-beheertool via github.

    1. Wordt gedownload als zip-bestand
      1. Je kunt, indien nodig, de versie van de branch wijzigen.
      2. Bekijk het bestand version.php om te zien of het benodigde nummer en de benodigde release van Moodle ('vereiste') overeenkomt met jouw versie van Moodle. Bijv. voor Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        De release "3.4.3" zou met jouw Moodle 3.4-installatie moeten werken. Als deze parameters niet overeenkomen met die van jouw Moodle-installatie, zul je de branch mogelijk opnieuw moeten wijzigen.

        Meer informatie over de bijbehorende releases en versienummers van Moodle

      3. Download de bestanden in de opslaglocatie met 'Klonen of downloaden > Zip downloaden'
    2. Git-opslaglocatie klonen
      1. De map met tools openen.

        cd [moodle location]/admin/tool

      2. De opslaglocatie klonen
        • SSH gebruiken

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

        • HTTP gebruiken

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

      3. Check de bijbehorende branch uit. Voor Moodle 3.4 is deze bijvoorbeeld MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Het uitchecken van de branch kan ook worden gebruikt voor het ontvangen van updates. Als je je Moodle-installatie dus hebt bijgewerkt, kun je de bijbehorende branch uitchecken. Als de branch niet gevonden is, kan het zijn dat je opslaglocatie verouderd is. Dit kan worden verholpen met een ophaalactie:

        git fetch

  2. Download of kloon de benodigde versie van het Ally-filter via github.

    1. Wordt gedownload als zip-bestand
      1. Je kunt, indien nodig, de versie van de branch wijzigen.
      2. Bekijk het bestand version.php om te zien of het benodigde nummer en de benodigde release van Moodle ('vereiste') overeenkomt met jouw versie van Moodle. Bijv. voor Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        De release "3.4.3" zou met jouw Moodle 3.4-installatie moeten werken. Als deze parameters niet overeenkomen met die van jouw Moodle-installatie, zul je de branch mogelijk opnieuw moeten wijzigen.

        Meer informatie over de bijbehorende releases en versienummers van Moodle.

      3. Download de bestanden in de opslaglocatie met 'Klonen of downloaden > Zip downloaden'
    2. Git-opslaglocatie klonen
      1. De map met filters openen.

        cd [moodle location]/filter

      2. De opslaglocatie klonen
        • SSH gebruiken

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

        • HTTP gebruiken

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

      3. Check de bijbehorende branch uit. Voor Moodle 3.4 is deze bijvoorbeeld MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Het uitchecken van de branch kan ook worden gebruikt voor het ontvangen van updates. Als je je Moodle-installatie dus hebt bijgewerkt, kun je de bijbehorende branch uitchecken. Als de branch niet gevonden is, kan het zijn dat je opslaglocatie verouderd is. Dit kan worden verholpen met een ophaalactie:

        git fetch

  3. Download de benodigde versie van de LTI-tool voor Ally-rapporten via github.

    1. Wordt gedownload als zip-bestand
      1. Je kunt, indien nodig, de versie van de branch wijzigen.
      2. Bekijk het bestand version.php om te zien of het benodigde nummer en de benodigde release van Moodle ('vereiste') overeenkomt met jouw versie van Moodle. Bijv. voor Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        De release "3.4.3" zou met jouw Moodle 3.4-installatie moeten werken. Als deze parameters niet overeenkomen met die van jouw Moodle-installatie, zul je de branch mogelijk opnieuw moeten wijzigen.

        Meer informatie over de bijbehorende releases en versienummers van Moodle.

      3. Download de bestanden in de opslaglocatie met 'Klonen of downloaden > Zip downloaden'
    2. Git-opslaglocatie klonen
      1. De map met rapporten openen

        cd [moodle location]/report

      2. De opslaglocatie klonen
        • SSH gebruiken

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

        • HTTP gebruiken

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

      3. Check de bijbehorende branch uit. Voor Moodle 3.4 is deze bijvoorbeeld MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Het uitchecken van de branch kan ook worden gebruikt voor het ontvangen van updates. Als je je Moodle-installatie dus hebt bijgewerkt, kun je de bijbehorende branch uitchecken. Als de branch niet gevonden is, kan het zijn dat je opslaglocatie verouderd is. Dit kan worden verholpen met een ophaalactie:

        git fetch

  4. Controleer de mappenstructuur.

    De map van de beheertool moet ally worden genoemd. Het pad moet als volgt zijn:

    [yourmoodledir]/admin/tool/ally

    De map met filters moet ally worden genoemd. Het pad moet als volgt zijn:

    [yourmoodledir]/filter/ally

    De map met rapporten moet allylti worden genoemd. Het pad moet als volgt zijn:

    [yourmoodledir]/report/allylti

  5. Zorg dat elke map en de inhoud ervan leesbaar zijn door je webserver.
  6. Log in als beheerder van je Moodle-site en open de beheerpagina. Er wordt vervolgens gecontroleerd op nieuwe plugins en de volgende optie wordt weergegeven: Moodle-database nu upgraden. Klik op deze knop om de plugins te installeren.
  7. Na het installeren van de plugins navigeer je naar Systeembeheerder > Plugins > Beheertools > Ally.
  8. Kies voor Ally-webservice automatisch configureren.

    Op het volgende scherm wordt een webservice-token en een URL voor het testen van de Ally-webservice weergegeven.

    Deze URL moet direct beschikbaar zijn via internet, zodat Ally er gebruik van kan maken.

    Indien dit is gelukt, kopieer je de token van de Ally-webservice en de koppeling naar de webservice. Deel deze met de technische ondersteuning via de IronBox-deelfunctie en zij zullen de webservice dan configureren en je toegang geven via een e-mailkoppeling. Ze nemen contact met je op zodra alles aan hun kant is ingesteld en geven je de 'sleutel', het 'geheim', de 'opstart-URL', de 'URL voor het bijwerken van bestanden' en de 'client-ID'.

    Als jouw Moodle-installatie gebruikmaakt van aangepaste verplichte velden voor gebruikersaccount, 'log dan in als' de gebruiker van de Ally-webservice die wordt aangemaakt door de plugin voor automatische configuratie om te garanderen dat deze velden ingevuld en opgeslagen zijn.


De Moodle-plugin configureren

De technische ondersteuning van Ally maakt de Ally-client aan met de Moodle Webservice Token die in een eerder deel is gegenereerd en geeft je technische informatie over het configureren van de Ally-plugin.

  1. Log in als Moodle-beheerder.
  2. Kies in Sitebeheer voor Plugins en Beheertools. Selecteer Ally-configuratie.
  3. Geef de volgende gegevens op
    • Inhoudsauteurs: De gebruikersrollen die contentauteurs zijn. Moet als volgt zijn: Manager, Cursusmaker, Docent (de standaardwaarden).

      Deze mogen normaal gesproken niet worden gewijzigd. We willen je vragen om contact op te nemen met de technische ondersteuning van Ally om deze waarden te wijzigen.

    • Sleutel: De LTI-sleutel die door de technische ondersteuning van Ally is verstrekt
    • Geheim: Het LTI-geheim dat door de technische ondersteuning van Ally is verstrekt
    • Opstart-URL: De LTI opstart-URL die door de technische ondersteuning van Ally is verstrekt
    • URL voor het bijwerken van bestanden: De URL voor het bijwerken van bestanden/gebeurtenissen die door de technische ondersteuning van Ally is verstrekt. https://[AllyEnvironment].ally.ac/api/v1/events
    • Client-ID: De Client-ID die door de technische ondersteuning van Ally is verstrekt
  4. Wijzigingen opslaan.

Ally-instellingsrapport

Zodra de Ally-plugin is geconfigureerd, kun je het Ally-instellingsrapport openen.

Er worden geen gegevens in het rapport weergegeven tot synchronisatie van de Ally is uitgevoerd en het eerste rapport is gegenereerd.

Om het Ally-instellingsrapport te openen, ga je naar Sitebeheer en kies je voor Rapporten. Selecteer Toegankelijkheid.

Meer informatie over Ally-instellingsrapporten


Ally-filter

Wanneer je er klaar voor bent om de downloadopties voor de Ally-toegankelijkheidsscore en alternatieve toegankelijke versies beschikbaar te stellen in Moodle, moet je het Ally-filter activeren.

Het Ally-filter inschakelen

  1. Kies in Sitebeheer voor Plugins en Plugins-overzicht.
  2. Ga naar het gedeelte Tekstfilters en schakel het Ally-filter in.
  3. Verplaats het Ally-filter naar de hoogste positie in de Filter-lijst.

UI Ally-configuratie openen

Wij bieden je instructies voor het openen van de Ally-configuratie tijdens de installatie. Als je geen toegang hebt, dien je een aanvraag in op 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