Instalar ferramentas, filtro e plug-ins de relatórios do Ally

As versões 3.3 dos plug-ins são compatíveis com o Moodle 3.2.

  1. Baixe ou clone a versão necessária da ferramenta do administrador do Ally no github.

    1. Baixar como um arquivo ZIP
      1. Se necessário, altere a versão da ramificação.
      2. Revise o arquivo version.php para ver se o número de versão e atualização necessário ("requer") do Moodle corresponde a sua versão do Moodle. Por exemplo, para Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        A atualização "3.4.3" deve funcionar com as instalações do Moodle 3.4. Se estes parâmetros não corresponderem à sua instalação do Moodle, talvez você precise mudar a ramificação novamente.

        Mais sobre os números de versão e atualizações do Moodle correspondentes

      3. Baixe a pasta usando o “Clonar ou baixar > Baixar ZIP”
    2. Como clonar a pasta git
      1. Acessar a pasta de ferramentas.

        cd [moodle location]/admin/tool

      2. Clonar a pasta
        • Como usar o SSH

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

        • Como usar o HTTP

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

      3. Verifique a ramificação correspondente, por exemplo, para o Moodle 3.4 é o MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        A verificação da ramificação também pode ser usada para obter atualizações, portanto, se você atualizou sua instalação do Moodle, pode apenas verificar a ramificação correspondente. Se a ramificação não for localizada, sua pasta pode estar desatualizada, o que pode ser corrigido fazendo a busca:

        git fetch

  2. Baixe ou clone a versão necessária do filtro do Ally do github.

    1. Baixar como um arquivo ZIP
      1. Se necessário, altere a versão da ramificação
      2. Revise o arquivo version.php para ver se o número de versão e atualização necessário ("requer") do Moodle corresponde a sua versão do Moodle. Por exemplo, para Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        A atualização "3.4.3" deve funcionar com as instalações do Moodle 3.4. Se estes parâmetros não corresponderem à sua instalação do Moodle, talvez você precise mudar a ramificação novamente.

        Mais sobre os números de versão e atualizações do Moodle correspondentes.

      3. Baixe a pasta usando o “Clonar ou baixar > Baixar ZIP”
    2. Como clonar a pasta git
      1. Acessar a pasta de filtros.

        cd [moodle location]/filter

      2. Clonar a pasta
        • Como usar o SSH

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

        • Como usar o http

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

      3. Verifique a ramificação correspondente, por exemplo, para o Moodle 3.4 é o MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        A verificação da ramificação também pode ser usada para obter atualizações, portanto, se você atualizou sua instalação do Moodle, pode apenas verificar a ramificação correspondente. Se a ramificação não for localizada, sua pasta pode estar desatualizada, o que pode ser corrigido fazendo a busca:

        git fetch

  3. Baixe ou clone a versão necessária da ferramenta de LTI do relatório do Ally pelo github.

    1. Baixar como um arquivo ZIP
      1. Se necessário, altere a versão da ramificação
      2. Revise o arquivo version.php para ver se o número de versão e atualização necessário ("requer") do Moodle corresponde a sua versão do Moodle. Por exemplo, para Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        A atualização "3.4.3" deve funcionar com as instalações do Moodle 3.4. Se estes parâmetros não corresponderem à sua instalação do Moodle, talvez você precise mudar a ramificação novamente.

        Mais sobre os números de versão e atualizações do Moodle correspondentes.

      3. Baixe a pasta usando o “Clonar ou baixar > Baixar ZIP”
    2. Como clonar a pasta git
      1. Acessar a pasta de relatórios

        cd [moodle location]/report

      2. Clonar a pasta
        • Como usar o SSH

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

        • Como usar o HTTP

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

      3. Verifique a ramificação correspondente, por exemplo, para o Moodle 3.4 é o MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        A verificação da ramificação também pode ser usada para obter atualizações, portanto, se você atualizou sua instalação do Moodle, pode apenas verificar a ramificação correspondente. Se a ramificação não for localizada, sua pasta pode estar desatualizada, o que pode ser corrigido fazendo a busca:

        git fetch

  4. Verificar a estrutura da pasta.

    O diretório de ferramenta do administrador deve ser nomeado ally. Deve haver um caminho conforme abaixo:

    [yourmoodledir]/admin/tool/ally

    O diretório de filtro deve ser nomeado ally. Deve haver um caminho conforme abaixo:

    [yourmoodledir]/filter/ally

    O diretório de relatório deve ser nomeado allylti. Deve haver um caminho conforme abaixo:

    [yourmoodledir]/report/allylti

  5. Certifique-se de que cada pasta e seus conteúdos possam ser lidos pelo seu servidor da web.
  6. Faça logon no seu site do Moodle como usuário administrador e abra a página do administrador. Isso deve verificar se há novos plug-ins e apresentar a você uma opção para Atualizar o banco de dados do Moodle agora. Selecione este botão para instalar os plug-ins.
  7. Após instalar os plug-ins, navegue até Administração do sistema > Plug-ins > Ferramentas do administrador > Ally.
  8. Selecione Autoconfigurar o serviço da web do Ally.

    Na próxima tela haverá um código do serviço da web e um URL para testar o serviço da web do Ally.

    Este URL precisa ser acessível diretamente pela internet para que o Ally possa usá-lo.

    Se for bem sucedido, você terá que copiar o código de serviço da web do Ally e o link de serviço da web e fornecê-los ao seu consultor técnico do Ally por meio do compartilhamento do IronBox, que ele configurará e ao qual fornecerá acesso em um link por e-mail. Ele entrará em contato quando tiver terminado as configurações relevantes e fornecerá “chave”, “segredo”, “URL inicial”, “URL de atualizações de arquivo” e “código do cliente”.

    Se sua instância do Moodle usa campos obrigatórios personalizados para contas de usuários, “Fazer logon como” o usuário do serviço da web do Ally criado pelo plug-in de autoconfiguração garante que esses campos personalizados sejam preenchidos e salvos.


Configurar o plug-in do Moodle

A consultoria técnica do Ally criará um cliente do Ally usando o código de serviço da web do Moodle gerado na seção anterior e lhe fornecerá detalhes para configurar o plug-in do Ally.

  1. Faça logon como administrador do Moodle.
  2. Em Administração do site selecione Plug-ins e Ferramentas do administrador. Selecione Configuração do Ally.
  3. Insira os seguintes detalhes
    • Autores de conteúdo: as funções de usuários que são autores de conteúdo. Devem ser: Gerente, Criador do curso, Professor (os padrões).

      Normalmente, isto não deve ser alterado; não faça alterações sem perguntar ao consultor técnico do Ally.

    • Chave: a chave de LTI fornecida pelo consultor técnico do Ally
    • Segredo: o segredo de LTI fornecido pelo consultor técnico do Ally
    • URL inicial: o URL inicial de LTI fornecido pelo consultor técnico do Ally
    • URL de atualização de arquivo: o URL de evento/atualização de arquivo fornecido pelo consultor técnico do Ally. https://[AllyEnvironment].ally.ac/api/v1/events
    • Código do cliente: o código do cliente fornecido pelo consultor técnico do Ally
  4. Salvar alterações.

Relatório institucional do Ally

Assim que o plug-in do Ally for configurado, você terá acesso ao Relatório institucional do Ally.

Nenhum dado será apresentado no relatório até que ocorra a sincronização do curso do Ally e o relatório inicial seja gerado.

Para acessar o Relatório institucional do Ally, vá para Administração do site e selecione Relatórios. Selecione Acessibilidade.

Mais sobre o Relatório institucional do Ally


Filtro do Ally

Quando você estiver pronto para obter os indicadores de pontuação de acessibilidade do Ally, e a opção para baixar a versão de acessibilidade alternativa ficar disponível dentro do Moodle, você precisará habilitar o filtro.

Habilitar o filtro do Ally

  1. Em Administração do site  selecione Plug-ins  e Visão geral dos plug-ins.
  2. Desça até seção dos Filtros de texto e habilite o filtro do Ally.
  3. Mova o filtro do Ally para o topo da lista Filtro.

Acessar a interface de usuário da configuração do Ally

Fornecemos as instruções sobre como acessar a Configuração do Ally durante a configuração. Se você não tiver acesso, envie uma solicitação no 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