Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System

2017-11-08T05:27:26Z

Tkothar: /* Problem Statement */

__TOC__

= <em><strong>Team Contact</strong></em> =

<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>

= <em><strong>Project Description</strong></em> =

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

<strong>The full project topic description can be found [https://docs.google.com/document/d/1WYiXxhYyycp9a3I0GTC-4KFgHrg65Tf27ijJNQvxhmk/edit#heading=h.u6i7q1mdz0zl here]</strong>.
<br/><br/>
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.
<br/><br/>
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.
<br/><br/>
Per the full project topic description, the badges will be designed using [https://credly.com Credly].
<br/><br/>
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.
<br/><br/>
The "Good Reviewer" badge will be awarded to students who receive very high review grades.
<br/><br/>
The "Good Teammate" badge will be awarded to team members who receive very high teammate review scores.
<br/><br/>
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.
<br/><br/>
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.
<br/><br/>
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.
<br/><br/>
Please refer to the "Preliminary Mocks" section below for further detail.
</div>

= <em><strong>Project Requirements</strong></em> =

<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 <span style="font-family: menlo; color: cornflowerblue">app/assets/images/badges</span> directory

2. Create tables for the badging system

        2.1. Create a table named <span style="font-family: menlo; color: cornflowerblue">badges</span> with the following attributes

                2.1.1. <span style="font-family: menlo; color: cornflowerblue">id</span> — <em>primary key</em>

                2.1.2. <span style="font-family: menlo; color: cornflowerblue">name</span> — <em>varchar</em>

                2.1.3. <span style="font-family: menlo; color: cornflowerblue">description</span> — <em>varchar</em>

        2.2. Create a mapping table named <span style="font-family: menlo; color: cornflowerblue">assignment_badges</span> with the following attributes

                2.2.1 <span style="font-family: menlo; color: cornflowerblue">id</span> — <em>primary key</em>

                2.2.2 <span style="font-family: menlo; color: cornflowerblue">badge_id</span> — <em>foreign key</em>

                2.2.3 <span style="font-family: menlo; color: cornflowerblue">assignment_id</span> — <em>foreign key</em>

                2.2.4 <span style="font-family: menlo; color: cornflowerblue">threshold</span> — <em>int</em>

        2.3. Create a mapping table named <span style="font-family: menlo; color: cornflowerblue">awarded_badges</span> with the following attributes

                2.3.1. <span style="font-family: menlo; color: cornflowerblue">id</span> — primary key

                2.3.2. <span style="font-family: menlo; color: cornflowerblue">badge_id</span> — foreign key

                2.3.3. <span style="font-family: menlo; color: cornflowerblue">participant_id</span> — foreign key

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

        3.1. Add a new "Badges" tab to the <span style="font-family: menlo; color: cornflowerblue">assignments/edit</span> page

        3.2. Add badge icons to the <span style="font-family: menlo; color: cornflowerblue">student_task/list</span> page for students to view

        3.3. Add badge icons to the <span style="font-family: menlo; color: cornflowerblue">participants/list</span> page for instructors to view

4. Write feature tests to verify the modifications

        4.1. Include tests in the a new <span style="font-family: menlo; color: cornflowerblue">badge_system_spec.rb</span> file in the <span style="font-family: menlo; color: cornflowerblue">spec/features</span> directory

</div>

= <em><strong>Preliminary Mocks</strong></em> =

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

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

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

</div>

= <em><strong>Overview of Work Completed</strong></em> =

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

= <em><strong>Testing</strong></em> =

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

= <em><strong>Files Modified</strong></em> =

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

=== <em><strong>New Files</strong></em> ===

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

=== <em><strong>Edited Files</strong></em> ===

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

= <em><strong>References</strong></em> =

<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>

= Problem Statement=
To create a simple badging system for Expertiza such that the students can be badged when certain criteria are matched.
<br><br>Badging feature allows students to be badged on expertiza based on the matching of certain criteria. ‘Good Reviewer’ and ‘Good Teammate’ badges can be given to students based on the scores given to them by instructors or the other teammates.
<br><br>A ‘Good Reviewer’ badge is assigned when a student gets review score of more than a particular threshold or more than 95 by default.
<br><br>Similarly, a 'Good teammate' badge is assigned when the teammate review score is greater than a particular threshold, defaulted to 95.
<br><br>The criterion to receive the badges are configurable for the instructors and can be changed for different tasks and assignments.

=Requirement Specification=

1. Creating badges for 'Good Reviewer' and 'Good Teammate'.
<br><br>2. Create a table named “badges” where the badges and their description can be stored.
<br><br>3. Create a mapping table named “assignment_badges”, for mapping badges with assignments and storing the specific thresholds
<br><br>4. Create a mapping table named “awarded_badges”, to map student with badges.
<br><br>5. Providing means to configure the badging criteria by adding 'Calibration' tab in Assignments/edit page.
<br><br>6. Adding badges in student/task list to allow the viewing of badges associated with students.
<br><br>7. Adding badges to participants/list for an instructor to view.
<br><br>8. Implement feature tests to verify the new feature addition.
<br><br>9. Adding hover feature on each badge to allow the viewer to read the description of the badge without taking up column width or height.

CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System

2017-11-08T05:24:11Z

Tkothar: /* Requirement Specification */

__TOC__

= <em><strong>Team Contact</strong></em> =

<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>

= <em><strong>Project Description</strong></em> =

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

<strong>The full project topic description can be found [https://docs.google.com/document/d/1WYiXxhYyycp9a3I0GTC-4KFgHrg65Tf27ijJNQvxhmk/edit#heading=h.u6i7q1mdz0zl here]</strong>.
<br/><br/>
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.
<br/><br/>
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.
<br/><br/>
Per the full project topic description, the badges will be designed using [https://credly.com Credly].
<br/><br/>
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.
<br/><br/>
The "Good Reviewer" badge will be awarded to students who receive very high review grades.
<br/><br/>
The "Good Teammate" badge will be awarded to team members who receive very high teammate review scores.
<br/><br/>
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.
<br/><br/>
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.
<br/><br/>
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.
<br/><br/>
Please refer to the "Preliminary Mocks" section below for further detail.
</div>

= <em><strong>Project Requirements</strong></em> =

<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 <span style="font-family: menlo; color: cornflowerblue">app/assets/images/badges</span> directory

2. Create tables for the badging system

        2.1. Create a table named <span style="font-family: menlo; color: cornflowerblue">badges</span> with the following attributes

                2.1.1. <span style="font-family: menlo; color: cornflowerblue">id</span> — <em>primary key</em>

                2.1.2. <span style="font-family: menlo; color: cornflowerblue">name</span> — <em>varchar</em>

                2.1.3. <span style="font-family: menlo; color: cornflowerblue">description</span> — <em>varchar</em>

        2.2. Create a mapping table named <span style="font-family: menlo; color: cornflowerblue">assignment_badges</span> with the following attributes

                2.2.1 <span style="font-family: menlo; color: cornflowerblue">id</span> — <em>primary key</em>

                2.2.2 <span style="font-family: menlo; color: cornflowerblue">badge_id</span> — <em>foreign key</em>

                2.2.3 <span style="font-family: menlo; color: cornflowerblue">assignment_id</span> — <em>foreign key</em>

                2.2.4 <span style="font-family: menlo; color: cornflowerblue">threshold</span> — <em>int</em>

        2.3. Create a mapping table named <span style="font-family: menlo; color: cornflowerblue">awarded_badges</span> with the following attributes

                2.3.1. <span style="font-family: menlo; color: cornflowerblue">id</span> — primary key

                2.3.2. <span style="font-family: menlo; color: cornflowerblue">badge_id</span> — foreign key

                2.3.3. <span style="font-family: menlo; color: cornflowerblue">participant_id</span> — foreign key

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

        3.1. Add a new "Badges" tab to the <span style="font-family: menlo; color: cornflowerblue">assignments/edit</span> page

        3.2. Add badge icons to the <span style="font-family: menlo; color: cornflowerblue">student_task/list</span> page for students to view

        3.3. Add badge icons to the <span style="font-family: menlo; color: cornflowerblue">participants/list</span> page for instructors to view

4. Write feature tests to verify the modifications

        4.1. Include tests in the a new <span style="font-family: menlo; color: cornflowerblue">badge_system_spec.rb</span> file in the <span style="font-family: menlo; color: cornflowerblue">spec/features</span> directory

</div>

= <em><strong>Preliminary Mocks</strong></em> =

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

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

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

</div>

= <em><strong>Overview of Work Completed</strong></em> =

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

= <em><strong>Testing</strong></em> =

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

= <em><strong>Files Modified</strong></em> =

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

=== <em><strong>New Files</strong></em> ===

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

=== <em><strong>Edited Files</strong></em> ===

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

= <em><strong>References</strong></em> =

<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>

= Problem Statement=

To create a simple badging system for Expertiza such that the students can be badged when certain criteria are matched.

Badging feature allows students to be badged on expertiza based on the matching of certain criteria. ‘Good Reviewer’ and ‘Good Teammate’ badges can be given to students based on the scores given to them by instructors or the other teammates.

A ‘Good Reviewer’ badge is assigned when a student gets review score of more than a particular threshold or more than 95 by default.
Similarly, a 'Good teammate' badge is assigned when the teammate review score is greater than a particular threshold, defaulted to 95.
The criterion to receive the badges are configurable for the instructors and can be changed for different tasks and assignments.

=Requirement Specification=

1. Creating badges for 'Good Reviewer' and 'Good Teammate'.
<br><br>2. Create a table named “badges” where the badges and their description can be stored.
<br><br>3. Create a mapping table named “assignment_badges”, for mapping badges with assignments and storing the specific thresholds
<br><br>4. Create a mapping table named “awarded_badges”, to map student with badges.
<br><br>5. Providing means to configure the badging criteria by adding 'Calibration' tab in Assignments/edit page.
<br><br>6. Adding badges in student/task list to allow the viewing of badges associated with students.
<br><br>7. Adding badges to participants/list for an instructor to view.
<br><br>8. Implement feature tests to verify the new feature addition.
<br><br>9. Adding hover feature on each badge to allow the viewer to read the description of the badge without taking up column width or height.

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-11-02T18:43:39Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, so that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<pre>
user = User.find_by_name(row[0])

if user.nil?
attributes = ImportFileHelper.define_attributes(row)
user = ImportFileHelper.create_new_user(attributes, session)
password = user.reset_password # the password is reset
MailerHelper.send_mail_to_user(user, "Your Expertiza account has been created.", "user_welcome", password).deliver
else
user.email = row[2].strip # ***** Use of hard-coded index values *****
user.fullname = row[1].strip
user.parent_id = (session[:user]).id
user.save
end
</pre>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed. Following is a snippet from the "User.rb" to demonstrate our usage of hash.

<pre>
user = User.find_by_name(row_hash[:name])

if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
password = user.reset_password
MailerHelper.send_mail_to_user(user, "Your Expertiza account has been created.", "user_welcome", password).deliver
else
user.email = row_hash[:email] # ***** No hard-coded index values required *****
user.fullname = row_hash[:fullname] # ***** Direct use of field name for setting up user parameters for import *****
user.parent_id = (session[:user]).id
user.save
end
</pre>

The import process in the previous implementation imports is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* Once the user clicks "Import" button on this view, "import" method of the Import File controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
* "import_file" converts the data from import file into a multidimensional array in which each row represents a row from the import file. Following is an example -
<pre>
[ [ 'name','fullname','email ],
[ 'ppatel16','Pushpendra Patel','ppatel@ncsu.edu' ],
[ 'tkothar','Tanay Kothari','tkothar@ncsu.edu' ],
[ 'tmdement','Timothy Dement','tmdement@ncsu.edu' ] ]
</pre>

*This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

<br>
Import process of using our implementation is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* When user submits the options to import, the file is parsed row-by-row. It is divided into a "header" which contains the column names and a "body" which contains all the data to be imported in form of a multi-dimensional array.
* "show" action of the Import File controller is called and user is redirected to "show" view the same controller. On this view user can use drop downs to select which field of the import data is which.
* Once the user clicks "Import" button on the "show" view, "import" method of the Import File controller is called which in turn calls the "import_from_hash" method of the same controller. "import" method collects the errors which might be encountered during the import process and displays it to the user.
* In the "import_from_hash" method, each row of the multidimensional array (body) is converted from into a hash. Following is an example of such a converted hash -
<pre>
[ { :name => 'ppatel16',
:fullname => 'Pushpendra Patel',
:email => 'ppatel16@ncsu.edu' },
{ :name => 'tkothar',
:fullname => 'Tanay Kothari',
:email => 'tkothar@ncsu.edu' },
{ :name => 'tmdement',
:fullname => 'Timothy Dement',
:email => 'tmdement@ncsu.edu } ]
</pre>
* This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

= 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''

= 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-11-02T18:41:20Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, so that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<pre>
user = User.find_by_name(row[0])

if user.nil?
attributes = ImportFileHelper.define_attributes(row)
user = ImportFileHelper.create_new_user(attributes, session)
password = user.reset_password # the password is reset
MailerHelper.send_mail_to_user(user, "Your Expertiza account has been created.", "user_welcome", password).deliver
else
user.email = row[2].strip # ***** Use of hard-coded index values *****
user.fullname = row[1].strip
user.parent_id = (session[:user]).id
user.save
end
</pre>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed. Following is a snippet from the "User.rb" to demonstrate our usage of hash.

<pre>
user = User.find_by_name(row_hash[:name])

if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
password = user.reset_password
MailerHelper.send_mail_to_user(user, "Your Expertiza account has been created.", "user_welcome", password).deliver
else
user.email = row_hash[:email] # ***** No hard-coded index values required *****
user.fullname = row_hash[:fullname] # ***** Direct use of field name for setting up user parameters for import *****
user.parent_id = (session[:user]).id
user.save
end
</pre>

The import process in the previous implementation of "User" imports is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* Once the user clicks "Import" button on this view, "import" method of the Import File controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
* "import_file" converts the data from import file into a multidimensional array in which each row represents a row from the import file. Following is an example -
<pre>
[ [ 'name','fullname','email ],
[ 'ppatel16','Pushpendra Patel','ppatel@ncsu.edu' ],
[ 'tkothar','Tanay Kothari','tkothar@ncsu.edu' ],
[ 'tmdement','Timothy Dement','tmdement@ncsu.edu' ] ]
</pre>

*This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

<br>
Import process of "Users" using our implementation is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* When user submits the options to import, the file is parsed row-by-row. It is divided into a "header" which contains the column names and a "body" which contains all the data to be imported in form of a multi-dimensional array.
* "show" action of the Import File controller is called and user is redirected to "show" view the same controller. On this view user can use drop downs to select which field of the import data is which.
* Once the user clicks "Import" button on the "show" view, "import" method of the Import File controller is called which in turn calls the "import_from_hash" method of the same controller. "import" method collects the errors which might be encountered during the import process and displays it to the user.
* In the "import_from_hash" method, each row of the multidimensional array (body) is converted from into a hash. Following is an example of such a converted hash -
<pre>
[ { :name => 'ppatel16',
:fullname => 'Pushpendra Patel',
:email => 'ppatel16@ncsu.edu' },
{ :name => 'tkothar',
:fullname => 'Tanay Kothari',
:email => 'tkothar@ncsu.edu' },
{ :name => 'tmdement',
:fullname => 'Timothy Dement',
:email => 'tmdement@ncsu.edu } ]
</pre>
* This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

= 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''

= 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-11-02T18:40:04Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, so that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<pre>
user = User.find_by_name(row[0])

if user.nil?
attributes = ImportFileHelper.define_attributes(row)
user = ImportFileHelper.create_new_user(attributes, session)
password = user.reset_password # the password is reset
MailerHelper.send_mail_to_user(user, "Your Expertiza account has been created.", "user_welcome", password).deliver
else
user.email = row[2].strip # ***** Use of hard-coded index values *****
user.fullname = row[1].strip
user.parent_id = (session[:user]).id
user.save
end
</pre>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed. Following is a snippet from the "User.rb" to demonstrate our usage of hash.

<pre>
user = User.find_by_name(row_hash[:name])

if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
password = user.reset_password
MailerHelper.send_mail_to_user(user, "Your Expertiza account has been created.", "user_welcome", password).deliver
else
user.email = row_hash[:email] # ***** No hard-coded index values required *****
user.fullname = row_hash[:fullname] # ***** Direct use of field name for setting up user parameters for import *****
user.parent_id = (session[:user]).id
user.save
end
</pre>

The import process in the previous implementation of "User" imports is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* Once the user clicks "Import" button on this view, "import" method of the Import File controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
* "import_file" converts the data from import file into a multidimensional array in which each row represents a row from the import file. Following is an example -
<pre>
[ [ 'name','fullname','email ],
[ 'ppatel16','Pushpendra Patel','ppatel@ncsu.edu' ],
[ 'tkothar','Tanay Kothari','tkothar@ncsu.edu' ],
[ 'tmdement','Timothy Dement','tmdement@ncsu.edu' ] ]
</pre>

*This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

<br>
Import process of "Users" using our implementation is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* When user submits the options to import, the file is parsed row-by-row. It is divided into a "header" which contains the column names and a "body" which contains all the data to be imported in form of a multi-dimensional array.
* "show" action of the Import File controller is called and user is redirected to "show" view the same controller. On this view user can use drop downs to select which field of the import data is which.
* Once the user clicks "Import" button on the "show" view, "import" method of the Import File controller is called which in turn calls the "import_from_hash" method of the same controller. "import" method collects the errors which might be encountered during the import process and displays it to the user.
* In the "import_from_hash" method, each row of the multidimensional array (body) is converted from into a hash. Following is an example of such a converted hash -
<pre>
[ { :name => 'ppatel16',
:fullname => 'Pushpendra Patel',
:email => 'ppatel16@ncsu.edu' },
{ :name => 'tkothar',
:fullname => 'Tanay Kothari',
:email => 'tkothar@ncsu.edu' },
{ :name => 'tmdement',
:fullname => 'Timothy Dement',
:email => 'tmdement@ncsu.edu } ]
</pre>
* This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

= 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''

= 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-11-02T18:37:50Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, so that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<pre>
user = User.find_by_name(row[0])

if user.nil?
attributes = ImportFileHelper.define_attributes(row)
user = ImportFileHelper.create_new_user(attributes, session)
password = user.reset_password # the password is reset
MailerHelper.send_mail_to_user(user, "Your Expertiza account has been created.", "user_welcome", password).deliver
else
user.email = row[2].strip # ***** Use of hard-coded index values *****
user.fullname = row[1].strip
user.parent_id = (session[:user]).id
user.save
end
</pre>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed. Following is a snippet from the "User.rb" to demonstrate our usage of hash.

<pre>
user = User.find_by_name(row_hash[:name])

if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
password = user.reset_password
MailerHelper.send_mail_to_user(user, "Your Expertiza account has been created.", "user_welcome", password).deliver
else
user.email = row_hash[:email] # ***** No hard-coded index values required *****
user.fullname = row_hash[:fullname] # ***** Direct use of field name for setting up user parameters for import *****
user.parent_id = (session[:user]).id
user.save
end
</pre>

The import process in the previous implementation of "User" imports is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* Once the user clicks "Import" button on this view, "import" method of the Import File controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
* "import_file" converts the data from import file into a multidimensional array in which each row represents a row from the import file. Following is an example -
<pre>
[ 'name','fullname','email ]
[ 'ppatel16','Pushpendra Patel','ppatel@ncsu.edu' ]
[ 'tkothar','Tanay Kothari','tkothar@ncsu.edu' ]
[ 'tmdement','Timothy Dement','tmdement@ncsu.edu' ]
</pre>

*This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

<br>
Import process of "Users" using our implementation is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* When user submits the options to import, the file is parsed row-by-row. It is divided into a "header" which contains the column names and a "body" which contains all the data to be imported in form of a multi-dimensional array.
* "show" action of the Import File controller is called and user is redirected to "show" view the same controller. On this view user can use drop downs to select which field of the import data is which.
* Once the user clicks "Import" button on the "show" view, "import" method of the Import File controller is called which in turn calls the "import_from_hash" method of the same controller. "import" method collects the errors which might be encountered during the import process and displays it to the user.
* In the "import_from_hash" method, each row of the multidimensional array (body) is converted from into a hash. Following is an example of such a converted hash -
<pre>
[ { :name => 'ppatel16',
:fullname => 'Pushpendra Patel',
:email => 'ppatel16@ncsu.edu' },
{ :name => 'tkothar',
:fullname => 'Tanay Kothari',
:email => 'tkothar@ncsu.edu' },
{ :name => 'tmdement',
:fullname => 'Timothy Dement',
:email => 'tmdement@ncsu.edu } ]
</pre>
* This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

= 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''

= 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-11-02T18:34:12Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, so that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<span style="color:red;"><big>Code to show hard coded index values </big></span>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed. Following is a snippet from the "User.rb" to demonstrate our usage of hash.

<pre>
user = User.find_by_name(row_hash[:name])

if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
password = user.reset_password
MailerHelper.send_mail_to_user(user, "Your Expertiza account has been created.", "user_welcome", password).deliver
else
user.email = row_hash[:email] # ***** No hard-coded index values required *****
user.fullname = row_hash[:fullname] # ***** Direct use of field name for setting up user parameters for import *****
user.parent_id = (session[:user]).id
user.save
end
</pre>

The import process in the previous implementation of "User" imports is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* Once the user clicks "Import" button on this view, "import" method of the Import File controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
* "import_file" converts the data from import file into a multidimensional array in which each row represents a row from the import file. Following is an example -
<pre>
[ 'name','fullname','email ]
[ 'ppatel16','Pushpendra Patel','ppatel@ncsu.edu' ]
[ 'tkothar','Tanay Kothari','tkothar@ncsu.edu' ]
[ 'tmdement','Timothy Dement','tmdement@ncsu.edu' ]
</pre>

*This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

<br>
Import process of "Users" using our implementation is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* When user submits the options to import, the file is parsed row-by-row. It is divided into a "header" which contains the column names and a "body" which contains all the data to be imported in form of a multi-dimensional array.
* "show" action of the Import File controller is called and user is redirected to "show" view the same controller. On this view user can use drop downs to select which field of the import data is which.
* Once the user clicks "Import" button on the "show" view, "import" method of the Import File controller is called which in turn calls the "import_from_hash" method of the same controller. "import" method collects the errors which might be encountered during the import process and displays it to the user.
* In the "import_from_hash" method, each row of the multidimensional array (body) is converted from into a hash. Following is an example of such a converted hash -
<pre>
[ { :name => 'ppatel16',
:fullname => 'Pushpendra Patel',
:email => 'ppatel16@ncsu.edu' },
{ :name => 'tkothar',
:fullname => 'Tanay Kothari',
:email => 'tkothar@ncsu.edu' },
{ :name => 'tmdement',
:fullname => 'Timothy Dement',
:email => 'tmdement@ncsu.edu } ]
</pre>
* This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

= 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''

= 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-11-02T18:27:51Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, so that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<span style="color:red;"><big>Code to show hard coded index values </big></span>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed.

<span style="color:red;"><big>Code to show hash implementation</big></span?

The import process in the previous implementation of "User" imports is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* Once the user clicks "Import" button on this view, "import" method of the Import File controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
* "import_file" converts the data from import file into a multidimensional array in which each row represents a row from the import file. Following is an example -
<pre>
[ 'name','fullname','email ]
[ 'ppatel16','Pushpendra Patel','ppatel@ncsu.edu' ]
[ 'tkothar','Tanay Kothari','tkothar@ncsu.edu' ]
[ 'tmdement','Timothy Dement','tmdement@ncsu.edu' ]
</pre>

*This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

<br>
Import process of "Users" using our implementation is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* When user submits the options to import, the file is parsed row-by-row. It is divided into a "header" which contains the column names and a "body" which contains all the data to be imported in form of a multi-dimensional array.
* "show" action of the Import File controller is called and user is redirected to "show" view the same controller. On this view user can use drop downs to select which field of the import data is which.
* Once the user clicks "Import" button on the "show" view, "import" method of the Import File controller is called which in turn calls the "import_from_hash" method of the same controller. "import" method collects the errors which might be encountered during the import process and displays it to the user.
* In the "import_from_hash" method, each row of the multidimensional array (body) is converted from into a hash. Following is an example of such a converted hash -
<pre>
[ { :name => 'ppatel16',
:fullname => 'Pushpendra Patel',
:email => 'ppatel16@ncsu.edu' },
{ :name => 'tkothar',
:fullname => 'Tanay Kothari',
:email => 'tkothar@ncsu.edu' },
{ :name => 'tmdement',
:fullname => 'Timothy Dement',
:email => 'tmdement@ncsu.edu } ]
</pre>
* This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

= 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''

= 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-11-02T18:27:20Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, such that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<span style="color:red;"><big>Code to show hard coded index values </big></span>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed.

<span style="color:red;"><big>Code to show hash implementation</big></span?

The import process in the previous implementation of "User" imports is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* Once the user clicks "Import" button on this view, "import" method of the Import File controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
* "import_file" converts the data from import file into a multidimensional array in which each row represents a row from the import file. Following is an example -
<pre>
[ 'name','fullname','email ]
[ 'ppatel16','Pushpendra Patel','ppatel@ncsu.edu' ]
[ 'tkothar','Tanay Kothari','tkothar@ncsu.edu' ]
[ 'tmdement','Timothy Dement','tmdement@ncsu.edu' ]
</pre>

*This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

<br>
Import process of "Users" using our implementation is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* When user submits the options to import, the file is parsed row-by-row. It is divided into a "header" which contains the column names and a "body" which contains all the data to be imported in form of a multi-dimensional array.
* "show" action of the Import File controller is called and user is redirected to "show" view the same controller. On this view user can use drop downs to select which field of the import data is which.
* Once the user clicks "Import" button on the "show" view, "import" method of the Import File controller is called which in turn calls the "import_from_hash" method of the same controller. "import" method collects the errors which might be encountered during the import process and displays it to the user.
* In the "import_from_hash" method, each row of the multidimensional array (body) is converted from into a hash. Following is an example of such a converted hash -
<pre>
[ { :name => 'ppatel16',
:fullname => 'Pushpendra Patel',
:email => 'ppatel16@ncsu.edu' },
{ :name => 'tkothar',
:fullname => 'Tanay Kothari',
:email => 'tkothar@ncsu.edu' },
{ :name => 'tmdement',
:fullname => 'Timothy Dement',
:email => 'tmdement@ncsu.edu } ]
</pre>
* This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

= 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''

= 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-11-02T18:26:23Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, such that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<span style="color:red;"><big>Code to show hard coded index values </big></span>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed.

<span style="color:red;"><big>Code to show hash implementation</big></span?

The import process in the previous implementation of "User" imports is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* Once the user clicks "Import" button on this view, "import" method of the Import File controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
* "import_file" converts the data from import file into a multidimensional array in which each row represents a row from the import file. Following is an example -
<pre>
[ 'name','fullname','email ]
[ 'ppatel16','Pushpendra Patel','ppatel@ncsu.edu' ]
[ 'tkothar','Tanay Kothari','tkothar@ncsu.edu' ]
[ 'tmdement','Timothy Dement','tmdement@ncsu.edu' ]
</pre>

*This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

<br>
Import process of "Users" using our implementation is as follows -
* User initiates import process via links for importing files on different views for different models.
* User is redirected to "start" view of Import File controller.
* User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
* When user submits the options to import, the file is parsed row-by-row. It is divided into a "header" which contains the column names and a "body" which contains all the data to be imported in form of a multi-dimensional array.
* "show" action of the Import File controller is called and user is redirected to "show" view the same controller. On this view user can use drop downs to select which field of the import data is which.
* Once the user clicks "Import" button on the "show" view, "import" method of the Import File controller is called which in turn calls the "import_from_hash" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
* In the "import_from_hash" method, each row of the multidimensional array (body) is converted from into a hash. Following is an example of such a converted hash -
<pre>
[ { :name => 'ppatel16',
:fullname => 'Pushpendra Patel',
:email => 'ppatel16@ncsu.edu' },
{ :name => 'tkothar',
:fullname => 'Tanay Kothari',
:email => 'tkothar@ncsu.edu' },
{ :name => 'tmdement',
:fullname => 'Timothy Dement',
:email => 'tmdement@ncsu.edu } ]
</pre>
* This method now checks which model is to be used to import the data and calls "import" method of the respective models.
* "import" method of respective model performs the import based on hard coded order of columns.

= 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''

= 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-11-02T17:53:35Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, such that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<span style="color:red;"><big>Code to show hard coded index values </big></span>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed.

<span style="color:red;"><big>Code to show hash implementation</big></span?

The import process in the previous implementation is as follows -
# User initiates import process via links for importing files on different views for different models.
# User is redirected to "start" view of import file controller.
# User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
# "import" method of the Import File Controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
# "import_file" method checks which model is to be used to import the data and calls "import" method of the respective models.
# "import" method of respective model performs the import based on hard coded order of columns.

Import process using our implementation is as follows -
# User initiates import process via links for importing files on different views for different models.
# User is redirected to "start" view of import file controller.
# User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.

= 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''

= 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-11-02T17:51:37Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, such that user is able to easily specify the order of columns using drop down menus.

<span style="color:red;"><big> Here is view used for the previous implementation of the User Imports - </big></span>

<span style="color:red;"><big> Here is the view with our implementation of the User Imports - </big></span>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<span style="color:red;"><big>Code to show hard coded index values </big></span>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed.

<span style="color:red;"><big>Code to show hash implementation</big></span?

The import process in the previous implementation is as follows -
1. User initiates import process via links for importing files on different views for different models.
2. User is redirected to "start" view of import file controller.
3. User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
4. "import" method of the Import File Controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
5. "import_file" method checks which model is to be used to import the data and calls "import" method of the respective models.
6. "import" method of respective model performs the import based on hard coded order of columns.

Import process using our implementation is as follows -
1. User initiates import process via links for importing files on different views for different models.
2. User is redirected to "start" view of import file controller.
3. User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.

= 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''

= 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-11-02T17:50:17Z

Tkothar: /* Plan of Work and Implementation Process */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, such that user is able to easily specify the order of columns using drop down menus.

<big> Here is view used for the previous implementation of the User Imports - </big>

<big> Here is the view with our implementation of the User Imports - </big>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<big>Code to show hard coded index values </big>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed.

<big>Code to show hash implementation</big>

The import process in the previous implementation is as follows -
1. User initiates import process via links for importing files on different views for different models.
2. User is redirected to "start" view of import file controller.
3. User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
4. "import" method of the Import File Controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
5. "import_file" method checks which model is to be used to import the data and calls "import" method of the respective models.
6. "import" method of respective model performs the import based on hard coded order of columns.

Import process using our implementation is as follows -
1. User initiates import process via links for importing files on different views for different models.
2. User is redirected to "start" view of import file controller.
3. User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.

= 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''

= 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-11-02T17:49:59Z

Tkothar: /* Added Features */

<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 an open-source web application devloped on the Ruby on Rails platform that helps students to create reusable learning objects through peer review, and also supports document submission and team projects.

Expertiza includes several variations of import functionality, and 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 reviewers (reviewing contributors to assignments).
* A list of meta-reviewers (reviewing reviewers).


These imports are done by uploading a file containing rows of data, with each individual value of a row separated by a given delimiter.

Expertiza allows four specifications for delimiters:

# Comma
# Space
# Tab
# Other (any custom delimiter provided by the user as text)

All of these import functions are routed through the Import File Controller, which is responsible for parsing file data and delegating the import process to the appropriate model.

=== 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], detailed on the Expertiza Github. A significant problem with the existing import functions is that they are not implemented consistently, and there are rigid restrictions placed on how the columns should be ordered in the given import files. In the current implementation, rows are taken is arrays, with the column numbers of specific fields hard-coded into the helper methods for different imports. The aim of this project is to improve the import functionality as well as provide a flexible and user-friendly interface so that users can easily and reliably take advantage of Expertiza's various import functions.

=== Solution ===

To resolve this issue, we have enhanced the interface and the import process, keeping the core methods of import intact, but expanding its functionality to increase its reliability, robustness, and ease-of-use. In the new interface, the system will display what will be imported in an easy-to-read grid before the import is finalized, letting the user verify the correctness of the data and, if necessary, choose from a dropdown menu which columns need to be rearranged. 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.

In our implementation of the import method, we have made the use of hash data structure. During the import process, we create an array of hashes, in which each row of the array corresponds to a row of the original import file. In each hash, keys refer to the field name, and values refer to the actual value of that field that will be saved to the database. This greatly improved the flexibility of the import process, since the order of the data in the import files is no longer required to be in one specific order only.

= Test Plan and Demonstrations =

=== User Import ===

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

This video demonstrates the enhanced import features for the User model with several varying examples, and also demonstrates that the original error messaging system is preserved with our new implementation.

=== Assigment Participant and Course Participant Import ===

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

This video demonstrates the enhanced import features for the Assignment Participant and Course Participant models with several varying examples.

=== Assignment Team and Course Team Import ===

[https://youtu.be/JFX4VZItSyQ Team Import Demo]

This video demonstrates the enhanced import features for the Assignment Team and Course Team models with several varying examples.

=== Reviewer and Meta-reviewer Import ===

[https://youtu.be/01XV12nygLE Review Import Demo]

This video demonstrates the enhanced import features for the Review Response Map and Metareview Response Map models with several varying examples.



= Plan of Work and Implementation Process =

In this project we have tried to make the import process more flexible. As stated in the previous section, in the old implementation, user had to import the files with restriction to the order of columns required. We tried to make this process flexible for the user, such that user is able to easily specify the order of columns using drop down menus.

<big> Here is view used for the previous implementation of the User Imports - <big>

<big> Here is the view with our implementation of the User Imports - <big>

On the code side of imports, we have improved the implementation significantly. Previously, the import process used hard coded index values to retrieve specific columns from the import file -

<big>Code to show hard coded index values </big>

This was the reason why columns were needed to be in a restricted order. But in our approach, we divide the rows of data provided in import files into hashes. Accessing data from hashes is flexible as we just need the keys to access certain values which we specify during our import process and thus we know ,before hand, what key to use to access a specific value whenever needed.

<big>Code to show hash implementation</big>

The import process in the previous implementation is as follows -
1. User initiates import process via links for importing files on different views for different models.
2. User is redirected to "start" view of import file controller.
3. User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.
4. "import" method of the Import File Controller is called which in turn calls the "import_file" method of the same controller. "import" method collects the error which might be encountered during the import process and displays it to the user.
5. "import_file" method checks which model is to be used to import the data and calls "import" method of the respective models.
6. "import" method of respective model performs the import based on hard coded order of columns.

Import process using our implementation is as follows -
1. User initiates import process via links for importing files on different views for different models.
2. User is redirected to "start" view of import file controller.
3. User uploads the file containing data to be imported. User also modifies the options used for import on the "start" view.

= 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''

= 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-28T03:50:41Z

Tkothar: /* Demonstrations */

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T03:49:29Z

Tkothar: /* Solution */

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T03:39:48Z

Tkothar: /* Topic Description */

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T03:13:10Z

Tkothar: /* Models */

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T03:10:46Z

Tkothar: /* Topic Description */

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T03:09:51Z

Tkothar:

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T03:05:09Z

Tkothar: /* Topic Description */

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T03:00:57Z

Tkothar: /* Topic Description */

CSC/ECE 517 Fall 2017/E1776 Enhance Imports

2017-10-28T01:41:21Z

Tkothar: /* Topic Description */ Added

MainPage

2017-10-27T18:37:44Z

Tkothar: Reverting Homepage Edits - I believe this was a mistake done by some student who, instead of the OSS project page of his team, modified the homepage itself. I am reverting back the changes till the time when the page was correctly written.

==Expertiza==
* [[Expertiza documentation]]

==Course-Specific Topics==

* [[CSC/ECE 517 Summer 2008]]
* [[CSC/ECE 517 Fall 2010]]
* [[CSC/ECE 517 Fall 2011]]
* [[CSC/ECE 517 Fall 2012]]
* [[CSC/ECE 517 Fall 2013]]
* [[CSC/ECE 517 Fall 2014]]
* [[CSC/ECE 517 Fall 2015]]
* [[CSC/ECE 517 Fall 2016]]
* [[CSC/ECE 517 Spring 2014]]
* [[CSC/ECE 517 Spring 2015]]
* [[CSC/ECE 517 Spring 2016]]
* [[CSC/ECE 517 Spring 2017]]
* [[CSC/ECE 517 Fall 2017]]
* [[CSC 456 Spring 2011|CSC 456 Spring 2012]]
* [[ECE 633]]
* [[KCU]]
* [[Progress reports]]

==Application Behavior==
* [[Grading]]

==Metaprogramming==
* [[CSC/ECE_517_Spring_2013/ch1b_1k_hf|Lecture on Metaprogramming]]

==Development==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]

==Production==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

==Testing==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==References==
* [[Object-Oriented Design and Programming]]