MoodleDocs - User contributions [en]

Dataform FAQ

2016-08-25T15:04:40Z

Itamart:

{{Dataform | innertrail = ► See also }}
==How can I set up the Dataform to allow students to view only their own entries?==
Set [[Dataform_settings#Separate_participants|Separate participants]] in the activity settings to 'Yes'.

==How can I list entries content horizontally in an aligned table?==
Use the [[Dataformview Tabular|Tabular view type]] or the [[Dataformview Aligned|Aligned view type]].

==Is there a Time stamp for Dataform entries?==
The internal [[Dataformfield entrytime|Entry time field]] allows you to display the time-created and time-modified of the entry.

==How can I make the title of an entry into a link?==
To make the title of an entry in list view link to the single view, add the following code to the list template:
<nowiki><a href="##moreurl##">[[Title]]</a></nowiki>

==How can I make email addresses clickable?==
To make email addresses clickable, add the following code to the view template:
<nowiki><a href="mailto:[[Email]]">[[Email]]</a></nowiki>
where 'Email' is the text field for entering an email addresses.

==How can I delete a file attached to an entry?==
*Edit the entry.
*Right-click on the file in the file manager.
*Select 'delete'.
*Save the entry.

==How can I add a default sort order of entries?==
In the Filters tab
* Add a new filter.
* Add sorting criteria to the filter.
* Click on the 'default' button of the filter in the filters list.

==How can I prevent students from adding entries?==
In the Dataform settings, set max number of entries to 0.

You can also prevent adding and editing entries in a particular view by disabling all submission buttons in the view's submission settings.

==How can I add entries en masse?==
In the general section of the view template add the tag ##addnewentries## (as opposed to the default ##addnewentry##). This pattern displays a dropdown to select the number of entries to add.

==How can I edit/delete entries en masse?==
In the view template add the selector, bulk-edit and bulk-delete patterns. In the entries list tick the checkboxes of the entries to edit/delete and click the the respective bulk action link.

==How can I completely reset a Dataform activity?==
In the Dataform administration section of the Settings block, click 'Renew'.

==How can I display totals from number fields within an entry (line) and for a set of entries (column) in the view?==
You can enter in the entry template or view template (as the case may be) formula patterns in which you specify arithmetic operations on field patterns or other formula patterns. For example, an entry template in a tabular view with line and column formulas:

[[File:df-formula-in-tabular-view3.png]]

And the display is:

[[File:df-formula-in-tabular-view4.png]]

(See forum post at https://moodle.org/mod/forum/discuss.php?d=140433#p991346)

Note the '!' prefix in the field pattern inside the formula. This is a flag which disables editing mode for the field pattern. Typically we don't want field patterns in formula to open for editing (as input elements) and so if the view allows editing we need to add these flags to editable field patterns in the formula.

You can aggregate formulas with the same higher indices. So, for instance, the formula

%%F:=SUM(_F1_)%%

will display the sum total of all the formulas that look like

%%F1:=...%%

anywhere in the view.

The formula

%%F:=SUM(_F1_,AVERAGE(_F2_))%%

will display the sum total of all the F1 formulas + the average of all the F2 formulas.

The rule is that the aggregated formulas must have a higher index than the aggregating formula.

It becomes a bit tricky if you want both line totals and column totals. For line totals you would typically use the entry id as the index of the aggregated formula since it is unique per line. Something like:

%%F[[entryid] ]:=...%%

But that won't work for column total. It seems that currently the only way to do that is to add another hidden formula in each cell for the column totals. So you could have something like:

%%F[[entryid] ]:=...%% <nowiki><span class="hide">%%F1:=...%%</span></nowiki>

Both formulas will yield the same figure in the cell but only one will be displayed. The line total will use the first and the column total will use the second.

To reduce clutter in the view template you can use designated text fields for complex formulas. You enter the formula in the field's template and use the pattern [[T@fieldname] ]. The field template currently doesn't support html so you would have to add the html for hiding the second in the view template. This could look something like:

[[T@LineFormula] ] <nowiki><span class="hide">[[T@ColumnFormula] ]</span></nowiki>

Again, this technique is useful mainly when you have long formulas in complex view templates.

The Dataform uses the same moodle library that is used by the gradebook formulas and you can find a list of functions (in addition to the standard arithmetic operators) at http://docs.moodle.org/en/Grade_calculations.

[[Category:FAQ]]

File:df-formula-in-tabular-view4.png

2016-08-25T14:58:22Z

Itamart:

File:df-formula-in-tabular-view3.png

2016-08-25T14:53:00Z

Itamart:

MH AAIRS block

2016-04-20T15:19:25Z

Itamart: /* Reset caches */

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|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
* 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 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.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.png]]

Admin can click the Reset link to clear the caches.
[[File: 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.
[[File: 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).
[[File: mhaairs-instructor-add-block-02.png]]

In the Add a block dropdown list select McGraw-Hill AAIRS.
[[File: mhaairs-instructor-add-block-03.png]]

The mhaairs block is now added to your course.
[[File: 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.
[[File: 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'.
[[File: 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'.
[[File: 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.
[[File: mhaairs-instructor-block-config-03.png]]

==Usage==
[[File: 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
[[Category:Block]]

MH AAIRS block

2016-03-22T15:12:36Z

Itamart:

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|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
* 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 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.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.png]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.png]]

The caches will be automatically regenerated as soon as the respective info is required.
==Course administration==
===Adding the mhaairs block in a course===
In your course press the 'Turn editing on' button to turn editing on.
[[File: 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).
[[File: mhaairs-instructor-add-block-02.png]]

In the Add a block dropdown list select McGraw-Hill AAIRS.
[[File: mhaairs-instructor-add-block-03.png]]

The mhaairs block is now added to your course.
[[File: 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.
[[File: 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'.
[[File: 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'.
[[File: 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.
[[File: mhaairs-instructor-block-config-03.png]]

==Usage==
[[File: 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
[[Category:Block]]

File:mhaairs-user-block-usage-01.png

2016-03-22T12:41:14Z

Itamart:

MH AAIRS block

2016-03-22T12:40:51Z

Itamart:

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.png]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.png]]

The caches will be automatically regenerated as soon as the respective info is required.
==Course administration==
===Adding the mhaairs block in a course===
In your course press the 'Turn editing on' button to turn editing on.
[[File: 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).
[[File: mhaairs-instructor-add-block-02.png]]

In the Add a block dropdown list select McGraw-Hill AAIRS.
[[File: mhaairs-instructor-add-block-03.png]]

The mhaairs block is now added to your course.
[[File: 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.
[[File: 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'.
[[File: 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'.
[[File: 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.
[[File: mhaairs-instructor-block-config-03.png]]

==Usage==
[[File: 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.
[[Category:Block]]

MH AAIRS block

2016-03-21T16:57:29Z

Itamart: /* Changing the list of the displayed tools */

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.png]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.png]]

The caches will be automatically regenerated as soon as the respective info is required.
==Course administration==
===Adding the mhaairs block in a course===
In your course press the 'Turn editing on' button to turn editing on.
[[File: 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).
[[File: mhaairs-instructor-add-block-02.png]]

In the Add a block dropdown list select McGraw-Hill AAIRS.
[[File: mhaairs-instructor-add-block-03.png]]

The mhaairs block is now added to your course.
[[File: 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.
[[File: 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'.
[[File: 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'.
[[File: 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.
[[File: mhaairs-instructor-block-config-03.png]]

==Usage==
===Accessing MH Campus===

[[Category:Block]]

File:mhaairs-instructor-block-config-03.png

2016-03-21T16:57:14Z

Itamart:

File:mhaairs-instructor-block-config-02.png

2016-03-21T16:55:32Z

Itamart:

File:mhaairs-instructor-block-config-01.png

2016-03-21T16:53:42Z

Itamart:

File:mhaairs-instructor-add-block-05.png

2016-03-21T15:49:23Z

Itamart:

File:mhaairs-instructor-add-block-04.png

2016-03-21T15:49:09Z

Itamart:

File:mhaairs-instructor-add-block-03.png

2016-03-21T15:38:45Z

Itamart:

File:mhaairs-instructor-add-block-02.png

2016-03-21T15:36:34Z

Itamart:

MH AAIRS block

2016-03-21T15:36:11Z

Itamart:

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.png]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.png]]

The caches will be automatically regenerated as soon as the respective info is required.
==Course administration==
===Adding the mhaairs block in a course===
In your course press the 'Turn editing on' button to turn editing on.
[[File: 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).
[[File: mhaairs-instructor-add-block-02.png]]

In the Add a block dropdown list select McGraw-Hill AAIRS.
[[File: mhaairs-instructor-add-block-03.png]]

The mhaairs block is now added to your course.
[[File: 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.
[[File: 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'.
[[File: 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'.
[[File: 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.
[[File: mhaairs-instructor-block-config-03.png]]

==Usage==
===Accessing MH Campus===

[[Category:Block]]

MH AAIRS block

2016-03-21T15:29:43Z

Itamart:

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.png]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.png]]

The caches will be automatically regenerated as soon as the respective info is required.
==Course administration==
===Adding the mhaairs block in a course===
In your course press the 'Turn editing on' button to turn editing on.
[[File: mhaairs-instructor-add-block-01.png]]

The 'Add a block' dropdown is now displayed.

In the Add a block dropdown list select McGraw-Hill AAIRS.
[[File: mhaairs-instructor-add-block-02.png]]

The mhaairs block is now added to your course.
[[File: mhaairs-instructor-add-block-03.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.
[[File: mhaairs-instructor-add-block-04.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'.
[[File: 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'.
[[File: 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.
[[File: mhaairs-instructor-block-config-03.png]]

==Usage==
===Accessing MH Campus===

[[Category:Block]]

MH AAIRS block

2016-03-21T15:28:38Z

Itamart:

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===RESET CACHES===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.png]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.png]]

The caches will be automatically regenerated as soon as the respective info is required.
==Course administration==
===Adding the mhaairs block in a course===
In your course press the 'Turn editing on' button to turn editing on.
[[File: mhaairs-instructor-add-block-01.png]]

The 'Add a block' dropdown is now displayed.

In the Add a block dropdown list select McGraw-Hill AAIRS.
[[File: mhaairs-instructor-add-block-02.png]]

The mhaairs block is now added to your course.
[[File: mhaairs-instructor-add-block-03.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.
[[File: mhaairs-instructor-add-block-04.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'.
[[File: 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'.
[[File: 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.
[[File: mhaairs-instructor-block-config-03.png]]

==Usage==
===Accessing MH Campus===

[[Category:Block]]

File:mhaairs-instructor-add-block-01.png

2016-03-21T15:24:08Z

Itamart:

MH AAIRS block

2016-03-21T15:19:52Z

Itamart:

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.png]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.png]]

The caches will be automatically regenerated as soon as the respective info is required.
==COURSE ADMINISTRATION==
===ADDING THE MHAAIRS BLOCK IN A COURSE===
In your course turn editing on.
[[File: mhaairs-instructor-add-block-01.png]]

The 'Add a block' dropdown is now displayed.

In the Add a block dropdown list select McGraw-Hill AAIRS.
[[File: mhaairs-instructor-add-block-02.png]]

The mhaairs block is now added to your course.
[[File: mhaairs-instructor-add-block-03.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.
[[File: mhaairs-instructor-add-block-04.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'.
[[File: 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'.
[[File: 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.
[[File: mhaairs-instructor-block-config-03.png]]

==USAGE==
===ACCESSING MH CAMPUS===

[[Category:Block]]

MH AAIRS block

2016-03-21T12:11:12Z

Itamart:

File:mhaairs-admin-reset-caches-02.png

2016-03-20T22:20:13Z

Itamart:

File:mhaairs-admin-reset-caches-01.png

2016-03-20T22:20:00Z

Itamart:

MH AAIRS block

2016-03-20T22:19:42Z

Itamart: /* Reset caches */

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
==Administration==
The mhaairs block administration options can be found in the Administration block under Site administration > Plugins > Blocks > McGraw-Hill AAIRS.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.png]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.png]]

The caches will be automatically regenerated as soon as the respective info is required.

==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]]

[[Category:Block]]

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

2016-03-20T22:15:08Z

Itamart:

MH AAIRS block

2016-03-20T22:14:52Z

Itamart: /* Grade exchange logs */

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
==Administration==
The mhaairs block administration options can be found in the Administration block under Site administration > Plugins > Blocks > McGraw-Hill AAIRS.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.png]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.jpg]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.jpg]]

The caches will be automatically regenerated as soon as the respective info is required.
==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]]

[[Category:Block]]

MH AAIRS block

2016-03-20T22:13:23Z

Itamart: /* Grade exchange logs */

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
==Administration==
The mhaairs block administration options can be found in the Administration block under Site administration > Plugins > Blocks > McGraw-Hill AAIRS.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.jpg]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.jpg]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.jpg]]

The caches will be automatically regenerated as soon as the respective info is required.
==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]]

[[Category:Block]]

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

2016-03-20T22:13:00Z

Itamart:

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

2016-03-20T22:10:27Z

Itamart:

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

2016-03-20T22:09:17Z

Itamart:

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

2016-03-20T22:06:52Z

Itamart:

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

2016-03-18T21:43:39Z

Itamart:

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

2016-03-18T21:42:04Z

Itamart:

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

2016-03-18T21:39:43Z

Itamart: Itamart uploaded a new version of File:mhaairs-admin-web-service-test-client-02.png

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

2016-03-18T21:37:49Z

Itamart:

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

2016-03-18T21:37:16Z

Itamart:

MH AAIRS block

2016-03-18T21:36:33Z

Itamart: /* Web service test client */

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
==Administration==
The mhaairs block administration options can be found in the Administration block under Site administration > Plugins > Blocks > McGraw-Hill AAIRS.
[[File: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===
[[File: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.
[[File: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:
[[File: 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.
[[File: 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.
[[File: 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:
[[File: mhaairs-admin-web-service-test-client-05.png]]

[[File: 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.
[[File: 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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.jpg]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.jpg]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.jpg]]

The caches will be automatically regenerated as soon as the respective info is required.
==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]]

[[Category:Block]]

File:mhaairs-admin-site-settings.png

2016-03-18T17:41:51Z

Itamart:

File:mhaairs-admin-administration-options.png

2016-03-18T17:38:24Z

Itamart:

MH AAIRS block

2016-03-18T17:32:52Z

Itamart:

{{Infobox plugin
|type = Blocks
|set = N/A
|entry = [http://moodle.org/plugins/view.php?plugin=block_mhaairs Moodle plugins repo]
|tracker = [https://tracker.moodle.org/browse/CONTRIB/component/14834 Moodle tracker]
|discussion = TBA
|maintainer = [[User:Itamar Tzadok|Itamar Tzadok]]
}}
==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
* 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 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.
==Administration==
The mhaairs block administration options can be found in the Administration block under Site administration > Plugins > Blocks > McGraw-Hill AAIRS.
[[File: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===
[[File: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.
[[File: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:
[[File: mhaairs-admin-web-service-test-client-02.jpg]]

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.
[[File: mhaairs-admin-web-service-test-client-03.jpg]]

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.
[[File: mhaairs-admin-web-service-test-client-04.jpg]]

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:
[[File: mhaairs-admin-web-service-test-client-05.jpg]]

[[File: mhaairs-admin-web-service-test-client-06.jpg]]

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.
[[File: mhaairs-admin-web-service-test-client-07.jpg]]

===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.
[[File: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.
[[File:mhaairs-admin-grade-exchange-logs-02.jpg]]

===Reset caches===
This plugin caches store the configured tools and help urls.
[[File: mhaairs-admin-reset-caches-01.jpg]]

Admin can click the Reset link to clear the caches.
[[File: mhaairs-admin-reset-caches-02.jpg]]

The caches will be automatically regenerated as soon as the respective info is required.
==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]]

[[Category:Block]]

MH AAIRS block

2015-12-08T14:08:29Z

Itamart: /* Administration */

MH AAIRS block

2015-12-08T13:57:57Z

Itamart: /* Administration */

MH AAIRS block

2015-12-08T13:39:39Z

Itamart: /* Administration */

MH AAIRS block

2015-12-08T13:34:41Z

Itamart:

MH AAIRS block

2015-12-08T13:31:08Z

Itamart: /* Select locking type */

MH AAIRS block

2015-12-08T13:25:55Z

Itamart: /* Site configuration */

MH AAIRS block

2015-12-08T13:25:40Z

Itamart:

MH AAIRS block

2015-12-08T13:20:18Z

Itamart: /* Help links */

MH AAIRS block

2015-12-08T13:19:53Z

Itamart: /* Available Services */

MH AAIRS block

2015-12-08T13:18:31Z

Itamart: