Changes between Initial Version and Version 1 of UserDocV3


Ignore:
Timestamp:
2013-01-03T22:37:41Z (11 years ago)
Author:
michael
Comment:

User Doc created for iPeer v3.0

Legend:

Unmodified
Added
Removed
Modified
  • UserDocV3

    v1 v1  
     1                                 
     2[[PageOutline(2-7, Table of Contents, floated)]]
     3
     4== iPeer User Documentation ==
     5(Created January 2013)[[br]]
     6
     7iPeer is an application to develop and deliver rubric-like peer evaluations, to review and release student comments, to build progress report forms on-line, and to analyze evaluation results. It has extensive features including a user management system, student feedback control, data import/export, automatic installer, self-evaluation and etc…
     8
     9==== Technical Information ====
     10iPeer is a Web Application. This means that it runs on a server, and can be accessed with any web browser.[[br]]
     11iPeer is written in a web programming language called PHP (http://www.php.net) and uses an application framework called CakePHP. (http://www.cakephp.org) to structure its code.
     12For more technical details, please see iPeer's Trac website at http://ipeer.ctlt.ubc.ca/trac/
     13
     14There are 5 types of users in iPeer: students, tutors, instructors, faculty administrators, and administrators.
     15
     16=== Students ===
     17The students interface is focused on completing evaluations. After students have been created they can log into the system, and after they have been assigned to courses they can complete evaluation events.
     18
     19==== Login for Students ====
     20Students can log in via 2 mechanisms:
     21 * via username and password, like every other type of iPeer user.
     22 * via the CWL plug-in (for University of British Columbia (UBC)).
     23  * Note that if CWL plug-in is enabled, the students cannot login via iPeer's username and password, and must always use their CWL login.
     24
     25===== iPeer Login for Students =====
     26The students login with their username and password.
     27 * Username: enter your student number.
     28 * Password: enter the password given to you by your instructor or TA. You can update your password later.
     29Click the login button to complete the login process.
     30
     31===== CWL Login for UBC Students =====
     32Click on the CWL logo at the login screen, and you will be taken to the UBC CWL login page. Login like you do for other UBC pages, and after the login is complete, you'll be taken iPeer Home.
     33* Please note that if you use your CWL login, changing your password in iPeer will have no effect on your CWL password.
     34
     35==== Home Page ====
     36When a students logs in, they are presented with the home page. Student's view of iPeer is focused on submitting evaluations assigned by their instructors.[[br]]
     37This page contains 5 sections, listing evaluation events:
     38
     39===== Peer Evaluations Due =====
     40
     41These are the evaluations that should be completed. Example:
     42
     43||'''Event'''||'''Group'''||'''Course'''||'''Due Date'''||'''Due In / Late By'''||
     44||Evaluation 2||Unnamed||COMP 101 101||Sun, Sep 5, 2010 11:55 am||30.2 days||
     45
     46To complete an evaluation, just click on its title. So, to complete the above event, you would click on "Evaluation 2".
     47
     48===== Peer Evaluations Submitted =====
     49
     50These evaluations were already completed. Example:
     51
     52||'''Event'''||'''Viewable Start / End'''||'''Group'''||'''Course'''||'''Due Date'''||'''Date Submitted'''||
     53||Evaluation 1||2013-01-01 00:00:00||Unnamed||COMP 101 101||Tues,Jan 1,2012 12:00 am||2012-11-23 12:24:51||
     54
     55If the "Viewable Start / End" date is coloured
     56 * ''red'', the name of the event is a link to the previously submitted evaluation, allowing students to change their submission.
     57 * ''black'', the name of the event is a link to the evaluation answers and results (if they were released by the instructor).
     58
     59If the name of the event is not a link, the event has ended (no more submissions can be made) and the results are not viewable yet.
     60
     61===== Peer Evaluations Expired With No Submission =====
     62
     63These evaluations have expired and have not been completed. Example:
     64
     65||'''Event'''||'''Viewable Start / End'''||'''Group'''||'''Course'''||'''Due Date'''||
     66||Evaluation 3||2013-01-01 00:00:00||Unnamed||COMP 101 101||Tues,Dec 25,2012 12:00 am||
     67
     68If the name of the event is a link, results are viewable
     69
     70===== Surveys Due =====
     71
     72These are the surveys that should be completed. Example:
     73
     74||'''Event'''||'''Course'''||'''Due Date'''||'''Due In / Late By'''||
     75||Survey 1||COMP 101 101||Tues,Jan 8,2013 12:00 pm||6 days||
     76
     77To complete a survey, just click on its title. So, to complete the above survey, you would click on "Survey 1".
     78
     79===== Surveys Submitted =====
     80
     81These surveys were already completed. Example:
     82
     83||'''Event'''||'''Course'''||'''Due Date'''||'''Date Submitted'''||
     84||Survey 2||COMP 101 101||Tues,Jan 1, 2013 12:00 pm||2012-12-25 11:37:17||
     85
     86The name of the event is a link to the answers submitted.
     87
     88==== Filling out Evaluations ====
     89
     90There are 3 types of evaluations in iPeer: Simple Evaluations, Rubrics, and Mixed evaluations.
     91After clicking on an evaluation name, the selected evaluation will open.
     92
     93===== Simple Evaluations =====
     94[[Image(simple_evaluation.png, 240px, align=right, border=3)]] 
     95Simple evaluations are the most basic evaluation types in iPeer. They consist of a set number of points to distribute among your team members.
     96The following instructions appear on the evaluation page itself:
     97
     98 1. Rate your peer's relative performance by using the slider. [Weight 1-10]
     99  * iPeer has a semi-automatic system for distributing points with amongst your team members. Slide each of the orange sliders to evaluate your team members relative to one-another. This will assign them "slider-points".
     100 2. Click "Distribute" button to distribute points.
     101  * iPeer will calculate the percentage of "slider-points" you assigned to each of your teammates, and will then calculate how many real points each is given. For example, the evaluation has 200 Real Points to distribute amongst your 4 teammates. You assign them "relative score" of 8 for each. You then click distribute. The total number of "relative scores" will be 32. Each member has 8 relative points, their will all get 8/32*100% = 25% of the total real score. In real score, each member will get 200 Points * 25% = 50 points / member.
     102  * The above situation would repeat itself if you assigned '''each''' member a slider score, of 2, or 4, or 6, or anything else. Since the number of "relative points" you gave to each member mains equal, they will all be equal relative to one another. It is only the real score for each member that counts.
     103  * Quick note: If the above info is confusing, then simply forget about the sliders and Distribute button! Instead, enter the number of points you would like to give to each teammate manually, fill out the comments, and submit your evaluation. Make sure that the points add up to the total number of points to distribute. This is explained in point 3, below.
     104 3. Allocate any remaining points.
     105  * This step usually occurs in cases where the "Distribute" button could not allocate all the points exactly according to your relative scores.
     106  * For example, if you relative-scored all your three teammates equally, and the number of total points is 100, the real points cannot be equally divided! Each member would get 33 points, and 33+33+33 = 99, with one real point left to distribute. To distribute this point, you would give one of your team members a score of 34 manually. That way, the total real score would be '''34''' + 33 + 33 = 100, and all points would be distributed.
     107  * If "Distribute" button succeeded in giving everyone a fair score, or if you distributed all the points yourself, this step is unnecessary.
     108 4. Enter Comments
     109  * You may always enter a comment. Some instructors will ''require'' you to enter comments, and ''others will not''. Whatever the case might be, please remember that explaining the reasons behind your evaluation of your team-mates is always a good idea!
     110 5. NOTE: "Submit Evaluation" button will only be enabled when all points are distributed, and comments (if required) are filled!
     111  * Before you submit:
     112   * Look over your scores one more time.
     113   * Check that you entered all the comments that you like, or are required to.
     114  * If the Submit button is grayed out, something is likely missing. Check the comments and total number of real points once again.
     115 6. (Show / Hide late penalty policy)
     116  * If the evaluation has a late penalty, details can be found here.
     117  * If there are no late penalty, "No penalty is specified for this evaluation" will appear.
     118
     119===== Rubric Evaluations =====
     120[[Image(rubric_evaluation.png, 240px, align=right, border=3)]] 
     121In Rubric Evaluations, you will rate your team members on different aspects of their performance.
     122 * For example, if one of your teammates participates very well in meetings, but is late turning-in assignments, you could rate them separately on these categories.
     123Each category has a score, and comment.
     124 * Filling out the score is required. There are usually 5 available scores. Make sure to set a score for each category (the lowest score is selected by default, and your teammate probably deserves more!)
     125 * Comments may or may not be required, depending on your instructor's wishes. When writing comments, please be thorough, respectful and descriptive.
     126All you teammate's forms will be arranged in a "accordion"-type interface. This means that each member's evaluation is folded-up. Here's an example with 4 teammates:
     127||Group Member Wilma || - || (click to expand) ||
     128||Group Member Fred  || - || (click to expand) ||
     129||Group Member Betty || - || (click to expand) ||
     130||Group Member Barny || - || (click to expand) ||
     131 1. Your first teammate's evaluation will be shown already.
     132 2. Please fill out that first team mate's evaluation, and save it!
     133  * If you don't save each part as you fill it out, the information could be lost when you move on to the next teammate. Always be sure you saved.
     134 3. When you click another teammate's name, their evaluation forms will unfold. You can now complete the evaluation and Save it. Please complete each teammate's evaluation in this way.
     135  * You may freely go back and forth between your teammates, but if you modify anything for a teammate, please save their section before moving on.
     136  * When you save a section, the accordion interface will show your first teammate's evaluation form again. This is a known iPeer issue - please select your next teammate manually for now.
     137 4. When you are rating and commenting on all your teammates, submit the evaluation!
     138  * If the Submit button is disabled, some of the evaluations have not been complete. You should:
     139   * Check that you have completed the evaluations for everyone.
     140   * If your instructor requires comments, check all the input fields (blank-white areas) for your teammates are filled. There's a comment for each teammate's category, and a general comment about each teammate.
     141 5. Late Penalty
     142  * To check whether it is implemented for the evaluation, click on "(Show / Hide late penalty policy)".
     143
     144===== Mixed Evaluations =====
     145[[Image(mixed_evaluation.png, 240px,  align=right, border=3)]] 
     146Mixed evaluations are similar to rubrics, with an addition of short answer questions.
     147Just like in rubrics, the evaluations are arranged in an accordion-like arrangement,
     148||Group Member Wilma || - || Incomplete (click to expand) ||
     149||Group Member Fred  || - || Incomplete (click to expand) ||
     150||Group Member Betty || - || Incomplete (click to expand) ||
     151||Group Member Barny || - || Incomplete (click to expand) ||
     152 1. Your first teammate's evaluation will be shown.
     153 2. Please fill out that first team mate's evaluation, and save it!
     154 3. After saving, click the name of your next teammate, and complete the evaluation in the save way, and then save it too.
     155  * You may freely go back and forth between your teammates, but if you modify anything for a teammate, please save their section before moving on.
     156  * When you save a section, the accordion interface will show your first teammate's evaluation form again. This is a known iPeer issue - please select your next teammate manually for now.
     157 4. After completing all the evaluations for all the group members, submit the evaluation.
     158  * If the Submit button is disabled, some of the evaluations have not been complete. You should:
     159   * Check that you have completed the evaluations for all students. All the questions must be answered, and the answeres saved.
     160 5. Late Penalty
     161  * To check whether it is implemented for the evaluation, click on "(Show / Hide late penalty policy)".
     162
     163=== Instructors ===
     164Instructors are responsible for importing student into iPeer, and creating and scheduling evaluations. The have many options and tools; these will be covered in the next sections.
     165
     166==== New to iPeer? ====
     167If you're an instructor that just started to use iPeer, this is
     168After your account has been created by an administrator, you are ready to login and use iPeer.
     169 * You should login with the username and password provided by your admin.
     170 * If you are at UBC, please note that CWL login ''does not'' work for instructor accounts. In iPeer, CWL is meant for students only.
     171Next is a list of steps for new Instructors. To get your courses up and running, you should:
     172 1. First, create a course!
     173 2. Then, add students to your course, either one-by-one, or all at once using a CSV file.
     174 3. Assign your students into groups.
     175You would then be ready to create evaluations for your students to complete, which is done like this:
     176 1. Create an Evaluation. There are 3 types available, and each evaluation can be re-used many times.
     177 2. Create an Evaluation Event. This will give the evaluation to the students to complete, once.
     178 3. After the due date, look at the Evaluation Event results, or export them into a CSV file.
     179
     180All of these steps are described in detail in the sections bellow
     181
     182==== Courses ====
     183All objects in iPeer have some connection with courses. Courses contain student lists, group lists, and evaluation events.
     184
     185===== Creating a Course =====
     186[[Image(add_course.png, 240px,  align=right, border=3)]] 
     187[[Image(course_index.png, 240px,  align=right, border=3)]]
     188To create a course:
     189 1. Click on the courses tab.
     190 2. Click "Add a course", just like in the image on the right
     191 3. Enter a course name. This is best done as [Department] [Course#] [Section#], so for example:
     192  * ENGL 112 102, meaning this is English course number 112, section 102.
     193 4. Enter a course Title, like:
     194  * Academic Writing
     195 5. Select the instructor(s) of the course. To select multiple instructors hold "ctrl" or "command" key.
     196 6. Select the department the course belongs to. This will allow admins to help troubleshoot.
     197 7. Enter a homepage for the course, with a URL starting with !http:// or !https://
     198 8. Click Save. A course list will show up, and you can select your new course to start adding students. To do this, click on the course's name or title.
     199
     200===== Course Maintenance =====
     201If you ever wish to edit the information you entered when creating your course, you can do this from the courses tab:
     202 1. Click on the courses tab.
     203 2. Right click on the course and select "Edit Course" on the menu.
     204 3. Edit any information you choose, and save it by clicking the "Update Course" Button.
     205
     206You may also delete your own courses. Please be warned: deleting a course also removes all students from that course, their responses to evaluations for that course, and any evaluation events. If you are absolutely, positively sure that you want to delete a course, this is done by:
     207 1. Clicking on the courses tab.
     208 2. Right click on the course and select "Delete Course" on the menu.
     209 3. Confirm that you intend to delete the course by clicking on the OK button.
     210 4. The course is now deleted.
     211
     212==== Course Home Screen ====
     213Most functionality is accessed from a course's home screen. You can manage students, groups, and evaluation events from the home screen. To activate it:
     214 1. Click on the courses tab.
     215 2. Click on your course's name or title links.
     216Details of what is done at the home screen are found in the next few sections.
     217
     218==== Students ====
     219Adding students to your courses can be done in 2 ways, and these are explained bellow:
     220===== Adding Students one by one =====
     221This method is best for classes with few (10-20) students. Each student is entered manually via iPeer form. For larger classes, it may be better to assemble a CSV form, as described in the next section
     222 1. Go to a course's home page.
     223 2. Click on "Add Student"
     224 3. Enter a student's data.
     225  * note: Username (Student #), First Name, Last Name are all required. Email is not required.
     226 4. Click Save to add the student, the student password will now be randomly generated and printed near the top of the interface.
     227Please record this password, and give it to this student so that they can login.
     228  * Note, that recording a password is not necessary if you are at UBC, since the students can use CWL to login to iPeer.
     229  * Click on Save & Add Another to add more students. Then, repeat from step 3. for all the students in the class.
     230
     231===== Adding Students via CSV file =====
     232To add many students as once, you can create a CSV file in the following format:
     233
     234Each line represents a new student, and the column order is the following:
     235{{{
     236Username, First Name,Last Name, Student#, Email (optional), Password (optional)
     237}}}
     238The username should be the same as the student number.
     239{{{
     24022928030, Sam, Badhan, 22928030, sam@server.com, password123
     24178233046, Jamille, Borromeo, 78233046, jb@server.com, pass5323123
     24239577051, Jordon, Cheung, 39577051, jc@server.com, psaswdrcD23 
     24368000058, David, Cliff,  68000058,  dc@server.com, password123
     244}}}
     245If you wish to leave the Email Column out, just empty that column out, leaving the comma, for example:
     246{{{
     24722928030, Sam, Badhan, 22928030,, password123
     24878233046, Jamille, Borromeo, 78233046,, pass5323123
     24939577051, Jordon, Cheung, 39577051,, psaswdrcD23 
     25068000058, David, Cliff,  68000058,, password123
     251}}}
     252Note the double-comma between the student number, and the password.
     253 
     254This type of file should be created in a text editor, like Notepad. You could also create this file with a spreadsheet editor like OpenOffice Calc, or Microsoft Excel, but make sure you set the CSV export settings correctly when saving the file:
     255 * Comma character as the separator.
     256 * No quotes in rows or columns.
     257
     258When the CSV file is ready, do the following to access the student import form.
     259 1. Go to a course's home page.
     260 2. Click on "Import Students"
     261
     262[[Image(imported_students.png, 240px,  align=right, border=3)]]   
     263[[Image(import_students.png, 240px,  align=right, border=3)]]
     264Follow the steps below to upload your CSV to iPeer.
     265 1) Select the file to import, click on the '''Browse...''' button and select the file from your computer.
     266 2) Select the course to import into:
     267   * Make sure to choose the right course to import the students into. This will not always be set to your current course, so please check this field before importing.
     268 3) Once ready, press Import button to import the students. The next screen will display a summary of the students that were imported. Look over the data to check that the import process completed successfully.
     269     
     270==== Groups ====
     271[[Image(add_group.png, 240px,  align=right, border=3)]]
     272After students are imported, groups should be created. The manual way to create groups is recommended
     273===== Manual Group Creation =====
     274This can be done manually (quick and simple for small to medium sized classes, maybe up to 50 students).
     275 1. Go to a course's home page.
     276 2. Click on "Create Groups (Manual)".
     277 3. There are 2 list of students, one full of your class students on the left, and one empty on the right.
     278  * The students on the left are your students
     279  * Note: the students who are in one or more groups are marked with * and are on the bottom of the list.
     280  * The students on the right are already in the group you are creating
     281 4. Add students to this group. You could do any on the following bellow.
     282  * Select one student at a time from the left list, and click the "Assign >>"  button. This will add the student to the group. Or you could...
     283  * Select more than on student by holding the Control or Command key while clicking on students, then clicking the "Assign >>"  button. This would transfer all the selected students to the group
     284  * A combination of the above methods. Ex: Select and Add 2 students at a time, then repeat 3 times to make a group of 6.
     285 5. If you added a student by mistake, you could remove them from the group by selecting the student from the right list, and clicking on "Remove".
     286 6. When you are done adding students to the group, please:
     287  * Enter a group name for these students
     288  * Click "Add Group" on the bottom of the page
     289 7. Repeat this process for all the groups in you class.
     290
     291===== Importing group list from CSV file =====
     292This method is suited to grouping students in very large classes. It involves a similar process to importing students from a CSV file above.
     293
     294You should first prepare a CSV file in the following format:
     295The column order is
     296{{{
     297Student#, Group#, Group Name
     298}}}
     299And the file contents is like:
     300{{{
     30129978037, 1, Team A
     30229978063, 1, Team A
     30329978043, 2, Team B
     30429978051, 2, Team B
     305}}}
     306
     307Please ensure that all the students listed have already been created in iPeer, and added to the class.
     308
     309Just like for the student import procedure, this type of file should be created in a text editor, like Notepad. You could also create this file with a spreadsheet editor like OpenOffice Calc, or Microsoft Excel, but make sure you set the CSV export settings correctly when saving the file:
     310 * Comma character as the separator.
     311 * No quotes in rows or columns.
     312
     313Once this file is prepared, you are ready to import it into iPeer.
     314
     315 1. Go to a course's home page.
     316 2. Click on "Create Groups (Import)". This will open the group creation window.
     317
     318All you need to do now is just follow the instruction for importing the file:
     319 1) Please select a CSV file to import:
     320   * Click "Browse..." and find the CSV file you created.
     321 2) Select the course to import into:
     322   * Be sure to select the right course to import, since the list will likely not have your courses selected by default.
     323 3) Click the button below to create the Groups:
     324   * After you are sure everything is set up correctly, click on import. This will process the file, and take you to the group listing for your course. The group creation process is now complete.
     325
     326==== Evaluations ====
     327
     328Evaluations can be created at any time in iPeer. There are 3 general types of Evaluations, all have their benefits and drawbacks.
     329
     330===== Simple Evaluations =====
     331[[Image(simple_evaluation.png, 240px, align=right, border=3)]] 
     332Simple evaluations let a student distribute a set number of points among her or his teammates, and comment on their score for each teammate. See the screen shot to the left.[[br]]
     333This type of evaluation is the easiest to set up by instructors and do by students, taking the least time. However, it rates students as a whole, and does not ask specific questions about their team contributions.
     334
     335To create a simple evaluation:
     336 1. Click on the Evaluation tab, then, on the top of the "My Simple Evaluation" section, the Add Simple Evaluation link. This will make the "Add Simple Evaluation
     337 form appear.
     338 2. On this form, please enter
     339  * Evaluation Name (required)
     340  * Description, if you like
     341  * Base Point Per Member - recommended values are between 10 and 100.
     342  * Availability - choose "private" by default, or "public" only if you would like other instructors to be able to use this template.
     343 3. Click "Save" button to create the evaluation
     344
     345Remember to create an "Evaluation Event" when you are done! Otherwise your students won't see your evaluation.[[br]]
     346You can create as many "evaluation events" for your Evaluation as you like (for example, one event for each class assignment in your class).[[br]]
     347Read about [#point1 Evaluation Event]s here.
     348
     349===== Rubric Evaluations =====
     350[[Image(rubric_evaluation.png, 240px, align=right, border=3)]]
     351
     352To create a Rubric evaluation:
     353 1. Click on the Evaluation tab, then, on the top of the "My Rubrics Evaluation" section the Add Rubric link. This will make the "Add Rubric" Form Appear.
     354 2. There are 2 parts to the Rubric Add form. On this part, please enter:
     355  * Evaluation Name (required)
     356  * Levels Of Mastery (LOM):
     357   * This sets the number of performance levels for students in each category. For example:
     358   * 3 LOMs would mean a student could have been { Poor, Average, Good }
     359   * 5 LOMs would mean a student could have been { Very Poor, Poor, Average, Good, Very Good}.
     360  * Number of Criteria - the number of aspects to rate the student by, so for example:
     361   * "Participated in meetings", "Handed in work on time", "Co-operated with team" would make 3 criteria.
     362  * Availability - choose "private" by default, or "public" only if you would like other instructors to be able to use this rubric.
     363 3. Click "Next" to proceed to the next form. In this screen, you will choose the categories, and the performance levels (Levels of Mastery).
     364 4. You will see a rubric preview:
     365  * If you wish, fill in or change any LOM General comments on the top row of the preview (like poor, average, good, etc...) The students will see these LOM's in the same way when evaluating their team members.
     366  * Fill in or Change any Criteria in the first column on the (like "Participated in Team Meetings", "Was Helpful and Co-operative", etc...). These are the categories the students will rate each other on.
     367 5. When you are done, click the "Save" button, near the top of the page. This will add the rubric to your list!
     368
     369Remember to create an "Evaluation Event" when you are done! Otherwise your students won't see your evaluation.[[br]]
     370You can create as many "evaluation events" for your Evaluation as you like (for example, one event for each class assignment in your class).[[br]]
     371Read about [#point1 Evaluation Event]s here.
     372
     373===== Mixed Evaluations =====
     374[[Image(mixed_evaluation.png, 240px,  align=right, border=3)]]
     375
     376To create a Mixed Evaluation:
     377 1. Click on the Evaluation tab, then, on the top of the "My Mixed Evaluation" section the Add Mixed Evaluaton link. This will make the "Add Mixed Evaluation" Form Appear.
     378 2. There are 2 parts to the Mixed Evaluation Add form. On this part, please enter:
     379  * Mixed Evaluation name.
     380  * Number of Lickert Questions (how many Rubric-like questions will this evaluation have).
     381  * Number of pre-Fill Text Questions (how many short answer questions will the evaluation have).
     382  * Level of Scale - is just like the Level of Mastery for the Rubrics. Enter the total number of performance levels a student can have for each question.
     383  * Availability - choose "private" by default, or "public" only if you would like other instructors to be able to use this Mixed Evaluation.
     384 3. Click next. This will take you to the next part of this form, where you can see and edit a preview of your Mixed Evaluation
     385  * For Lickert Scales (section 1), enter a question for each question number. Bellow each Rubric-like question are Descriptors for each level of scale. You can change these, if you like.
     386  * Note: Each Lickert Scales question must have a minimum of 2 descriptors.
     387  * For short-answer questions (Section 1), Fill in the question prompt, and any instructions you like. Select between single line of text, or multiple-lined, longer answers.
     388 4. After you are finished creating the evaluation, should click the "Save" button, near the top of the page.
     389
     390Remember to create an "Evaluation Event" when you are done! Otherwise your students won't see your evaluation.[[br]]
     391You can create as many "evaluation events" for your Evaluation as you like (for example, one event for each class assignment in your class).[[br]]
     392Read about [#point1 Evaluation Event]s below.
     393
     394==== Surveys ====
     395[[Image(add_survey-question.png, 240px,  align=right, border=3)]]
     396[[Image(add_survey.png, 240px,  align=right, border=3)]]
     397Surveys can be created to help generate groups using !TeamMaker within iPeer.[[BR]][[BR]]
     398To create a Survey Template:
     399 1. Click on the Evaluation tab and select Surveys from the list of tools near the top.
     400 2. Select "Add Survey" on the top right.
     401 3. Fill out the desired survey name and choose a survey template. If you want to create your own survey questions, select "(No Template)".
     402 4. Select Add Survey. You will be redirected to the list of available surveys.
     403 5. Select your survey by clicking on the yellow area around your survey name.
     404 6. Select View Questions.
     405 7. Select Add Questions.
     406 8. Fill out the form. The Question Types available are Multiple Choice, Choose Any of... (multiple answers), short answer, and long answer.
     407 9. Repeat Steps 7 and 8 for all your questions.
     408 10. Select Finish.
     409
     410Remember to create an "Evaluation Event" when you are done! Otherwise your students won't see your survey.[[br]]
     411You can create as many "evaluation events" for your Survey as you like.[[br]]
     412Read about [#point1 Evaluation Event]s below.
     413[=#point1]
     414==== Events ====
     415[[Image(event_creation.png, 240px,  align=right, border=3)]]
     416Before an evaluation can be taken, an evaluation event is added.
     417
     418An evaluation event includes the following information:
     419  * Which type (Simple, Rubric, or Mixed)
     420  * Which specific evaluation.
     421  * The time window when the evaluation can be submitted.
     422  * The time window when the evaluation results can be viewed.
     423  * The due date for the event.
     424   * (although students can still submit after the due date, their submissions are marked "late").
     425  * Whether students are required to complete written comments on evaluations, or if the comments are optional.
     426  * Whether students should evaluate themselves along with the rest of their team.
     427  * Whether a penalty is given for late submissions.
     428
     429You can create as many evaluation events for each evaluation as you'd like. This is like having the same, consistent evaluation for many assignments in your class.
     430
     431To create an Evaluation Event:
     432 1. Go to a course's home page.
     433 2. Click on "Add Event". This will open the Add event menu.
     434 3. Fill in:
     435  * Event title and Event Description
     436  * Evaluation format and name:
     437   * Select the format of your created evaluation
     438   * After, select the Name of your evaluation for this event.
     439  * Select !Enabled/Disabled for Self-Evaluation
     440  * Select !Enabled/Disabled for Comments Requirement.
     441  * The Due date - all evaluation submitted after this date will be marked late. (this date must be between Release FROM and TO dates)
     442  * Select the start and end dates for this event. Clicking on the text field opens a calendar allowing you to select the date
     443  * Select the dates for releasing results.
     444  * To add penalty for late submission click on Add Penalty. Each time you click on Add Penalty, you can fill out how much to penalize for a specific number of days late.
     445   * Example: '''2''' days '''10'''% deducted
     446
     447A single evaluation can be completed many times, and the results of each event are saved in iPeer.
     448
     449==== Evaluation Results ====
     450
     451When students submit their evaluations, the instructors can view the results. This can be done at any time after the release date, even if only some results are in.
     452
     453===== Viewing =====
     454To view the results of an evaluation:
     455 1. Go to your course's homepage. This can be done by
     456  * Clicking on the Courses Tab.
     457  * Finding your course, and clicking on its title.
     458 2. On the Home page, look for the section called "Evaluation Events".
     459 3. Click "List Evaluation Events". A list of the evaluation events for the course will show up.
     460 4. Find the evaluation of interest, and click on "Results" under "View" column. A list of all the groups will show up.
     461 5. Now, by clicking on each of the groups' names, see which group members submitted their evaluation and when. To see the evaluation results, click on "Results" under "View" column. The results will look different depending on which type of evaluation this is.
     462   * Simple Evaluations - shows the individual and average scores for all students in the group in a table near the top. Comments are shown below as well.
     463   * Rubric Evaluations - has 2 views: Basic and Detail (select between them by clicking the small (Basic | Detail) on the upper left corner.
     464    * '''Basic''' - Shows the averages for all group members.
     465    * '''Detail''' - Shows detailed rating in each category, as well as evaluation comments. Just click on each student's name to show the evaluation scores and comments, just like how the students entered them.
     466   * Mixed Evaluations - also has the Basic and Detailed view.
     467    * '''Basic''' - view is just like the rubric above, summaries of point-base questions
     468    * '''Detail''' - contains comments for all questions, and answers for the short-answer questions.
     469
     470===== Exporting to CSV file =====
     471To export the results of an evaluation choose one of the two methods below:[[BR]][[BR]]
     472METHOD 1
     473 1. Go to your course's homepage. This can be done by
     474  * Clicking on the Courses Tab.
     475  * Finding your course, and clicking on its title.
     476 2. On the Home page, look for the section called "Evaluation Events".
     477 3. Click "Export Evaluation Results".
     478 4. Fill in the form.
     479  * Fill in your desired file name. Default: the date
     480  * Select the desired evaluation event.
     481  * Uncheck the details that are not not wanted. Note: Leave at least one field of each detail group (marked with similarly colored *) checked.
     482 5. Select Export.
     483METHOD 2
     484 1. Go to your course's homepage. This can be done by
     485  * Clicking on the Courses Tab.
     486  * Finding your course, and clicking on its title.
     487 2. On the Home page, look for the section called "Evaluation Events".
     488 3. Click "List Evaluation Events".
     489 4. Find the evaluation of interest, and click on "Results" under "View" column. A list of all the groups will show up.
     490 5. On the top left corner, select "Export Evaluations".
     491 6. Fill in the form.
     492  * Fill in your desired file name. Default: the date
     493  * Select the desired evaluation event.
     494  * Uncheck the details that are not not wanted. Note: Leave at least one field of each detail group (marked with similarly colored *) checked.
     495 7. Select Export.
     496
     497=== Administrators ===
     498
     499Administrators form the smallest user group. An administrator has instructor capabilities (see above) for all courses and users. The administrator also has the privilege to delete information, which can cause data inconsistency. There are faculty admin accounts available which allows the user to have admin access to all the courses in the departments within their faculty. There is also a super admin account that is used for administration of all users including administrators.  Administrators should be extremely cautious when removing data as it is very easy to cause database inconsistencies.
     500 * For example, to remove a student that has been enrolled in a course, and has taken evaluations will likely cause errors when those evaluations are viewed. It is best to leave old users in the database.
     501
     502=== Icons ===
     503Below is a description of the icons that are used in the iPeer web application.
     504
     505[[Image(icon.jpg)]]
     506
     507=== Glossary ===
     508'''Evaluation Event''':  An evaluation task which is assigned to specific groups of students. An evaluation event must also have an evaluation format, release time (starting and end), and due date.
     509
     510'''Evaluation format''': Methods for members of a group to evaluate other members (and possibly themselves).
     511
     512'''Rubric evaluation''':  An evaluation format where a matrix is used to rate students according to different levels of mastery (e.g. poor, satisfactory, excellent). Students assess their team members' contributions through answering multiple choice type questions and providing written comments if desired.
     513
     514'''Simple Evaluation''':  An evaluation format where members rate other members (possibly themselves) by allocating to each member a portion of a possible mark total (conceptually dividing up money among group members).