Note: You are currently viewing documentation for Moodle 3.0. Up-to-date documentation for the latest stable version of Moodle may be available here: Attendance activity.

Attendance activity: Difference between revisions

From MoodleDocs
(Replaced version 1.9 documentation with current version of documentation (from version 2.2))
m (added link to spanish translation of page)
 
(19 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Function of the Attendance Module==
{{Infobox plugin
|type = Activity module and optional block
|entry = https://moodle.org/plugins/browse.php?list=set&id=36
|tracker = https://github.com/danmarsden/moodle-mod_attendance/issues
|discussion = https://moodle.org/mod/forum/view.php?id=741
|maintainer = [[User:Dan Marsden|Dan Marsden]]
|float = right
}}


This [[Module|module]] enables you to easily keep track of attendance with a few clicks.  You add Attendance as an activity and then set up the sessions to track.  Attendance will generate reports for either the entire class or for individual students.  Students may also see their own attendance record if the activity is not hidden.  The optional [[Attendance_block|Attendance block]] allows teachers quick control of attendance and students a summary report for their own attendance.
==About the Attendance activity==


===History of Attendance plugin===
The '''Attendance activity''' is designed for ''teachers to be able take attendance'' during class, and for ''students to be able to view their own attendance record''.


Attendance was originally a Moodle [[Block|block]] developed by Russell Jungwirth in the Fall of 2003.[http://moodle.org/mod/forum/discuss.php?d=2431] In the Fall of 2005, [http://moodle.org/user/view.php?id=18237 Dmitry Pupinin] picked up the reins and released version 1.0.2, his first version of the Attendance block.[http://moodle.org/mod/forum/discuss.php?d=33132#p158189] In May of 2007 Dmitry released a new version 2.0 suitable for Moodle 1.8. This release was a dramatic restructuring of code that resulted in a significant [[Module|module]] along with a small [[Block|block]].[http://moodle.org/mod/forum/discuss.php?d=71597] Dmitry continued to develop the Attendance module and block through 2010.  In the November of 2010, [http://moodle.org/user/profile.php?id=52322 Artem Andreev] updated the code to version 2.2[http://moodle.org/mod/forum/discuss.php?d=162960] to add common and group session options and some user interface improvements. [http://moodle.org/user/view.php?id=1281787&course=5 Luis Ramón López] wrote modifications that added the ability to create multiple attendance instances in a single course (e.g., one instance for laboratory activities and another instance for lecture periods)[http://moodle.org/mod/forum/discuss.php?d=162960#p724169] and version 2.3 was released in January of 2011. Immediately after the release of Attendance version 2.3, work began on porting Attendance to Moodle 2.x.  In July of 2011, Artem released Attendance version 2.4.0[http://moodle.org/mod/forum/discuss.php?d=181299], a rewrite of the code as a [[Module|module]] with optional [[Block|block]] only for use with Moodle 2.x.  In July of 2012, Artem released a new branch of version 2.4.0 updated to work with Moodle 2.3.
A teacher can mark the attendance status of a student as "Present", "Absent", "Late", or "Excused". These status descriptions are configurable, and more can be added. The teacher adds Attendance as an activity of a course, and then sets up the sessions whose attendance is to be tracked.


===The latest version===
The Attendance activity can generate reports for either the entire class or for individual students. Students may also see their own attendance record if the activity is not hidden.
There are currently four branches available at http://github.com/andreev-artem/moodle_mod_attforblock for the Attendance [[Module|module]].  They are:
::[http://github.com/andreev-artem/moodle_mod_attforblock/tree/MDL_19 MDL_19] for Moodle 1.9
::[http://github.com/andreev-artem/moodle_mod_attforblock/tree/v2.3 v2.3]  for Moodle 1.9
::[http://github.com/andreev-artem/moodle_mod_attforblock/tree/MDL_20 MDL_20] for Moodle 2.0 - 2.2
::[http://github.com/andreev-artem/moodle_mod_attforblock/tree/MDL_23 MDL_23] for Moodle 2.3


The [[Attendance_block|Attendance block]] has a similar set of versions:
The optional Attendance block allows teachers quick access to the Attendance functionality, and allows students quick access to a summary report for their own attendance.
::[http://github.com/andreev-artem/moodle_blocks_attendance/tree/MDL_19 MDL_19] for Moodle 1.9
::[http://github.com/andreev-artem/moodle_blocks_attendance/tree/v2.3 v2.3]  for Moodle 1.9
::[http://github.com/andreev-artem/moodle_blocks_attendance/tree/MDL_20 MDL_20] for Moodle 2.0 - 2.3
 
Users should install the latest update of the Attendance module and optional block as linked in the table below.


{| class="nicetable"
==Adding an Attendance activity==
|-
! Moodle Version
! Module (attforblock)
! Block (attendance)
|-
| Moodle 1.9.x
| [http://github.com/andreev-artem/moodle_mod_attforblock/zipball/MDL_19 MDL_19 mod]
| [http://github.com/andreev-artem/moodle_blocks_attendance/zipball/MDL_19 MDL_19 block]
|-
| Moodle 2.0 - 2.2.x
| [http://github.com/andreev-artem/moodle_mod_attforblock/zipball/MDL_20 MDL_20 mod]
| [http://github.com/andreev-artem/moodle_blocks_attendance/zipball/MDL_20 MDL_20 block]
|-
| Moodle 2.3.x
| [http://github.com/andreev-artem/moodle_mod_attforblock/zipball/MDL_23 MDL_23 mod]
| [http://github.com/andreev-artem/moodle_blocks_attendance/zipball/MDL_20 MDL_20 block]
|}


==Installation by Moodle Administrator==
An Attendance activity can be added to a course in the same way as any other activity:


To install Artem's version of the attendance module, follow these directions. Installation can only be completed by a user having write access to the file structure on the computer hosting Moodle and with administration rights for your installation of Moodle.
# Turn editing on
# Click 'Add an activity or resource'
# Select Attendance


===Download and Unzip Files===
Note that you may now add as many Attendance instances as you like, and that each instance may have multiple sections. Be sure to give the instance a name that indicates what it will be used for; for example, "Lecture Attendance". If you will be using groups in your course, set the Group mode accordingly, because even if groups exist in the course, you will not be able to use them within the Attendance activity if you select ''No groups''.


Download the latest zipball of the Attendance module using the link above and unzip the file.  When you unzip, you should have a folder with a name like '''<code>andreev-artem-moodle_mod_attforblock-175cd46</code>'''. This folder must be renamed '''<code>attforblock</code>'''. While optional, it is recommended that you likewise download the latest zipball of the Attendance block and, after unzipping, rename the folder '''<code>attendance</code>'''.
Once you have added an attendance instance, you are ready to start taking attendance during classes.


===Language Files===
== Setting Attendance categories and grading options==


The language file used with the module is contained in the '''<code>attforblock/lang/[language pack]/attforblock.php</code>''' file where <code>[language pack]</code> is the Moodle indicator for the [[Language_packs|language pack]] you are using.  If the language pack contains an underscore, for instance, "en_us" then the module will first check in the '''<code>attforblock/lang/en_us/attforblock.php</code>''' file for a phrase.  If the phrase does not exist in that file, then it will check in the "parent language" file which in this example is '''<code>attforblock/lang/en/attforblock.php</code>'''.  You may wish to edit the language files for localized preferences.  For instance, you might consider replacing each occurrence of 'Attendances' with 'Attendance' since some dictionaries say that attendances is the plural form of attendance while others say there is no plural form. Similarly, you may elect to change the spelling of enrolment to enrollment.
Now it is time to set your attendance options. Select your attendance activity and you will see a bar of tabs, the last of which is "Settings." Select "Settings" and you are presented with acronyms, attendance status descriptions, and grade (points) to assign. By default, the status descriptions are "Present", "Absent", "Late", and "Excused".


Note that the '''date format''' is also controlled by the language file you install. If you prefer Month/Day/Year format, for example, you will want to edit the '''<code>attforblock/lang/en_us/attforblock.php</code>''' file to make the changes shown below as well.
You may prefer to change the descriptions (for example, by changing "Late" to "Tardy"), change the way points are counted, or add new status descriptions. To do the latter, fill in the fifth line and click the ''Add'' button. Important: when you hit the ''Add'' button, any changes made to existing options that were made after the last time the ''Update'' button was used will be lost. Likewise, when you hit the ''Update'' button, any changes made to the ''Add'' after the last time the ''Add'' button was hit will be lost.


:$string['strftimedm'] = '%m/%d';
Finally, when you are done changing items on this page, be sure to click the ''Update'' button to register the changes.
:$string['strftimedmy'] = '%m/%d/%Y';
:$string['strftimedmyw'] = '%m/%d/%y&nbsp;(%a)';
:$string['strftimeshortdate'] = '%m/%d/%Y';
:$string['strftimedmyhm'] = '%m/%d/%Y %H:%M'; // line added to allow multiple sessions in the same day


===Mod Installation===
== Adding sessions ==


If you look at your Moodle installation, you will see that among the many subfolders in the Moodle folder you have a folder named '''<code>mod/</code>'''. Installation is completed by copying the '''<code>attforblock</code>''' folder into your '''<code>moodle/mod/</code>''' folder. Don't forget to change ownership and read/write/execute privileges to the copied files to match the rest of your site.
Next, it is time to add sessions. To add class sections, click the ''Add'' tab (second from left) at the top of the Attendance page. Alternatively, you can click the ''Add'' button from the Attendance block (if you've installed it) to directly navigate to the page for adding sessions. If you chose "No groups", or have not defined groups, then the Session type will be forced to "Common." If you have defined groups and have chosen to use them in your course's Attendance activity, then you will have the option to create sessions for a group or all students.


===Block Installation===
You have two options for adding sessions, adding a single session or adding multiple sessions. The single session is self-explanatory as well as time-consuming to use when you have many class sessions, so we will go straight to the more useful option.


If you are also installing the Attendance block, the installation for the block is very similar to that of the module. Installation is completed by copying the '''<code>attendance</code>''' folder into your '''<code>moodle/blocks/</code>''' folder. Once again, don't forget to change ownership and read/write/execute privileges to the copied files to match the rest of your site.
Check the ''Create multiple sessions'' button. Select the date and time for the first session you wish to add, followed by the duration of the session. Then, enter the date for the last session you wish to add. Since most classes do not meet seven days a week, select the checkboxes for days the class meets. The final option, frequency, may look confusing but it is actually straightforward: if your class meets every week, as is typical, then you want a frequency of 1 week, which is the default. If your class meets every other week, then select a frequency of 2 weeks, and so on. If you wish, you may type a description for the sessions you are creating. If you leave the description field blank, it will default to "Regular class session". Finally, click the ''Add multiple sessions'' button to create your sessions. You will see a message confirming this.


===Rebuilding Databases===
== Editing sessions ==


Once you have completed copying files and changing privileges, you need to log into Moodle as the administrator and go to the '''Site administration-->Notifications''' link.  This will indicate that you have installed a new plugin and has a button to click for Moodle to update the database structure. Once you have updated the database structure, the Attendance module is ready for use.
Click on the ''Attendance'' tab. <!-- Attendance tab of what page? --> Here, you will see the list of all attendance sessions you have added. You can delete an individual session by clicking the X on the session rectangle's right-hand side. Alternatively, you can check the checkboxes of each session you wish to delete, and then choose "Delete" from the pull-down menu at the bottom right-hand corner of the page to delete all the selected sessions.


==Using Attendance in a Class by a Teacher==
You can edit a session &mdash; for example, to change its date or description &mdash; by clicking the hand icon on the session rectangle's right-hand side.


===Adding an Attendance Activity Instance===
== Taking attendance ==


After the attendance module has been properly installed, you (the teacher) must add attendance as an activity to each course you in which you wish to keep attendance. This is done by first ensuring that you are in the edit mode and then selecting, "Add an activity or resource" in a Moodle [[Course_sections|section]] box. Note that you may now add as many instances of the Attendance module as you like, and that each instance may have multiple sections. Be sure to give the instance a name that indicates what it will be used for (e.g., "Lecture Attendance").  If you will be using groups in your course, set the Group mode accordingly (even if groups exist in the course, you will not be able to use them within the Attendance module if you select <code>No groups</code>).
Finally, we get to using the activity for its intended purpose. You can take attendance for a session by clicking on the green radio button on the session rectangle's right-hand side. Those sessions whose attendance has already been taken do not have the green button. However, the description is a link that takes you to a screen for modifying the attendance record for that session.


Once you have added an attendance instance, you are ready to start using the attendance module.
Note that when taking attendance, the column headings for attendance status are links. If you click one of these column headings, all students will have their status changed to the status you selected. Thus, if everyone is present, you can merely click the ''P'' column header to change everyone's status to "Present". If only one person is absent, you could first click ''P'' to set everyone's status to "Present", and then set the absent student's status to "Absent".


===Adding Attendance Block to Course Page===
Enter remarks as appropriate &mdash; for example, the reason for an absence if known, or the number of minutes a student was late &mdash; and click the ''OK'' button to record the information.


Because it makes both the teacher's job and the students' access to information simpler, it is recommended that you install the associated [[Attendance_block|Attendance block]].  If you have done so, you also need to add the Attendance block to your course page.  This is accomplished by making sure that editing is turned on and then finding the block entitled, "Add a block."  In the drop-down menu in this block, select '''Attendance''' and the block will be added.  As always, move the block to fit your viewing preference.
== Reports ==


===Setting Attendance Categories and Grading Options===
You can generate attendance reports on sessions:
* Select the Attendance activity of the course and session you're interested in.
* Click on the ''Export'' tab near the top.
* Change the export settings if you wish.
* From the ''Format'' pull-down menu, select the file format you'd like to export the attendance report in.
* Click on the ''OK'' button.
* Your browser will now probably ask you to either display or save the file.


Now it is time to set your attendance options. Select your attendance activity and you will have a bar of options, the last of which is "Settings." Select "Settings" and you are presented with acronyms, descriptions, and grade (points) to assign. By default these are Present, Absent, Late, and Excused. You may prefer to change the descriptions (e.g., change the word Late to Tardy), change the way points are counted, or add new options.  Be sure to click the "Update" button when you are done changing items on this page.  If you wish to add a fifth (or more) items, you may do so by filling in the fifth line and then clicking the "Add" button.  It is important to note that when you hit the "Add" button, any changes made to existing options that were made after the last time the "Update" button was used will be lost.  Likewise, when you hit the "Update" button, any changes made to the "Add" after the last time the "Add" button was hit will be lost.
One teacher's style of using the Attendance module, useful in those (probably frequent) situations where there's no access to Moodle in the classroom, is to first take attendance on paper, and then to transfer the information to Moodle later. To ease this task, one can print a monthly report before the start of the month and use the printout for recording attendance during class. This method has the added advantage of having a picture on the printed report for each student who has uploaded their photo to Moodle. '''(as of 4 Aug. 2012, can't see this feature working)'''
 
===Adding Sessions===
 
Next it is time to add sessions. To add class sections, click the "Add" tab (second from left) at the top of the attendance page. Alternatively, if you are using the Attendance block, you can click the '''Add''' button from the Attendance block to directly navigate to the page for adding sessions.  If you chose "No groups" or have not defined groups, then the Session type will be forced to "Common."  If you have groups defined and chose to use them in the Attendance activity, then you will have the option to create sessions for a group or all students. You have two options for adding sessions: add a single session or to add multiple sessions. The single session is self-explanatory as well as time consuming to use when you have many class sessions so I will go straight to the more useful option, how to add multiple sessions.  
 
Check the "Create multiple sessions" button if you wish to create multiple sessions.  Select the date and time for the first session you wish to add followed by the duration of the session.  Next enter the date for the last session you wish to add. Since most classes do not meet seven days a week, select the days the class meets at this time.  The final option, frequency, may look confusing but it is actually straight-forward. If your class meets every week (the normal situation) then you want a frequency of 1 week which is the default. If your class meets every other week, then select a frequency of 2 weeks, and so on. You may type a description for the sessions you are creating if you like.  If you leave this blank, it will default to "Regular class session" or something similar depending on your language pack.  When you click the "Add multiple sessions" button, your sessions will be created and you will see a message indicating this.
 
===Taking Attendance===
 
Now head to the attendance tab. Here you see the list of all attendance sessions you have added. You can delete an individual session by clicking the X to the right of it. Alternatively, you can select the check box to the right of each session you wish to delete and choose "delete" from the pull-down menu at the bottom right-hand corner of the page to delete all of the sessions that you have selected. You can edit a session (change the date or add a description) with the standard hand icon to the right of the session, or you can take attendance for a session by clicking the green radio button to the right of the session. Sessions where attendance has already been taken do not have the green button, but instead the description is a link that takes you to the screen to modify the attendance record for that session.
 
You will note that when taking attendance that the column headings for attendance state are links. If you click one of these column headings, all students will have their status changed to the status you selected. Thus, if everyone is absent (God forbid!), you merely click the '''A''' and it will change everyone's status to absent. If Little Johnny is the only student absent, you would logically click '''P''' to set everyone to present and then go down to Little Johnny and change his status to '''A'''. Enter remarks as appropriate (e.g., the reason for an absence if known or the minutes late if someone is tardy) and click OK to complete taking record.
 
===Reports===
 
Finally, you have the reports. This is, again, obvious. One of my colleagues prefers to take record on paper and transfer it to Moodle. She suggested printing the monthly report before the start of the month and then taking record on this report. It has an added advantage because you have each student's picture with the record sheet. Of course, that is only useful for students who actually put photos of themselves in for their picture.
 
==Give advice to developer==
Have an idea about new features? You need something? Please add your idea or vote for existing at [http://attendance.uservoice.com Attendance Module on UserVoice] page!
 
==See also==
* [http://moodle.org/mod/forum/view.php?f=125 Attendance module forum]
* [[Attendance block]] page
 
[[Category:Contributed code]]
[[Category:Teacher]]


[[es:Actividad de asistencia]]
[[ja:出欠]]
[[ja:出欠]]

Latest revision as of 18:03, 10 March 2016

About the Attendance activity

The Attendance activity is designed for teachers to be able take attendance during class, and for students to be able to view their own attendance record.

A teacher can mark the attendance status of a student as "Present", "Absent", "Late", or "Excused". These status descriptions are configurable, and more can be added. The teacher adds Attendance as an activity of a course, and then sets up the sessions whose attendance is to be tracked.

The Attendance activity can generate reports for either the entire class or for individual students. Students may also see their own attendance record if the activity is not hidden.

The optional Attendance block allows teachers quick access to the Attendance functionality, and allows students quick access to a summary report for their own attendance.

Adding an Attendance activity

An Attendance activity can be added to a course in the same way as any other activity:

  1. Turn editing on
  2. Click 'Add an activity or resource'
  3. Select Attendance

Note that you may now add as many Attendance instances as you like, and that each instance may have multiple sections. Be sure to give the instance a name that indicates what it will be used for; for example, "Lecture Attendance". If you will be using groups in your course, set the Group mode accordingly, because even if groups exist in the course, you will not be able to use them within the Attendance activity if you select No groups.

Once you have added an attendance instance, you are ready to start taking attendance during classes.

Setting Attendance categories and grading options

Now it is time to set your attendance options. Select your attendance activity and you will see a bar of tabs, the last of which is "Settings." Select "Settings" and you are presented with acronyms, attendance status descriptions, and grade (points) to assign. By default, the status descriptions are "Present", "Absent", "Late", and "Excused".

You may prefer to change the descriptions (for example, by changing "Late" to "Tardy"), change the way points are counted, or add new status descriptions. To do the latter, fill in the fifth line and click the Add button. Important: when you hit the Add button, any changes made to existing options that were made after the last time the Update button was used will be lost. Likewise, when you hit the Update button, any changes made to the Add after the last time the Add button was hit will be lost.

Finally, when you are done changing items on this page, be sure to click the Update button to register the changes.

Adding sessions

Next, it is time to add sessions. To add class sections, click the Add tab (second from left) at the top of the Attendance page. Alternatively, you can click the Add button from the Attendance block (if you've installed it) to directly navigate to the page for adding sessions. If you chose "No groups", or have not defined groups, then the Session type will be forced to "Common." If you have defined groups and have chosen to use them in your course's Attendance activity, then you will have the option to create sessions for a group or all students.

You have two options for adding sessions, adding a single session or adding multiple sessions. The single session is self-explanatory as well as time-consuming to use when you have many class sessions, so we will go straight to the more useful option.

Check the Create multiple sessions button. Select the date and time for the first session you wish to add, followed by the duration of the session. Then, enter the date for the last session you wish to add. Since most classes do not meet seven days a week, select the checkboxes for days the class meets. The final option, frequency, may look confusing but it is actually straightforward: if your class meets every week, as is typical, then you want a frequency of 1 week, which is the default. If your class meets every other week, then select a frequency of 2 weeks, and so on. If you wish, you may type a description for the sessions you are creating. If you leave the description field blank, it will default to "Regular class session". Finally, click the Add multiple sessions button to create your sessions. You will see a message confirming this.

Editing sessions

Click on the Attendance tab. Here, you will see the list of all attendance sessions you have added. You can delete an individual session by clicking the X on the session rectangle's right-hand side. Alternatively, you can check the checkboxes of each session you wish to delete, and then choose "Delete" from the pull-down menu at the bottom right-hand corner of the page to delete all the selected sessions.

You can edit a session — for example, to change its date or description — by clicking the hand icon on the session rectangle's right-hand side.

Taking attendance

Finally, we get to using the activity for its intended purpose. You can take attendance for a session by clicking on the green radio button on the session rectangle's right-hand side. Those sessions whose attendance has already been taken do not have the green button. However, the description is a link that takes you to a screen for modifying the attendance record for that session.

Note that when taking attendance, the column headings for attendance status are links. If you click one of these column headings, all students will have their status changed to the status you selected. Thus, if everyone is present, you can merely click the P column header to change everyone's status to "Present". If only one person is absent, you could first click P to set everyone's status to "Present", and then set the absent student's status to "Absent".

Enter remarks as appropriate — for example, the reason for an absence if known, or the number of minutes a student was late — and click the OK button to record the information.

Reports

You can generate attendance reports on sessions:

  • Select the Attendance activity of the course and session you're interested in.
  • Click on the Export tab near the top.
  • Change the export settings if you wish.
  • From the Format pull-down menu, select the file format you'd like to export the attendance report in.
  • Click on the OK button.
  • Your browser will now probably ask you to either display or save the file.

One teacher's style of using the Attendance module, useful in those (probably frequent) situations where there's no access to Moodle in the classroom, is to first take attendance on paper, and then to transfer the information to Moodle later. To ease this task, one can print a monthly report before the start of the month and use the printout for recording attendance during class. This method has the added advantage of having a picture on the printed report for each student who has uploaded their photo to Moodle. (as of 4 Aug. 2012, can't see this feature working)