Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System

2017-12-02T07:32:08Z

Ppatel16: Updated the new and edited files changed

__TOC__

= External Links =

<div style="padding: 10px 25px 25px 25px">

[https://docs.google.com/document/d/1WYiXxhYyycp9a3I0GTC-4KFgHrg65Tf27ijJNQvxhmk/edit#heading=h.mo1zn1d9w38l Fall 2017 Final Project Topics]

[https://github.com/pushpendrasp/expertiza/tree/badges Working Repo Branch]

[https://github.com/expertiza/expertiza/pull/1095 Expertiza Pull Request]

</div>

= Team Contact =

<div style="padding: 10px 25px 25px 25px">

; MEMBERS:

:Priyanka Jain: [mailto:pjain15@ncsu.edu pjain15@ncsu.edu]

:Pushpendra Patel: [mailto:ppatel16@ncsu.edu ppatel16@ncsu.edu]

:Tanay Kothari: [mailto:tkothar@ncsu.edu tkothar@ncsu.edu]

:Timothy Dement: [mailto:tmdement@ncsu.edu tmdement@ncsu.edu]

; MENTOR:

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

</div>

= Project Description =

<div style="padding: 10px 25px 25px 25px">


The goal of this project is to create a simple badging system for Expertiza, allowing students to earn badges when they meet certain predefined criteria while using the platform. The full E17A2 project topic description can be found [https://docs.google.com/document/d/1WYiXxhYyycp9a3I0GTC-4KFgHrg65Tf27ijJNQvxhmk/edit#heading=h.u6i7q1mdz0zl here]

 

Per the full project topic description, the badges will be designed using [https://credly.com Credly]. Previous work on this project topic revealed that any text included on the badges is too small to read, so all text should be removed from the badges and instead appear when the badges are hovered over.

 

This project is concerned with two preliminary badges — "Good Reviewer" and "Good Teammate" — but the design will be such that the badging system can be easily extended to include more badges in the future. The "Good Reviewer" badge will be awarded to students who receive very high review grades. The "Good Teammate" badge will be awarded to team members who receive very high teammate review scores. By default, the "threshold" for earning these badges will be set to a score of 95, but this value will be configurable on a per-assignment basis by the instructor.

 

A new "Badges" tab will be added for instructors on the "Edit Assignment" page where instructors can add badges and configure the badge criteria for a given assignment. Badges a student has earned can be seen when they view their "Task List" page, and an instructor will be able to view all badges earned by students when they view the "Participants List" page.

 

Please refer to the sections below for further detail.

</div>

= Project Requirements =

<div style="padding: 10px 25px 25px 25px">

1. Create badges using Credly (do not include text)

        1.1. Create the "Good Reviewer" Badge

        1.2. Create the "Good Teammate" Badge

        1.3. Store these badge images in the app/assets/images/badges directory

2. Create tables for the badging system

        2.1. Create a table named badges with the following attributes

                2.1.1. id — primary key

                2.1.2. name — varchar

                2.1.3. description — varchar

        2.2. Create a mapping table named assignment_badges with the following attributes

                2.2.1 id — primary key

                2.2.2 badge_id — foreign key

                2.2.3 assignment_id — foreign key

                2.2.4 threshold — int

        2.3. Create a mapping table named awarded_badges with the following attributes

                2.3.1. id — primary key

                2.3.2. badge_id — foreign key

                2.3.3. participant_id — foreign key

3. Change the UI so that instructors can add, configure, and view badges, and so that students can view their badges

        3.1. Add a new "Badges" tab to the assignments/edit page for instructors to add and configure badges

        3.2. Add badge icons to the participants/list page for instructors to view badges

        3.3. Add badge icons to the student_task/list page for students to view badges

4. Write feature tests to verify the modifications

        4.1. Include tests in the a new badge_system_spec.rb file in the spec/features directory

</div>

= Preliminary Mocks =

=== Badges ===

<div style="padding: 10px 25px 25px 25px">

The following Credly badge will be awarded to students who meet the "Good Reviewer" criterion for a given assignment:

[[File:Badge-Good-Reviewer-Small.png|none|frame|Good Reviewer Badge]]

 The following Credly badge will be awarded to team members who meet the "Good Teammate" criterion for a given assignment:

[[File:Badge-Good-Teammate-Small.png|none|frame|Good Teammate Badge]]

</div>

=== Tables ===

<div style="padding: 10px 25px 25px 25px">

The following is an example of mock data in the badges table:

{| class="wikitable"
|-
! style="padding:10px; text-align: center" | id (primary key)
! style="padding:10px; text-align: center" | name (varchar)
! style="padding:10px; text-align: center" | description (varchar)
|-
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | Good Reviewer
| style="padding:10px; text-align: center" | This badge is awarded to students who receive very high review grades.
|-
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | Good Teammate
| style="padding:10px; text-align: center" | This badge is awarded to team members who receive very high teammate review scores.
|}

 The following is an example of mock data in the assignment_badges mapping table:

{| class="wikitable"
|-
! style="padding:10px; text-align: center" | id (primary key)
! style="padding:10px; text-align: center" | badge_id (foreign key)
! style="padding:10px; text-align: center" | assignment_id (foreign key)
! style="padding:10px; text-align: center" | threshold (int)
|-
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 95
|-
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 95
|-
| style="padding:10px; text-align: center" | 3
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 90
|-
| style="padding:10px; text-align: center" | 4
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 85
|-
| style="padding:10px; text-align: center" | 5
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 3
| style="padding:10px; text-align: center" | 80
|}

The first row represents that the badge with badge_id 1 ("Good Reviewer") has been activated for assignment with assignment_id 1 with the default threshold of 95.

The second row represents that the badge with badge_id 2 ("Good Teammate") has been activated for assignment with assignment_id 1 with the default threshold of 95.

The third row represents that the badge with badge_id 1 ("Good Reviewer") has been activated for assignment with assignment_id 2 with a customized threshold of 90.

The fourth row represents that the badge with badge_id 2 ("Good Teammate") has been activated for assignment with assignment_id 2 with a customized threshold of 85.

The fifth row represents that the badge with badge_id 1 ("Good Reviewer") has been activated for assignment with assignment_id 3 with a customized threshold of 80.

 The following is an example of mock data in the awarded_badges mapping table:

{| class="wikitable"
|-
! style="padding:10px; text-align: center" | id (primary key)
! style="padding:10px; text-align: center" | badge_id (foreign key)
! style="padding:10px; text-align: center" | participant_id (foreign key)
|-
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
|-
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 1
|-
| style="padding:10px; text-align: center" | 3
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 2
|-
| style="padding:10px; text-align: center" | 4
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 3
|}

The first row represents that the assignment participant with participant_id 1 has earned the badge with badge_id 1 ("Good Reviewer") for the given assignment.

The second row represents that the assignment participant with participant_id 1 has earned the badge with badge_id 2 ("Good Teammate") for the given assignment.

The third row represents that the assignment participant with participant_id 2 has earned the badge with badge_id 1 ("Good Reviewer") for the given assignment.

The fourth row represents that the assignment participant with participant_id 3 has earned the badge with badge_id 2 ("Good Teammate") for the given assignment.
</div>

=== Views ===

<div style="padding:10px 25px 25px 25px">

The following screenshots show a comparison of the existing "Assignments Edit" page, alongside a mockup incorporating the new badging system where instructors can add and configure badges for a given assignment.

 [[File:Original-Assignments-Edit.png|none|frame|The original "Assignments Edit" page.]]

 [[File:Modified-Assignments-Edit.png|none|frame|The modified "Assignments Edit" page.]]

 The following screenshots show a comparison of the existing "Participants List" page, alongside a mockup incorporating the new badging system where instructors can view all awarded badges for a given assignment.

 [[File:Original-Participants-List.png|none|frame|The original "Participants List" page.]]

 [[File:Modified-Participants-List.png|none|frame|The modified "Participants List" page.]]

 The following screenshots show a comparison of the existing "Student Task List" page, alongside a mockup incorporating the new badging system where students can view all of the badges they have earned.

 [[File:Original-Student-Task-List.png|none|frame|The original "Student Task List" page.]]

 [[File:Modified-Student-Task-List.png|none|frame|The modified "Student Task List" page.]]

</div>

= Test Plan =
The following will be our test plan for this project:
<pre>
describe 'Good Reviewer Badge Presence' do

it "should appear on the instructor's participant list when threshold is set below score" do

end

it "should appear on the student's task list when threshold is set below score" do

end

it "should appear on the instructor's participant list when score is set above threshold" do

end

it "should appear on the student's task list when score is set above threshold" do

end

end
</pre>
<pre>
describe 'Good Reviewer Badge Absence' do

it "should not appear on the instructor's participant list when threshold is set above score" do

end

it "should not appear on the student's task list when threshold is set above score" do

end

it "should not appear on the instructor's participant list when score is set below threshold" do

end

it "should not appear on the student's task list when score is set below threshold" do

end

end
</pre>
<pre>
describe 'Good Teammate Badge Presence' do

it "should appear on the instructor's participant list when threshold is set below score" do

end

it "should appear on the student's task list when threshold is set below score" do

end

it "should appear on the instructor's participant list when score is set above threshold" do

end

it "should appear on the student's task list when score is set above threshold" do

end

end
</pre>
<pre>
describe 'Good Teammate Badge Absence' do

it "should not appear on the instructor's participant list when threshold is set above score" do

end

it "should not appear on the student's task list when threshold is set above score" do

end

it "should not appear on the instructor's participant list when score is set below threshold" do

end

it "should not appear on the student's task list when score is set below threshold" do

end

end
</pre>
<div style="padding: 10px 25px 25px 25px">

A new badge_system_spec.rb file will be created in the spec/features folder, and will include feature tests that verify the modifications made for the project.

NOTE: More information will be included in this section as the project progresses and the tests are written.

</div>

= Video Demonstrations =

<div style="padding: 10px 25px 25px 25px">

NOTE: More information will be included in this section as the project progresses.

</div>

= Files Modified =

=== New Files ===

<div style="padding: 10px 25px 25px 25px">

• app/assets/images/badges

        A new directory created to house the new badge image files.

 • app/assets/images/badges/Badge-Good-Reviewer.png

        The image used for the new "Good Reviewer" badge.

 • app/assets/images/badges/Badge-Good-Teammate.png

        The image used for the new "Good Teammate" badge.

 • app/views/assignments/edit/_badges.html.erb

 • spec/features/badge_system_spec.rb

        The file holding the new tests written for the badging system.

 • db/migrate/20171115222415_create_badges.rb

        The migration for the new badges table.

 • db/migrate/20171115224048_create_assignment_badges.rb

        The migration for the new assignment_badges table.

 • db/migrate/20171115230007_create_awarded_badges.rb

        The migration for the new awarded_badges table.

 • app/models/badge.rb

        The model associated with the new badges table.

 • app/models/assignment_badge.rb

        The model associated with the new assignment_badges table.

 • app/models/awarded_badge.rb

        The model associated with the new awarded_badges table.

 • test/fixtures/assignment_badges.yml

 • test/fixtures/awarded_badges.yml

 • test/fixtures/badges.yml

 • test/models/assignment_badge_test.rb

 • test/models/awarded_badge_test.rb

 • test/models/badge_test.rb

</div>

=== Edited Files ===

<div style="padding: 10px 25px 25px 25px">

 • app/controllers/assignment_badges_controller.rb

 • app/controllers/assignments_controller.rb

 • app/controllers/response_controller.rb

 • app/controllers/review_mapping_controller.rb

 • app/models/assignment_form.rb

 • app/models/review_response_map.rb

        The file in which the code for the "Good Reviewer" badge will be inserted.

        NOTE: More detail will be provided as the project progresses.

 • app/models/teammate_review_response_map.rb

        The file in which the code for the "Good Teammate" badge will be inserted.

        NOTE: More detail will be provided as the project progresses.

 • app/views/assignments/edit.html.erb

        The UI changes allowing instructors to add and calibrate badges for a given assignment.

 • app/views/assignments/edit/_badges.html.erb

 • app/views/participants/list.html.erb

        The UI changes allowing instructors to view badges for the participants of a given assignment.

 • app/views/participants/_participant.html.erb

 • spec/factories/factories.rb

 • app/views/shared_scripts/_user_list.html.erb

 • app/views/student_task/list.html.erb

        The UI changes allowing students to view their badges for all of their assignments.

 • db/schema.rb

        Incorporating schema changes for the three new badges, assignment_badges, and awarded_badges tables.

</div>

= References =

<div style="padding: 10px 25px 25px 25px">

Videos summarizing the previous team's work on this project topic can be found [https://www.youtube.com/playlist?list=PLdDBHYYDZueeGNdQtzS2FfI-eC0-SK6cb here].

</div>

CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System

2017-12-02T07:17:43Z

Ppatel16: /* Edited Files */

__TOC__

= External Links =

<div style="padding: 10px 25px 25px 25px">

[https://docs.google.com/document/d/1WYiXxhYyycp9a3I0GTC-4KFgHrg65Tf27ijJNQvxhmk/edit#heading=h.mo1zn1d9w38l Fall 2017 Final Project Topics]

[https://github.com/pushpendrasp/expertiza/tree/badges Working Repo Branch]

[https://github.com/expertiza/expertiza/pull/1095 Expertiza Pull Request]

</div>

= Team Contact =

<div style="padding: 10px 25px 25px 25px">

; MEMBERS:

:Priyanka Jain: [mailto:pjain15@ncsu.edu pjain15@ncsu.edu]

:Pushpendra Patel: [mailto:ppatel16@ncsu.edu ppatel16@ncsu.edu]

:Tanay Kothari: [mailto:tkothar@ncsu.edu tkothar@ncsu.edu]

:Timothy Dement: [mailto:tmdement@ncsu.edu tmdement@ncsu.edu]

; MENTOR:

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

</div>

= Project Description =

<div style="padding: 10px 25px 25px 25px">


The goal of this project is to create a simple badging system for Expertiza, allowing students to earn badges when they meet certain predefined criteria while using the platform. The full E17A2 project topic description can be found [https://docs.google.com/document/d/1WYiXxhYyycp9a3I0GTC-4KFgHrg65Tf27ijJNQvxhmk/edit#heading=h.u6i7q1mdz0zl here]

 

Per the full project topic description, the badges will be designed using [https://credly.com Credly]. Previous work on this project topic revealed that any text included on the badges is too small to read, so all text should be removed from the badges and instead appear when the badges are hovered over.

 

This project is concerned with two preliminary badges — "Good Reviewer" and "Good Teammate" — but the design will be such that the badging system can be easily extended to include more badges in the future. The "Good Reviewer" badge will be awarded to students who receive very high review grades. The "Good Teammate" badge will be awarded to team members who receive very high teammate review scores. By default, the "threshold" for earning these badges will be set to a score of 95, but this value will be configurable on a per-assignment basis by the instructor.

 

A new "Badges" tab will be added for instructors on the "Edit Assignment" page where instructors can add badges and configure the badge criteria for a given assignment. Badges a student has earned can be seen when they view their "Task List" page, and an instructor will be able to view all badges earned by students when they view the "Participants List" page.

 

Please refer to the sections below for further detail.

</div>

= Project Requirements =

<div style="padding: 10px 25px 25px 25px">

1. Create badges using Credly (do not include text)

        1.1. Create the "Good Reviewer" Badge

        1.2. Create the "Good Teammate" Badge

        1.3. Store these badge images in the app/assets/images/badges directory

2. Create tables for the badging system

        2.1. Create a table named badges with the following attributes

                2.1.1. id — primary key

                2.1.2. name — varchar

                2.1.3. description — varchar

        2.2. Create a mapping table named assignment_badges with the following attributes

                2.2.1 id — primary key

                2.2.2 badge_id — foreign key

                2.2.3 assignment_id — foreign key

                2.2.4 threshold — int

        2.3. Create a mapping table named awarded_badges with the following attributes

                2.3.1. id — primary key

                2.3.2. badge_id — foreign key

                2.3.3. participant_id — foreign key

3. Change the UI so that instructors can add, configure, and view badges, and so that students can view their badges

        3.1. Add a new "Badges" tab to the assignments/edit page for instructors to add and configure badges

        3.2. Add badge icons to the participants/list page for instructors to view badges

        3.3. Add badge icons to the student_task/list page for students to view badges

4. Write feature tests to verify the modifications

        4.1. Include tests in the a new badge_system_spec.rb file in the spec/features directory

</div>

= Preliminary Mocks =

=== Badges ===

<div style="padding: 10px 25px 25px 25px">

The following Credly badge will be awarded to students who meet the "Good Reviewer" criterion for a given assignment:

[[File:Badge-Good-Reviewer-Small.png|none|frame|Good Reviewer Badge]]

 The following Credly badge will be awarded to team members who meet the "Good Teammate" criterion for a given assignment:

[[File:Badge-Good-Teammate-Small.png|none|frame|Good Teammate Badge]]

</div>

=== Tables ===

<div style="padding: 10px 25px 25px 25px">

The following is an example of mock data in the badges table:

{| class="wikitable"
|-
! style="padding:10px; text-align: center" | id (primary key)
! style="padding:10px; text-align: center" | name (varchar)
! style="padding:10px; text-align: center" | description (varchar)
|-
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | Good Reviewer
| style="padding:10px; text-align: center" | This badge is awarded to students who receive very high review grades.
|-
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | Good Teammate
| style="padding:10px; text-align: center" | This badge is awarded to team members who receive very high teammate review scores.
|}

 The following is an example of mock data in the assignment_badges mapping table:

{| class="wikitable"
|-
! style="padding:10px; text-align: center" | id (primary key)
! style="padding:10px; text-align: center" | badge_id (foreign key)
! style="padding:10px; text-align: center" | assignment_id (foreign key)
! style="padding:10px; text-align: center" | threshold (int)
|-
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 95
|-
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 95
|-
| style="padding:10px; text-align: center" | 3
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 90
|-
| style="padding:10px; text-align: center" | 4
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 85
|-
| style="padding:10px; text-align: center" | 5
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 3
| style="padding:10px; text-align: center" | 80
|}

The first row represents that the badge with badge_id 1 ("Good Reviewer") has been activated for assignment with assignment_id 1 with the default threshold of 95.

The second row represents that the badge with badge_id 2 ("Good Teammate") has been activated for assignment with assignment_id 1 with the default threshold of 95.

The third row represents that the badge with badge_id 1 ("Good Reviewer") has been activated for assignment with assignment_id 2 with a customized threshold of 90.

The fourth row represents that the badge with badge_id 2 ("Good Teammate") has been activated for assignment with assignment_id 2 with a customized threshold of 85.

The fifth row represents that the badge with badge_id 1 ("Good Reviewer") has been activated for assignment with assignment_id 3 with a customized threshold of 80.

 The following is an example of mock data in the awarded_badges mapping table:

{| class="wikitable"
|-
! style="padding:10px; text-align: center" | id (primary key)
! style="padding:10px; text-align: center" | badge_id (foreign key)
! style="padding:10px; text-align: center" | participant_id (foreign key)
|-
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
|-
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 1
|-
| style="padding:10px; text-align: center" | 3
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 2
|-
| style="padding:10px; text-align: center" | 4
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 3
|}

The first row represents that the assignment participant with participant_id 1 has earned the badge with badge_id 1 ("Good Reviewer") for the given assignment.

The second row represents that the assignment participant with participant_id 1 has earned the badge with badge_id 2 ("Good Teammate") for the given assignment.

The third row represents that the assignment participant with participant_id 2 has earned the badge with badge_id 1 ("Good Reviewer") for the given assignment.

The fourth row represents that the assignment participant with participant_id 3 has earned the badge with badge_id 2 ("Good Teammate") for the given assignment.
</div>

=== Views ===

<div style="padding:10px 25px 25px 25px">

The following screenshots show a comparison of the existing "Assignments Edit" page, alongside a mockup incorporating the new badging system where instructors can add and configure badges for a given assignment.

 [[File:Original-Assignments-Edit.png|none|frame|The original "Assignments Edit" page.]]

 [[File:Modified-Assignments-Edit.png|none|frame|The modified "Assignments Edit" page.]]

 The following screenshots show a comparison of the existing "Participants List" page, alongside a mockup incorporating the new badging system where instructors can view all awarded badges for a given assignment.

 [[File:Original-Participants-List.png|none|frame|The original "Participants List" page.]]

 [[File:Modified-Participants-List.png|none|frame|The modified "Participants List" page.]]

 The following screenshots show a comparison of the existing "Student Task List" page, alongside a mockup incorporating the new badging system where students can view all of the badges they have earned.

 [[File:Original-Student-Task-List.png|none|frame|The original "Student Task List" page.]]

 [[File:Modified-Student-Task-List.png|none|frame|The modified "Student Task List" page.]]

</div>

= Test Plan =
The following will be our test plan for this project:
<pre>
describe 'Good Reviewer Badge Presence' do

it "should appear on the instructor's participant list when threshold is set below score" do

end

it "should appear on the student's task list when threshold is set below score" do

end

it "should appear on the instructor's participant list when score is set above threshold" do

end

it "should appear on the student's task list when score is set above threshold" do

end

end
</pre>
<pre>
describe 'Good Reviewer Badge Absence' do

it "should not appear on the instructor's participant list when threshold is set above score" do

end

it "should not appear on the student's task list when threshold is set above score" do

end

it "should not appear on the instructor's participant list when score is set below threshold" do

end

it "should not appear on the student's task list when score is set below threshold" do

end

end
</pre>
<pre>
describe 'Good Teammate Badge Presence' do

it "should appear on the instructor's participant list when threshold is set below score" do

end

it "should appear on the student's task list when threshold is set below score" do

end

it "should appear on the instructor's participant list when score is set above threshold" do

end

it "should appear on the student's task list when score is set above threshold" do

end

end
</pre>
<pre>
describe 'Good Teammate Badge Absence' do

it "should not appear on the instructor's participant list when threshold is set above score" do

end

it "should not appear on the student's task list when threshold is set above score" do

end

it "should not appear on the instructor's participant list when score is set below threshold" do

end

it "should not appear on the student's task list when score is set below threshold" do

end

end
</pre>
<div style="padding: 10px 25px 25px 25px">

A new badge_system_spec.rb file will be created in the spec/features folder, and will include feature tests that verify the modifications made for the project.

NOTE: More information will be included in this section as the project progresses and the tests are written.

</div>

= Video Demonstrations =

<div style="padding: 10px 25px 25px 25px">

NOTE: More information will be included in this section as the project progresses.

</div>

= Files Modified =

=== New Files ===

<div style="padding: 10px 25px 25px 25px">

• app/assets/images/badges

        A new directory created to house the new badge image files.

 • app/assets/images/badges/Badge-Good-Reviewer.png

        The image used for the new "Good Reviewer" badge.

 • app/assets/images/badges/Badge-Good-Teammate.png

        The image used for the new "Good Teammate" badge.

 • spec/features/badge_system_spec.rb

        The file holding the new tests written for the badging system.

 • db/migrate/20171115222415_create_badges.rb

        The migration for the new badges table.

 • db/migrate/20171115224048_create_assignment_badges.rb

        The migration for the new assignment_badges table.

 • db/migrate/20171115230007_create_awarded_badges.rb

        The migration for the new awarded_badges table.

 • app/models/badge.rb

        The model associated with the new badges table.

 • app/models/assignment_badge.rb

        The model associated with the new assignment_badges table.

 • app/models/awarded_badge.rb

        The model associated with the new awarded_badges table.

</div>

=== Edited Files ===

<div style="padding: 10px 25px 25px 25px">

 • app/controllers/assignment_badges_controller.rb

 • app/controllers/assignments_controller.rb

 • app/controllers/response_controller.rb

 • app/controllers/review_mapping_controller.rb

 • app/models/review_response_map.rb

        The file in which the code for the "Good Reviewer" badge will be inserted.

        NOTE: More detail will be provided as the project progresses.

 • app/models/teammate_review_response_map.rb

        The file in which the code for the "Good Teammate" badge will be inserted.

        NOTE: More detail will be provided as the project progresses.

 • app/views/assignments/edit.html.erb

        The UI changes allowing instructors to add and calibrate badges for a given assignment.

 • app/views/participants/list.html.erb

        The UI changes allowing instructors to view badges for the participants of a given assignment.

 • app/views/student_task/list.html.erb

        The UI changes allowing students to view their badges for all of their assignments.

 • db/schema.rb

        Incorporating schema changes for the three new badges, assignment_badges, and awarded_badges tables.

</div>

= References =

<div style="padding: 10px 25px 25px 25px">

Videos summarizing the previous team's work on this project topic can be found [https://www.youtube.com/playlist?list=PLdDBHYYDZueeGNdQtzS2FfI-eC0-SK6cb here].

</div>

CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System

2017-12-02T07:09:19Z

Ppatel16: Updated the test plan section

__TOC__

= External Links =

<div style="padding: 10px 25px 25px 25px">

[https://docs.google.com/document/d/1WYiXxhYyycp9a3I0GTC-4KFgHrg65Tf27ijJNQvxhmk/edit#heading=h.mo1zn1d9w38l Fall 2017 Final Project Topics]

[https://github.com/pushpendrasp/expertiza/tree/badges Working Repo Branch]

[https://github.com/expertiza/expertiza/pull/1095 Expertiza Pull Request]

</div>

= Team Contact =

<div style="padding: 10px 25px 25px 25px">

; MEMBERS:

:Priyanka Jain: [mailto:pjain15@ncsu.edu pjain15@ncsu.edu]

:Pushpendra Patel: [mailto:ppatel16@ncsu.edu ppatel16@ncsu.edu]

:Tanay Kothari: [mailto:tkothar@ncsu.edu tkothar@ncsu.edu]

:Timothy Dement: [mailto:tmdement@ncsu.edu tmdement@ncsu.edu]

; MENTOR:

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

</div>

= Project Description =

<div style="padding: 10px 25px 25px 25px">


The goal of this project is to create a simple badging system for Expertiza, allowing students to earn badges when they meet certain predefined criteria while using the platform. The full E17A2 project topic description can be found [https://docs.google.com/document/d/1WYiXxhYyycp9a3I0GTC-4KFgHrg65Tf27ijJNQvxhmk/edit#heading=h.u6i7q1mdz0zl here]

 

Per the full project topic description, the badges will be designed using [https://credly.com Credly]. Previous work on this project topic revealed that any text included on the badges is too small to read, so all text should be removed from the badges and instead appear when the badges are hovered over.

 

This project is concerned with two preliminary badges — "Good Reviewer" and "Good Teammate" — but the design will be such that the badging system can be easily extended to include more badges in the future. The "Good Reviewer" badge will be awarded to students who receive very high review grades. The "Good Teammate" badge will be awarded to team members who receive very high teammate review scores. By default, the "threshold" for earning these badges will be set to a score of 95, but this value will be configurable on a per-assignment basis by the instructor.

 

A new "Badges" tab will be added for instructors on the "Edit Assignment" page where instructors can add badges and configure the badge criteria for a given assignment. Badges a student has earned can be seen when they view their "Task List" page, and an instructor will be able to view all badges earned by students when they view the "Participants List" page.

 

Please refer to the sections below for further detail.

</div>

= Project Requirements =

<div style="padding: 10px 25px 25px 25px">

1. Create badges using Credly (do not include text)

        1.1. Create the "Good Reviewer" Badge

        1.2. Create the "Good Teammate" Badge

        1.3. Store these badge images in the app/assets/images/badges directory

2. Create tables for the badging system

        2.1. Create a table named badges with the following attributes

                2.1.1. id — primary key

                2.1.2. name — varchar

                2.1.3. description — varchar

        2.2. Create a mapping table named assignment_badges with the following attributes

                2.2.1 id — primary key

                2.2.2 badge_id — foreign key

                2.2.3 assignment_id — foreign key

                2.2.4 threshold — int

        2.3. Create a mapping table named awarded_badges with the following attributes

                2.3.1. id — primary key

                2.3.2. badge_id — foreign key

                2.3.3. participant_id — foreign key

3. Change the UI so that instructors can add, configure, and view badges, and so that students can view their badges

        3.1. Add a new "Badges" tab to the assignments/edit page for instructors to add and configure badges

        3.2. Add badge icons to the participants/list page for instructors to view badges

        3.3. Add badge icons to the student_task/list page for students to view badges

4. Write feature tests to verify the modifications

        4.1. Include tests in the a new badge_system_spec.rb file in the spec/features directory

</div>

= Preliminary Mocks =

=== Badges ===

<div style="padding: 10px 25px 25px 25px">

The following Credly badge will be awarded to students who meet the "Good Reviewer" criterion for a given assignment:

[[File:Badge-Good-Reviewer-Small.png|none|frame|Good Reviewer Badge]]

 The following Credly badge will be awarded to team members who meet the "Good Teammate" criterion for a given assignment:

[[File:Badge-Good-Teammate-Small.png|none|frame|Good Teammate Badge]]

</div>

=== Tables ===

<div style="padding: 10px 25px 25px 25px">

The following is an example of mock data in the badges table:

{| class="wikitable"
|-
! style="padding:10px; text-align: center" | id (primary key)
! style="padding:10px; text-align: center" | name (varchar)
! style="padding:10px; text-align: center" | description (varchar)
|-
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | Good Reviewer
| style="padding:10px; text-align: center" | This badge is awarded to students who receive very high review grades.
|-
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | Good Teammate
| style="padding:10px; text-align: center" | This badge is awarded to team members who receive very high teammate review scores.
|}

 The following is an example of mock data in the assignment_badges mapping table:

{| class="wikitable"
|-
! style="padding:10px; text-align: center" | id (primary key)
! style="padding:10px; text-align: center" | badge_id (foreign key)
! style="padding:10px; text-align: center" | assignment_id (foreign key)
! style="padding:10px; text-align: center" | threshold (int)
|-
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 95
|-
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 95
|-
| style="padding:10px; text-align: center" | 3
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 90
|-
| style="padding:10px; text-align: center" | 4
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 85
|-
| style="padding:10px; text-align: center" | 5
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 3
| style="padding:10px; text-align: center" | 80
|}

The first row represents that the badge with badge_id 1 ("Good Reviewer") has been activated for assignment with assignment_id 1 with the default threshold of 95.

The second row represents that the badge with badge_id 2 ("Good Teammate") has been activated for assignment with assignment_id 1 with the default threshold of 95.

The third row represents that the badge with badge_id 1 ("Good Reviewer") has been activated for assignment with assignment_id 2 with a customized threshold of 90.

The fourth row represents that the badge with badge_id 2 ("Good Teammate") has been activated for assignment with assignment_id 2 with a customized threshold of 85.

The fifth row represents that the badge with badge_id 1 ("Good Reviewer") has been activated for assignment with assignment_id 3 with a customized threshold of 80.

 The following is an example of mock data in the awarded_badges mapping table:

{| class="wikitable"
|-
! style="padding:10px; text-align: center" | id (primary key)
! style="padding:10px; text-align: center" | badge_id (foreign key)
! style="padding:10px; text-align: center" | participant_id (foreign key)
|-
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 1
|-
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 1
|-
| style="padding:10px; text-align: center" | 3
| style="padding:10px; text-align: center" | 1
| style="padding:10px; text-align: center" | 2
|-
| style="padding:10px; text-align: center" | 4
| style="padding:10px; text-align: center" | 2
| style="padding:10px; text-align: center" | 3
|}

The first row represents that the assignment participant with participant_id 1 has earned the badge with badge_id 1 ("Good Reviewer") for the given assignment.

The second row represents that the assignment participant with participant_id 1 has earned the badge with badge_id 2 ("Good Teammate") for the given assignment.

The third row represents that the assignment participant with participant_id 2 has earned the badge with badge_id 1 ("Good Reviewer") for the given assignment.

The fourth row represents that the assignment participant with participant_id 3 has earned the badge with badge_id 2 ("Good Teammate") for the given assignment.
</div>

=== Views ===

<div style="padding:10px 25px 25px 25px">

The following screenshots show a comparison of the existing "Assignments Edit" page, alongside a mockup incorporating the new badging system where instructors can add and configure badges for a given assignment.

 [[File:Original-Assignments-Edit.png|none|frame|The original "Assignments Edit" page.]]

 [[File:Modified-Assignments-Edit.png|none|frame|The modified "Assignments Edit" page.]]

 The following screenshots show a comparison of the existing "Participants List" page, alongside a mockup incorporating the new badging system where instructors can view all awarded badges for a given assignment.

 [[File:Original-Participants-List.png|none|frame|The original "Participants List" page.]]

 [[File:Modified-Participants-List.png|none|frame|The modified "Participants List" page.]]

 The following screenshots show a comparison of the existing "Student Task List" page, alongside a mockup incorporating the new badging system where students can view all of the badges they have earned.

 [[File:Original-Student-Task-List.png|none|frame|The original "Student Task List" page.]]

 [[File:Modified-Student-Task-List.png|none|frame|The modified "Student Task List" page.]]

</div>

= Test Plan =
The following will be our test plan for this project:
<pre>
describe 'Good Reviewer Badge Presence' do

it "should appear on the instructor's participant list when threshold is set below score" do

end

it "should appear on the student's task list when threshold is set below score" do

end

it "should appear on the instructor's participant list when score is set above threshold" do

end

it "should appear on the student's task list when score is set above threshold" do

end

end
</pre>
<pre>
describe 'Good Reviewer Badge Absence' do

it "should not appear on the instructor's participant list when threshold is set above score" do

end

it "should not appear on the student's task list when threshold is set above score" do

end

it "should not appear on the instructor's participant list when score is set below threshold" do

end

it "should not appear on the student's task list when score is set below threshold" do

end

end
</pre>
<pre>
describe 'Good Teammate Badge Presence' do

it "should appear on the instructor's participant list when threshold is set below score" do

end

it "should appear on the student's task list when threshold is set below score" do

end

it "should appear on the instructor's participant list when score is set above threshold" do

end

it "should appear on the student's task list when score is set above threshold" do

end

end
</pre>
<pre>
describe 'Good Teammate Badge Absence' do

it "should not appear on the instructor's participant list when threshold is set above score" do

end

it "should not appear on the student's task list when threshold is set above score" do

end

it "should not appear on the instructor's participant list when score is set below threshold" do

end

it "should not appear on the student's task list when score is set below threshold" do

end

end
</pre>
<div style="padding: 10px 25px 25px 25px">

A new badge_system_spec.rb file will be created in the spec/features folder, and will include feature tests that verify the modifications made for the project.

NOTE: More information will be included in this section as the project progresses and the tests are written.

</div>

= Video Demonstrations =

<div style="padding: 10px 25px 25px 25px">

NOTE: More information will be included in this section as the project progresses.

</div>

= Files Modified =

=== New Files ===

<div style="padding: 10px 25px 25px 25px">

• app/assets/images/badges

        A new directory created to house the new badge image files.

 • app/assets/images/badges/Badge-Good-Reviewer.png

        The image used for the new "Good Reviewer" badge.

 • app/assets/images/badges/Badge-Good-Teammate.png

        The image used for the new "Good Teammate" badge.

 • spec/features/badge_system_spec.rb

        The file holding the new tests written for the badging system.

 • db/migrate/20171115222415_create_badges.rb

        The migration for the new badges table.

 • db/migrate/20171115224048_create_assignment_badges.rb

        The migration for the new assignment_badges table.

 • db/migrate/20171115230007_create_awarded_badges.rb

        The migration for the new awarded_badges table.

 • app/models/badge.rb

        The model associated with the new badges table.

 • app/models/assignment_badge.rb

        The model associated with the new assignment_badges table.

 • app/models/awarded_badge.rb

        The model associated with the new awarded_badges table.

</div>

=== Edited Files ===

<div style="padding: 10px 25px 25px 25px">

• app/models/review_response_map.rb

        The file in which the code for the "Good Reviewer" badge will be inserted.

        NOTE: More detail will be provided as the project progresses.

 • app/models/teammate_review_response_map.rb

        The file in which the code for the "Good Teammate" badge will be inserted.

        NOTE: More detail will be provided as the project progresses.

 • app/views/assignments/edit.html.erb

        The UI changes allowing instructors to add and calibrate badges for a given assignment.

 • app/views/participants/list.html.erb

        The UI changes allowing instructors to view badges for the participants of a given assignment.

 • app/views/student_task/list.html.erb

        The UI changes allowing students to view their badges for all of their assignments.

 • db/schema.rb

        Incorporating schema changes for the three new badges, assignment_badges, and awarded_badges tables.

</div>

= References =

<div style="padding: 10px 25px 25px 25px">

Videos summarizing the previous team's work on this project topic can be found [https://www.youtube.com/playlist?list=PLdDBHYYDZueeGNdQtzS2FfI-eC0-SK6cb here].

</div>

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T03:25:36Z

Ppatel16: /* Assets */

<div style="padding: 25px 25px 25px 25px">
= Team Contact =

; MEMBERS:

:Pushpendra Patel: [mailto:ppatel16@ncsu.edu ppatel16@ncsu.edu]

:Tanay Kothari: [mailto:tkothar@ncsu.edu tkothar@ncsu.edu]

:Timothy Dement: [mailto:tmdement@ncsu.edu tmdement@ncsu.edu]

; MENTOR:

:Ferry Pramudianto: [mailto:fferry@ncsu.edu fferry@ncsu.edu]

__TOC__

= Topic Description =

=== Backgroud ===

Expertiza is web application devloped on Ruby on Rails platform. It helps students to create reusable learning objects through peer review. It also supports document submission and team projects. Expertiza allows the instructors to import following data:

* A list of users.
* A list of participants for an existing assignment.
* A list of participants for an existing course.
* A list of teams for an existing assignment
* A list of teams for an existing course.
* A list of reviewer assignments.
* A list of meta-reviewer assignments.

These imports are done by uploading a file containing data. The data should be formatted as different rows represented as lines of text in the file. The rows should contain values separated using delimiters. There can be 4 types of delimiters:
# Comma
# Space
# Tab
# Other - Any custom delimiter provided by the user as text

=== Problem Statement ===

The following is an Expertiza based OSS project which deals primarily with the Import File controller. This project is associated with fixing [https://github.com/expertiza/expertiza/issues/110 issue #110] on the Expertiza Github. The problem with these imports is that they are not implemented consistently. There are restrictions to how the columns should be ordered in the import file. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly user-interface to the users so that they are able easily import users, participants, topics, etc.

=== Solution ===

To resolve this issue we have changed the interface and the import process to an extent, keeping the core methods of import intact with just few required minor changes. In the new interface, upon importing, the system would then display what was imported, and let the user choose from a dropdown which field was which. The default ordering is the same as what is currently required by Expertiza unless a specific order is provided by the user as a header in the import file.

= Added Features =

= Files Changed =

=== Assets ===

To implement the functionality of non-duplicate column names, we created two new methods ''checkIfUserColumnDuplicate()'' and ''checkIfParticipateColumnDuplicate()'' in the shared.js .
We have also fixed the ''checkIfFileExist()'' method so that if the user doesn't select the file and click on import button it gives him/her an error stating that "No file has been selected to import".

=== Config ===

We needed to change the ''routes.rb'' so that the new partial views can be implemented.

=== Controllers ===

For the enhancement of the import functionality, we modified the import_file_controller. In this controller, we modified one existing method ''import()'', other than that we had to declare some additional methods ''import_from_hash()'', ''hash_rows_with_headers()'', ''parse_to_hash()'', ''parse_to_grid()'' and ''show()''.

=== Helpers ===

As we changed the original implementation from array to hash we need to also modify the import_file_helper a little bit.

=== Models ===

Here is a list of models and their respective methods that we had to modify to enhance the import functionality:

#assignment_participant : ''self.import()''
#course_participant : ''self.import()''
#course_team : ''add_member()''
#metareview_response_map : ''self.import()''
#review_response_map : ''self.import()''
#team : ''import_team_members()'' and ''self.import()''
#user : ''self.import()''

=== Views ===

To use the import functionality in a new and enhanced way, we modified one of the existing view and added new views, listed below:

Views Modified:
#''start.html.erb''

Views Created:
#''_metareviewer.html.erb''
#''_participant.html.erb''
#''show.html.erb''
#''_reviewer.html.erb''
#''_team.html.erb''
#''_user.html.erb''

= Demonstrations =

== User Import ==

[https://youtu.be/HaaXKxfqzes User Import Demo]

DESCRIPTION

== Assignent Participant and Course Participant Import ==

[https://youtu.be/BGGPjJrkEjI Participant Import Demo]

DESCRIPTION

== Assignment Team and Course Team Import ==

DESCRIPTION

LINK TO YOUTUBE VIDEO

== Reviewer and Metareviewer Import ==

LINK TO YOUTUBE VIDEO

DESCRIPTION



= Navigating Expertiza =

== User Import ==

To begin the User import process, first select the "User" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Users.png|none|frame|Manage Users]]
</div>

Next, scroll to the bottom of the page and click the "Import Users" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Users.png|none|frame|Import Users]]
</div>

You will then be redirected to the User import page.

== Participant Import ==

There are two types of Participants, Assignment Participants and Course Participants.

=== Assignment Participant Import ===

To begin the Assignment Participant import process, first select the "Assignments" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Assignments.png|none|frame|Manage Assignments]]
</div>

Make sure that "Assignments" is highlighted on the "Manage content" page, then locate the appropriate assignment and click the "Add Participants" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Add-Assignment-Participant.png|none|frame|Add Assignment Participant]]
</div>

Finally, scroll to the bottom of the page and click the "Import assignment participants" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Assignment-Participant.png|none|Import Assignment Participant]]
</div>

You will then be redirected to the Assignment Participant import page.

=== Course Participant Import ===

To begin the Course Participant import process, first select the "Courses" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Courses.png|none|frame|Manage Courses]]
</div>

Make sure that "Courses" is highlighted on the "Manage content" page, then locate the appropriate course and click the "Add Participants" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Add-Course-Participant.png|none|frame|Add Course Participant]]
</div>

Finally, scroll to the bottom of the page and click the "Import course participants" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Course-Participant.png|none|frame|Import Course Participant]]
</div>

You will then be redirected to the Course Participant import page.

== Team Import ==

There are two types of Teams, Assignment Teams and Course Teams.

=== Assignment Team Import ===

To begin the Assignment Team import process, first select the "Assignments" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Assignments.png|none|frame|Manage Assignments]]
</div>

Make sure that "Assignments" is highlighted on the "Manage content" page, then locate the appropriate assignment and click the "Create Teams" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Create-Assignment-Teams.png|none|frame|Create Assignment Team]]
</div>

Finally, scroll to the bottom of the page and click the "Import Teams" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Assignment-Teams.png|none|Import Assignment Teams]]
</div>

You will then be redirected to the Assignment Team import page.

=== Course Team Import ===

To begin the Course Team import process, first select the "Courses" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Courses.png|none|frame|Manage Courses]]
</div>

Make sure that "Courses" is highlighted on the "Manage content" page, then locate the appropriate assignment and click the "Create Teams" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Create-Course-Teams.png|none|frame|Create Course Team]]
</div>

Finally, scroll to the bottom of the page and click the "Import Teams" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Course-Teams.png|none|Import Course Teams]]
</div>

You will then be redirected to the Course Team import page.

== Reviewer and Metareviewer Import ==

To begin the Reviewer and Metareviewer import process, first select the "Assignments" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Assignments.png|none|Manage Assignments]]
</div>

Make sure that "Assignments" is highlighted on the "Manage content" page, then locate the appropriate assignment and click the "Assign reviewers" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Assign-Reviewers.png|none|Assign Reviewers]]
</div>

Finally, scroll to the bottom of the page, and click either the "Import reviewer mappings" link or the "Import meta reviewer mappings" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Reviewer-Mappings.png|none|Import Reviewer Mappings]]
</div>

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Metareviewer-Mappings.png|none|Import Metareviewer Mappings]]
</div>

You will then be redirected to either the Reviewer import page or the Metareviewer import page.



</div>

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T02:26:38Z

Ppatel16: /* Files Changed */

<div style="padding: 25px 25px 25px 25px">
= Team Contact =

; MEMBERS:

:Pushpendra Patel: [mailto:ppatel16@ncsu.edu ppatel16@ncsu.edu]

:Tanay Kothari: [mailto:tkothar@ncsu.edu tkothar@ncsu.edu]

:Timothy Dement: [mailto:tmdement@ncsu.edu tmdement@ncsu.edu]

; MENTOR:

:Ferry Pramudianto: [mailto:fferry@ncsu.edu fferry@ncsu.edu]

__TOC__

= Topic Description =

<big> '''Background''' </big>

Expertiza is web application devloped on Ruby on Rails platform. It helps students to create reusable learning objects through peer review. It also supports document submission and team projects. Expertiza allows the instructors to import following data:

* A list of users.
* A list of participants for an existing assignment.
* A list of participants for an existing course.
* A list of teams for an existing assignment
* A list of teams for an existing course.
* A list of reviewer assignments.
* A list of meta-reviewer assignments.

These imports are done by uploading a file containing data. The data should be formatted as different rows represented as lines of text in the file. The rows should contain values separated using delimiters. There can be 4 types of delimiters:
# Comma
# Space
# Tab
# Other - A custom delimiter provided by the user as text

<big> '''Problem Statement''' </big>

The following is an Expertiza based OSS project which deals primarily with the Import File controller. This project is associated with fixing [https://github.com/expertiza/expertiza/issues/110 issue #110] on the Expertiza Github. The problem with these imports is that they are not implemented consistently. There are restrictions to how the columns should be ordered in the import file. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly user-interface to the users so that they are able easily import users, participants, topics, etc.

<big> '''Solution''' </big>

To resolve this issue, we have changed the interface and the import process to an extent keeping the core methods of import intact with just required minor changes. In the new interface, upon importing, the system would then display what was imported, and let the user choose from a dropdown which field was which. The default ordering is the same as what is currently required by Expertiza unless a specific order is provided by the user as a header in the import file.

= Added Features =

= Files Changed =

== Assets ==

To implement the functionality of non-duplicate column names, we created two new methods ''checkIfUserColumnDuplicate()'' and ''checkIfParticipateColumnDuplicate()'' in the shared.js .

== Config ==

We needed to change the ''routes.rb'' so that the new partial views can be implemented.

== Controllers ==

For the enhancement of the import functionality, we modified the import_file_controller. In this controller, we modified one existing method ''import()'', other than that we had to declare some additional methods ''import_from_hash()'', ''hash_rows_with_headers()'', ''parse_to_hash()'', ''parse_to_grid()'' and ''show()''.
== Helpers ==

As we changed the original implementation from array to hash we need to also modify the import_file_helper a little bit.

== Models ==

There is a list of models we had to modify for enhancing the import functionality, which are listed below along with the original methods we needed to modify:

#assignment_participant : ''self.import()''
#course_participant : ''self.import()''
#course_team : ''add_member()''
#metareview_response_map : ''self.import()''
#review_response_map : ''self.import()''
#team : ''import_team_members()'' and ''self.import()''
#user : ''self.import()''

== Views ==

To use the import functionality in a new and enhanced way, we modified one of the existing view and added new views, listed below:

Views Modified:
#''start.html.erb''

Views Created:
#''_metareviewer.html.erb''
#''_participant.html.erb''
#''show.html.erb''
#''_reviewer.html.erb''
#''_team.html.erb''
#''_user.html.erb''

= Demonstrations =

== User Import ==

[https://youtu.be/HaaXKxfqzes User Import Demo]

DESCRIPTION

== Assignent Participant and Course Participant Import ==

[https://youtu.be/BGGPjJrkEjI Participant Import Demo]

DESCRIPTION

== Assignment Team and Course Team Import ==

DESCRIPTION

LINK TO YOUTUBE VIDEO

== Reviewer and Metareviewer Import ==

LINK TO YOUTUBE VIDEO

DESCRIPTION



= Navigating Expertiza =

== User Import ==

To begin the User import process, first select the "User" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Users.png|none|frame|Manage Users]]
</div>

Next, scroll to the bottom of the page and click the "Import Users" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Users.png|none|frame|Import Users]]
</div>

You will then be redirected to the User import page.

== Participant Import ==

There are two types of Participants, Assignment Participants and Course Participants.

=== Assignment Participant Import ===

To begin the Assignment Participant import process, first select the "Assignments" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Assignments.png|none|frame|Manage Assignments]]
</div>

Make sure that "Assignments" is highlighted on the "Manage content" page, then locate the appropriate assignment and click the "Add Participants" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Add-Assignment-Participant.png|none|frame|Add Assignment Participant]]
</div>

Finally, scroll to the bottom of the page and click the "Import assignment participants" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Assignment-Participant.png|none|Import Assignment Participant]]
</div>

You will then be redirected to the Assignment Participant import page.

=== Course Participant Import ===

To begin the Course Participant import process, first select the "Courses" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Courses.png|none|frame|Manage Courses]]
</div>

Make sure that "Courses" is highlighted on the "Manage content" page, then locate the appropriate course and click the "Add Participants" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Add-Course-Participant.png|none|frame|Add Course Participant]]
</div>

Finally, scroll to the bottom of the page and click the "Import course participants" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Course-Participant.png|none|frame|Import Course Participant]]
</div>

You will then be redirected to the Course Participant import page.

== Team Import ==

There are two types of Teams, Assignment Teams and Course Teams.

=== Assignment Team Import ===

To begin the Assignment Team import process, first select the "Assignments" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Assignments.png|none|frame|Manage Assignments]]
</div>

Make sure that "Assignments" is highlighted on the "Manage content" page, then locate the appropriate assignment and click the "Create Teams" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Create-Assignment-Teams.png|none|frame|Create Assignment Team]]
</div>

Finally, scroll to the bottom of the page and click the "Import Teams" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Assignment-Teams.png|none|Import Assignment Teams]]
</div>

You will be redirected to the Assignment Team import page.

=== Course Team Import ===

To begin the Course Team import process, first select the "Courses" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Courses.png|none|frame|Manage Courses]]
</div>

Make sure that "Courses" is highlighted on the "Manage content" page, then locate the appropriate assignment and click the "Create Teams" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Create-Course-Teams.png|none|frame|Create Course Team]]
</div>

Finally, scroll to the bottom of the page and click the "Import Teams" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Course-Teams.png|none|Import Course Teams]]
</div>

You will then be redirected to the Course Team import page.

== Reviewer and Metareviewer Import ==

To begin the Reviewer and Metareviewer import process, first select the "Assignments" link from the "Manage" drop-down menu.

<div style="padding: 0px 0px 0px 25px">
[[File:Manage-Assignments.png|none|Manage Assignments]]
</div>

Make sure that "Assignments" is highlighted on the "Manage content" page, then locate the appropriate assignment and click the "Assign reviewers" button.

<div style="padding: 0px 0px 0px 25px">
[[File:Assign-Reviewers.png|none|Assign Reviewers]]
</div>

Finally, scroll to the bottom of the page, and click either the "Import reviewer mappings" link or the "Import meta reviewer mappings" link.

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Reviewer-Mappings.png|none|Import Reviewer Mappings]]
</div>

<div style="padding: 0px 0px 0px 25px">
[[File:Import-Metareviewer-Mappings.png|none|Import Metareviewer Mappings]]
</div>

You will then be redirected to either the Reviewer import page or the Metareviewer import page.



</div>

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T01:14:34Z

Ppatel16: Order Changed