Installation d'outils, du filtre et de plug-ins de rapport Ally

Les versions 3.3 des plug-ins sont compatibles avec Moodle 3.2.

  1. Télécharger ou cloner la version requise de l'outil d'administration Ally depuis github.

    1. Téléchargement en tant que fichier ZIP
      1. Modifiez la version de branche si nécessaire.
      2. Consultez le fichier version.php pour vérifier que le numéro de version (« requires ») et la version Moodle requis correspondent à votre version de Moodle. Par exemple, pour Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        La version « 3.4.3 » devrait fonctionner avec les installations de Moodle 3.4. Si ces paramètres ne correspondent pas à votre installation Moodle, vous devrez peut-être modifier à nouveau la branche.

        En savoir plus sur les versions et numéros de version de Moodle correspondants.

      3. Téléchargez le répertoire à l'aide de l'option « Cloner ou télécharger > Télécharger le ZIP »
    2. Clonage du répertoire git
      1. Accédez au dossier d'outils.

        cd [moodle location]/admin/tool

      2. Clonez le répertoire
        • En utilisant SSH

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

        • En utilisant HTTP

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

      3. Extraction de la branche correspondante, par ex. pour Moodle 3.4, il s'agit de MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Extraire une branche permet également d'obtenir des mises à jour. Par conséquent, si vous avez mis à jour votre installation Moodle, vous pouvez simplement extraire la branche correspondante. Si la branche est introuvable, votre répertoire est peut-être obsolète. Ceci peut être résolu grâce à la commande fetch :

        git fetch

  2. Télécharger ou cloner la version requise du filtre Ally depuis github.

    1. Téléchargement en tant que fichier ZIP
      1. Modifiez la version de branche si nécessaire.
      2. Consultez le fichier version.php pour vérifier que le numéro de version (« requires ») et la version Moodle requis correspondent à votre version de Moodle. Par exemple, pour Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        La version « 3.4.3 » devrait fonctionner avec les installations de Moodle 3.4. Si ces paramètres ne correspondent pas à votre installation Moodle, vous devrez peut-être modifier à nouveau la branche.

        En savoir plus sur les versions et numéros de version de Moodle correspondants.

      3. Téléchargez le répertoire à l'aide de l'option « Cloner ou télécharger > Télécharger le ZIP »
    2. Clonage du répertoire git
      1. Accédez au dossier de filtres.

        cd [moodle location]/filter

      2. Clonez le répertoire
        • En utilisant SSH

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

        • En utilisant HTTP

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

      3. Extraction de la branche correspondante, par ex. pour Moodle 3.4, il s'agit de MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Extraire une branche permet également d'obtenir des mises à jour. Par conséquent, si vous avez mis à jour votre installation Moodle, vous pouvez simplement extraire la branche correspondante. Si la branche est introuvable, votre répertoire est peut-être obsolète. Ceci peut être résolu grâce à la commande fetch :

        git fetch

  3. Télécharger ou cloner la version requise de l'outil LTI de rapport Ally depuis github.

    1. Téléchargement en tant que fichier ZIP
      1. Modifiez la version de branche si nécessaire.
      2. Consultez le fichier version.php pour vérifier que le numéro de version (« requires ») et la version Moodle requis correspondent à votre version de Moodle. Par exemple, pour Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        La version « 3.4.3 » devrait fonctionner avec les installations de Moodle 3.4. Si ces paramètres ne correspondent pas à votre installation Moodle, vous devrez peut-être modifier à nouveau la branche.

        En savoir plus sur les versions et numéros de version de Moodle correspondants.

      3. Téléchargez le répertoire à l'aide de l'option « Cloner ou télécharger > Télécharger le ZIP »
    2. Clonage du répertoire git
      1. Accédez au dossier de rapports.

        cd [moodle location]/report

      2. Clonez le répertoire
        • En utilisant SSH

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

        • En utilisant HTTP

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

      3. Extraction de la branche correspondante, par ex. pour Moodle 3.4, il s'agit de MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Extraire une branche permet également d'obtenir des mises à jour. Par conséquent, si vous avez mis à jour votre installation Moodle, vous pouvez simplement extraire la branche correspondante. Si la branche est introuvable, votre répertoire est peut-être obsolète. Ceci peut être résolu grâce à la commande fetch :

        git fetch

  4. Vérifier la structure du dossier.

    Le nom du répertoire de l'outil d'administration doit être ally. Le chemin d'accès doit être le suivant :

    [yourmoodledir]/admin/tool/ally

    Le nom du répertoire du filtre doit être ally. Le chemin d'accès doit être le suivant :

    [yourmoodledir]/filter/ally

    Le nom du répertoire du rapport doit être allylti. Le chemin d'accès doit être le suivant :

    [yourmoodledir]/report/allylti

  5. Assurez-vous que chaque dossier et son contenu sont lisibles par votre serveur Web.
  6. Connectez-vous en tant qu'administrateur à votre site Moodle et ouvrez la page administrateur. Les nouveaux plug-ins disponibles seront recherchés et affichés le cas échéant, ainsi qu'une option permettant de Mettre à jour la base de données Moodle maintenant. Sélectionnez le bouton correspondant pour installer les plug-ins.
  7. Après avoir installé les plug-ins, accédez à Administration du système > Plug-ins > Outils d'administration > Ally.
  8. Sélectionnez Configurer automatiquement le service Web Ally.

    Sur l'écran suivant seront affichés un jeton de service Web et une URL pour tester le service Web Ally.

    Cette URL doit être directement accessible à partir d'Internet pour que Ally puisse l'utiliser.

    Si l'opération réussit, copiez le jeton du service Web d'Ally et le lien du service Web. Vous devrez ensuite le fournir à votre conseiller technique Ally. Pour se faire, il configurera un partage IronBox et vous enverra le lien d'accès correspondant par e-mail. Il vous contactera une fois tous les éléments configurés de son côté et vous fournira une « clé », un « secret », une « URL de lancement», ainsi qu'une « URL de mise à jour de fichier » et un « code client ».

    Si votre instance Moodle utilise des champs obligatoires personnalisés pour les comptes utilisateur, connectez-vous au compte utilisateur du service Web Ally créé par le plug-in d'auto-configuration pour vous assurer que les champs personnalisés sont renseignés et enregistrés.


Configurer le plug-in Moodle

Le conseiller technique Ally crée le client Ally à l'aide du jeton de service Web Moodle généré à l'étape précédente et vous fournit les détails de la configuration du plug-in Ally.

  1. Connectez-vous en tant qu'administrateur Moodle.
  2. Dans Administration du site sélectionnez Plug-ins et Outils d'administration. Sélectionnez Configuration Ally.
  3. Saisissez les détails suivants :
    • Auteurs de contenu : les rôles utilisateurs pouvant créer du contenu. Il s'agit généralement des personnes suivantes : gestionnaire, créateur de cours, professeur (valeurs par défaut).

      Il n'est normalement pas nécessaire de modifier ce paramètre, veuillez ne pas le modifier sans consulter le conseiller technique Ally.

    • Clé : la clé LTI fournie par le conseiller technique Ally
    • Secret : le secret LTI fourni par le conseiller technique Ally
    • URL de lancement : l'URL de lancement LTI fournie par le conseiller technique Ally
    • URL de mise à jour du fichier : l'URL d'événement / de mise à jour du fichier fournie par le conseiller technique Ally https://[AllyEnvironment].ally.ac/api/v1/events
    • Code client : le code client fourni par le conseiller technique Ally
  4. Enregistrez les modifications.

Rapport d'établissement Ally

Une fois le plug-in Ally configuré, vous pourrez accéder au rapport d'établissement Ally.

Aucune donnée ne sera présente dans le rapport avant la synchronisation de cours Ally et la génération du rapport initial.

Pour accéder au rapport d'établissement Ally, rendez-vous sous Administration du site et sélectionnez Rapports. Sélectionnez Accessibilité.

En savoir plus sur le rapport d'établissement Ally


Filtre Ally

Lorsque vous êtes prêt à activer les indicateurs de résultat d'accessibilité et l'option de téléchargement de versions accessibles alternatives Ally au sein de Moodle, vous devez activer le filtre Ally.

Activer le filtre Ally

  1. Dans Administration du site sélectionnez Plug-ins et Vue d'ensemble des plug-ins.
  2. Descendez jusqu'à la section Filtres de texte et activez le filtre Ally.
  3. Déplacez le filtre Ally vers le haut de la liste Filtre.

Accéder à l'interface d'utilisateur de configuration d'Ally

Nous vous fournissons les instructions pour accéder à la Configuration Ally lors de la configuration. Si vous n'avez pas installé Ally, envoyez une demande sur 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