MoodleDocs - User contributions [en]

MRBS block

2009-06-02T14:32:09Z

Mike1989: /* Installation */

==MRBS Block==

The MRBS block integrates the MRBS project (http://sourceforge.net/projects/mrbs/) by using Moodle functions to authenticate. While initially designed to work with Moodle 1.6 as a single sign on integration, later work made the MRBS project a contributed Moodle block.

Stephen Bourget was kind enough to work on some changes to prepare the MRBS block to take advantage of roles and for use with Moodle 1.7 and beyond. Furthermore, a recently discovered SQL injection vulnerability in the MRBS application was patched. As a result, the MRBS integration/block is no longer supported or maintained for versions prior to Moodle 1.7.

As with any customization, it is recommended that you have a good backup of your Moodle site before attempting to install contributed code. While those contributing code make every effort to provide the best code that they can, using contributed code nevertheless entails a certain degree of risk as contributed code is not as carefully reviewed and/or tested as the Moodle core code.

MRBS is useful for scheduling a variety of resources. More information about MRBS can be obtained at http://mrbs.sourceforge.net/. As distributed here it is setup for periods; however, this can easily be changed to times by modifying the config.inc.php file.

===Installation===
* Code - Copy the files into your Moodle blocks folder ($CFG->dirroot/blocks)
* Database - Login in as a Moodle Administrator and go to the Administration notifications page to create the MRBS tables
* Capabilities - The MRBS block is primarily intended for use on the Moodle front page. Privileges to use the scheduler are currently based on three custom defined capabilities:

# block/mrbs:administermrbs
# block/mrbs:editmrbs
# block/mrbs:viewmrbs

** While these capabilities are created automatically, the system roles are not. As such, it is recommended that you create three system wide roles by:

# Login as the Site administrator
# Go to the Site Administration block
# Click on Users -> Permissions -> Define Roles
# Click on the 'Add a new role' pushbutton
# Fill in the Name, Short name, and description fields with MRBS Administrator, MRBS Scheduler, or MRBS Viewer depending on the role you are creating.
# Under Permissions set the capability to allow for the respective role (i.e. block/mrbs:administermrbs for the MRBS Administrator role, block/mrbs:editmrbs for the MRBS Scheduler role, and block/mrbs:viewmrbs for the MRBS Viewer role).
# Scroll down to the bottom and click on the 'Add a new role' (or 'Save changes' if editing the role) pushbutton.
# Once the roles are created, go to Site Administration block, click on Frontpage -> Frontpage roles and assign users to the appropriate/desired roles.

** Typically, teachers get assigned as MRBS Schedulers and students as MRBS Viewers. Keep in mind that no assignment is equivalent to MRBS Viewers. Site administrators have the option of making the MRBS Calendar viewable to guests and non-logged in users. To force users to login in order to view the MRBS Calendar:
# Login as the site administrator
# Go to the Site Administration block under Security -> Site Policies
# Enable the 'Force users to login' setting

===Suggested configuration rules===
Not following these suggestions will not totally break mrbs, but will prevent some features working optimally.

* Where bookings are for courses, the booking name should match the shortname of the course
* Rooms should be described such that:
** All teaching rooms include the word 'teaching' in their description
** IT teaching rooms should have 'Teaching IT' in their description
** Teaching rooms that are not suitable for general teaching (i.e. tech workshops) should have 'special' in their names.

===Languages===

Thanks to the generosity of translators, the MRBS Block is available in:
*English (en_utf8)
*Spanish (es_utf8)
*German (de_utf8)
** Installation instructions in German are available at: https://docs.moodle.org/de/blocks/mrbs#.C3.84ndern_der_MRBS_Texte

If you would like to supply translations for other languages, please create an issue in the tracker and attach a zip file of the language files.

===Extra Moodle MRBS Features===
* [[MRBS_block/import|Import timetable]]
* [[MRBS_block/forcebook|Force booking]]
* [[MRBS_block/usertt|User timetables]]

===Contributor/Maintainer===
The MRBS Block was contributed and is maintained by Anthony Borrow.
More information about the MRBS Block is available at: http://moodle.org/mod/data/view.php?d=13&rid=734

Mike Worth has done significant work on new features for the MRBS block, and has taken on the role of co-maintainer. More details about these new features are available at: http://moodle.org/mod/forum/discuss.php?d=121753

[[Category:Contributed code]]

MRBS block/usertt

2009-06-02T14:21:00Z

Mike1989: New page: This feature allows users to view a personal timetable. == How do I get to it?== As standard, there are no links to this page; the idea is that you create a 'My Timetable' link on one of...

This feature allows users to view a personal timetable.

== How do I get to it?==
As standard, there are no links to this page; the idea is that you create a 'My Timetable' link on one of your own menus (probably either in a theme or html block, but can be anywhere).

* A link pointing to [yourmoodle]/blocks/mrbs/web/userweek.php will give any user their own timetable.
* [yourmoodle]/blocks/mrbs/web/userweek.php?user=[userid] (where userid is the users id(not idnumber)) will link directly to another users timetable. Only users with the block/mrbs/viewalltt capability are permitted to view other users' timetables.

== Which bookings are displayed? ==
There are two classes of bookings that are displayed on this page:
# Bookings that belong to the user
# Bookings which correspond to moodle courses (via the shortname) which the user is enrolled on as a student.

The second of these sounds a bit complicated, but as long as your booking names match up to your course shortnames then it will all work.

MRBS block

2009-06-02T14:11:34Z

Mike1989: /* Extra Moodle MRBS Features */

==MRBS Block==

The MRBS block integrates the MRBS project (http://sourceforge.net/projects/mrbs/) by using Moodle functions to authenticate. While initially designed to work with Moodle 1.6 as a single sign on integration, later work made the MRBS project a contributed Moodle block.

Stephen Bourget was kind enough to work on some changes to prepare the MRBS block to take advantage of roles and for use with Moodle 1.7 and beyond. Furthermore, a recently discovered SQL injection vulnerability in the MRBS application was patched. As a result, the MRBS integration/block is no longer supported or maintained for versions prior to Moodle 1.7.

As with any customization, it is recommended that you have a good backup of your Moodle site before attempting to install contributed code. While those contributing code make every effort to provide the best code that they can, using contributed code nevertheless entails a certain degree of risk as contributed code is not as carefully reviewed and/or tested as the Moodle core code.

MRBS is useful for scheduling a variety of resources. More information about MRBS can be obtained at http://mrbs.sourceforge.net/. As distributed here it is setup for periods; however, this can easily be changed to times by modifying the config.inc.php file.

===Installation===
* Code - Copy the files into your Moodle blocks folder ($CFG->dirroot/blocks)
* Database - Login in as a Moodle Administrator and go to the Administration notifications page to create the MRBS tables
* Capabilities - The MRBS block is primarily intended for use on the Moodle front page. Privileges to use the scheduler are currently based on three custom defined capabilities:

# block/mrbs:administermrbs
# block/mrbs:editmrbs
# block/mrbs:viewmrbs

** While these capabilities are created automatically, the system roles are not. As such, it is recommended that you create three system wide roles by:

# Login as the Site administrator
# Go to the Site Administration block
# Click on Users -> Permissions -> Define Roles
# Click on the 'Add a new role' pushbutton
# Fill in the Name, Short name, and description fields with MRBS Administrator, MRBS Scheduler, or MRBS Viewer depending on the role you are creating.
# Under Permissions set the capability to allow for the respective role (i.e. block/mrbs:administermrbs for the MRBS Administrator role, block/mrbs:editmrbs for the MRBS Scheduler role, and block/mrbs:viewmrbs for the MRBS Viewer role).
# Scroll down to the bottom and click on the 'Add a new role' (or 'Save changes' if editing the role) pushbutton.
# Once the roles are created, go to Site Administration block, click on Frontpage -> Frontpage roles and assign users to the appropriate/desired roles.

** Typically, teachers get assigned as MRBS Schedulers and students as MRBS Viewers. Keep in mind that no assignment is equivalent to MRBS Viewers. Site administrators have the option of making the MRBS Calendar viewable to guests and non-logged in users. To force users to login in order to view the MRBS Calendar:
# Login as the site administrator
# Go to the Site Administration block under Security -> Site Policies
# Enable the 'Force users to login' setting

===Languages===

Thanks to the generosity of translators, the MRBS Block is available in:
*English (en_utf8)
*Spanish (es_utf8)
*German (de_utf8)
** Installation instructions in German are available at: https://docs.moodle.org/de/blocks/mrbs#.C3.84ndern_der_MRBS_Texte

If you would like to supply translations for other languages, please create an issue in the tracker and attach a zip file of the language files.

===Extra Moodle MRBS Features===
* [[MRBS_block/import|Import timetable]]
* [[MRBS_block/forcebook|Force booking]]
* [[MRBS_block/usertt|User timetables]]

===Contributor/Maintainer===
The MRBS Block was contributed and is maintained by Anthony Borrow.
More information about the MRBS Block is available at: http://moodle.org/mod/data/view.php?d=13&rid=734

Mike Worth has done significant work on new features for the MRBS block, and has taken on the role of co-maintainer. More details about these new features are available at: http://moodle.org/mod/forum/discuss.php?d=121753

[[Category:Contributed code]]

MRBS block/import

2009-06-02T13:33:22Z

Mike1989:

This feature works in a similar way to flatfile enrolement; it is enabled by configuring a file location in the module settings. Once there is a location set, that location will be checked every time cron runs and if a file is found it will be processed.

All existing imported bookings will be deleted from the database before the new import is processed- this is done so that a timetable can be imported regularly, ensuring that mrbs is kept up to date. Any imported bookings that have been edited will not be deleted and will not be re-imported, however any deleted bookings will be re-imported.

The file should be a csv file, without a header row, containing the following fields:
{| class="nicetable"
|-
!Start time
!End time
!Date of first session
!Weekpattern
!Room name
!Username
!Name
!Description
|-
|hh:mm format, if periods are used then see the section below
|hh:mm format, if periods are used then see the section below
|YYYY/MM/DD format
|This field enables a session to be repeated weekly, missing out weeks for holidays etc. To make a single booking just put 1 in this field, otherwise enter a string of 1s and spaces (each 1 representing a booking, each space representing a week without a booking). This string can be as long as required.
|must be the same as that held in the mrbs_room table
|this field is used to link the booking to a moodle user. It is not case sensitive and will not cause an error if no matching user is found (however if this is the case then only mrbs admins will be able to edit the booking)
|the name for the booking to have. If you want to take advantage of some other features then you should set this to the shortname of the course the booking is for (if there is a moodle course for it)
|a description for the booking
|}

====Times when periods are enabled====
MRBS stores period times as minutes past midnight, 00:00 is the time period1 starts, 00:01 is the time period1 ends and period 2 starts etc.

MRBS block/forcebook

2009-06-02T13:13:51Z

Mike1989: New page: The block/mrbs:forcebook capability empowers certain users to book rooms even if they are already occupied. Any bookings currently in those rooms are automatically moved to the most suitab...

The block/mrbs:forcebook capability empowers certain users to book rooms even if they are already occupied. Any bookings currently in those rooms are automatically moved to the most suitable empty room.

The force book checkbox can be selected any time a booking is made/edited (assuming correct permissions); it will override the 'only allow choice of free rooms' feature and will reload the complete rooms list so that an occupied room can be selected. When such a booking is made, the booking will be moved according to the criteria listed below. The users who own the bookings will be notified via email about the movement of their booking. If there are any errors with moving the booking (e.g. there are no suitable rooms available) then an error is displayed and an email is sent to the mrbs admin.

== Room Selection Criteria ==

* Only rooms with 'teaching' in their description will be considered
* If the booking name matches a course shortname, only rooms with enough capacity for all the students will be considered
* Rooms with 'special' in the description will only be considered if they are within the same area
* Only rooms that are not occupied at the relevant time will be considered

Of these rooms, the most order of preference is:
# Rooms with matching descriptions and in the same area
# Rooms with matching descriptions
# Rooms in the same area
# Any other rooms

MRBS block/import

2009-06-02T12:56:25Z

Mike1989: New page: This feature works in a similar way to flatfile enrolement; it is enabled by configuring a file location in the module settings. Once there is a location set, that location will be checked...

This feature works in a similar way to flatfile enrolement; it is enabled by configuring a file location in the module settings. Once there is a location set, that location will be checked every time cron runs and if a file is found it will be processed.

The file should be a csv file, without a header row, containing the following fields:
{| class="nicetable"
|-
!Start time
!End time
!Date of first session
!Weekpattern
!Room name
!Username
!Name
!Description
|-
|hh:mm format, if periods are used then see the section below
|hh:mm format, if periods are used then see the section below
|YYYY/MM/DD format
|This field enables a session to be repeated weekly, missing out weeks for holidays etc. To make a single booking just put 1 in this field, otherwise enter a string of 1s and spaces (each 1 representing a booking, each space representing a week without a booking). This string can be as long as required.
|must be the same as that held in the mrbs_room table
|this field is used to link the booking to a moodle user. It is not case sensitive and will not cause an error if no matching user is found (however if this is the case then only mrbs admins will be able to edit the booking)
|the name for the booking to have. If you want to take advantage of some other features then you should set this to the shortname of the course the booking is for (if there is a moodle course for it)
|a description for the booking
|}

====Times when periods are enabled====
MRBS stores period times as minutes past midnight, 00:00 is the time period1 starts, 00:01 is the time period1 ends and period 2 starts etc.

MRBS block

2009-06-02T11:36:08Z

Mike1989: Adding docs for my new features

==MRBS Block==

The MRBS block integrates the MRBS project (http://sourceforge.net/projects/mrbs/) by using Moodle functions to authenticate. While initially designed to work with Moodle 1.6 as a single sign on integration, later work made the MRBS project a contributed Moodle block.

Stephen Bourget was kind enough to work on some changes to prepare the MRBS block to take advantage of roles and for use with Moodle 1.7 and beyond. Furthermore, a recently discovered SQL injection vulnerability in the MRBS application was patched. As a result, the MRBS integration/block is no longer supported or maintained for versions prior to Moodle 1.7.

As with any customization, it is recommended that you have a good backup of your Moodle site before attempting to install contributed code. While those contributing code make every effort to provide the best code that they can, using contributed code nevertheless entails a certain degree of risk as contributed code is not as carefully reviewed and/or tested as the Moodle core code.

MRBS is useful for scheduling a variety of resources. More information about MRBS can be obtained at http://mrbs.sourceforge.net/. As distributed here it is setup for periods; however, this can easily be changed to times by modifying the config.inc.php file.

===Installation===
* Code - Copy the files into your Moodle blocks folder ($CFG->dirroot/blocks)
* Database - Login in as a Moodle Administrator and go to the Administration notifications page to create the MRBS tables
* Capabilities - The MRBS block is primarily intended for use on the Moodle front page. Privileges to use the scheduler are currently based on three custom defined capabilities:

# block/mrbs:administermrbs
# block/mrbs:editmrbs
# block/mrbs:viewmrbs

** While these capabilities are created automatically, the system roles are not. As such, it is recommended that you create three system wide roles by:

# Login as the Site administrator
# Go to the Site Administration block
# Click on Users -> Permissions -> Define Roles
# Click on the 'Add a new role' pushbutton
# Fill in the Name, Short name, and description fields with MRBS Administrator, MRBS Scheduler, or MRBS Viewer depending on the role you are creating.
# Under Permissions set the capability to allow for the respective role (i.e. block/mrbs:administermrbs for the MRBS Administrator role, block/mrbs:editmrbs for the MRBS Scheduler role, and block/mrbs:viewmrbs for the MRBS Viewer role).
# Scroll down to the bottom and click on the 'Add a new role' (or 'Save changes' if editing the role) pushbutton.
# Once the roles are created, go to Site Administration block, click on Frontpage -> Frontpage roles and assign users to the appropriate/desired roles.

** Typically, teachers get assigned as MRBS Schedulers and students as MRBS Viewers. Keep in mind that no assignment is equivalent to MRBS Viewers. Site administrators have the option of making the MRBS Calendar viewable to guests and non-logged in users. To force users to login in order to view the MRBS Calendar:
# Login as the site administrator
# Go to the Site Administration block under Security -> Site Policies
# Enable the 'Force users to login' setting

===Languages===

Thanks to the generosity of translators, the MRBS Block is available in:
*English (en_utf8)
*Spanish (es_utf8)
*German (de_utf8)
** Installation instructions in German are available at: https://docs.moodle.org/de/blocks/mrbs#.C3.84ndern_der_MRBS_Texte

If you would like to supply translations for other languages, please create an issue in the tracker and attach a zip file of the language files.

===Extra Moodle MRBS Features===
* [[MRBS_block/import|Import timetable]]
* [[MRBS_block/forcebook|Force booking]]

===Contributor/Maintainer===
The MRBS Block was contributed and is maintained by Anthony Borrow.
More information about the MRBS Block is available at: http://moodle.org/mod/data/view.php?d=13&rid=734

Mike Worth has done significant work on new features for the MRBS block, and has taken on the role of co-maintainer. More details about these new features are available at: http://moodle.org/mod/forum/discuss.php?d=121753

[[Category:Contributed code]]

MRBS block

2009-06-01T15:18:07Z

Mike1989: /* MRBS Block */

==MRBS Block==

The MRBS block integrates the MRBS project (http://sourceforge.net/projects/mrbs/) by using Moodle functions to authenticate. While initially designed to work with Moodle 1.6 as a single sign on integration, later work made the MRBS project a contributed Moodle block.

Stephen Bourget was kind enough to work on some changes to prepare the MRBS block to take advantage of roles and for use with Moodle 1.7 and beyond. Furthermore, a recently discovered SQL injection vulnerability in the MRBS application was patched. As a result, the MRBS integration/block is no longer supported or maintained for versions prior to Moodle 1.7.

As with any customization, it is recommended that you have a good backup of your Moodle site before attempting to install contributed code. While those contributing code make every effort to provide the best code that they can, using contributed code nevertheless entails a certain degree of risk as contributed code is not as carefully reviewed and/or tested as the Moodle core code.

MRBS is useful for scheduling a variety of resources. More information about MRBS can be obtained at http://mrbs.sourceforge.net/. As distributed here it is setup for periods; however, this can easily be changed to times by modifying the config.inc.php file.

===Installation===
* Code - Copy the files into your Moodle blocks folder ($CFG->dirroot/blocks)
* Database - Login in as a Moodle Administrator and go to the Administration notifications page to create the MRBS tables
* Capabilities - The MRBS block is primarily intended for use on the Moodle front page. Privileges to use the scheduler are currently based on three custom defined capabilities:

# block/mrbs:administermrbs
# block/mrbs:editmrbs
# block/mrbs:viewmrbs

** While these capabilities are created automatically, the system roles are not. As such, it is recommended that you create three system wide roles by:

# Login as the Site administrator
# Go to the Site Administration block
# Click on Users -> Permissions -> Define Roles
# Click on the 'Add a new role' pushbutton
# Fill in the Name, Short name, and description fields with MRBS Administrator, MRBS Scheduler, or MRBS Viewer depending on the role you are creating.
# Under Permissions set the capability to allow for the respective role (i.e. block/mrbs:administermrbs for the MRBS Administrator role, block/mrbs:editmrbs for the MRBS Scheduler role, and block/mrbs:viewmrbs for the MRBS Viewer role).
# Scroll down to the bottom and click on the 'Add a new role' (or 'Save changes' if editing the role) pushbutton.
# Once the roles are created, go to Site Administration block, click on Frontpage -> Frontpage roles and assign users to the appropriate/desired roles.

** Typically, teachers get assigned as MRBS Schedulers and students as MRBS Viewers. Keep in mind that no assignment is equivalent to MRBS Viewers. Site administrators have the option of making the MRBS Calendar viewable to guests and non-logged in users. To force users to login in order to view the MRBS Calendar:
# Login as the site administrator
# Go to the Site Administration block under Security -> Site Policies
# Enable the 'Force users to login' setting

===Languages===

Thanks to the generosity of translators, the MRBS Block is available in:
*English (en_utf8)
*Spanish (es_utf8)
*German (de_utf8)
** Installation instructions in German are available at: https://docs.moodle.org/de/blocks/mrbs#.C3.84ndern_der_MRBS_Texte

If you would like to supply translations for other languages, please create an issue in the tracker and attach a zip file of the language files.

===Contributor/Maintainer===
The MRBS Block was contributed and is maintained by Anthony Borrow.
More information about the MRBS Block is available at: http://moodle.org/mod/data/view.php?d=13&rid=734

Mike Worth has done significant work on new features for the MRBS block, and has taken on the role of co-maintainer. More details about these new features are available at: http://moodle.org/mod/forum/discuss.php?d=121753

[[Category:Contributed code]]

MRBS block

2009-06-01T15:12:02Z

Mike1989: /* Contributor/Maintainer */

==MRBS Block==

The MRBS block integrates the MRBS project (http://sourceforge.net/projects/mrbs/) by using settings in the Moodle config.php to authenticate against the mdl_user file as its external database and thus allows for single sign on (SSO). While initially designed to work with Moodle 1.6 as a single sign on integration, later work made the MRBS project a contributed Moodle block. Stephen Bourget was kind enough to work on some changes to prepare the MRBS block to take advantage of roles and for use with Moodle 1.7 and beyond. Furthermore, a recently discovered SQL injection vulnerability in the MRBS application was patched. As a result, the MRBS integration/block is no longer supported or maintained for versions prior to Moodle 1.7. The MRBS block currently requires MySQL; however, I have added an issue in the tracker (http://tracker.moodle.org/browse/CONTRIB-340) to provide Postgresql support.

As with any customization, it is recommended that you have a good backup of your Moodle site before attempting to install contributed code. While those contributing code make every effort to provide the best code that they can, using contributed code nevertheless entails a certain degree of risk as contributed code is not as carefully reviewed and/or tested as the Moodle core code.

MRBS is useful for scheduling a variety of resources. More information about MRBS can be obtained at http://mrbs.sourceforge.net/. As distributed here it is setup for periods; however, this can easily be changed to times by modifying the config.inc.php file.

===Installation===
* Code - Copy the files into your Moodle blocks folder ($CFG->dirroot/blocks)
* Database - Login in as a Moodle Administrator and go to the Administration notifications page to create the MRBS tables
* Capabilities - The MRBS block is primarily intended for use on the Moodle front page. Privileges to use the scheduler are currently based on three custom defined capabilities:

# block/mrbs:administermrbs
# block/mrbs:editmrbs
# block/mrbs:viewmrbs

** While these capabilities are created automatically, the system roles are not. As such, it is recommended that you create three system wide roles by:

# Login as the Site administrator
# Go to the Site Administration block
# Click on Users -> Permissions -> Define Roles
# Click on the 'Add a new role' pushbutton
# Fill in the Name, Short name, and description fields with MRBS Administrator, MRBS Scheduler, or MRBS Viewer depending on the role you are creating.
# Under Permissions set the capability to allow for the respective role (i.e. block/mrbs:administermrbs for the MRBS Administrator role, block/mrbs:editmrbs for the MRBS Scheduler role, and block/mrbs:viewmrbs for the MRBS Viewer role).
# Scroll down to the bottom and click on the 'Add a new role' (or 'Save changes' if editing the role) pushbutton.
# Once the roles are created, go to Site Administration block, click on Frontpage -> Frontpage roles and assign users to the appropriate/desired roles.

** Typically, teachers get assigned as MRBS Schedulers and students as MRBS Viewers. Keep in mind that no assignment is equivalent to MRBS Viewers. Site administrators have the option of making the MRBS Calendar viewable to guests and non-logged in users. To force users to login in order to view the MRBS Calendar:
# Login as the site administrator
# Go to the Site Administration block under Security -> Site Policies
# Enable the 'Force users to login' setting

===Languages===

Thanks to the generosity of translators, the MRBS Block is available in:
*English (en_utf8)
*Spanish (es_utf8)
*German (de_utf8)
** Installation instructions in German are available at: https://docs.moodle.org/de/blocks/mrbs#.C3.84ndern_der_MRBS_Texte

If you would like to supply translations for other languages, please create an issue in the tracker and attach a zip file of the language files.

===To Do List===

*Postgresql support

===Contributor/Maintainer===
The MRBS Block was contributed and is maintained by Anthony Borrow.
More information about the MRBS Block is available at: http://moodle.org/mod/data/view.php?d=13&rid=734

Mike Worth has done significant work on new features for the MRBS block, and has taken on the role of co-maintainer. More details about these new features are available at: http://moodle.org/mod/forum/discuss.php?d=121753

[[Category:Contributed code]]

CSV user relationships block

2009-05-15T14:33:32Z

Mike1989:

This block allows user relationships(that is one user assigned a role in another user's context) to be created/kept up to date via csv files. It was written for personal tutors, but would work equally well for parents.

It can be operated in two modes:

manual upload- any user with the block/tutorlink:use capability (by default, only admins) can upload a file to process

automatic- a file location is configured, then the block automatically checks this location. If a file is found, it is processed and results emailed to the administrator.

==Correct File Format==
The files to be processed should be in CSV format (hopefully no surprises there). They may consist of any number of rows, each with three fields: tutor idnumber,tutee idnumber, action; it is important to note that the idnumbers are expected to be populated from an external database, they are not the id field in the user table. Action can be add or del, with add creating relationships and del deleting relationships. None of the fields should be delimited.

Including relationships that already exist in moodle in the file will not cause problems, as this block will skip over those records.

==Manual upload==
The file is created, then a user with the block/tutorlink:use capability (by default, only admins) adds the block to a course (or the front page, other users will not be able to see the block) then just uploads the file; popup will appear with the results.

==Automatic processing==
The cronfile setting must be set to an absolute location on the server's filesystem, once this is done any file put into that location will be processed. It is recommended that a file is automatically produced my an MIS then automatically transferred to the moodle server via scp or similar- this results in relationships being kept up to date with no human intervention. Once a file has been processed, it is renamed to the current date to [originalfilename].yyyymmdd and the results are emailed to the primary administrator (the user with the r lowest id in the role_assignment table for their administrator assignment).

CSV user relationships block

2009-05-15T14:32:35Z

Mike1989:

This block allows user relationships(that is one user assigned a role in another user's context) to be created/kept up to date via csv files. It was written for personal tutors, but would work equally well for parents.

It can be operated in two modes:

manual upload- any user with the block/tutorlink:use capability (by default, only admins) can upload a file to process
automatic- a file location is configured, then the block automatically checks this location. If a file is found, it is processed and results emailed to the administrator.

==Correct File Format==
The files to be processed should be in CSV format (hopefully no surprises there). They may consist of any number of rows, each with three fields: tutor idnumber,tutee idnumber, action; it is important to note that the idnumbers are expected to be populated from an external database, they are not the id field in the user table. Action can be add or del, with add creating relationships and del deleting relationships. None of the fields should be delimited.

Including relationships that already exist in moodle in the file will not cause problems, as this block will skip over those records.

==Manual upload==
The file is created, then a user with the block/tutorlink:use capability (by default, only admins) adds the block to a course (or the front page, other users will not be able to see the block) then just uploads the file; popup will appear with the results.

==Automatic processing==
The cronfile setting must be set to an absolute location on the server's filesystem, once this is done any file put into that location will be processed. It is recommended that a file is automatically produced my an MIS then automatically transferred to the moodle server via scp or similar- this results in relationships being kept up to date with no human intervention. Once a file has been processed, it is renamed to the current date to [originalfilename].yyyymmdd and the results are emailed to the primary administrator (the user with the r lowest id in the role_assignment table for their administrator assignment).

CSV user relationships block

2009-05-15T14:32:07Z

Mike1989: New page: This block allows user relationships(that is one user assigned a role in another user's context) to be created/kept up to date via csv files. It was written for personal tutors, but would ...

This block allows user relationships(that is one user assigned a role in another user's context) to be created/kept up to date via csv files. It was written for personal tutors, but would work equally well for parents.

It can be operated in two modes:

* manual upload- any user with the block/tutorlink:use capability (by default, only admins) can upload a file to process
* automatic- a file location is configured, then the block automatically checks this location. If a file is found, it is processed and results emailed to the administrator.

==Correct File Format==
The files to be processed should be in CSV format (hopefully no surprises there). They may consist of any number of rows, each with three fields: tutor idnumber,tutee idnumber, action; it is important to note that the idnumbers are expected to be populated from an external database, they are not the id field in the user table. Action can be add or del, with add creating relationships and del deleting relationships. None of the fields should be delimited.

Including relationships that already exist in moodle in the file will not cause problems, as this block will skip over those records.

==Manual upload==
The file is created, then a user with the block/tutorlink:use capability (by default, only admins) adds the block to a course (or the front page, other users will not be able to see the block) then just uploads the file; popup will appear with the results.

==Automatic processing==
The cronfile setting must be set to an absolute location on the server's filesystem, once this is done any file put into that location will be processed. It is recommended that a file is automatically produced my an MIS then automatically transferred to the moodle server via scp or similar- this results in relationships being kept up to date with no human intervention. Once a file has been processed, it is renamed to the current date to [originalfilename].yyyymmdd and the results are emailed to the primary administrator (the user with the r lowest id in the role_assignment table for their administrator assignment).

mod/termreview/view

2009-03-27T13:38:26Z

Mike1989: added mention of new viewall page

This is the main page of the termreview block.

==Writing Reviews==
If the user has write review capability and the review is open they will actually get a form to complete the review for all the students of the course; the page is slightly different for [[mod/termreview/tutor|tutor groups and normal classes]]:

===Normal Classes===

To select a student, simply select their name from the dropdown list- their review page will automatically load, complete with their attendance/punctuality(assuming attendance block is installed) and the course total from the gradebook and their average GCSE score (previous reviews for this class will also be displayed at the bottom of the page).

Assuming ALIS data has been properly configured, the target grade field will automatically be filled in with what should be an appropriate grade (but it is fully changeable). Filling in the data for the everything else should be ronseal.

===Tutor Groups===

Again selecting a student is just a case of selecting their name from the dropdown list. As well as displaying the attendance and punctuality for the tutor group, a summary of all the class teachers reviews will be displayed. The only non-ronseal part is [[mod/termreview/referrals|referrals]]- they must be created and selected in the review options form.

==Viewing all reviews==
If the user either doesn't have write review capability or the review is closed, but does have view all reviews capability they will be presented with a dropdown list of students, selecting the student will display their review. If the course is a [[mod/termreview/tutor|tutor group]] all the class teacher reviews will also be displayed.

There is also a view all link displayed; clicking on this just gives all the reviews in that activity on one page

==Viewing own review==
If the user only has the view own review capability they will (suprise, suprise!) just get their own review. If the course is a [[mod/termreview/tutor|tutor group]] all the class teacher reviews will also be displayed.

==See also==
*[https://docs.moodle.org/en/mod/termreview termreview documentation overview]

mod/termreview/alis

2009-03-27T13:36:55Z