Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment

2017-12-02T03:48:05Z

Asharm33: /* Automated test */

This wiki page describes the changes made according to the specification of E17A4 - final project for CSC/ECE (517)Fall 2017.

== Introduction ==

Calibration is the term used for rectifying, or checking or determining something. In the context of this project, a 'Calibrated review' is the one which is performed by student and instructor as well, so that student can check on his work by comparing with instructors' response for the same assignment. Since calibrated reviews are just for checking on our progress, they are not graded. They are just meant for practice, so that peer review (which are performed later) can be performed well which is graded.

== Problem Statement ==

In order to gain practice for giving a reviews , the Student should be able to give calibration reviews before providing peer reviews. Thus, the Instructor should be able to enable calibration for every new assignment. By this way, the student can improve peer reviewing by comparing his/her results with expert reviews for the same assignment.

=== Limitation ===
At present, the instructor is able to calibrate the students’ peer review abilities on Expertiza by creating only a separate assignment for this purpose. In this separate assignment that the instructor creates, the student and the instructor will simultaneously do peer review for the project. After submission of the reviews, the student's and instructor's reviews are compared and a calibration report is generated for the student to view and improve their peer reviewing skills.

Unfortunately, for students to practice peer reviewing, a separate assignment has to be created every time. In order to facilitate sufficient practice for peer review, this is not a convenient method.

=== Proposed System ===

The objective of this project is to enable calibration to be one part of the normal assignment. The instructor should be able to turn on this feature if necessary and provide the corresponding calibration deadline. The student should be pre-assigned with sample assignments. Once the student submits the calibration reviews, the calibration results comparing the student and expert review are provided to the student.
When the actual review period starts, the student will review other assignments, and submit peer reviews. So the total number of reviews calculated should not count calibration reviews.

Tasks are listed as below:

1. To integrate calibration feature into a normal assignment, a new due date, that is calibration due date needs to be added in deadline_types table. So a migration needs to be written for implementing this.

2. When instructor checks “Calibration for training?” and saves the assignment, in “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.

3. In student_task/list page, current stage column should display calibration when the assignment is in calibration period.

4. In student_review/list page, in Other's work, calibration reviews need to be excluded from the peer reviews.

To achieve this goal, filter the reviews with timestamp earlier than submission due date, which means reviews are done in the calibration period.
The wording and numbering on this view should be changed to: Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in the normal review period.

== System Overview ==

The current system has the following actors:

'''a) Instructors:'''Users who have administrative privileges to create/edit assignments and impersonate students

'''b) Students:''' Users who submit assignments and peer reviews

In the current system, the calibration functionality works correctly. In the assignments' edit page, once the instructor enables “Calibration for training?” and saves the assignment, an extra tab "Calibration" appears. After this, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. This is the existing functionality.

In the proposed system, the entire flow of the assignment submission done by the student, changes. First is the calibration review of sample assignment, then normal assignment submission followed by rounds of peer reviews for the submitted assignments.

Flow:

1. As an instructor, a new Assignment "Project 4" was created.

2. In assignment edit mode, when calibration is not enabled, the "Due date" tab appears as shown below:

[[File:Past due dates.PNG]]

3. Once the “Calibration for training?” (see the below figure) is enabled, in addition to the “Calibration” tab, a new row for calibration deadline entry appears under the “Due dates” tab (see the figure below) before submission row. The due date for the calibration review is entered and the assignment is saved.

[[File:Cal check.png]]

[[File:New due dates.PNG]]

4. 2 students are assigned as participants (student1, student2) and 1 student (student3) as reviewer for the assignment "Program 4". Then, the Instructor impersonated one of the participant students, say student1, and submitted a sample assignment that is to be used for calibration review.

5. The review strategy was set to "Instructor-selected" for calibration review. Then, the instructor assigned student3 as a reviewer for this sample assignment submitted by the expert and also, submitted an expert review for this sample submission.

6. Now student3 is impersonated. The "current stage" of the assignment "Program 4" shows as "calibration" on the student_task page as shown below:

[[File:Current stage calib.PNG]]

7. As student3, on getting into "Program 4", the "Other's work" link is enabled (as shown below). This is enabled even before submission period as we should allow students to enter calibration review beforehand. If calibration is not enabled for the assignment, the others' work link will be enabled only after submission period.

[[File:Other's work enabled.PNG]]

8. In "Other's work", one calibration review for the sample assignment is displayed for which the reviewer can submit the calibration review.

[[File:Calibrated review.PNG]]

9. Once the calibration review is submitted, the "show calibration results" link is displayed which shows the scores against the expert review. Show calibration results gets enabled when the expert and the student submits the review.

[[File:Show calib results.PNG]]

10. Once the calibration due date elapses, the assignment enters the "submission" period. During this period, student submissions are made. The review strategy is set as "auto-selected" and number of reviews allowed are set to 2.

11. When impersonated as student3, in other's work, both the calibration and assigned peer reviews are displayed as shown below

[[File:Total reviews.PNG]]

The reviewer can now request new submission for peer review.

Also, the number of reviews required and allowed considers only the peer reviews and not the calibration reviews. Since only one peer review is present, the "request new submission for review" button is enabled. Once a new review is requested since there are 2 peer reviews, the "request new submission for review" button is not displayed. This shows that only the peer reviews are considered for the total number of reviews allowed and required.

After completion of the calibration reviews (before the due date), the student should submit the assignment on/before the submission deadline, which is the existing functionality. Since the students have had enough experience during the calibration period on peer reviewing, the next task will be carried over effectively.

Peer reviewing is the concept of review your peer’s work. This concept enables the students to understand the solution to a problem from multiple perspectives. This will also embed new ideas and the skill of constructive criticism in the student. Hence, the student will provide peer reviews after the submission of their work.

== System Use Cases ==

Use Case Diagram :

[[File:New Use Case Film Production (1)-1.png]]

'''1. Add/Edit Assignment: Enable Calibration'''

Use Case Id: 1

Use Case Description: Instructor can select the option - "Calibration for training?"

Actors: Instructor

Pre Conditions: The assignment is present in the assignments list

Post Conditions: Instructor can navigate to the edit assignment page where the enable calibration option is present

'''2. Edit Assignment: Set Due Dates for Calibration and Peer Reviews'''

Use Case Id: 2

Use Case Description: Instructor can set due date for calibration under due dates tab

Actors: Instructor

Pre Conditions: Once calibration option is enabled, a separate row for calibration should be created

Post Conditions: The instructor should be able to see the new date set for calibration.

Special cases: Calibration deadline should come before the submission deadline.

'''3. View the current stage in assignments as "Calibration" during the calibration period'''

Use Case Id: 3

Use Case Description: In assignments home page, the assignment should now be in the calibration period.

Actors: Student

'''4. View the pre-assigned sample assignments in "other's work" tab which can be opened even before submitting the assignment'''

Use Case Id: 4

Use Case Description: Student should be able to see the list of assignments in others' work tab for reviewing

Actors: Student

Pre Conditions: Sample assignments are provided by the instructor for the student to review and the tab "other's work" is enabled.

'''5. Submit 'n' pre-assigned Calibration Reviews'''

Use Case Id: 5

Use Case Description: Student can now review those assignments and submit them

Actors: Student

Pre Conditions: Sample assignments are provided by the instructor for the student to review

Post Conditions: Student can now see and edit the newly submitted review and also see the instructor's review for the assignment

'''6. View the 'Calibration Result' after submitting'''

Use Case Id: 6

Use Case Description: Student can see the comparison between student's and instructor's reviews for the pre-assignment

Actors: Student

Pre Conditions: Student had already submitted a calibration review

Post Conditions: Student can now view the comparison results

'''7. Submit the assignment before the due date'''

Use Case Id: 7

Use Case Description: Student should submit the assignment before the submission deadline

Actors: Student

Pre Conditions: An assignment exists and the calibration review is submitted

Post Conditions: Student can successfully submit the assignment before the deadline

'''8. Request for a Peer Review'''

Use Case Id: 8

Use Case Description: After the student submits the assignment, the student can request to do peer review of other student's submission

Actors: Student

Pre Conditions: peer review period has started and other students' submissions are available for reviewing

Post Conditions: Student should be assigned with a project for reviewing.

'''9. Submit the Peer Review and request for next one after minimum number of peer reviews are completed'''

Use Case Id: 9

Use Case Description: After the student requests for a peer review, he can review the assignment and submit it, After minimum number of reviews are commpleted, he/she can request for more assignments to be reviewed

Actors: Student

Pre Conditions: Student received an assignment for peer reviewing

Post Conditions: View and edit options are available for the submitted review until the peer review period deadline

''All the actions performed by the student can be done by the instructor by impersonating a student''

== Design ==

1. MVC

The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).

2. Dry Principle

The existing functionalities in Expertiza are reused, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating a new one.
Example: Currently, calibrated reviews are handled separately and peer reviews are handled separately.
In our enhancement, we need to merge both the reviews. So instead of duplicating the code in calibrated reviews, the same code is used to handle both the reviews.

No design patterns are used because existing methods are modified and no new methods are created. So the framework remains the same.

=== Files Modified ===

The following files were modified to implement the feature:

#DeadlineType model (Needs to support deadline type for Calibration)
#Assignments model (Calibration needs to be integrated into normal Assignment)
#_responses.html.erb (The user will be able begin calibration, view calibration results)
#StudentTask model (Have attribute current stage which should have the value ‘Calibration’).
#student_task/list.html.erb view (The current stage should be able to display ‘Calibration’ when the assignment is in calibration period).
#DueDate model (needs to store the calibration due date for the assignments).
#calibration_spec.rb (feature tests to verify our implementation)

== Test Plan ==
===In GUI ===

To test this feature in GUI, perform the following steps:

1. Login as instructor in Expertiza.

2. Create a new Assignment.

3. Click edit assignment and in the general tab, select the option - 'Calibration for training?' and click 'save'

4. Once that option is enabled, a new tab opens in the name 'Calibration'. Now, under Due dates tab, a new row would have been created for 'calibration'.

5. Enter the Due Date for the calibration round (Enter a date which is before the submission due date) and save the assignment.

7. Go to the calibration tab and submit one expert review for the sample assignment.

8. Impersonate as student and under assignments home page, the assignment for which calibration was enabled will now have the''' current stage''' as 'calibration'

9. Now select that assignment and go to '''other's work''' link, which should be enabled.

10. One review will now appear as calibrated review. Begin the review and submit.

11. Now on the same page i.e '''other's work''' , you will see a new link: "Show calibration results" for the respective calibration review.

12. Once the calibration period is over and submission period starts, the students can now submit the actual assignment. Post submission due date, the peer review period will start.

13. When the peer review period begins, in others' work, the student will now see two sections: Calibrated review and Review.

14. Here, the total number of reviews count only the peer reviews.

=== Automated test ===

Automated tests are written in calibration_spec.rb and staggered_deadline_spec.rb file under specs/features folder.

The RSpec tests cover the following scenarios:

1. If calibration is enabled, check if a new row is created in the deadlines table with the deadline type as Calibration.

2. After the submission period, check if both the calibrated reviews and the peer reviews are present in the reviews list.

3. Check if the total number of reviews count only the peer reviews.

[[File:Calibration1.PNG]]

[[File:Calibration2.PNG]]

= Team Contact =

; MEMBERS:

:Harika Malapaka: [mailto:hsmalapa@ncsu.edu hsmalapa@ncsu.edu]

:Vidhyalakshimi Sreenivasan: [mailto:vsreeni@ncsu.edu vsreeni@ncsu.edu]

:Valli Annamalai: [mailto:vannama@ncsu.edu vannama@ncsu.edu]

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

; MENTOR:

:Zhewei Hu: [mailto:zhu6@ncsu.edu zhu6@ncsu.edu]

CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment

2017-12-02T03:47:31Z

Asharm33: /* Automated test */

This wiki page describes the changes made according to the specification of E17A4 - final project for CSC/ECE (517)Fall 2017.

== Introduction ==

Calibration is the term used for rectifying, or checking or determining something. In the context of this project, a 'Calibrated review' is the one which is performed by student and instructor as well, so that student can check on his work by comparing with instructors' response for the same assignment. Since calibrated reviews are just for checking on our progress, they are not graded. They are just meant for practice, so that peer review (which are performed later) can be performed well which is graded.

== Problem Statement ==

In order to gain practice for giving a reviews , the Student should be able to give calibration reviews before providing peer reviews. Thus, the Instructor should be able to enable calibration for every new assignment. By this way, the student can improve peer reviewing by comparing his/her results with expert reviews for the same assignment.

=== Limitation ===
At present, the instructor is able to calibrate the students’ peer review abilities on Expertiza by creating only a separate assignment for this purpose. In this separate assignment that the instructor creates, the student and the instructor will simultaneously do peer review for the project. After submission of the reviews, the student's and instructor's reviews are compared and a calibration report is generated for the student to view and improve their peer reviewing skills.

Unfortunately, for students to practice peer reviewing, a separate assignment has to be created every time. In order to facilitate sufficient practice for peer review, this is not a convenient method.

=== Proposed System ===

The objective of this project is to enable calibration to be one part of the normal assignment. The instructor should be able to turn on this feature if necessary and provide the corresponding calibration deadline. The student should be pre-assigned with sample assignments. Once the student submits the calibration reviews, the calibration results comparing the student and expert review are provided to the student.
When the actual review period starts, the student will review other assignments, and submit peer reviews. So the total number of reviews calculated should not count calibration reviews.

Tasks are listed as below:

1. To integrate calibration feature into a normal assignment, a new due date, that is calibration due date needs to be added in deadline_types table. So a migration needs to be written for implementing this.

2. When instructor checks “Calibration for training?” and saves the assignment, in “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.

3. In student_task/list page, current stage column should display calibration when the assignment is in calibration period.

4. In student_review/list page, in Other's work, calibration reviews need to be excluded from the peer reviews.

To achieve this goal, filter the reviews with timestamp earlier than submission due date, which means reviews are done in the calibration period.
The wording and numbering on this view should be changed to: Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in the normal review period.

== System Overview ==

The current system has the following actors:

'''a) Instructors:'''Users who have administrative privileges to create/edit assignments and impersonate students

'''b) Students:''' Users who submit assignments and peer reviews

In the current system, the calibration functionality works correctly. In the assignments' edit page, once the instructor enables “Calibration for training?” and saves the assignment, an extra tab "Calibration" appears. After this, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. This is the existing functionality.

In the proposed system, the entire flow of the assignment submission done by the student, changes. First is the calibration review of sample assignment, then normal assignment submission followed by rounds of peer reviews for the submitted assignments.

Flow:

1. As an instructor, a new Assignment "Project 4" was created.

2. In assignment edit mode, when calibration is not enabled, the "Due date" tab appears as shown below:

[[File:Past due dates.PNG]]

3. Once the “Calibration for training?” (see the below figure) is enabled, in addition to the “Calibration” tab, a new row for calibration deadline entry appears under the “Due dates” tab (see the figure below) before submission row. The due date for the calibration review is entered and the assignment is saved.

[[File:Cal check.png]]

[[File:New due dates.PNG]]

4. 2 students are assigned as participants (student1, student2) and 1 student (student3) as reviewer for the assignment "Program 4". Then, the Instructor impersonated one of the participant students, say student1, and submitted a sample assignment that is to be used for calibration review.

5. The review strategy was set to "Instructor-selected" for calibration review. Then, the instructor assigned student3 as a reviewer for this sample assignment submitted by the expert and also, submitted an expert review for this sample submission.

6. Now student3 is impersonated. The "current stage" of the assignment "Program 4" shows as "calibration" on the student_task page as shown below:

[[File:Current stage calib.PNG]]

7. As student3, on getting into "Program 4", the "Other's work" link is enabled (as shown below). This is enabled even before submission period as we should allow students to enter calibration review beforehand. If calibration is not enabled for the assignment, the others' work link will be enabled only after submission period.

[[File:Other's work enabled.PNG]]

8. In "Other's work", one calibration review for the sample assignment is displayed for which the reviewer can submit the calibration review.

[[File:Calibrated review.PNG]]

9. Once the calibration review is submitted, the "show calibration results" link is displayed which shows the scores against the expert review. Show calibration results gets enabled when the expert and the student submits the review.

[[File:Show calib results.PNG]]

10. Once the calibration due date elapses, the assignment enters the "submission" period. During this period, student submissions are made. The review strategy is set as "auto-selected" and number of reviews allowed are set to 2.

11. When impersonated as student3, in other's work, both the calibration and assigned peer reviews are displayed as shown below

[[File:Total reviews.PNG]]

The reviewer can now request new submission for peer review.

Also, the number of reviews required and allowed considers only the peer reviews and not the calibration reviews. Since only one peer review is present, the "request new submission for review" button is enabled. Once a new review is requested since there are 2 peer reviews, the "request new submission for review" button is not displayed. This shows that only the peer reviews are considered for the total number of reviews allowed and required.

After completion of the calibration reviews (before the due date), the student should submit the assignment on/before the submission deadline, which is the existing functionality. Since the students have had enough experience during the calibration period on peer reviewing, the next task will be carried over effectively.

Peer reviewing is the concept of review your peer’s work. This concept enables the students to understand the solution to a problem from multiple perspectives. This will also embed new ideas and the skill of constructive criticism in the student. Hence, the student will provide peer reviews after the submission of their work.

== System Use Cases ==

Use Case Diagram :

[[File:New Use Case Film Production (1)-1.png]]

'''1. Add/Edit Assignment: Enable Calibration'''

Use Case Id: 1

Use Case Description: Instructor can select the option - "Calibration for training?"

Actors: Instructor

Pre Conditions: The assignment is present in the assignments list

Post Conditions: Instructor can navigate to the edit assignment page where the enable calibration option is present

'''2. Edit Assignment: Set Due Dates for Calibration and Peer Reviews'''

Use Case Id: 2

Use Case Description: Instructor can set due date for calibration under due dates tab

Actors: Instructor

Pre Conditions: Once calibration option is enabled, a separate row for calibration should be created

Post Conditions: The instructor should be able to see the new date set for calibration.

Special cases: Calibration deadline should come before the submission deadline.

'''3. View the current stage in assignments as "Calibration" during the calibration period'''

Use Case Id: 3

Use Case Description: In assignments home page, the assignment should now be in the calibration period.

Actors: Student

'''4. View the pre-assigned sample assignments in "other's work" tab which can be opened even before submitting the assignment'''

Use Case Id: 4

Use Case Description: Student should be able to see the list of assignments in others' work tab for reviewing

Actors: Student

Pre Conditions: Sample assignments are provided by the instructor for the student to review and the tab "other's work" is enabled.

'''5. Submit 'n' pre-assigned Calibration Reviews'''

Use Case Id: 5

Use Case Description: Student can now review those assignments and submit them

Actors: Student

Pre Conditions: Sample assignments are provided by the instructor for the student to review

Post Conditions: Student can now see and edit the newly submitted review and also see the instructor's review for the assignment

'''6. View the 'Calibration Result' after submitting'''

Use Case Id: 6

Use Case Description: Student can see the comparison between student's and instructor's reviews for the pre-assignment

Actors: Student

Pre Conditions: Student had already submitted a calibration review

Post Conditions: Student can now view the comparison results

'''7. Submit the assignment before the due date'''

Use Case Id: 7

Use Case Description: Student should submit the assignment before the submission deadline

Actors: Student

Pre Conditions: An assignment exists and the calibration review is submitted

Post Conditions: Student can successfully submit the assignment before the deadline

'''8. Request for a Peer Review'''

Use Case Id: 8

Use Case Description: After the student submits the assignment, the student can request to do peer review of other student's submission

Actors: Student

Pre Conditions: peer review period has started and other students' submissions are available for reviewing

Post Conditions: Student should be assigned with a project for reviewing.

'''9. Submit the Peer Review and request for next one after minimum number of peer reviews are completed'''

Use Case Id: 9

Use Case Description: After the student requests for a peer review, he can review the assignment and submit it, After minimum number of reviews are commpleted, he/she can request for more assignments to be reviewed

Actors: Student

Pre Conditions: Student received an assignment for peer reviewing

Post Conditions: View and edit options are available for the submitted review until the peer review period deadline

''All the actions performed by the student can be done by the instructor by impersonating a student''

== Design ==

1. MVC

The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).

2. Dry Principle

The existing functionalities in Expertiza are reused, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating a new one.
Example: Currently, calibrated reviews are handled separately and peer reviews are handled separately.
In our enhancement, we need to merge both the reviews. So instead of duplicating the code in calibrated reviews, the same code is used to handle both the reviews.

No design patterns are used because existing methods are modified and no new methods are created. So the framework remains the same.

=== Files Modified ===

The following files were modified to implement the feature:

#DeadlineType model (Needs to support deadline type for Calibration)
#Assignments model (Calibration needs to be integrated into normal Assignment)
#_responses.html.erb (The user will be able begin calibration, view calibration results)
#StudentTask model (Have attribute current stage which should have the value ‘Calibration’).
#student_task/list.html.erb view (The current stage should be able to display ‘Calibration’ when the assignment is in calibration period).
#DueDate model (needs to store the calibration due date for the assignments).
#calibration_spec.rb (feature tests to verify our implementation)

== Test Plan ==
===In GUI ===

To test this feature in GUI, perform the following steps:

1. Login as instructor in Expertiza.

2. Create a new Assignment.

3. Click edit assignment and in the general tab, select the option - 'Calibration for training?' and click 'save'

4. Once that option is enabled, a new tab opens in the name 'Calibration'. Now, under Due dates tab, a new row would have been created for 'calibration'.

5. Enter the Due Date for the calibration round (Enter a date which is before the submission due date) and save the assignment.

7. Go to the calibration tab and submit one expert review for the sample assignment.

8. Impersonate as student and under assignments home page, the assignment for which calibration was enabled will now have the''' current stage''' as 'calibration'

9. Now select that assignment and go to '''other's work''' link, which should be enabled.

10. One review will now appear as calibrated review. Begin the review and submit.

11. Now on the same page i.e '''other's work''' , you will see a new link: "Show calibration results" for the respective calibration review.

12. Once the calibration period is over and submission period starts, the students can now submit the actual assignment. Post submission due date, the peer review period will start.

13. When the peer review period begins, in others' work, the student will now see two sections: Calibrated review and Review.

14. Here, the total number of reviews count only the peer reviews.

=== Automated test ===

Automated tests are written in calibration_spec.rb file under specs/features folder.

The RSpec tests cover the following scenarios:

1. If calibration is enabled, check if a new row is created in the deadlines table with the deadline type as Calibration.

2. After the submission period, check if both the calibrated reviews and the peer reviews are present in the reviews list.

3. Check if the total number of reviews count only the peer reviews.

[[File:Calibration1.PNG]]

[[File:Calibration2.PNG]]

= Team Contact =

; MEMBERS:

:Harika Malapaka: [mailto:hsmalapa@ncsu.edu hsmalapa@ncsu.edu]

:Vidhyalakshimi Sreenivasan: [mailto:vsreeni@ncsu.edu vsreeni@ncsu.edu]

:Valli Annamalai: [mailto:vannama@ncsu.edu vannama@ncsu.edu]

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

; MENTOR:

:Zhewei Hu: [mailto:zhu6@ncsu.edu zhu6@ncsu.edu]

CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment

2017-12-02T03:46:45Z

Asharm33: /* Automated test */

This wiki page describes the changes made according to the specification of E17A4 - final project for CSC/ECE (517)Fall 2017.

== Introduction ==

Calibration is the term used for rectifying, or checking or determining something. In the context of this project, a 'Calibrated review' is the one which is performed by student and instructor as well, so that student can check on his work by comparing with instructors' response for the same assignment. Since calibrated reviews are just for checking on our progress, they are not graded. They are just meant for practice, so that peer review (which are performed later) can be performed well which is graded.

== Problem Statement ==

In order to gain practice for giving a reviews , the Student should be able to give calibration reviews before providing peer reviews. Thus, the Instructor should be able to enable calibration for every new assignment. By this way, the student can improve peer reviewing by comparing his/her results with expert reviews for the same assignment.

=== Limitation ===
At present, the instructor is able to calibrate the students’ peer review abilities on Expertiza by creating only a separate assignment for this purpose. In this separate assignment that the instructor creates, the student and the instructor will simultaneously do peer review for the project. After submission of the reviews, the student's and instructor's reviews are compared and a calibration report is generated for the student to view and improve their peer reviewing skills.

Unfortunately, for students to practice peer reviewing, a separate assignment has to be created every time. In order to facilitate sufficient practice for peer review, this is not a convenient method.

=== Proposed System ===

The objective of this project is to enable calibration to be one part of the normal assignment. The instructor should be able to turn on this feature if necessary and provide the corresponding calibration deadline. The student should be pre-assigned with sample assignments. Once the student submits the calibration reviews, the calibration results comparing the student and expert review are provided to the student.
When the actual review period starts, the student will review other assignments, and submit peer reviews. So the total number of reviews calculated should not count calibration reviews.

Tasks are listed as below:

1. To integrate calibration feature into a normal assignment, a new due date, that is calibration due date needs to be added in deadline_types table. So a migration needs to be written for implementing this.

2. When instructor checks “Calibration for training?” and saves the assignment, in “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.

3. In student_task/list page, current stage column should display calibration when the assignment is in calibration period.

4. In student_review/list page, in Other's work, calibration reviews need to be excluded from the peer reviews.

To achieve this goal, filter the reviews with timestamp earlier than submission due date, which means reviews are done in the calibration period.
The wording and numbering on this view should be changed to: Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in the normal review period.

== System Overview ==

The current system has the following actors:

'''a) Instructors:'''Users who have administrative privileges to create/edit assignments and impersonate students

'''b) Students:''' Users who submit assignments and peer reviews

In the current system, the calibration functionality works correctly. In the assignments' edit page, once the instructor enables “Calibration for training?” and saves the assignment, an extra tab "Calibration" appears. After this, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. This is the existing functionality.

In the proposed system, the entire flow of the assignment submission done by the student, changes. First is the calibration review of sample assignment, then normal assignment submission followed by rounds of peer reviews for the submitted assignments.

Flow:

1. As an instructor, a new Assignment "Project 4" was created.

2. In assignment edit mode, when calibration is not enabled, the "Due date" tab appears as shown below:

[[File:Past due dates.PNG]]

3. Once the “Calibration for training?” (see the below figure) is enabled, in addition to the “Calibration” tab, a new row for calibration deadline entry appears under the “Due dates” tab (see the figure below) before submission row. The due date for the calibration review is entered and the assignment is saved.

[[File:Cal check.png]]

[[File:New due dates.PNG]]

4. 2 students are assigned as participants (student1, student2) and 1 student (student3) as reviewer for the assignment "Program 4". Then, the Instructor impersonated one of the participant students, say student1, and submitted a sample assignment that is to be used for calibration review.

5. The review strategy was set to "Instructor-selected" for calibration review. Then, the instructor assigned student3 as a reviewer for this sample assignment submitted by the expert and also, submitted an expert review for this sample submission.

6. Now student3 is impersonated. The "current stage" of the assignment "Program 4" shows as "calibration" on the student_task page as shown below:

[[File:Current stage calib.PNG]]

7. As student3, on getting into "Program 4", the "Other's work" link is enabled (as shown below). This is enabled even before submission period as we should allow students to enter calibration review beforehand. If calibration is not enabled for the assignment, the others' work link will be enabled only after submission period.

[[File:Other's work enabled.PNG]]

8. In "Other's work", one calibration review for the sample assignment is displayed for which the reviewer can submit the calibration review.

[[File:Calibrated review.PNG]]

9. Once the calibration review is submitted, the "show calibration results" link is displayed which shows the scores against the expert review. Show calibration results gets enabled when the expert and the student submits the review.

[[File:Show calib results.PNG]]

10. Once the calibration due date elapses, the assignment enters the "submission" period. During this period, student submissions are made. The review strategy is set as "auto-selected" and number of reviews allowed are set to 2.

11. When impersonated as student3, in other's work, both the calibration and assigned peer reviews are displayed as shown below

[[File:Total reviews.PNG]]

The reviewer can now request new submission for peer review.

Also, the number of reviews required and allowed considers only the peer reviews and not the calibration reviews. Since only one peer review is present, the "request new submission for review" button is enabled. Once a new review is requested since there are 2 peer reviews, the "request new submission for review" button is not displayed. This shows that only the peer reviews are considered for the total number of reviews allowed and required.

After completion of the calibration reviews (before the due date), the student should submit the assignment on/before the submission deadline, which is the existing functionality. Since the students have had enough experience during the calibration period on peer reviewing, the next task will be carried over effectively.

Peer reviewing is the concept of review your peer’s work. This concept enables the students to understand the solution to a problem from multiple perspectives. This will also embed new ideas and the skill of constructive criticism in the student. Hence, the student will provide peer reviews after the submission of their work.

== System Use Cases ==

Use Case Diagram :

[[File:New Use Case Film Production (1)-1.png]]

'''1. Add/Edit Assignment: Enable Calibration'''

Use Case Id: 1

Use Case Description: Instructor can select the option - "Calibration for training?"

Actors: Instructor

Pre Conditions: The assignment is present in the assignments list

Post Conditions: Instructor can navigate to the edit assignment page where the enable calibration option is present

'''2. Edit Assignment: Set Due Dates for Calibration and Peer Reviews'''

Use Case Id: 2

Use Case Description: Instructor can set due date for calibration under due dates tab

Actors: Instructor

Pre Conditions: Once calibration option is enabled, a separate row for calibration should be created

Post Conditions: The instructor should be able to see the new date set for calibration.

Special cases: Calibration deadline should come before the submission deadline.

'''3. View the current stage in assignments as "Calibration" during the calibration period'''

Use Case Id: 3

Use Case Description: In assignments home page, the assignment should now be in the calibration period.

Actors: Student

'''4. View the pre-assigned sample assignments in "other's work" tab which can be opened even before submitting the assignment'''

Use Case Id: 4

Use Case Description: Student should be able to see the list of assignments in others' work tab for reviewing

Actors: Student

Pre Conditions: Sample assignments are provided by the instructor for the student to review and the tab "other's work" is enabled.

'''5. Submit 'n' pre-assigned Calibration Reviews'''

Use Case Id: 5

Use Case Description: Student can now review those assignments and submit them

Actors: Student

Pre Conditions: Sample assignments are provided by the instructor for the student to review

Post Conditions: Student can now see and edit the newly submitted review and also see the instructor's review for the assignment

'''6. View the 'Calibration Result' after submitting'''

Use Case Id: 6

Use Case Description: Student can see the comparison between student's and instructor's reviews for the pre-assignment

Actors: Student

Pre Conditions: Student had already submitted a calibration review

Post Conditions: Student can now view the comparison results

'''7. Submit the assignment before the due date'''

Use Case Id: 7

Use Case Description: Student should submit the assignment before the submission deadline

Actors: Student

Pre Conditions: An assignment exists and the calibration review is submitted

Post Conditions: Student can successfully submit the assignment before the deadline

'''8. Request for a Peer Review'''

Use Case Id: 8

Use Case Description: After the student submits the assignment, the student can request to do peer review of other student's submission

Actors: Student

Pre Conditions: peer review period has started and other students' submissions are available for reviewing

Post Conditions: Student should be assigned with a project for reviewing.

'''9. Submit the Peer Review and request for next one after minimum number of peer reviews are completed'''

Use Case Id: 9

Use Case Description: After the student requests for a peer review, he can review the assignment and submit it, After minimum number of reviews are commpleted, he/she can request for more assignments to be reviewed

Actors: Student

Pre Conditions: Student received an assignment for peer reviewing

Post Conditions: View and edit options are available for the submitted review until the peer review period deadline

''All the actions performed by the student can be done by the instructor by impersonating a student''

== Design ==

1. MVC

The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).

2. Dry Principle

The existing functionalities in Expertiza are reused, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating a new one.
Example: Currently, calibrated reviews are handled separately and peer reviews are handled separately.
In our enhancement, we need to merge both the reviews. So instead of duplicating the code in calibrated reviews, the same code is used to handle both the reviews.

No design patterns are used because existing methods are modified and no new methods are created. So the framework remains the same.

=== Files Modified ===

The following files were modified to implement the feature:

#DeadlineType model (Needs to support deadline type for Calibration)
#Assignments model (Calibration needs to be integrated into normal Assignment)
#_responses.html.erb (The user will be able begin calibration, view calibration results)
#StudentTask model (Have attribute current stage which should have the value ‘Calibration’).
#student_task/list.html.erb view (The current stage should be able to display ‘Calibration’ when the assignment is in calibration period).
#DueDate model (needs to store the calibration due date for the assignments).
#calibration_spec.rb (feature tests to verify our implementation)

== Test Plan ==
===In GUI ===

To test this feature in GUI, perform the following steps:

1. Login as instructor in Expertiza.

2. Create a new Assignment.

3. Click edit assignment and in the general tab, select the option - 'Calibration for training?' and click 'save'

4. Once that option is enabled, a new tab opens in the name 'Calibration'. Now, under Due dates tab, a new row would have been created for 'calibration'.

5. Enter the Due Date for the calibration round (Enter a date which is before the submission due date) and save the assignment.

7. Go to the calibration tab and submit one expert review for the sample assignment.

8. Impersonate as student and under assignments home page, the assignment for which calibration was enabled will now have the''' current stage''' as 'calibration'

9. Now select that assignment and go to '''other's work''' link, which should be enabled.

10. One review will now appear as calibrated review. Begin the review and submit.

11. Now on the same page i.e '''other's work''' , you will see a new link: "Show calibration results" for the respective calibration review.

12. Once the calibration period is over and submission period starts, the students can now submit the actual assignment. Post submission due date, the peer review period will start.

13. When the peer review period begins, in others' work, the student will now see two sections: Calibrated review and Review.

14. Here, the total number of reviews count only the peer reviews.

=== Automated test ===

Automated tests are written in calibration_spec.rb file under specs/features folder.

The RSpec tests cover the following scenarios:

1. If calibration is enabled, check if a new row is created in the deadlines table with the deadline type as Calibration.

2. After the submission period, check if both the calibrated reviews and the peer reviews are present in the reviews list.

3. Check if the total number of reviews count only the peer reviews.

[[File:Calibration1.PNG]]

[[File:Calibration2.PNG]]

= Team Contact =

; MEMBERS:

:Harika Malapaka: [mailto:hsmalapa@ncsu.edu hsmalapa@ncsu.edu]

:Vidhyalakshimi Sreenivasan: [mailto:vsreeni@ncsu.edu vsreeni@ncsu.edu]

:Valli Annamalai: [mailto:vannama@ncsu.edu vannama@ncsu.edu]

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

; MENTOR:

:Zhewei Hu: [mailto:zhu6@ncsu.edu zhu6@ncsu.edu]

File:Calibration2.PNG

2017-12-02T03:46:03Z

Asharm33:

File:Calibration1.PNG

2017-12-02T03:45:50Z

Asharm33:

CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment

2017-11-08T01:03:06Z

Asharm33:

This wiki page describes the changes made according to the specification of E17A4 final project assignment for Fall 2017.

== Problem Statement ==

In order to gain practice, the Student should be able to give calibration reviews before providing peer reviews. Thus, the Instructor should be able to enable calibration for every new and existing assignment. By this way, the student can improve peer reviewing by comparing his/her results with expert reviews for the same assignment.

=== Limitation ===
At present, the instructor is able to calibrate the students’ peer review abilities on Expertiza by creating only a separate assignment for this purpose. In this separate assignment that the instructor creates, the student and the instructor will simultaneously do peer review for the project. After submission of the reviews, the student's and instructor's reviews are compared and a calibration report is generated for the student to view and improve their peer reviewing skills.

Unfortunately, for students to practice peer reviewing, a separate assignment has to be created every time. In order to facilitate sufficient practice for peer review, this is not a convenient method.

=== Proposed System ===

The objective of this project is to enable calibration to be one part of the normal assignment. The instructor should be able to turn on this feature if necessary and provide the corresponding calibration deadline. The student should be pre-assigned sample assignments. Once the student submits the calibration reviews, the calibration results comparing the student and expert review are provided to the student. This feature should be available for normal assignments.

== System Overview ==

Calibration review is the sample practice peer review used for comparing students' review with expert's review. The calibration results show the results and the experts' reviews, based on which the students can improve their peer reviewing skills.

In the current system has the following actors:

'''a) Instructors:'''Users who have administrative privileges to create/edit assignments and impersonate students

'''b) Students:''' Users who submit assignments and peer reviews

The current system allows the instructors to create assignments separately for calibration purposes. This is clearly inconvenient and ineffective as the students will not receive enough practice for peer reviewing on their normal assignments beforehand.

Hence, if students were able to compare their reviews with the experts' review for normal assignments before providing actual peer reviews, they will be able to learn and improve their peer reviewing skills from the experts. Therefore, we have to integrate this feature of calibration reviewing in normal assignments as well.

In the current system, the calibration functionality works correctly. In the assignments' edit page, once the instructor enables “Calibration for training?” and saves the assignment, an extra tab "Calibration" appears. After this, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. This is the existing functionality.

In the proposed system, the flow of the assignment submission done by the student, changes. First is the calibration review of sample assignment, then normal assignment submission followed by rounds of peer reviews.
In the proposed system, once the “Calibration for training?” is enabled, in addition to the “Calibration” tab, a row for calibration deadline entry appears under the “Due dates” tab before any submissions row. The instructor has to enter the deadline for the calibration review and save the assignment.

Consequently, the student assignments page, the stage of this assignment will be set to “Calibration” during the calibration period. Furthermore, once the student submits one of the calibration reviews in the student_review page, the student can view the calibration results in the “Show calibration results” link. The calibration result shows the comparison of the student’s reviews and the respective instructor reviews. Based on the result, the student will learn to give better peer reviews for the particular assignment.

After completion of the calibration reviews (before the due date), the student should submit the assignment on/before the submission deadline, which is the existing functionality. Since the students have had enough experience during the calibration period on peer reviewing, the next task will be carried over effectively.

Peer reviewing is the concept of review your peer’s work. This concept enables the students to understand the solution to a problem from multiple perspectives. This will also embed new ideas and the skill of constructive criticism in the student. And, hence, the student will provide peer reviews after the submission of their work. These rounds of reviews will be controlled by the instructor. Once all the submissions are made, the assignment’s stage gets assigned the finish status.

== System Use Cases ==

Use Case Diagram :

[[File:Image-oodd.png]]

'''1. Add/Edit Assignment: Enable Calibration.'''

Use Case Id : 1

Use Case Description :

Actors : Instructor

Pre Conditions:

Post Conditions :

'''2. Edit Assignment : Set Due Dates for Calibration and Peer Reviews'''

Use Case Id : 2

Use Case Description :

Actors : Instructor

Pre Conditions:

Post Conditions :

'''3. View the current stage in assignments as "Calibration" during the calibration period'''

Use Case Id : 3

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''4. View the pre-assigned sample assignments'''

Use Case Id : 4

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''5. Submit 'n' pre-assigned Calibration Reviews'''

Use Case Id : 5

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''6. View the 'Calibration Result' after submitting'''

Use Case Id : 6

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''7. Submit the assignment before the due date'''

Use Case Id : 7

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''8. Request for a Peer Review'''

Use Case Id : 8

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''9. Submit the Peer Review and request for next one until'''

Use Case Id : 9

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''10. Submit the allowable number of Peer Reviews'''

Use Case Id : 10

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

== Files to be Modified ==

For implementing the functionality to allow calibration to be part of an assignment, there will be changes made to the view code and the models to include calibration into normal assignment. The following files are required to implement this feature.

#DeadlineType model (Needs to support deadline type for Calibration)
#Assignments model (Calibration needs to be integrated into normal Assignment)
#_responses.html.erb (The user will be able begin calibration, view calibration results)
#StudentTask model (Have attribute current stage which should have the value ‘Calibration’).
#student_task/list.html.erb view (The current stage should be able to display ‘Calibration’ when the assignment is in calibration period).
#DueDate model (needs to store the calibration due dates for the assignments).
#caliberation_spec.rb (feature tests to verify our implementation)
#submitted_content/_self_review.html.erb

= Team Contact =

; MEMBERS:

:Harika Malapaka: [mailto:hsmalapa@ncsu.edu hsmalapa@ncsu.edu]

:Vidhyalakshimi Sreenivasan: [mailto:vsreeni@ncsu.edu vsreeni@ncsu.edu]

:Valli Annamalai: [mailto:vannama@ncsu.edu vannama@ncsu.edu]

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

; MENTOR:

:Zhewei Hu: [mailto:zhu6@ncsu.edu zhu6@ncsu.edu]

CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment

2017-11-08T00:56:41Z

Asharm33: /* Files to be Modified */

CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment

2017-11-08T00:55:58Z

Asharm33: /* Files to be Modified */

This wiki page describes the changes made according to the specification of E17A4 final project assignment for Fall 2017.

== Problem Statement ==

In order to gain practice, the Student should be able to give calibration reviews before providing peer reviews. Thus, the Instructor should be able to enable calibration for every new and existing assignment. By this way, the student can improve peer reviewing by comparing his/her results with expert reviews for the same assignment.

=== Limitation ===
At present, the instructor is able to calibrate the students’ peer review abilities on Expertiza by creating only a separate assignment for this purpose. In this separate assignment that the instructor creates, the student and the instructor will simultaneously do peer review for the project. After submission of the reviews, the student's and instructor's reviews are compared and a calibration report is generated for the student to view and improve their peer reviewing skills.

Unfortunately, for students to practice peer reviewing, a separate assignment has to be created every time. In order to facilitate sufficient practice for peer review, this is not a convenient method.

=== Proposed System ===

The objective of this project is to enable calibration to be one part of the normal assignment. The instructor should be able to turn on this feature if necessary and provide the corresponding calibration deadline. The student should be pre-assigned sample assignments. Once the student submits the calibration reviews, the calibration results comparing the student and expert review are provided to the student. This feature should be available for normal assignments.

== System Overview ==

Calibration review is the sample practice peer review used for comparing students' review with expert's review. The calibration results show the results and the experts' reviews, based on which the students can improve their peer reviewing skills.

In the current system has the following actors:

'''a) Instructors:'''Users who have administrative privileges to create/edit assignments and impersonate students

'''b) Students:''' Users who submit assignments and peer reviews

The current system allows the instructors to create assignments separately for calibration purposes. This is clearly inconvenient and ineffective as the students will not receive enough practice for peer reviewing on their normal assignments beforehand.

Hence, if students were able to compare their reviews with the experts' review for normal assignments before providing actual peer reviews, they will be able to learn and improve their peer reviewing skills from the experts. Therefore, we have to integrate this feature of calibration reviewing in normal assignments as well.

In the current system, the calibration functionality works correctly. In the assignments' edit page, once the instructor enables “Calibration for training?” and saves the assignment, an extra tab "Calibration" appears. After this, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. This is the existing functionality.

In the proposed system, the flow of the assignment submission done by the student, changes. First is the calibration review of sample assignment, then normal assignment submission followed by rounds of peer reviews.
In the proposed system, once the “Calibration for training?” is enabled, in addition to the “Calibration” tab, a row for calibration deadline entry appears under the “Due dates” tab before any submissions row. The instructor has to enter the deadline for the calibration review and save the assignment.

Consequently, the student assignments page, the stage of this assignment will be set to “Calibration” during the calibration period. Furthermore, once the student submits one of the calibration reviews in the student_review page, the student can view the calibration results in the “Show calibration results” link. The calibration result shows the comparison of the student’s reviews and the respective instructor reviews. Based on the result, the student will learn to give better peer reviews for the particular assignment.

After completion of the calibration reviews (before the due date), the student should submit the assignment on/before the submission deadline, which is the existing functionality. Since the students have had enough experience during the calibration period on peer reviewing, the next task will be carried over effectively.

Peer reviewing is the concept of review your peer’s work. This concept enables the students to understand the solution to a problem from multiple perspectives. This will also embed new ideas and the skill of constructive criticism in the student. And, hence, the student will provide peer reviews after the submission of their work. These rounds of reviews will be controlled by the instructor. Once all the submissions are made, the assignment’s stage gets assigned the finish status.

== System Use Cases ==

Use Case Diagram :

[[File:Image-oodd.png]]

'''1. Add/Edit Assignment: Enable Calibration.'''

Use Case Id : 1

Use Case Description :

Actors : Instructor

Pre Conditions:

Post Conditions :

'''2. Edit Assignment : Set Due Dates for Calibration and Peer Reviews'''

Use Case Id : 2

Use Case Description :

Actors : Instructor

Pre Conditions:

Post Conditions :

'''3. View the current stage in assignments as "Calibration" during the calibration period'''

Use Case Id : 3

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''4. View the pre-assigned sample assignments'''

Use Case Id : 4

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''5. Submit 'n' pre-assigned Calibration Reviews'''

Use Case Id : 5

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''6. View the 'Calibration Result' after submitting'''

Use Case Id : 6

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''7. Submit the assignment before the due date'''

Use Case Id : 7

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''8. Request for a Peer Review'''

Use Case Id : 8

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''9. Submit the Peer Review and request for next one until'''

Use Case Id : 9

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''10. Submit the allowable number of Peer Reviews'''

Use Case Id : 10

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

== Files to be Modified ==

For implementing the functionality to allow calibration to be part of an assignment, there will be changes made to the view code and the models to include calibration into normal assignment. The following files are required to implement this feature.

#DeadlineType model (Needs to support deadline type for Calibration)
#Assignments model (Calibration needs to be integrated into normal Assignment)
#_responses.html.erb (The user is able Begin calibration, view calibration results)
#StudentTask model (Have attribute Current Stage which should have the value ‘Calibration’).
#student_task/list.html.erb view (The Current Stage should be able to display ‘Calibration’ when the assignment is in calibration period).
#DueDate model (needs to store the calibration due dates for the assignments).
#caliberation_spec.rb (feature tests to verify our implementation)
#submitted_content/_self_review.html.erb

CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment

2017-11-08T00:54:45Z

Asharm33:

This wiki page describes the changes made according to the specification of E17A4 final project assignment for Fall 2017.

== Problem Statement ==

In order to gain practice, the Student should be able to give calibration reviews before providing peer reviews. Thus, the Instructor should be able to enable calibration for every new and existing assignment. By this way, the student can improve peer reviewing by comparing his/her results with expert reviews for the same assignment.

=== Limitation ===
At present, the instructor is able to calibrate the students’ peer review abilities on Expertiza by creating only a separate assignment for this purpose. In this separate assignment that the instructor creates, the student and the instructor will simultaneously do peer review for the project. After submission of the reviews, the student's and instructor's reviews are compared and a calibration report is generated for the student to view and improve their peer reviewing skills.

Unfortunately, for students to practice peer reviewing, a separate assignment has to be created every time. In order to facilitate sufficient practice for peer review, this is not a convenient method.

=== Proposed System ===

The objective of this project is to enable calibration to be one part of the normal assignment. The instructor should be able to turn on this feature if necessary and provide the corresponding calibration deadline. The student should be pre-assigned sample assignments. Once the student submits the calibration reviews, the calibration results comparing the student and expert review are provided to the student. This feature should be available for normal assignments.

== System Overview ==

Calibration review is the sample practice peer review used for comparing students' review with expert's review. The calibration results show the results and the experts' reviews, based on which the students can improve their peer reviewing skills.

In the current system has the following actors:

'''a) Instructors:'''Users who have administrative privileges to create/edit assignments and impersonate students

'''b) Students:''' Users who submit assignments and peer reviews

The current system allows the instructors to create assignments separately for calibration purposes. This is clearly inconvenient and ineffective as the students will not receive enough practice for peer reviewing on their normal assignments beforehand.

Hence, if students were able to compare their reviews with the experts' review for normal assignments before providing actual peer reviews, they will be able to learn and improve their peer reviewing skills from the experts. Therefore, we have to integrate this feature of calibration reviewing in normal assignments as well.

In the current system, the calibration functionality works correctly. In the assignments' edit page, once the instructor enables “Calibration for training?” and saves the assignment, an extra tab "Calibration" appears. After this, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. This is the existing functionality.

In the proposed system, the flow of the assignment submission done by the student, changes. First is the calibration review of sample assignment, then normal assignment submission followed by rounds of peer reviews.
In the proposed system, once the “Calibration for training?” is enabled, in addition to the “Calibration” tab, a row for calibration deadline entry appears under the “Due dates” tab before any submissions row. The instructor has to enter the deadline for the calibration review and save the assignment.

Consequently, the student assignments page, the stage of this assignment will be set to “Calibration” during the calibration period. Furthermore, once the student submits one of the calibration reviews in the student_review page, the student can view the calibration results in the “Show calibration results” link. The calibration result shows the comparison of the student’s reviews and the respective instructor reviews. Based on the result, the student will learn to give better peer reviews for the particular assignment.

After completion of the calibration reviews (before the due date), the student should submit the assignment on/before the submission deadline, which is the existing functionality. Since the students have had enough experience during the calibration period on peer reviewing, the next task will be carried over effectively.

Peer reviewing is the concept of review your peer’s work. This concept enables the students to understand the solution to a problem from multiple perspectives. This will also embed new ideas and the skill of constructive criticism in the student. And, hence, the student will provide peer reviews after the submission of their work. These rounds of reviews will be controlled by the instructor. Once all the submissions are made, the assignment’s stage gets assigned the finish status.

== System Use Cases ==

Use Case Diagram :

[[File:Image-oodd.png]]

'''1. Add/Edit Assignment: Enable Calibration.'''

Use Case Id : 1

Use Case Description :

Actors : Instructor

Pre Conditions:

Post Conditions :

'''2. Edit Assignment : Set Due Dates for Calibration and Peer Reviews'''

Use Case Id : 2

Use Case Description :

Actors : Instructor

Pre Conditions:

Post Conditions :

'''3. View the current stage in assignments as "Calibration" during the calibration period'''

Use Case Id : 3

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''4. View the pre-assigned sample assignments'''

Use Case Id : 4

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''5. Submit 'n' pre-assigned Calibration Reviews'''

Use Case Id : 5

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''6. View the 'Calibration Result' after submitting'''

Use Case Id : 6

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''7. Submit the assignment before the due date'''

Use Case Id : 7

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''8. Request for a Peer Review'''

Use Case Id : 8

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''9. Submit the Peer Review and request for next one until'''

Use Case Id : 9

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

'''10. Submit the allowable number of Peer Reviews'''

Use Case Id : 10

Use Case Description :

Actors : Student

Pre Conditions:

Post Conditions :

== Files to be Modified ==

For implementing the functionality to allow calibration to be part of an assignment, there will be changes made to the view code and the models to include calibration into normal assignment. The following files are required to implement this feature.

1. DeadlineType model (Needs to support deadline type for Calibration)
2. Assignments model (Calibration needs to be integrated into normal Assignment)
3. _responses.html.erb (The user is able Begin calibration, view calibration results)
4. StudentTask model (Have attribute Current Stage which should have the value ‘Calibration’).
5. student_task/list.html.erb view (The Current Stage should be able to display ‘Calibration’ when the assignment is in calibration period).
6. DueDate model (needs to store the calibration due dates for the assignments).
7. caliberation_spec.rb (feature tests to verify our implementation)
8. submitted_content/_self_review.html.erb

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-31T07:08:21Z

Asharm33:

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Setting Up The Working Environment ==
''One of several ways to set up the environment and the one we adopted is:-'' 
'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza </pre>
<pre>bash ./setup.sh </pre>
<pre>bundle install </pre>
<pre>rake db:migrate </pre>
*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation 1) Expertiza Documentation]

[https://github.com/expertiza/expertiza 2) Experitza on Github]

[https://github.com/expertiza/expertiza/pull/1063 3) Pull Request 1]

[https://github.com/expertiza/expertiza/pull/1077 4) Pull Request 2]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-31T07:07:54Z

Asharm33:

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-31T00:10:34Z

Asharm33:

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:35:53Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation 1) Expertiza Documentation]

[https://github.com/expertiza/expertiza 2) Experitza on Github]

[https://github.com/expertiza/expertiza/pull/1063 3) Pull Request 1]

[https://github.com/expertiza/expertiza/pull/1077 4) Pull Request 2]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:35:25Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Experitza on Github]

[https://github.com/expertiza/expertiza/pull/1063 Pull Request 1]

[https://github.com/expertiza/expertiza/pull/1077 Pull Request 2]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:35:09Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

<poem>
[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]
[https://github.com/expertiza/expertiza Experitza on Github]
[https://github.com/expertiza/expertiza/pull/1063 Pull Request 1]
[https://github.com/expertiza/expertiza/pull/1077 Pull Request 2]
<poem />

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:34:58Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

<poem>
[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]
[https://github.com/expertiza/expertiza Experitza on Github]
[https://github.com/expertiza/expertiza/pull/1063 Pull Request 1]
[https://github.com/expertiza/expertiza/pull/1077 Pull Request 2]
<poem/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:33:38Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation];
[https://github.com/expertiza/expertiza Experitza on Github];
[https://github.com/expertiza/expertiza/pull/1063 Pull Request 1];
[https://github.com/expertiza/expertiza/pull/1077 Pull Request 2];

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:32:04Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

{{plainlist|
[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]
[https://github.com/expertiza/expertiza Experitza on Github]
[https://github.com/expertiza/expertiza/pull/1063 Pull Request 1]
[https://github.com/expertiza/expertiza/pull/1077 Pull Request 2]
}}

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:31:55Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

{{list|
[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]
[https://github.com/expertiza/expertiza Experitza on Github]
[https://github.com/expertiza/expertiza/pull/1063 Pull Request 1]
[https://github.com/expertiza/expertiza/pull/1077 Pull Request 2]
}}

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:30:36Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

 [http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation] 
 [https://github.com/expertiza/expertiza Experitza on Github] 
 [https://github.com/expertiza/expertiza/pull/1063 Pull Request 1] 
 [https://github.com/expertiza/expertiza/pull/1077 Pull Request 2]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:29:34Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]
[https://github.com/expertiza/expertiza Experitza on Github]
[https://github.com/expertiza/expertiza/pull/1063 Pull Request 1]
[https://github.com/expertiza/expertiza/pull/1077 Pull Request 2]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:27:50Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

{{cite web | url = | title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}
{{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}
{{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:27:41Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

{{cite web | url = | title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}
{{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}
{{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation | title Expertiza Documentation]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:27:13Z

Asharm33:

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later. The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153)
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

{{cite web | url = | title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}
{{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}
{{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation link title Expertiza Documentation]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:25:05Z

Asharm33:

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

{{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}

<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:24:05Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:23:47Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

* reference 1
* reference 2

<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:23:11Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
{{Refbegin}}
* reference 1
* reference 2
{{Refend}}

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:22:09Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

<references />

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:21:58Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/SaiSameer/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]

<references />

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:21:21Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/SaiSameer/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]

</references>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:21:06Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/SaiSameer/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:18:10Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
{{reflist}}
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T21:16:01Z

Asharm33:

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
{{reflist}}

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T20:10:34Z

Asharm33: /* References */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T20:09:42Z

Asharm33:

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===
We have the feature to import review mappings, but we do not have the feature to export the review mappings. Review Mapping used the common User Interface designed for export functionality. Due to this, the export feature wasn't working fine.

=== Solution ===
Created a partial render for Review Response Map. Add the feature of exporting review mapping and making sure it exports in the same format as importations.

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T20:03:29Z

Asharm33: /* Export Review Mapping Functionality */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/views/export_file/_reviewer_mapping.html.erb, app/views/export_file/start.html.erb

=== Original Functionality ===

=== Solution ===

https://github.com/expertiza/expertiza/issues/1081

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T19:56:53Z

Asharm33:

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== Export Review Mapping Functionality ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

[[File:Review_mapping_export1.PNG]]

[[File:Review_mapping_export.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
<references/>

File:Review mapping export.PNG

2017-10-30T19:56:06Z

Asharm33:

File:Review mapping export1.PNG

2017-10-30T19:55:52Z

Asharm33:

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T19:14:36Z

Asharm33: /* Current Implementation */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T19:14:12Z

Asharm33: /* Current Implementation */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue https://github.com/expertiza/expertiza/issues/719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/318.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T19:13:46Z

Asharm33: /* Current Implementation */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue [https://github.com/expertiza/expertiza/issues/719].
*When teams are imported in order to insert new members, the members are not inserted. See Issue https://github.com/expertiza/expertiza/issues/318.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T19:10:12Z

Asharm33:

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The User Interface for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* User Interface for importing (all types) of files should be as similar as possible.

== Current Implementation ==
The following tasks were listed as a requirement, but after careful examination it was determined that these tasks were already implemented
*The simplest fix: If I try to import topics, the import page gives me this message: “The import process expects the following columns:” but it doesn’t say what the columns are (topic number, topic name, category, number of slots, category)! It used to be in the system; please revert the change to fix this bug. See Issue 719.
*When teams are imported in order to insert new members, the members are not inserted. See Issue 328.
*It should be possible to leave off the final fields in a line of a CSV file. These fields are often not specified anyway. For example, if a password isn’t specified when a new user is created, the system generates a password (see Issue 183). When importing topics, topic categories are rarely specified. But if the final field is blank, the import requires the CSV line to end with “, “ (comma and space). This should be fixed for all imports.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T19:01:46Z

Asharm33: /* Team Contact */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The UI for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* UI for importing (all types) of files should be as similar as possible.

== Current Implementation ==

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T19:01:03Z

Asharm33:

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The UI for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* UI for importing (all types) of files should be as similar as possible.

== Current Implementation ==

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

= Team Contact =

; MEMBERS:

:Arjun Sharma: [mailto:asharm33@ncsu.edu asharm33@ncsu.edu]

:Bikram Singh: [mailto:bsingh8@ncsu.edu bsingh8@ncsu.edu]

; MENTOR:

:Yifan Guo: [mailto:yguo14@ncsu.edu yguo14@ncsu.edu]

__TOC__

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T18:54:19Z

Asharm33: /* Solution */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The UI for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* UI for importing (all types) of files should be as similar as possible.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import2.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T18:53:46Z

Asharm33: /* Solution */

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The UI for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* UI for importing (all types) of files should be as similar as possible.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]]

[[File:Import1.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== References ==
<references/>

CSC/ECE 517 Fall 2017/E1767 Improve imports

2017-10-30T18:53:19Z

Asharm33:

This page deals with issues picked up the project E1767 and the solutions developed. It is based on Expertiza, an open source project.

== Introduction ==
Expertiza is an open source project created using Ruby on Rails. This project is an software primarily to create reusable learning objects through peer review and also supports team projects. <ref> {{cite web | url = http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation| title = Expertiza Documentation| accessdate = 27 Oct 2017 | }}</ref> Expertiza allows the creation of instructors and student accounts. This allows the instructors to post assignments (student learning objects) which can be viewed and worked upon by students. These can also be peer reviewed by students later.<ref> {{cite web | url = https://github.com/expertiza/expertiza| title = Experitza on Github | accessdate = 27 Oct 2017 | }}</ref> The Expertiza project is supported by the National Science Foundation. It supports many types of documents, including articles, code, web sites, URLs and wiki pages.

== Motivation ==
Being an open source project, Expertiza is constantly improved. In particular, bugs are often found and resolved. Also new features are often added. The aim of this work is to rectify bugs around the import feature.

== Background==
As there are many users in the interface, adding several things (for each user) individually and manually will be cumbersome and time consuming. Hence another method is to import things from a file. Several things, like all students from a class, or all teams for a particular project, or even all possible topics for students for a particular assignment/project can be imported from a file. The reason for doing this is that some lists, like the teams students have formed, may not be available online but rather on a sheet of paper the students have filled offline. In addition, a bug on passwords when importing users (like students) will also be looked into.

== Problem Statement ==
* If no password is present in the password column in the CSV file for an user (while importing a list of users), Expertiza returns an error “each record in the file you are importing does not have enough records”. (Issue 183)
* There should be an option of importing teams (for a particular project/assignment) from an CSV file. (Issue 153) <ref> {{cite web | url = https://github.com/expertiza/expertiza/pull/1063| title = Issue 153 | accessdate = 27 Oct 2017 | }}</ref>
* While importing teams, if one (existing) team has the same name as a team being imported, there should be an option of renaming the existing team (Issue 329)
* There should be the functionality of adding (new) users into an existing assignment team (which may have been formed by one student or an instructor) which does not have maximum strength (Issue 328)
* There seem to be bugs while importing several (different) files
** The UI for importing different (but related) things like course participant and assignment participant should be similar
** If one extra column is present in an imported CSV text file, an appropriate message should appear (Issue 52)

== Expected functionality (with the issues identified) ==
* Users have the choice of the password for their account, including the choice of no password. Thus, while importing a list of users via a CSV text file into Expertiza, the online interface should be able to accept a blank password for any user.
* The option of importing teams by a text CSV file should be flexible, that is, while importing teams it is not necessary to have the topic assigned to the team (can be assigned later). However the option should be able to import the topic name (if it has already been assigned).
* No two teams should have the same name. This means if a new team (being imported into the database) and an existing have the same name, there should be an option of changing the name of either one of the two teams.
* Students (or instructors) should have the option of adding members (who do not have a team yet) to incomplete teams.
* UI for importing (all types) of files should be as similar as possible.

== Dealing with Issue 153 ==
=== Files changed ===
Import_file_controller.rb , models/sign_up_sheet.rb , views/sign_up_sheet/_add_topics.html.erb

=== Original Functionality ===
Currently, we cannot import teams from a file. Teams have to be created individually, (by the instructor or a student)

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

The other changes are to add the method to an appropriate place in the views and the controller.

== Dealing with Issue 329 ==
=== Files changed ===
models/team.rb , views/import_file/_start.html.erb

=== Original Functionality ===
While importing teams from a file, if a new team name is an exact match with an existing team, then the options for managing the conflict is either ignore (and not add) the new team, or to add the new team with a new name or to delete the old team and to add the new team in it's place.

=== Solution ===
The solution dealt with adding the feature. This involved adding a method in the model which is showed in the following code fragment:

[[File:329 code model.png]]

Also, the new option must be reflected in the appropriate view:

[[File:329 code view.PNG]]

The other changes are to add the method to an appropriate place in the views and the controller.

== Import User Interface Fix ==

=== Solution ===
When importing assignment participants and course participants, the User Interface indicates that there are multiple fields expected. However, in fact, user can only import file with 1 column which is user names. We can expect that the imported users are already in the system (otherwise, there should be an error message). Fixing the User Interface and also the code of importation accordingly.

[[File:Import1.png]] [[File:Import1.png]]

== Export Enhancement (Issue 1079) ==

=== Files changed ===
app/models/assignment_participant.rb, app/models/course_participant.rb, app/models/participant.rb, app/views/export_file/start.html.erb

=== Original Functionality ===
Exporting Course Participants and Assignment Participants neither share the same User Interface nor the same code. Assignment Participants used the common User Interface designed for export functionality. Due to this, the export feature of Assignment Participants return blank file.

=== Solution ===
Course Participants and Assignment Participants have same User Interface for Export feature as shown in the below image. Course Participants and Assignment Participants are derived from base class named Participants, the export feature can be generalized for both of them by moving it to Participants, which removed redundancy from the code base.

https://github.com/expertiza/expertiza/issues/1079

[[File:Export User Interface for Assignment Participants and Course Participants.JPG]]

Export methods added to participants.rb

[[File:Export1.PNG]]

[[File:Export2.PNG]]

== References ==
<references/>

File:Import2.png

2017-10-30T18:51:52Z

Asharm33: