Installation of Ally tools, filter, and report plugins

The 3.3 versions of the plugins are compatible with Moodle 3.2.

  1. Download or clone the needed version of the Ally admin tool from github.

    1. Downloading as a ZIP file
      1. Change the branch version, if necessary.
      2. Review the version.php file to see if the needed Moodle version ("requires") number and release matches your Moodle version. I.e. for Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        The "3.4.3" release should work with Moodle 3.4 installs. If these parameters don't match your Moodle installation, you may need to change the branch again.

        More on the corresponding Moodle releases and version numbers

      3. Download the repo using the "Clone or download > Download ZIP"
    2. Cloning git repository
      1. Access the tools folder.

        cd [moodle location]/admin/tool

      2. Clone the repository
        • Using SSH

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

        • Using HTTP

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

      3. Checkout the corresponding branch, I.e. for Moodle 3.4 it's MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Checking out the branch can be used for getting updates too, so, if you updated your Moodle installation, you can just check out the corresponding branch. If the branch is not found, your repo might be outdated, this can be fixed by doing fetch:

        git fetch

  2. Download or clone the needed version of the Ally filter from github.

    1. Downloading as a ZIP file
      1. Change the branch version if necessary
      2. Review the version.php file to see if the needed Moodle version ("requires") number and release matches your Moodle version. I.e. for Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        The "3.4.3" release should work with Moodle 3.4 installs. If these parameters don't match your Moodle installation, you may need to change the branch again.

        More on the corresponding Moodle releases and version numbers.

      3. Download the repo using the "Clone or download > Download ZIP"
    2. Cloning git repository
      1. Access the filters folder.

        cd [moodle location]/filter

      2. Clone the repository
        • Using SSH

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

        • Using http

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

      3. Checkout the corresponding branch, I.e. for Moodle 3.4 it's MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Checking out the branch can be used for getting updates too, so, if you updated your Moodle installation, you can just check out the corresponding branch. If the branch is not found, your repo might be outdated, this can be fixed by doing fetch:

        git fetch

  3. Download the needed version of the Ally report LTI tool from github.

    1. Downloading as a ZIP file
      1. Change the branch version if necessary
      2. Review the version.php file to see if the needed Moodle version ("requires") number and release matches your Moodle version. I.e. for Moodle 3.4

        $plugin->release = '3.4.3';

        $plugin->requires = 2017111300;

        The "3.4.3" release should work with Moodle 3.4 installs. If these parameters don't match your Moodle installation, you may need to change the branch again.

        More on the corresponding Moodle releases and version numbers.

      3. Download the repo using the "Clone or download > Download ZIP"
    2. Cloning git repository
      1. Access the reports folder

        cd [moodle location]/report

      2. Clone the repository
        • Using SSH

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

        • Using HTTP

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

      3. Checkout the corresponding branch, I.e. for Moodle 3.4 it's MOODLE_34_STABLE

        git checkout MOODLE_34_STABLE

        Checking out the branch can be used for getting updates too, so, if you updated your Moodle installation, you can just check out the corresponding branch. If the branch is not found, your repo might be outdated, this can be fixed by doing fetch:

        git fetch

  4. Verify the folder structure.

    The admin tool directory should be named ally. It should have a path as follows:

    [yourmoodledir]/admin/tool/ally

    The filter directory should be named ally. It should have a path as follows:

    [yourmoodledir]/filter/ally

    The report directory should be named allylti. It should have a path as follows:

    [yourmoodledir]/report/allylti

  5. Make sure that each folder and its contents are readable by your web server.
  6. Log in as an admin user to your Moodle site and open the admin page. This should check for new plugins and present you with an option to Upgrade Moodle database now. Select this button to install the plugins.
  7. After installing the plugins, navigate to System Administration > Plugins > Admin tools > Ally.
  8. Select Auto configure Ally web service'.

    On the next screen there will be a web service token and a URL for testing the ally web service.

    This URL needs to be directly accessible from the internet so that Ally can use it.

    If successful, you will need to copy the Ally web service token, and web service link and provide it to your Ally technical consultant via the IronBox share they will setup and give you access to via email link. They will contact you once everything is set up at their end and provide you the 'key', 'secret', 'launch URL, 'file updates URL and 'client id'.

    If your Moodle instance makes use of custom required fields for user accounts, “Log in as” the Ally Webservice user that gets created by the plugin auto-configure to ensure those custom fields are populated and saved.


Configure the Moodle plugin

The Ally technical consult will create the Ally client using the Moodle Webservice Token generated in the previous section and will provide you the details for configuring the Ally Plugin.

  1. Log in as a Moodle administrator and open the settings page for the Ally admin tool. (Site administration > Plugins > Admin tools > Ally)
  2. Enter the following details
    • Content Authors: The user roles that are content authors. Must be: Manager, Course creator, Teacher (the defaults).

      This normally shouldn't need to change, please don't change this without consulting with the Ally technical consultant.

    • Key: The LTI Key that was provided by Ally technical consultant
    • Secret: The LTI Secret that was provided by Ally technical consultant
    • Launch URL: The LTI Launch URL that was provided by Ally technical consultant
    • File Update URL: The File Update/Event URL that was provided by Ally technical consultant. https://[AllyEnvironment].ally.ac/api/v1/events
    • Client ID: The Client ID that was provided by Ally technical consultant
  3. Save changes.

Ally Institution Report

Once the Ally plugin has been configured, you will be able to access the Ally Institution Report.

No data will be present in the report until Ally course syncing has occurred and the initial report is generated.

To access the Ally Institution Report, go to Site administration and select Reports. Select Accessibility.

More on Ally's Institutional Report


Ally Filter

When you are ready to have the Ally accessibility score indicators and Alternative Accessible version download option made available within Moodle, you will need to activate the Ally filter.

Enable the Ally filter

  1. From Site administration  select Plugins  and Plugins overview.
  2. Go down to the Text filters section and enable the Ally filter.
  3. Move the Ally filter to the top of the Filter list.