MH AAIRS block: Difference between revisions
| MH AAIRS block | |
|---|---|
| Type | Blocks |
| Set | N/A |
| Downloads | Moodle plugins repo |
| Issues | Moodle tracker |
| Discussion | TBA |
| Maintainer(s) | Itamar Tzadok |
No edit summary |
|||
| Line 23: | Line 23: | ||
* Please contact Moodlerooms and ask them to install the MH-AAIRS moodleblock on your instance. | * Please contact Moodlerooms and ask them to install the MH-AAIRS moodleblock on your instance. | ||
== | ==Administration== | ||
===Settings=== | |||
The mhaairs block has a few settings which need to be configured by an administrator in Settings > Site administration > Plugins > Blocks > McGraw-Hill AAIRS > Settings. | The mhaairs block has a few settings which need to be configured by an administrator in Settings > Site administration > Plugins > Blocks > McGraw-Hill AAIRS > Settings. | ||
| Line 29: | Line 30: | ||
[[File:sitesettings.png]] | [[File:sitesettings.png]] | ||
===SSL Only=== | ====SSL Only==== | ||
===Customer Number=== | ====Customer Number==== | ||
Set the ‘Customer Number’ to value provided to you by MH Campus in a welcome email. | Set the ‘Customer Number’ to value provided to you by MH Campus in a welcome email. | ||
===Shared Secret=== | ====Shared Secret==== | ||
Set the ‘Customer Secret’ to value provided to you by MH Campus in a welcome email. | Set the ‘Customer Secret’ to value provided to you by MH Campus in a welcome email. | ||
===Available Services=== | ====Available Services==== | ||
'''Name:''' block_mhaairs_display_services. | '''Name:''' block_mhaairs_display_services. | ||
| Line 46: | Line 47: | ||
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. | 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. | ||
===Help links=== | ====Help links==== | ||
'''Name:''' block_mhaairs_display_helplinks. | '''Name:''' block_mhaairs_display_helplinks. | ||
| Line 53: | Line 54: | ||
Select this option if you wish help links to appear in the block appropriate to admin and teacher roles. | Select this option if you wish help links to appear in the block appropriate to admin and teacher roles. | ||
===Gradebook Sync=== | ====Gradebook Sync==== | ||
'''Name:''' block_mhaairs_sync_gradebook. | '''Name:''' block_mhaairs_sync_gradebook. | ||
| Line 60: | Line 61: | ||
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 is irrelevant. | 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 is irrelevant. | ||
===Select locking type=== | ====Select locking type==== | ||
'''Name:''' block_mhaairs_locktype. | '''Name:''' block_mhaairs_locktype. | ||
| Line 70: | Line 71: | ||
* Redis locking - TBA. | * Redis locking - TBA. | ||
===Grade exchange log=== | ====Grade exchange log==== | ||
===Web service test client=== | |||
===Grade exchange logs=== | |||
===Reset caches=== | |||
==AAIRS configuration== | ==AAIRS configuration== | ||
1. Login to your MH Campus account as the admin. | 1. Login to your MH Campus account as the admin. | ||
Revision as of 13:34, 8 December 2015
Installation
Git clone
- Type the following command in the root of your Moodle install: git clone git://github.com/itamart/moodle-block_mhaairs.git blocks/mhaairs
- Add /blocks/mhaairs to your .git/info/exclude.
- Visit http://your-domain/admin to finish the installation.
Download
- Download the recent release for your Moodle version from: https://github.com/itamart/moodle-block_mhaairs/releases or 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 moodleblock on your instance.
Administration
Settings
The mhaairs block has a few settings which need to be configured by an administrator in Settings > Site administration > Plugins > Blocks > McGraw-Hill AAIRS > Settings.
SSL Only
Customer Number
Set the ‘Customer Number’ to value provided to you by MH Campus in a welcome email.
Set the ‘Customer Secret’ to value provided to you by MH Campus in a welcome email.
Available Services
Name: block_mhaairs_display_services.
Default: Empty.
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.
Help links
Name: block_mhaairs_display_helplinks.
Default: Yes.
Select this option if you wish help links to appear in the block appropriate to admin and teacher roles.
Gradebook Sync
Name: block_mhaairs_sync_gradebook.
Default: Yes.
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 is irrelevant.
Select locking type
Name: block_mhaairs_locktype.
Default: No locking.
With Gradebook Syny enabled, choose locking type appropriate for your server setup. Available options:
- No locking - TBA.
- File locking - TBA.
- Redis locking - TBA.
Grade exchange log
Web service test client
Grade exchange logs
Reset caches
AAIRS configuration
1. Login to your MH Campus account as the admin. 2. Click ‘Manage AAIRS’ to open the AAIRS interface.
File:aairs-config-admin-dashboard.png
3. Edit the Authorization section.
File:aairs-config-authorization1.png
4. Drag the 'Custom' box from 'Manual Configuration' into the 'Currently Used Connectors' area.
File:aairs-config-authorization2.png
5. Enter the following parameters in the custom connector form:
- Title: Moodle
- Service URL: http://mhaairs.tegrity.com/CustomIntegrationModules/MoodlelIntegrationService.svc
- Extended Properties: server=YOUR-MOODLE-SERVER-URL;block_name=mhaairs;secret=YOUR-MHAAIRS-SECRET;protocol=YOUR-PREFERRED-PROTOCOL
- Replace YOUR-MOODLE-SERVER-URL with the actual url of your moodle server.
- Replace YOUR-SHARED-SECRET with the shared secret provided to you by MH Campus in a welcome email.
- Replace YOUR-PREFERRED-PROTOCOL with the protocol you use on your moodle server, either https or http.
File:aairs-config-authorization3.png
6. Click 'Save' in the custom connector form to save the Moodle connector configuration. 7. Click ‘Save & Continue’.
File:aairs-config-authorization4.png
