Merge pull request #326 from edx/carol/docs/EventsProbGradeReport

Add instructor report events to Researcher Guide
openedx · May 18, 2015 · b0fadac · b0fadac
2 parents 6da7390 + d1fde5e
commit b0fadac
Show file tree

Hide file tree

Showing 3 changed files with 101 additions and 19 deletions.
diff --git a/en_us/data/source/front_matter/change_log.rst b/en_us/data/source/front_matter/change_log.rst
@@ -4,8 +4,9 @@
 Change Log
 ###########
 
+
 **********************
-January-March 2015
+April-June 2015
 **********************
 
 .. list-table::
@@ -14,6 +15,9 @@ January-March 2015
 
    * - Date
      - Change
+   * - 19 May 15
+     - Added information about new instructor report events to the
+       :ref:`Tracking Logs` chapter.
    * - 11 May 2015 
      - Updated the descriptions of the ``pause_video``, ``play_video``, and
        ``stop_video`` :ref:`video interaction events<video>` to include the
@@ -25,6 +29,18 @@ January-March 2015
    * - 6 Apr 15
      - Added a section to describe the
        :ref:`course structure<course_structure>` file.
+
+
+**********************
+January-March 2015
+**********************
+
+.. list-table::
+   :widths: 20 70
+   :header-rows: 1
+
+   * - Date
+     - Change
    * - 18 Mar 2015
      - Added information about library events for students to the
        :ref:`Tracking Logs` chapter.

diff --git a/en_us/data/source/internal_data_formats/event_list.rst b/en_us/data/source/internal_data_formats/event_list.rst
@@ -78,6 +78,10 @@ Alphabetical Event List
      - :ref:`content`
    * - ``edx.googlecomponent.document.displayed``
      - :ref:`content`
+   * - ``edx.instructor.report.downloaded``
+     - :ref:`Instructor_Event_Types`
+   * - ``edx.instructor.report.requested``
+     - :ref:`Instructor_Event_Types`
    * - ``edx.video.loaded``
      - :ref:`video`, see ``load_video``
    * - ``edx.video.paused``

diff --git a/en_us/data/source/internal_data_formats/tracking_logs.rst b/en_us/data/source/internal_data_formats/tracking_logs.rst
@@ -3626,12 +3626,13 @@ that are common to all events. See :ref:`common`.
 * ``list-staff``
 * ``list-students``
 
-.. _rescore_all:
 
 ======================================================
-``rescore-all-submissions`` and ``reset-all-attempts``
+``add_instructor`` and ``remove_instructor`` 
 ======================================================
 
+.. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined
+
 **Component**: Instructor Dashboard
 
 **Event Source**: Server
@@ -3644,11 +3645,10 @@ that are common to all events. See :ref:`common`.
 
    * - Field
      - Type
-   * - ``course``
-     - string
-   * - ``problem`` 
+   * - ``instructor``
      - string
 
+
 .. _rescore_student:
 
 ===================================================================
@@ -3676,32 +3676,60 @@ that are common to all events. See :ref:`common`.
    * - ``student``
      - string
 
-.. _reset_attempts:
 
 ======================================================
-``reset-student-attempts``
+``edx.instructor.report.downloaded`` 
 ======================================================
 
+The browser emits an  ``edx.instructor.report.downloaded`` event when the user
+clicks a report link on the instructor dashboard to download a report.
+
+**History**: Added 8 May 2015.
+
 **Component**: Instructor Dashboard
 
-**Event Source**: Server
+**Event Source**: Browser
 
 ``event`` **Member Fields**: 
 
 .. list-table::
-   :widths: 40 40
+   :widths: 20 20 40
    :header-rows: 1
 
    * - Field
      - Type
-   * - ``course``
-     - string
-   * - ``old_attempts``
+     - Details
+   * - ``report_url``
      - string
-   * - ``problem``
-     - string 
-   * - ``student``
+     - The URL to the report file.  
+
+
+======================================================
+``edx.instructor.report.requested`` 
+======================================================
+
+The server emits an  ``edx.instructor.report.requested`` event when the user
+clicks to request the generation of a report on the instructor dashboard. 
+
+**History**: Added 8 May 2015.
+
+**Component**: Instructor Dashboard
+
+**Event Source**: Server
+
+``event`` **Member Fields**: 
+
+.. list-table::
+   :widths: 20 20 40
+   :header-rows: 1
+
+   * - Field
+     - Type
+     - Details
+   * - ``report_type``
      - string
+     - The type of report that was requested.
+
 
 .. _progress:
 
@@ -3728,11 +3756,36 @@ that are common to all events. See :ref:`common`.
    * - ``student``
      - string
 
+
+.. _rescore_all:
+
 ======================================================
-``add_instructor`` and ``remove_instructor`` 
+``rescore-all-submissions`` and ``reset-all-attempts``
 ======================================================
 
-.. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined
+**Component**: Instructor Dashboard
+
+**Event Source**: Server
+
+``event`` **Member Fields**: 
+
+.. list-table::
+   :widths: 40 40
+   :header-rows: 1
+
+   * - Field
+     - Type
+   * - ``course``
+     - string
+   * - ``problem`` 
+     - string
+
+
+.. _reset_attempts:
+
+======================================================
+``reset-student-attempts``
+======================================================
 
 **Component**: Instructor Dashboard
 
@@ -3746,9 +3799,18 @@ that are common to all events. See :ref:`common`.
 
    * - Field
      - Type
-   * - ``instructor``
+   * - ``course``
+     - string
+   * - ``old_attempts``
+     - string
+   * - ``problem``
+     - string 
+   * - ``student``
      - string
 
+
+
+
 .. _list_forum:
 
 ======================================================