Adding instructor dashboard documentation for student and grade download data.

docs/en_us/course_authors/source/change_log.rst

@@ -5,8 +5,6 @@ Change Log
 **********
 
 
-
-
 .. list-table::
    :widths: 10 80
    :header-rows: 1
@@ -14,50 +12,56 @@ Change Log
    * - Date
      - Change
    * - 02/04/14
-     - Added :ref:`Additional Tools` topic with :ref:`Multiple Choice and Numerical Input` and :ref:`Protein Builder`
+     - Added the :ref:`Student Data` and :ref:`Grades` chapters.
+   * - 
+     - Added :ref:`Additional Tools` topic with :ref:`Multiple Choice and Numerical Input` and :ref:`Protein Builder`.
    * - 01/29/2014
      - Added the chapter :ref:`Using an Instant Hangout in Your Course`.
-   * - 01/21/2014
+   * - 01/24/2014
+     - Added the :ref:`Discussions` and :ref:`Guidance for Discussion Moderators` chapters.
+   * - 
      - Added more detailed instructions to :ref:`Zooming image`
+   * - 01/21/2014
+     - Added information about accessibility in the topic :ref:`Add Textbooks`.
    * - 01/14/2014
-     - Added info about scoring (:ref:`Access Scores`) and due dates in :ref:`Open Response Assessment Problems`
+     - Added info about scoring (:ref:`Access Scores`) and due dates in :ref:`Open Response Assessment Problems`.
    * - 01/13/2014
-     - Extensive updates to :ref:`Organizing Your Course Content` and :ref:`Working with HTML Components`
+     - Extensive updates to :ref:`Organizing Your Course Content` and :ref:`Working with HTML Components`.
    * - 01/08/2014
      - Updated :ref:`Add Files to a Course` to reflect addition of sorting to the **Files & Uploads** page.
    * - 
      - Updated :ref:`Set Important Dates for Your Course` to reflect change to default course start date to 2029.
    * - 01/07/2014
-     - Updated :ref:`Text Input` with info about multiple strings
+     - Updated :ref:`Text Input` with info about multiple strings.
    * - 
-     - Added info about template to :ref:`Checkbox`
+     - Added info about template to :ref:`Checkbox`.
    * - 01/06/2014
      - Created :ref:`Custom JavaScript Display and Grading`
    * - 01/06/2014
      - Created :ref:`Zooming image`
    * - 01/01/2014
-     - Updated the chapters :ref:`Organizing Your Course Content` and :ref:`Testing Your Course` to reflect changes in the Course Outline design
+     - Updated the chapters :ref:`Organizing Your Course Content` and :ref:`Testing Your Course` to reflect changes in the Course Outline design.
    * - 
-     - Updated the topic :ref:`Add Files to a Course` to reflect addition of pagination to the Files & Uploads page
+     - Updated the topic :ref:`Add Files to a Course` to reflect addition of pagination to the Files & Uploads page.
    * - 12/20/2013
-     - Made :ref:`ORA for Students` into template that instructors can customize
+     - Made :ref:`ORA for Students` into template that instructors can customize.
    * - 12/19/2013
-     - Created :ref:`Tools`
+     - Created :ref:`Tools`.
    * - 12/18/2013
-     - Updated documentation about video player options in :ref:`Working with Video Components`
+     - Updated documentation about video player options in :ref:`Working with Video Components`.
    * - 12/13/2013
-     - Created :ref:`LTI Component`
+     - Created :ref:`LTI Component`.
    * - 
-     - Created :ref:`ORA for Students`
+     - Created :ref:`ORA for Students`.
    * - 12/12/2013
-     - Added the edX :ref:`Glossary`
+     - Added the edX :ref:`Glossary`.
    * - 12/11/2013
-     - Added the chapter :ref:`Guidelines for Creating Accessible Content`
+     - Added the chapter :ref:`Guidelines for Creating Accessible Content`.
    * - 12/10/2013
-     - Added note about number of responses in "Available to Grade" column in :ref:`Open Response Assessment Problems`
+     - Added note about number of responses in "Available to Grade" column in :ref:`Open Response Assessment Problems`.
    * - 
-     - Added :ref:`MathJax in Studio`
+     - Added :ref:`MathJax in Studio`.
    * - 12/09/2013
-     - Created :ref:`MathJax in Studio`
+     - Created :ref:`MathJax in Studio`.
    * - 12/05/2013
-     - Complete revision of edX Studio documentation and integration of edX101 content
+     - Complete revision of edX Studio documentation and integration of edX101 content.

docs/en_us/course_authors/source/course_data.rst

+.. _Course Data:
+
+############################
+Course Data
+############################
+
+After you create a course, you can access information about it from the Instructor Dashboard. 
+
+To view course data:
+
+#. View the live version of your course.
+
+#. Click **Instructor** then **Try New Beta Dashboard**.
+
+#. Click **Course Info** if necessary. 
+   The page that displays shows the number of students who are currently enrolled, which includes all of the staff members you have defined for the course. It also lists identifying information for the course, indicates whether it has started or ended, and the the defined cutoff for a passing grade.
+
+You also use the Instructor Dashboard to set up the staff for your course, enroll and get information about students, and initiate and review grading.

docs/en_us/course_authors/source/course_enrollment.rst

+##########################
+Enrollment
+##########################
\ No newline at end of file

docs/en_us/course_authors/source/course_grades.rst

+.. _Grades:
+
+############################
+Grades
+############################
+
+You can review information about how grading is configured for your course, and generate student grades, at any time after you create the course. You can also make adjustments to how a problem is graded, for a single student or all students.
+
+For information about the grading data you can access and the changes you can make, see the following topics:
+
+* :ref:`Review_grades`
+
+* :ref:`Access_grades`
+
+* :ref:`Adjust_grades`
+
+For information about how you establish a grading policy and work with the problem components in your course, see :ref:`Establish a Grading Policy` or :ref:`Working with Problem Components`.
+
+**Important**: If you make changes to your grading policy or problem components after a course starts, students can see the effect of your changes on their Progress pages. Be sure to announce any changes on your Course Info page.
+
+.. _Review_grades:
+
+********************************************************
+Review how grading is configured for your course
+********************************************************
+
+You can review the assignment types that are graded and their respective weights on the Instructor Dashboard.
+
+You establish a grading policy for your course when you create it in Studio. While the course is running, you can view an XML representation of the assignment types in your course and how they are weighted to determine students' grades.
+
+#. View the live version of your course.
+
+#. Click **Instructor** > **Try New Beta Dashboard**.
+
+#. Click **Data Download** > **Grading Configuration**.
+
+   A list of the assignment types in your course displays. In this example, Homework is weighted as 60% of the grade. 
+
+   .. image:: Images/Grading_Configuration.png
+     :alt: XML of course assignment types and weights for grading
+
+   In Studio, you define this information by selecting **Settings** > **Grading**.
+
+   .. image:: Images/Grading_Configuration_Studio.png
+     :alt: Studio example of homework assignment type and grading weight
+     :height:283
+     :width:613
+
+For more information, see :ref:`configure`.
+
+
+.. _Access_grades:
+
+********************************************************
+Access student grades
+********************************************************
+
+You can generate and review your students' grades at any time during your course. You can generate grades for all currently enrolled students, or check the progress of a single student, who can be enrolled or unenrolled.
+
+=========================================================
+Generate grades for enrolled students
+=========================================================
+
+When you initiate calculations to grade student work, a process starts on the edX servers. The complexity of your grading configuration and the number of students enrolled in your course affect how long this process takes. You can download the calculated grades in a CSV (comma-separated values) file when the grading process is complete. You cannot view student grades on the Instructor Dashboard. 
+
+To generate grades for the students who are currently enrolled in your course:
+
+#. View the live version of your course.
+
+#. Click **Instructor** > **Try New Beta Dashboard**.
+
+#. Click **Data Download**.
+
+#. To start the grading process, click **Generate Grade Report**.
+
+A status message indicates that the grading process is in progress. This process can take some time to complete, but you can navigate away from this page and do other work while it runs.
+
+When the file is ready for download, a link to the CSV file displays at the bottom of this page.
+
+==========================================
+Download grades for enrolled students
+==========================================
+
+After you request a grade report for your students, the result is a time-stamped CSV file that includes columns to identify each student: id, email, and username. It also includes a column for every assignment that is included in your grading configuration: each homework, lab, midterm, final, and any other assignment type you added to your course. 
+
+To download a file of student grades:
+
+#. View the live version of your course.
+
+#. Click **Instructor** > **Try New Beta Dashboard**.
+
+#. Click **Data Download**.
+
+#. To open or save a grade report file, click the *course_id* \_grade_report_\ *date*.csv file name at the bottom of the page.
+
+**Note**: To prevent the accidental distribution of student data, you can only download these files by clicking the links on this page. You cannot copy a link and save it or email it, as the value for the link that you copy expires within five minutes.
+
+=========================================================
+Check the progress of a single student
+=========================================================
+
+For a single student, you can review a chart that plots the grade earned for every graded assignment, and the overall total, as of the current date. You identify the student by supplying either an email address or username. 
+
+Students can view a similar chart (of their own progress only) when they are logged in to the course.
+
+To view current grades for a student:
+
+#. View the live version of your course.
+
+#. Click **Instructor** > **Try New Beta Dashboard**.
+
+#. Click **Student Admin**.
+
+#. In the Student-Specific Grade Inspection section, enter the student's email address or username.
+
+#. Click **Student Progress Page**.
+
+The Course Progress page for the student displays a chart with the grade for each homework, lab, midterm, final, and any other assignment types in your course, and the total grade earned for the course to date. 
+
+   .. image:: Images/Student_Progress.png
+     :alt: A bar chart from a student's Progress page showing grade acheived for each assignment
+
+=========================================================
+Check a student's submission and submission history
+=========================================================
+
+For a single student and problem, you can review the exact response submitted, the number of attempts made, and the date and time of the submission. You identify the student by supplying a username. 
+
+To review a response submitted by a student:
+
+#. View the live version of your course.
+
+#. Click **Courseware** and navigate to the component that contains the problem you want to review.
+
+#. Display the problem then click **Submission history** at the end of the page.
+
+#. Enter the username for the student whose work you want to review and click **View History** at the end of the page.
+
+Information about the response or responses provided by the student displays. 
+
+To close the Submission History Viewer, click on the browser page outside of the viewer.
+
+===================================================
+View a histogram of scores for a problem
+===================================================
+
+You can view a chart of the score distribution for a specified problem.
+
+**Note**: In order to view the score distribution for a problem, you need its unique identifier. See :ref:`find_URL`.
+
+To display demographic distributions for gender and educational attainment:
+
+#. View the live version of your course.
+
+#. Click **Instructor** > **Try New Beta Dashboard**.
+
+#. Click **Analytics**. 
+
+#. In the Grade Distribution section, select a problem by using its URL. 
+
+   A graph displays a histogram of scores for that problem.
+
+..  **Question**: (sent to Olga 31 Jan 14) this is a tough UI to use: how do they correlate the codes in this drop-down with actual constructed problems? the copy-and-paste UI on the Student Admin page actually works a little better imo.
+.. **Question**: I'd like to include an image, but need a good example. Elina suggested using the edX demo course (I don't have access), and a problem that has multiple possible answers
+
+.. _Adjust_grades:
+
+***********************************
+Adjust grades
+***********************************
+
+You can adjust grades for one student at a time, or for all of the enrolled students in the course. For example, your course beta testers can evaluate numerous different correct and incorrect responses to verify that your course is set up as you intend. Students can also report problems while a course is running. 
+
+When an error is discovered or corrected, or if you modify a problem after students or beta testers have attempted to answer it, you can either:
+
+* Rescore the submitted answers to reevaluate the work.
+
+* Reset the number of attempts made to answer the question correctly so that students can try again.
+
+To make these adjustments, you need to specify a problem by supplying the unique identifier from its URL.
+
+.. _find_URL:
+
+==================================================
+Find the URL for a problem
+==================================================
+
+When you create each of the problems for a course, edX assigns a unique identifier. To make grading adjustments for a problem, or to view data about it, you need to specify this identifier.
+
+To find the unique identifier in the URL for a problem:
+
+#. View the live version of your course.
+
+#. Click **Courseware** and navigate to the component that contains the problem you want to review.
+
+#. Display the problem, and click **Staff Debug Info**.
+
+   Information about the problem displays, including its location or URL. This URL ends with the type of module, which is typically "problem", and the unique identifier. 
+
+   .. image:: Images/Problem_URL.png
+    :alt: The Staff Debug view of a problem with the unique identifier indicated at the end of a URL address
+
+
+#. To copy the identifier that is assigned to the problem, select it, right click, and choose **Copy**.
+
+   **Note**: If the URL does not include "problem/" before the identifer, you will need to specify that module identifier as well. Select and copy both the module identifer and the problem identifier.
+
+   To close the Staff Debug viewer, click on the browser page outside of the viewer.
+
+===================================================
+Rescore student submissions
+===================================================
+
+Each problem that you define for your course includes a correct answer, and may also include a tolerance or acceptable alternatives. If you decide to make a change to these values, you can recore any responses that were already submitted. For a specified problem, you can rescore the work submitted by a single student, or rescore the submissions made by every enrolled student. 
+
+**Note:** You can only rescore problems that have a correct answer entered in edX Studio. Problems that are scored by an external grader cannot be rescored with this procedure.
+
+In order to rescore a problem, you need its unique identifier. See :ref:`find_URL`.
+
+To rescore a problem:
+
+#. View the live version of your course.
+
+#. Click **Instructor** > **Try New Beta Dashboard**.
+
+#. Click **Student Admin**. 
+
+#. To recore a problem for one student, you work in the Student-Specific Grade Adjustment section of the page. Enter the student's email address or username and the problem URL then click **Rescore Student Submission**.
+
+#. To rescore a problem for all enrolled students, you work in the Course-Specific Grade Adjustment section of the page. Enter the problem URL then click **Rescore ALL students' problem submissions**. 
+
+#. A dialog opens to indicate that the rescore process is in progress. Click **OK**. 
+
+   This process does not take long for a single student, but can take some time to complete for all enrolled students. The process runs in the background, so you can navigate away from this page and do other work while it runs.
+
+#. To view the results of the rescore process, click either **Show Background Task History for Student** or **Show Background Task History for Problem**.
+
+   A table displays the status of the rescore process for each student or problem.
+
+===================================================
+Reset student attempts
+===================================================
+
+When you create a problem, you can limit the number of times that a student can try to answer that problem correctly. If unexpected issues occur for a problem, you can reset the value for one particular student's attempts back to zero so that the student can begin work over again. If the unexpected behavior affects all of the students in your course, you can reset the number of attempts for all students to zero. 
+
+For more information about modifying a released problem, including other workarounds, see :ref:`Modifying a Released Problem`.
+
+**Note**: In order to reset the number of attempts for a problem, you need its unique identifier. See :ref:`find_URL`.
+
+To reset student attempts for a problem:
+
+#. View the live version of your course.
+
+#. Click **Instructor** > **Try New Beta Dashboard**.
+
+#. Click **Student Admin**. 
+
+#. To reset the number of attempts for one student, you work in the Student-Specific Grade Adjustment section of the page. Enter the student's email address or username and the problem URL then click **Reset Student Attempts**.
+
+#. To reset the number of attempts for all enrolled students, you work in the Course-Specific Grade Adjustment section of the page. Enter the problem URL then click **Reset ALL students' attempts**. 
+
+#. A dialog opens to indicate that the reset process is in progress. Click **OK**. 
+
+   This process does not take long for a single student, but can take some time to complete for all enrolled students. The process runs in the background, so you can navigate away from this page and do other work while it runs.
+
+#. To view the results of the reset process, click either **Show Background Task History for Student** or **Show Background Task History for Problem**.
+
+   A table displays the status of the reset process for each student or problem.
+

docs/en_us/course_authors/source/course_staffing.rst

+##########################
+Staffing
+##########################
+
+
+
+* 
+
+* 
+
+
+
+You can also designate a team of people to help you moderate discussions. For more information, see :ref:``. 
+
+**********************
+Staff roles
+**********************
+
+
+
+
+* Course Staff . Discussion responses and comments made by course staff are marked as "Staff".
+
+* Instructors
+
+* Beta Testers
+
+
+**********************
+
+**********************
+
+To :
+
+#. View the live version of your course.
+
+#. Click **Instructor** then **Try New Beta Dashboard**.
+
+#. Click **Membership**.
+
+#. In the Administration List Management section, select 
\ No newline at end of file

docs/en_us/course_authors/source/course_student.rst

+.. _Student Data:
+
+############################
+Student Data
+############################
+
+You can access data about the students who are enrolled in your course at any time after you create the course. 
+
+For information about the data you can access, see the following topics:
+
+* :ref:`PII`
+
+* :ref:`Access_student_data`
+
+* :ref:`Access_anonymized`
+
+You can also view charts of certain student demographics for graded problems. See :ref:`Grades`. 
+
+.. _PII:
+
+***************************************************************
+Guidance for working with personal information
+***************************************************************
+
+The information that edX collects from site registrants includes personal information that can be used to identify, contact, and locate individuals. This information is available to course authors for the students who are enrolled in their courses. 
+
+Course authors should follow the policies established by their organizations and comply with the legal requirements of their locales to prevent public distribution or misuse of this information. 
+
+.. **Question**: I just made this statement up. What guidance can/should we give, for immediate publication and in the future? (sent to Tena and Jennifer Adams 31 Jan 14)
+
+.. _Access_student_data:
+
+****************************
+Access student data
+****************************
+
+You can view data about the students who are currently enrolled in your course. Data for enrolled students is also available for download in CSV (comma-separated values) format.  
+
+======================
+Student-reported data
+======================
+
+When students register with edX, they select a public username and supply information about themselves. Most of this information is optional, so not all of the students who are enrolled in your course provide it.
+
+ .. image:: Images/Registration_page.png
+   :alt: Fields that collect student information during registration
+
+Students then register for as many individual courses as they choose, which enrolls them in each selected course. 
+
+You can access this self-reported information for all of the students who are enrolled in your course:
+
+* username
+* name
+* email
+* year_of_birth
+* gender
+* level_of_education
+* mailing_address
+* goals
+
+The student data that is available to course staff always reflects the set of live, current enrollments. Students can register for your course throughout the defined enrollment period, and they can unregister from a course at any time, which unenrolls them. Students can also change their email addresses and full names at any time. As a result, you may want to download student data periodically to gain insights into how the student population changes over time. 
+
+==========================================
+View and download student data
+==========================================
+
+You can view and download student data to learn about population demographics at a specific point in time, compare demographics at different points in time, and plot trends in the population over time.
+
+**Important**: Do not navigate away from this page while you wait for the data to be prepared. The larger the enrollment for your course, the longer it takes to create and output the data. 
+
+To view or download student data:
+
+#. View the live version of your course.
+
+#. Click **Instructor** then **Try New Beta Dashboard**.
+
+#. Click **Data Download**.
+
+#. To display student enrollment data, click **List enrolled students' profile information**.
+
+   A table of the student data displays, with one row for each enrolled student. Longer values, such as student goals, are truncated.
+
+ .. image:: Images/StudentData_Table.png
+    :alt: Table with columns for the collected data points and rows for each student on the Instructor Dashboard
+
+   **Note**:: In the future, edX may also request that students select a language and location. This data is not collected at this time.
+
+5. To download student enrollment data in a CSV file, click **Download profile information as a CSV**.
+
+   You are prompted to open or save the enrolled_profiles.csv file. All student-supplied data is included without truncation.
+
+**Note**: In addition to the data for enrolled students, data for the course staff is included in the display or file.
+
+==========================================
+View demographic distributions
+==========================================
+
+You can view a course-wide summary of certain demographic distributions for your currently enrolled students. The total count for each value reported for gender and educational attainment displays on the Instructor Dashboard. Because this data is optional, the totals for each of these self-reported values are likely to be lower than your course enrollment total. You can also view a chart with the ages of all currently enrolled students.
+
+To display demographic data for your students:
+
+#. View the live version of your course.
+
+#. Click **Instructor** then **Try New Beta Dashboard**.
+
+#. Click **Analytics**. 
+
+   * The Year of Birth section displays a chart of enrolled students plotted by year of birth.
+
+   * The Gender Distribution and Level of Education sections show tables with counts of responses made by enrolled students.
+
+   .. image:: Images/Distribution_Education.png
+    :alt: Table with columns for different possible values for gender and total count reported for each value
+
+   .. image:: Images/Distribution_Gender.png
+    :alt: Table with columns for different possible values for level of education completed and total count reported for each value
+
+    "No Data" is the sum of the students for whom no value exists for the demographic. 
+
+  Data for individual students is not shown, and you cannot download data directly from this page. See :ref:`View and download student data`.
+
+
+.. _Access_anonymized:
+
+********************************
+Access anonymized student IDs
+********************************
+
+Some of the tools that are available for use with the edX platform, including external graders and surveys, work with anonymized student data. If it becomes necessary for you to deanonymize previously anonymized data, you can download a CSV file to use for that purpose.
+
+To download a file of assigned user IDs and anonymized user IDs:
+
+#. View the live version of your course.
+
+#. Click **Instructor** > **Try New Beta Dashboard**.
+
+#. Click **Data Download** > **Get Student Anonymized IDs CSV**.
+
+You are prompted to open or save the (course-id)-anon-id.csv file for your course. This file contains the user ID that is assigned to each student at registration and its corresponding anonymized ID. Values are included for every student who ever enrolled for your course. 
+
+You can use the data in this file together with the data in the enrolled_profile.csv file of student data and in a *course_id* \_grade_report_\ *date*.csv file for your course to research and deanonymize student data.
+
+
+

docs/en_us/course_authors/source/index.rst

@@ -37,6 +37,8 @@ Contents
    ora_students
    discussions
    discussion_guidance_moderators
+   course_student
+   course_grades
    glossary