Ally in Moodle

Ally-tools, filters en plugins voor rapporten installeren

Ally ondersteunt Moodle 3.4 en hoger.

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. D.w.z. 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 naar 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. Reken de bijbehorende branch af. D.w.z.: voor Moodle 3.4 is het 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. D.w.z. 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 naar 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. Reken de bijbehorende branch af. D.w.z.: voor Moodle 3.4 is het 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. D.w.z. 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 naar 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. Reken de bijbehorende branch af. D.w.z.: voor Moodle 3.4 is het 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
   • Logboekbereik: Licht
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.