MH AAIRS block

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 3.1. Up-to-date documentation for the latest stable version of Moodle is probably available here: MH AAIRS block.

MH AAIRS block
Type Blocks
Set N/A
Downloads Moodle plugins repo
Issues Moodle tracker
Discussion TBA
Maintainer(s) Itamar Tzadok

The MH AAIRS block is a Moodle integration with McGraw Hill's MH Campus and other educational tools and services. The block provides single sign on access point from the Moodle course to McGraw-Hill's educational applications. The block also supports grades sync from McGraw-Hill application to Moodle gradebook.

Installation

Git Clone

  • In the root of your Moodle install type the following command:
git clone git://github.com/itamart/moodle-block_mhaairs.git blocks/mhaairs.
  • Go to the blocks/mhaairs folder.
  • Type the following command (replace XX with your Moodle major version number; e.g. 29):
git checkout MOODLE_XX_STABLE

Download

  • Download the recent release for your Moodle version from one of the following locations:
https://github.com/itamart/moodle-block_mhaairs/releases
https://moodle.org/plugins/pluginversions.php?plugin=block_mhaairs
  • Extract into the 'blocks' subfolder of your Moodle install.
  • Rename the new folder to mhaairs.
  • Visit http://your-domain/admin to finish the installation.

Moodlerooms customer

  • Please contact Moodlerooms and ask them to install the MH-AAIRS moodle block on your instance.

Site administration

The mhaairs block administration options can be found in the Administration block under Site administration > Plugins > Blocks > McGraw-Hill AAIRS.

mhaairs-admin-administration-options.png

  • Settings - The plugin site configuration settings.
  • Web service test client - Forms for testing the block web services.
  • Grade exchange logs - Index and management of existing grade exchange logs.
  • Reset caches - Resets the block's local caches.

Settings

mhaairs-admin-site-settings.png

SSL Only

Require secured connection for login validation and user info requests from Connect. Either the moodle server protocol or the Connect protocol must be https.

Customer Number

Set the 'Customer Number' to value provided to you by MH Campus in a welcome email.

Shared Secret

Set the 'Customer Secret' to value provided to you by MH Campus in a welcome email.

Available Services

One or more of the web services is currently down or your client access data are not correctly configured. Please contact McGraw-Hill help for further action.

  • Name: block_mhaairs_display_services
  • Default: Empty

Help links

Select this option if you wish help links to appear in the block appropriate to admin and teacher roles.

  • Name: block_mhaairs_display_helplinks
  • Default: Yes

Gradebook Sync

Gradebook Sync provides the ability to push scores from MH Campus directly to the Moodle gradebook. Note: If only Tegrity is enabled on your site, this setting is irrelevant.

  • Name: block_mhaairs_sync_gradebook
  • Default: Yes

Locking type

With Gradebook Sync enabled, you may need to activate a locking method to prevent race conditions when the gradebook is updated. You can choose a locking type appropriate for your server setup.

  • Name: block_mhaairs_locktype
  • Default: No locking
  • Options:
    • No locking - No locking is done.
    • File locking - Creates a file in the Moodle data temp directory and uses the handler as the locking indicator.
    • Redis locking - Redis (http://redis.io/) is an open source (BSD licensed), in-memory data structure store, used as database, cache and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs and geospatial indexes with radius queries. Redis has built-in replication, Lua scripting, LRU eviction, transactions and different levels of on-disk persistence, and provides high availability via Redis Sentinel and automatic partitioning with Redis Cluster.

Grade exchange log

Log grade exchange raw data for debugging purposes. Should be disabled on production sites. Log files are stored in moodledata directory [moodledata]/mhaairs. Every individual web service request generates a separate log file with the filename format 'mhaairs_year-month-day_hour-min-sec_randomkey.log'.

  • Name: block_mhaairs_gradelog
  • Default: No

Web service test client

Admins can simulate external access to the plugin web services by using the plugin's web service client forms. Warning: The web service test client executes the functions for REAL. Do not use on production sites. The Function… dropdown displays a list of the plugin's web service functions that can be tested via the client.

mhaairs-admin-web-service-test-client-01.png

Selecting a function will open the proper form for entering the service parameters. For example, selecting the update_grade function will open the following form:

mhaairs-admin-web-service-test-client-02.png

The Web service test client section is shared by all functions and allows you to select the target protocol and response format. By default these are REST and JSON respectively. The test client currently supports only REST protocol. It supports JSON and XML response formats.

mhaairs-admin-web-service-test-client-03.png

The Authentication section is also shared by all functions and allows you to enter the authentication parameters. By default the client expects a token authentication. The token must be generated for the designated user by admin at Site administration ► Plugins ► Web services ► Manage tokens. Alternatively you can switch to the Username/Password method and enter the username and password of the designated user.

mhaairs-admin-web-service-test-client-04.png

The Service params section is function specific. In some functions the service params may consist of several sections for readability. You need to enter valid service params. For example:

mhaairs-admin-web-service-test-client-05.png

mhaairs-admin-web-service-test-client-06.png

Upon pressing the Execute button the service request will be executed. The service url and the response text will be displayed at the top of the form.

mhaairs-admin-web-service-test-client-07.png

Grade exchange logs

Displays the list of existing log files that are generated when the 'Grade exchange log' setting in the plugin configuration is enabled.

mhaairs-admin-grade-exchange-logs-01.png

Currently the content of the log files cannot be viewed on from this page. Admin will have to open the file from its actual location in the designated moodledata directory [moodledata]/mhaairs. You can click the 'Delete all' link to delete all the existing log files.

mhaairs-admin-grade-exchange-logs-02.png

Reset caches

This plugin caches store the configured tools and help urls.

mhaairs-admin-reset-caches-01.png 

Admin can click the Reset link to clear the caches.

mhaairs-admin-reset-caches-02.png

The caches will be automatically regenerated as soon as the respective info is required (e.g. on the next block rendering in any course).

Course administration

Adding the mhaairs block in a course

In your course press the 'Turn editing on' button to turn editing on.

mhaairs-instructor-add-block-01.png

The 'Add a block' dropdown is now displayed. (Note: depending on your site/course theme and the location of other blocks in your course, the 'Add a block' dropdown may appear in a different location from the illustrated).

mhaairs-instructor-add-block-02.png

In the Add a block dropdown list select McGraw-Hill AAIRS.

mhaairs-instructor-add-block-03.png

The mhaairs block is now added to your course.

mhaairs-instructor-add-block-04.png

By default the block displays the tools and documentation links which have been enabled by your administrator. You can change the list of the displayed tools in the block configuration (see below). If you site administrator has not enabled any tools, the block will display a warning message. In this state the block will be visible only for instructors and administrators. It will not be visible to students.

mhaairs-instructor-add-block-05.png

The documentation link are displayed according to your role. If you are site admin you will see both the admin and instructor documentation links. If you are an instructor but not site admin you will see only the instructor documentation link. The documentation links are displayed only if enabled by the site administrator. You cannot currently control the display of these links via the block configuration.

Changing the list of the displayed tools

In editing mode on, click on the cog icon in the block and select 'Configure McGraw-Hill AAIRS block'.

mhaairs-instructor-block-config-01.png

The block configuration form displays the tool options your administrator enabled for the site. Tick the checkbox next to the tools you wish to make available in your course, and untick the checkbox next to those you do not need in the course. Then press 'Save changes'.

mhaairs-instructor-block-config-02.png

If you unselect all the available tools and save the configuration, the block will display a warning message. In this state the block will be visible only for instructors and administrators. It will not be visible to students.

mhaairs-instructor-block-config-03.png

Usage

mhaairs-user-block-usage-01.png

Accessing MH Campus

To access MH Campus click on the McGraw-Hill Campus link. MH Campus will open in a new page.

Accessing Admin/Instructor documentation

To access the Admin/Instructor documentation click on the respective link. The documentation will open in a new page. Note: the documentation is available per role.

Grade sync

TBA