Installera Ally-verktyg, filter och plugin-program för rapporter

3.3-versionerna av plugin-programmen är kompatibla med Moodle 3.2.

  1. Hämta eller klona den nödvändiga versionen av administrationsverktyget för Ally från github.

    1. Hämta som en ZIP-fil
      1. Ändra grenversionen, vid behov.
      2. Granska filen version.php för att se om den nödvändiga versionsnumret och versionen av Moodle ("krav") matchar din Moodle-version. Dvs. för Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        Versionen "3.4.3" bör fungera tillsammans med Moodle 3.4-installationer. Om dessa parametrar inte matchar din Moodle-installation kan du behöva byta gren på nytt.

        Mer om överensstämmande Moodle-versioner och versionsnummer

      3. Hämta lager med hjälp av "Klona eller hämta och Hämta ZIP"
    2. Klona git-lager
      1. Komma åt verktygsmappen.

        cd [moodle location]/admin/tool

      2. Klona lagret
        • Med hjälp av SSH

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

        • Med hjälp av HTTP

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

      3. Kontrollera motsvarande gren, dvs. för Moodle 3.4 är det MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Kontroll av grenen kan även användas för att hämta uppdateringar, så om du har uppdaterat din Moodle-installation behöver du bara kontrollera motsvarande gren. Om grenen inte går att hitta kan ditt repo vara gammalt, detta kan du korrigera genom att köra fetch:

        git fetch

  2. Hämta eller klona den nödvändiga versionen av Ally-filtret från github.

    1. Hämta som en ZIP-fil
      1. Ändra grenversionen, vid behov
      2. Granska filen version.php för att se om den nödvändiga versionsnumret och versionen av Moodle ("krav") matchar din Moodle-version. Dvs. för Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        Versionen "3.4.3" bör fungera tillsammans med Moodle 3.4-installationer. Om dessa parametrar inte matchar din Moodle-installation kan du behöva byta gren på nytt.

        Mer om överensstämmande Moodle-versioner och versionsnummer.

      3. Hämta lager med hjälp av "Klona eller hämta och Hämta ZIP"
    2. Klona git-lager
      1. Komma åt filtermappen.

        cd [moodle location]/filter

      2. Klona lagret
        • Med hjälp av SSH

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

        • Med hjälp av http

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

      3. Kontrollera motsvarande gren, dvs. för Moodle 3.4 är det MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Kontroll av grenen kan även användas för att hämta uppdateringar, så om du har uppdaterat din Moodle-installation behöver du bara kontrollera motsvarande gren. Om grenen inte går att hitta kan ditt repo vara gammalt, detta kan du korrigera genom att köra fetch:

        git fetch

  3. Hämta den nödvändiga versionen av LTI-verktyget för rapporter till Ally från github.

    1. Hämta som en ZIP-fil
      1. Ändra grenversionen, vid behov
      2. Granska filen version.php för att se om den nödvändiga versionsnumret och versionen av Moodle ("krav") matchar din Moodle-version. Dvs. för Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        Versionen "3.4.3" bör fungera tillsammans med Moodle 3.4-installationer. Om dessa parametrar inte matchar din Moodle-installation kan du behöva byta gren på nytt.

        Mer om överensstämmande Moodle-versioner och versionsnummer.

      3. Hämta lager med hjälp av "Klona eller hämta och Hämta ZIP"
    2. Klona git-lager
      1. Komma åt rapportmappen

        cd [moodle location]/report

      2. Klona lagret
        • Med hjälp av SSH

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

        • Med hjälp av HTTP

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

      3. Kontrollera motsvarande gren, dvs. för Moodle 3.4 är det MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Kontroll av grenen kan även användas för att hämta uppdateringar, så om du har uppdaterat din Moodle-installation behöver du bara kontrollera motsvarande gren. Om grenen inte går att hitta kan ditt repo vara gammalt, detta kan du korrigera genom att köra fetch:

        git fetch

  4. Verifiera mappstrukturen.

    Administrationsverktygets katalog ska döpas till ally. Den ska ha följande sökväg:

    [yourmoodledir]/admin/tool/ally

    Filterkatalogen ska döpas till ally. Den ska ha följande sökväg:

    [yourmoodledir]/filter/ally

    Rapportkatalogen ska döpas till allylti. Den ska ha följande sökväg:

    [yourmoodledir]/report/allylti

  5. Se till att varje mapp och dess innehåll går att läsa med din webbserver.
  6. Logga in som administratör på din Moodle-sajt och öppna administrationssidan. Denna ska kontrollera om det finns nya plugin-program och ge dig ett alternativ för att Uppgradera Moodles databas nu. Tryck på denna knapp för att installera plugin-programmen.
  7. När du har installerat plugin-programmen ska du navigera till Systemadministration, Plugin-program, Administrationsverktyg och Ally.
  8. Välj Autokonfigurera webbtjänsten Ally'.

    På nästa skärm finns en webbtjänst-token och en URL för att testa webbtjänsten Ally.

    Denna URL måste gå att komma åt direkt från internet så att Ally kan använda den.

    Om det lyckas måste du kopiera webbtjänst-token för Ally och webbtjänstlänken och ge dem till din tekniska Ally-konsult via IronBox så kommer denne att ge dig åtkomst via e-postlänken. När allt är installerat på deras sida kommer du att kontaktas och få en "nyckel", "hemlighet", "start-URL, "filuppdaterings-URL" och "kund-ID".

    Om din Moodle-instans använder sig av anpassade obligatoriska fält för användarkonton ska du "Logga in som" så skapas Ally Webservice-användaren av plugin-programmets automatiska konfiguration för att säkerställa att dessa anpassade fält blir ifyllda och sparas.


Konfigurera plugin-programmet för Moodle

Den tekniska Ally-konsulten skapar Ally-klienten med hjälp av den webbtjänst-token som skapas i det föregående avsnittet och som förser dig med informationen för att konfigurera plugin-programmet för Ally.

  1. Logga in som Moodle-administratör.
  2. Från Webbplatsadministration ska du välja Plugin-program och Administrativa verktyg. Välj Konfiguration av Ally.
  3. Ange följande information
    • Innehållsförfattare: Användarrollerna som är innehållsförfattare. Måste vara: Hanterare, Kursskapare, Lärare (standardinställningarna).

      Detta ska normalt sett inte behöva ändras, så ändra inte detta utan att ha konsulterat den tekniska Ally-konsulten.

    • Nyckel: LTI-nyckeln som tillhandahölls av den tekniska Ally-konsulten
    • Hemlighet: LTI-hemligheten som tillhandahölls av den tekniska Ally-konsulten
    • Start-URL: Start-URL från LTI som tillhandahölls av den tekniska Ally-konsulten
    • Filuppdaterings-URL: Filuppdaterings-URL som tillhandahölls av den tekniska Ally-konsulten. https://[AllyEnvironment].ally.ac/api/v1/events
    • Kund-ID: Det kund-ID som tillhandahölls av den tekniska Ally-konsulten
  4. Spara ändringar.

Lärosätesrapport från Ally

När plugin-programmet för Ally har konfigurerats får du tillgång till Lärosätesrapporten från Ally.

Inga data finns i rapporten förrän kurssynkronisering har genomförts och den initiala rapporten har genererats.

För att få tillgång till Lärosätesrapport från Ally ska du gå till Webbplatsadministration och välja Rapporter. Välj Tillgänglighet.

Mer om Lärosätesrapport från Ally


Ally-filter

När du är redo att göra poängindikatorerna för tillgänglighet i Ally och alternativet för nedladdning av tillgänglig version tillgängliga inom Moodle måste du aktivera Ally-filtret.

Aktivera Ally-filtret

  1. Från Webbplatsadministration  ska du välja Plugin-program  och Översikt av plugin-program.
  2. Gå ner till avsnittet Textfilter och aktivera Ally-filtret.
  3. Flytta Ally-filtret till början av listan Filter.

Åtkomst till Allys konfigurationsgränssnitt

Vi ger dig information om hur du öppnar konfiguration av Ally under konfigurationen. Om du inte har åtkomst kan du skicka in en begäran på 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