Commit 41425a46 by Alison Hodges

Merge pull request #4773 from edx/ahodges/documentation/DOC804

Ahodges/documentation/doc804
parents 25963797 83f1231f
...@@ -11,6 +11,8 @@ Change Log ...@@ -11,6 +11,8 @@ Change Log
* - Date * - Date
- Change - Change
* - 08/12/14
- Added the :ref:`ora2` section to the :ref:`Tracking Logs` chapter.
* - 08/01/14 * - 08/01/14
- Added the :ref:`Package` chapter with information to help data czars - Added the :ref:`Package` chapter with information to help data czars
locate and download data package files. locate and download data package files.
...@@ -39,7 +41,9 @@ Change Log ...@@ -39,7 +41,9 @@ Change Log
* - 05/06/14 * - 05/06/14
- Added enrollment event types to the :ref:`Tracking Logs` chapter. - Added enrollment event types to the :ref:`Tracking Logs` chapter.
* - 05/05/14 * - 05/05/14
- Removed information on the Poll module. `Polls <http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/poll.html>`_ are now covered in the *Building and Running an edX Course* guide. - Removed information on the Poll module. `Polls <http://edx.readthedocs.o
rg/projects/ca/en/latest/exercises_tools/poll.html>`_ are now covered in
the *Building and Running an edX Course* guide.
* - * -
- Removed information on the Word Cloud tool. The `Word Cloud tool <http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/word_cloud.html>`_ is now covered in the *Building and Running an edX Course* guide. - Removed information on the Word Cloud tool. The `Word Cloud tool <http://edx.readthedocs.org/projects/ca/en/latest/exercises_tools/word_cloud.html>`_ is now covered in the *Building and Running an edX Course* guide.
* - * -
......
.. _event_list: .. _event_list:
############## #######################
Event List Alphabetical Event List
############## #######################
.. list-table:: .. list-table::
:widths: 30 30 :widths: 40 40
:header-rows: 1 :header-rows: 1
* - Event * - Event
...@@ -22,8 +22,6 @@ Event List ...@@ -22,8 +22,6 @@ Event List
- :ref:`Instructor_Event_Types` - :ref:`Instructor_Event_Types`
* - ``assigned_user_to_partition`` * - ``assigned_user_to_partition``
- :ref:`AB_Event_Types` - :ref:`AB_Event_Types`
* - ``peer_grading_show_question``
- :ref:`ora`
* - ``book`` * - ``book``
- :ref:`pdf` - :ref:`pdf`
* - ``calculate_grades_csv`` * - ``calculate_grades_csv``
...@@ -32,7 +30,17 @@ Event List ...@@ -32,7 +30,17 @@ Event List
- :ref:`AB_Event_Types` - :ref:`AB_Event_Types`
* - ``delete-student-module-state`` * - ``delete-student-module-state``
- :ref:`Instructor_Event_Types` - :ref:`Instructor_Event_Types`
* - ``dump_grades`` * - ``dump-answer-dist-csv``
- :ref:`Instructor_Event_Types`
* - ``dump-graded-assignments-config``
- :ref:`Instructor_Event_Types`
* - ``dump-grades``
- :ref:`Instructor_Event_Types`
* - ``dump-grades-csv``
- :ref:`Instructor_Event_Types`
* - ``dump-grades-csv-raw``
- :ref:`Instructor_Event_Types`
* - ``dump-grades-raw``
- :ref:`Instructor_Event_Types` - :ref:`Instructor_Event_Types`
* - ``edx.course.enrollment.activated`` * - ``edx.course.enrollment.activated``
- :ref:`enrollment` and :ref:`instructor_enrollment` - :ref:`enrollment` and :ref:`instructor_enrollment`
...@@ -78,6 +86,22 @@ Event List ...@@ -78,6 +86,22 @@ Event List
- :ref:`ora` - :ref:`ora`
* - ``oe_show_respond_to_feedback`` * - ``oe_show_respond_to_feedback``
- :ref:`ora` - :ref:`ora`
* - ``openassessmentblock.get_peer_submission``
- :ref:`ora2`
* - ``openassessmentblock.peer_assess``
- :ref:`ora2`
* - ``openassessmentblock.self_assess``
- :ref:`ora2`
* - ``openassessmentblock.submit_feedback_on_assessments``
- :ref:`ora2`
* - ``openassessment.create_submission``
- :ref:`ora2`
* - ``openassessment.save_submission``
- :ref:`ora2`
* - ``openassessment.student_training_assess_example``
- :ref:`ora2`
* - ``openassessment.upload_file``
- :ref:`ora2`
* - ``page_close`` * - ``page_close``
- :ref:`navigational` - :ref:`navigational`
* - ``pause_video`` * - ``pause_video``
......
...@@ -20,7 +20,7 @@ The sections in this chapter describe: ...@@ -20,7 +20,7 @@ The sections in this chapter describe:
in the LMS. in the LMS.
Student and instructor events are grouped into categories in this chapter. For Student and instructor events are grouped into categories in this chapter. For
an alphabetical list of events, see the :ref:`event_list`. a list of events, see the :ref:`event_list`.
.. _sample_events: .. _sample_events:
...@@ -149,8 +149,8 @@ If you use a JSON formatter to "pretty print" this event, a version that is more ...@@ -149,8 +149,8 @@ If you use a JSON formatter to "pretty print" this event, a version that is more
Common Fields Common Fields
******************** ********************
This section describes the JSON fields that are common to the schema definitions This section describes the JSON fields that are common to the schema
of all events. definitions of all events.
===================== =====================
``agent`` Field ``agent`` Field
...@@ -183,8 +183,8 @@ The member fields are blank if values cannot be determined. The ``context`` ...@@ -183,8 +183,8 @@ The member fields are blank if values cannot be determined. The ``context``
field can also contain additional member fields that apply to specific events field can also contain additional member fields that apply to specific events
only: see the description for each type of event. only: see the description for each type of event.
**History**: Added 23 Oct 2013; ``user_id`` added 6 Nov 2013. Other event fields **History**: Added 23 Oct 2013; ``user_id`` added 6 Nov 2013. Other event
may duplicate this data. ``course_user_tags`` added 12 Mar 2014. fields may duplicate this data. ``course_user_tags`` added 12 Mar 2014.
=================== ===================
``event`` Field ``event`` Field
...@@ -290,15 +290,18 @@ outside the Instructor Dashboard. ...@@ -290,15 +290,18 @@ outside the Instructor Dashboard.
* :ref:`problem` * :ref:`problem`
* :ref:`ora` * :ref:`forum_events`
* :ref:`ora2`
* :ref:`AB_Event_Types` * :ref:`AB_Event_Types`
* :ref:`forum_events` * :ref:`ora`
The descriptions that follow include what each event represents, the system The descriptions that follow include what each event represents, the system
component it originates from, the history of any changes made to the event over component it originates from, the history of any changes made to the event over
time, and any additional member fields that the ``context`` and ``event`` fields contain. time, and any additional member fields that the ``context`` and ``event``
fields contain.
The value in the ``event_source`` field (see the :ref:`common` section above) The value in the ``event_source`` field (see the :ref:`common` section above)
distinguishes between events that originate in the browser (in JavaScript) and distinguishes between events that originate in the browser (in JavaScript) and
...@@ -327,8 +330,8 @@ activities completed by a student. ...@@ -327,8 +330,8 @@ activities completed by a student.
**Unregister** for the course. **Unregister** for the course.
In addition, actions by instructors and course staff members also generate In addition, actions by instructors and course staff members also generate
enrollment events. For the actions that members of the course team complete that enrollment events. For the actions that members of the course team complete
result in these events, see :ref:`instructor_enrollment`. that result in these events, see :ref:`instructor_enrollment`.
**Event Source**: Server **Event Source**: Server
...@@ -375,8 +378,8 @@ result in these events, see :ref:`instructor_enrollment`. ...@@ -375,8 +378,8 @@ result in these events, see :ref:`instructor_enrollment`.
replace the ``event`` ``event_type`` field. replace the ``event`` ``event_type`` field.
* - ``session`` * - ``session``
- string - string
- The Django session ID, if available. Can be used to identify events for a - The Django session ID, if available. Can be used to identify events for
specific user within a session. **History**: Added 07 May 2014. a specific user within a session. **History**: Added 07 May 2014.
Example Example
-------- --------
...@@ -414,8 +417,8 @@ Example ...@@ -414,8 +417,8 @@ Example
Students who enroll with a ``student_courseenrollment.mode`` of 'audit' or Students who enroll with a ``student_courseenrollment.mode`` of 'audit' or
'honor' in a course that has a verified certificate option see a **Challenge 'honor' in a course that has a verified certificate option see a **Challenge
Yourself** link for the course on their dashboards. The browser emits this event Yourself** link for the course on their dashboards. The browser emits this
when a student clicks this option, and the process of upgrading the event when a student clicks this option, and the process of upgrading the
``student_courseenrollment.mode`` for the student to 'verified' begins. See ``student_courseenrollment.mode`` for the student to 'verified' begins. See
:ref:`student_courseenrollment`. :ref:`student_courseenrollment`.
...@@ -488,8 +491,9 @@ The browser emits these events when a user selects a navigational control. ...@@ -488,8 +491,9 @@ The browser emits these events when a user selects a navigational control.
**Event Source**: Browser **Event Source**: Browser
``event`` **Member Fields**: All of the navigational events have the same fields ``event`` **Member Fields**:
in the ``event`` dict field.
All of the navigational events add the same fields to the ``event`` dict field:
.. list-table:: .. list-table::
:widths: 15 15 60 :widths: 15 15 60
...@@ -629,7 +633,8 @@ to the same value. ...@@ -629,7 +633,8 @@ to the same value.
The browser emits ``speed_change_video`` events when a user selects a different The browser emits ``speed_change_video`` events when a user selects a different
playing speed for the video. playing speed for the video.
**History**: Prior to 12 Feb 2014, this event was emitted when the user selected either the same speed or a different speed. **History**: Prior to 12 Feb 2014, this event was emitted when the user
selected either the same speed or a different speed.
``event`` **Member Fields**: ``event`` **Member Fields**:
...@@ -653,7 +658,8 @@ playing speed for the video. ...@@ -653,7 +658,8 @@ playing speed for the video.
``load_video`` ``load_video``
----------------- -----------------
The browser emits ``load_video`` events when the video is fully rendered and ready to play. The browser emits ``load_video`` events when the video is fully rendered and
ready to play.
``event`` **Member Fields**: ``event`` **Member Fields**:
...@@ -725,7 +731,8 @@ Textbook Interaction Events ...@@ -725,7 +731,8 @@ Textbook Interaction Events
``book`` ``book``
---------- ----------
The browser emits ``book`` events when a user navigates within the PDF Viewer or the PNG Viewer. The browser emits ``book`` events when a user navigates within the PDF Viewer
or the PNG Viewer.
* For textbooks in PDF format, the URL in the common ``page`` field contains * For textbooks in PDF format, the URL in the common ``page`` field contains
'/pdfbook/'. '/pdfbook/'.
...@@ -808,8 +815,8 @@ on the icon to show or hide page thumbnails. ...@@ -808,8 +815,8 @@ on the icon to show or hide page thumbnails.
``textbook.pdf.thumbnail.navigated`` ``textbook.pdf.thumbnail.navigated``
------------------------------------ ------------------------------------
The browser emits ``textbook.pdf.thumbnail.navigated`` events when a user clicks The browser emits ``textbook.pdf.thumbnail.navigated`` events when a user
on a thumbnail image to navigate to a page. clicks on a thumbnail image to navigate to a page.
**Component**: PDF Viewer **Component**: PDF Viewer
...@@ -842,8 +849,8 @@ on a thumbnail image to navigate to a page. ...@@ -842,8 +849,8 @@ on a thumbnail image to navigate to a page.
``textbook.pdf.outline.toggled`` ``textbook.pdf.outline.toggled``
------------------------------------ ------------------------------------
The browser emits ``textbook.pdf.outline.toggled`` events when a user clicks the The browser emits ``textbook.pdf.outline.toggled`` events when a user clicks
outline icon to show or hide a list of the book's chapters. the outline icon to show or hide a list of the book's chapters.
**Component**: PDF Viewer **Component**: PDF Viewer
...@@ -904,8 +911,8 @@ on a link in the outline to navigate to a chapter. ...@@ -904,8 +911,8 @@ on a link in the outline to navigate to a chapter.
``textbook.pdf.page.navigated`` ``textbook.pdf.page.navigated``
------------------------------------ ------------------------------------
The browser emits ``textbook.pdf.page.navigated`` events when a user manually enters The browser emits ``textbook.pdf.page.navigated`` events when a user manually
a page number. enters a page number.
**Component**: PDF Viewer **Component**: PDF Viewer
...@@ -935,8 +942,8 @@ a page number. ...@@ -935,8 +942,8 @@ a page number.
``textbook.pdf.zoom.buttons.changed`` ``textbook.pdf.zoom.buttons.changed``
-------------------------------------- --------------------------------------
The browser emits ``textbook.pdf.zoom.buttons.changed`` events when a user clicks The browser emits ``textbook.pdf.zoom.buttons.changed`` events when a user
either the Zoom In or Zoom Out icon. clicks either the Zoom In or Zoom Out icon.
**Component**: PDF Viewer **Component**: PDF Viewer
...@@ -969,8 +976,8 @@ either the Zoom In or Zoom Out icon. ...@@ -969,8 +976,8 @@ either the Zoom In or Zoom Out icon.
``textbook.pdf.zoom.menu.changed`` ``textbook.pdf.zoom.menu.changed``
------------------------------------ ------------------------------------
The browser emits ``textbook.pdf.zoom.menu.changed`` events when a user selects a The browser emits ``textbook.pdf.zoom.menu.changed`` events when a user selects
magnification setting. a magnification setting.
**Component**: PDF Viewer **Component**: PDF Viewer
...@@ -1038,8 +1045,8 @@ magnification setting from the zoom menu or resizes the browser window. ...@@ -1038,8 +1045,8 @@ magnification setting from the zoom menu or resizes the browser window.
``textbook.pdf.display.scrolled`` ``textbook.pdf.display.scrolled``
------------------------------------ ------------------------------------
The browser emits ``textbook.pdf.display.scrolled`` events each time the displayed The browser emits ``textbook.pdf.display.scrolled`` events each time the
page changes while a user scrolls up or down. displayed page changes while a user scrolls up or down.
**Component**: PDF Viewer **Component**: PDF Viewer
...@@ -1072,11 +1079,11 @@ page changes while a user scrolls up or down. ...@@ -1072,11 +1079,11 @@ page changes while a user scrolls up or down.
``textbook.pdf.search.executed`` ``textbook.pdf.search.executed``
------------------------------------ ------------------------------------
The browser emits ``textbook.pdf.search.executed`` events when a user searches for a The browser emits ``textbook.pdf.search.executed`` events when a user searches
text value in the file. To reduce the number of events produced, instead of for a text value in the file. To reduce the number of events produced, instead
producing one event per entered character this event defines a search of producing one event per entered character this event defines a search string
string as the set of characters that is consecutively entered in the search as the set of characters that is consecutively entered in the search field
field within 500ms of each other. within 500ms of each other.
**Component**: PDF Viewer **Component**: PDF Viewer
...@@ -1119,8 +1126,8 @@ field within 500ms of each other. ...@@ -1119,8 +1126,8 @@ field within 500ms of each other.
``textbook.pdf.search.navigatednext`` ``textbook.pdf.search.navigatednext``
--------------------------------------------- ---------------------------------------------
The browser emits ``textbook.pdf.search.navigatednext`` events when a user clicks The browser emits ``textbook.pdf.search.navigatednext`` events when a user
on the Find Next or Find Previous icons for an entered search string. clicks on the Find Next or Find Previous icons for an entered search string.
**Component**: PDF Viewer **Component**: PDF Viewer
...@@ -1281,7 +1288,8 @@ checked, styled as GET parameters. ...@@ -1281,7 +1288,8 @@ checked, styled as GET parameters.
Both browser interactions and server requests produce ``problem_check`` events. Both browser interactions and server requests produce ``problem_check`` events.
The server emits ``problem_check`` events when a problem is successfully checked. The server emits ``problem_check`` events when a problem is successfully
checked.
**Event Source**: Server **Event Source**: Server
...@@ -1290,7 +1298,8 @@ The server emits ``problem_check`` events when a problem is successfully checked ...@@ -1290,7 +1298,8 @@ The server emits ``problem_check`` events when a problem is successfully checked
* On 5 Mar 2014, the ``submission`` dictionary was added to the ``event`` field * On 5 Mar 2014, the ``submission`` dictionary was added to the ``event`` field
and ``module`` was added to the ``context`` field. and ``module`` was added to the ``context`` field.
* Prior to 15 Oct 2013, this server-emitted event was named ``save_problem_check``. * Prior to 15 Oct 2013, this server-emitted event was named
``save_problem_check``.
* Prior to 15 Jul 2013, this event was emitted twice for the same action. * Prior to 15 Jul 2013, this event was emitted twice for the same action.
...@@ -1379,11 +1388,13 @@ The server emits ``problem_check`` events when a problem is successfully checked ...@@ -1379,11 +1388,13 @@ The server emits ``problem_check`` events when a problem is successfully checked
.. no sample to check .. no sample to check
The server emits ``problem_check_fail`` events when a problem cannot be checked successfully. The server emits ``problem_check_fail`` events when a problem cannot be checked
successfully.
**Event Source**: Server **Event Source**: Server
**History**: Prior to 15 Oct 2013, this event was named ``save_problem_check_fail``. **History**: Prior to 15 Oct 2013, this event was named
``save_problem_check_fail``.
``event`` **Member Fields**: ``event`` **Member Fields**:
...@@ -1410,7 +1421,8 @@ The server emits ``problem_check_fail`` events when a problem cannot be checked ...@@ -1410,7 +1421,8 @@ The server emits ``problem_check_fail`` events when a problem cannot be checked
``problem_reset`` ``problem_reset``
-------------------- --------------------
The browser emits ``problem_reset`` events when a user clicks **Reset** to reset the answer to a problem. The browser emits ``problem_reset`` events when a user clicks **Reset** to
reset the answer to a problem.
.. return Logger.log('problem_reset', [_this.answers, response.contents], _this.id); .. return Logger.log('problem_reset', [_this.answers, response.contents], _this.id);
...@@ -1434,7 +1446,8 @@ The browser emits ``problem_reset`` events when a user clicks **Reset** to reset ...@@ -1434,7 +1446,8 @@ The browser emits ``problem_reset`` events when a user clicks **Reset** to reset
.. no sample to check .. no sample to check
The server emits ``problem_rescore`` events when a problem is successfully rescored. The server emits ``problem_rescore`` events when a problem is successfully
rescored.
**Event Source**: Server **Event Source**: Server
...@@ -1480,7 +1493,8 @@ The server emits ``problem_rescore`` events when a problem is successfully resco ...@@ -1480,7 +1493,8 @@ The server emits ``problem_rescore`` events when a problem is successfully resco
.. no sample to check .. no sample to check
The server emits ``problem_rescore_fail`` events when a problem cannot be successfully rescored. The server emits ``problem_rescore_fail`` events when a problem cannot be
successfully rescored.
**Event Source**: Server **Event Source**: Server
...@@ -1536,14 +1550,16 @@ The browser emits ``problem_show`` events when a problem is shown. ...@@ -1536,14 +1550,16 @@ The browser emits ``problem_show`` events when a problem is shown.
- Details - Details
* - ``problem`` * - ``problem``
- string - string
- ID of the problem being shown. For example, i4x://MITx/6.00x/problem/L15:L15_Problem_2). - ID of the problem being shown. For example,
i4x://MITx/6.00x/problem/L15:L15_Problem_2).
``reset_problem`` ``reset_problem``
------------------------------------------------ ------------------------------------------------
.. no sample to check .. no sample to check
The server emits ``reset_problem`` events when a problem has been reset successfully. The server emits ``reset_problem`` events when a problem has been reset
successfully.
.. %%what is the difference between reset_problem and problem_reset? .. %%what is the difference between reset_problem and problem_reset?
...@@ -1573,7 +1589,8 @@ The server emits ``reset_problem`` events when a problem has been reset successf ...@@ -1573,7 +1589,8 @@ The server emits ``reset_problem`` events when a problem has been reset successf
.. no sample to check .. no sample to check
The server emits ``reset_problem_fail`` events when a problem cannot be reset successfully. The server emits ``reset_problem_fail`` events when a problem cannot be reset
successfully.
**Event Source**: Server **Event Source**: Server
...@@ -1627,7 +1644,8 @@ The server emits ``show_answer`` events when the answer to a problem is shown. ...@@ -1627,7 +1644,8 @@ The server emits ``show_answer`` events when the answer to a problem is shown.
.. no sample to check .. no sample to check
The server emits ``save_problem_fail`` events when a problem cannot be saved successfully. The server emits ``save_problem_fail`` events when a problem cannot be saved
successfully.
**Event Source**: Server **Event Source**: Server
...@@ -1658,7 +1676,8 @@ The server emits ``save_problem_fail`` events when a problem cannot be saved su ...@@ -1658,7 +1676,8 @@ The server emits ``save_problem_fail`` events when a problem cannot be saved su
.. no sample to check .. no sample to check
The server emits ``save_problem_success`` events when a problem is saved successfully. The server emits ``save_problem_success`` events when a problem is saved
successfully.
**Event Source**: Server **Event Source**: Server
...@@ -1700,34 +1719,84 @@ for a problem and it is graded successfully. ...@@ -1700,34 +1719,84 @@ for a problem and it is graded successfully.
- Details - Details
* - ``[answers, contents]`` * - ``[answers, contents]``
- array - array
- ``answers`` provides the value checked by the user. ``contents`` delivers - ``answers`` provides the value checked by the user. ``contents``
HTML using data entered for the problem in Studio, including the display delivers HTML using data entered for the problem in Studio, including
name, problem text, and choices or response field labels. The array the display name, problem text, and choices or response field labels.
includes each problem in a problem component that has multiple problems. The array includes each problem in a problem component that has multiple
problems.
.. _ora: .. _forum_events:
==========================
Forum Events
==========================
``edx.forum.searched``
----------------------------------
After a user executes a text search in the navigation sidebar of the course
**Discussion** page, the server emits an ``edx.forum.searched`` event.
**Component**: Discussion
**Event Source**: Server
**History**: Added 16 May 2014. The ``corrected_text`` field was added 5
Jun 2014.
``event`` **Fields**:
.. list-table::
:widths: 15 15 60
:header-rows: 1
* - Field
- Type
- Details
* - ``query``
- string
- The text entered into the search box by the user.
* - ``page``
- integer
- Results are returned in sets of 20 per page. Identifies the page of
results requested by the user.
* - ``total_results``
- integer
- The total number of results matching the query.
* - ``corrected_text``
- string
- A re-spelling of the query, suggested by the search engine, which was
automatically substituted for the original one. This happens only when
there are no results for the original query, but the index contains
matches for a similar term or phrase. Otherwise, this field is null.
.. _ora2:
====================================== ======================================
Open Response Assessment Events Open Response Assessment Events
====================================== ======================================
**History**: The events in this section record interactions with the prototype In an open response assessment, students review a question and then submit a
implementation of open response assessment (ORA) problem types. As of May 2014, text response and, optionally, an image file. To evaluate their own and one or
new courses are not using this implementation of ORA and a complete redesign of more other students' responses to the questions, students use an instructor-
this feature is in limited release. definfed scoring rubric. For more information about open response assessments,
see `Creating a Peer Assessment`_.
``oe_hide_question`` and ``oe_show_question`` **Component**: Open Response Assessments
---------------------------------------------------------------------------
The browser emits ``oe_hide_question`` and ``oe_show_question`` events when the **History:** The open response assessment feature was released in August 2014;
user hides or redisplays a combined open-ended problem. limited release of this feature began in April 2014.
**History**: These events were previously named ``oe_hide_problem`` and openassessmentblock.get_peer_submission
``oe_show_problem``. ----------------------------------------
**Component**: Combined Open-Ended After students submit their own responses for evaluation, they use the scoring
rubric to evaluate the responses of other course participants. The server emits
this event when a response is delivered to a student for evaluation.
**Event Source**: Browser **Event Source**: Server
**History**: Added 3 April 2014.
``event`` **Member Fields**: ``event`` **Member Fields**:
...@@ -1738,18 +1807,42 @@ user hides or redisplays a combined open-ended problem. ...@@ -1738,18 +1807,42 @@ user hides or redisplays a combined open-ended problem.
* - Field * - Field
- Type - Type
- Details - Details
* - ``location`` * - ``course_id``
- string - string
- The location of the question whose prompt is being shown or hidden. - The identifier of the course that includes this assessment. For open
response assessment problems, the course ID is stated in org/course/run
format.
``rubric_select`` (For courses created after mid-2014, the course ID is converted to this
---------------------- format for open response assessment problems only.)
**Component**: Combined Open-Ended * - ``item_id``
- string
- The i4x:// style locator that identifies the problem in the course.
* - ``submission_returned_uuid``
- string
- The unique identifer of the response that the student retrieved for
assessment.
**Event Source**: Browser If no assessment is available, this is set to "None".
``event`` **Member Fields**: * - ``requesting_student_id``
- string
- The course-specific anonymized user ID of the student who requested the
response.
openassessmentblock.peer_assess and openassessmentblock.self_assess
----------------------------------------------------------------------
The server emits this event when a student either submits an assessment of a
peer's response or submits a self-assessment of her own response.
**Event Source**: Server
**History**: Added 3 April 2014.
``event`` **Fields**:
.. list-table:: .. list-table::
:widths: 15 15 60 :widths: 15 15 60
...@@ -1758,33 +1851,55 @@ user hides or redisplays a combined open-ended problem. ...@@ -1758,33 +1851,55 @@ user hides or redisplays a combined open-ended problem.
* - Field * - Field
- Type - Type
- Details - Details
* - ``location`` * - ``scorer_id``
- string - string
- The location of the question whose rubric is being selected. - The course-specific anonymized user ID of the student who submitted this
* - ``selection`` assessment.
- integer * - ``feedback``
- Value selected on rubric. - string
* - ``category`` - The student's comments about the submitted response.
- integer * - ``submission_uuid``
- Rubric category selected. - string
- The unique identifier for the submitted response.
* - ``score_type``
- string
- "PE" for a peer evaluation, "SE" for a self evaluation.
* - ``parts: [criterion, option, feedback]``
- array
- The ``parts`` field contains member fields for each ``criterion`` in the
rubric, the ``option`` that the student selected for it, and any
``feedback`` comments that the student supplied.
``oe_show_full_feedback`` and ``oe_show_respond_to_feedback`` These member fields are repeated in an array to include all of the
------------------------------------------------------------------ rubric's criteria.
**Component**: Combined Open-Ended * ``criterion`` (object) contains ``points possible`` and ``name``
member fields
* ``option`` (string)
* ``feedback`` (string)
**Event Source**: Browser When the only criterion in the rubric is student feedback, ``points
possible`` is 0 and the ``option`` field is not included.
``event`` **Member Fields**: None. * - ``rubric``
- dict
- This field contains the member field ``contenthash``, which identifies
the rubric that the student used to assess the response.
* - ``scored_at``
- datetime
- Timestamp for when the assessment was submitted.
``oe_feedback_response_selected`` openassessmentblock.submit_feedback_on_assessments
-------------------------------------------- ----------------------------------------------------
**Component**: Combined Open-Ended The server emits this event when a student submits a suggestion, opinion, or
other feedback about the assessment process.
**Event Source**: Browser **Event Source**: Server
``event`` **Member Fields**: **History**: Added 3 April 2014.
``event`` **Fields**:
.. list-table:: .. list-table::
:widths: 15 15 60 :widths: 15 15 60
...@@ -1793,26 +1908,71 @@ user hides or redisplays a combined open-ended problem. ...@@ -1793,26 +1908,71 @@ user hides or redisplays a combined open-ended problem.
* - Field * - Field
- Type - Type
- Details - Details
* - ``value`` * - ``feedback_text``
- integer - string
- Value selected in the feedback response form. - The student's comments about the assessment process.
* - ``submission_uuid``
- string
- The unique identifier of the feedback.
* - ``options``
- array
- The label of each check box option that the student selected to evaluate
the assessment process.
``peer_grading_hide_question`` and ``peer_grading_show_question`` openassessment.create_submission
--------------------------------------------------------------------- --------------------------------
.. I couldn't find these names in any js file. peer_grading_problem.js includes oe_hide or show_question. The server emits this event when a student submits a response. The same event
is emitted when a student submits a response for peer assessment or for self
assessment.
The browser emits ``peer_grading_hide_question`` and **Event Source**: Server
``peer_grading_show_question`` events when the user hides or redisplays a
problem that is peer graded.
**History**: These events were previously named ``peer_grading_hide_problem`` and ``peer_grading_show_problem``. **History**: Added 3 April 2014.
**Component**: Peer Grading ``event`` **Fields**:
**Event Source**: Browser .. list-table::
:widths: 15 15 60
:header-rows: 1
``event`` **Member Fields**: * - Field
- Type
- Details
* - ``answer``
- dict
- This field contains a ``text`` (string) member field for the response.
For responses that also include an image file, this field contains a
``file_upload_key`` (string) member field with the AWS S3 key that
identifies the location of the image file on the Amazon S3 storage
service. This key is provided for reference only.
* - ``created_at``
- datetime
- Timestamp for when the student submitted the response.
* - ``attempt_number``
- int
- This value is currently always set to 1.
* - ``submission_uuid``
- string
- The unique identifier of the response.
* - ``submitted_at``
- datetime
- Timestamp for when the student submitted the response. This value is
currently always the same as ``created_at``.
openassessment.save_submission
-------------------------------
The server emits this event when a student saves a response. Students
save responses before they submit them for assessment.
**Event Source**: Server
**History**: Added 3 April 2014.
``event`` **Fields**:
.. list-table:: .. list-table::
:widths: 15 15 60 :widths: 15 15 60
...@@ -1821,26 +1981,64 @@ problem that is peer graded. ...@@ -1821,26 +1981,64 @@ problem that is peer graded.
* - Field * - Field
- Type - Type
- Details - Details
* - ``location`` * - ``saved_response``
- string - dict
- The location of the question whose prompt is being shown or hidden. - This field contains a ``text`` (string) member field for the response.
``staff_grading_hide_question`` and ``staff_grading_show_question`` For responses that also include an image file, this field contains a
----------------------------------------------------------------------- ``file_upload_key`` (string) member field with the AWS S3 key that
identifies the location of the image file on the Amazon S3 storage
service.
.. staff_grading.js openassessment.student_training_assess_example
-----------------------------------------------
The browser emits ``staff_grading_hide_question`` and The server emits this event when a student submits an assessment for an
``staff_grading_show_question`` events when the user hides or redisplays a example response. To assess the example, the student uses a scoring rubric
problem that is staff graded. provided by the instructor. These events record the options the student
selected to assess the example and identifies any criteria that the student
scored differently than the instructor.
**History**: These events were previously named ``staff_grading_hide_problem`` and ``staff_grading_show_problem``. **Event Source**: Server
**Component**: Staff Grading **History**: Added 6 August 2014.
``event`` **Fields**:
.. list-table::
:widths: 15 15 60
:header-rows: 1
* - Field
- Type
- Details
* - ``corrections``
- object
- A set of name/value pairs that identify criteria for which the student
selected a different option than the instructor, in the format
``criterion_name: instructor-defined_option_name``.
* - ``submission_uuid``
- string
- The unique identifier of the response. Identifies the student who
is undergoing training.
* - ``options_selected``
- object
- A set of name/value pairs that identify the option that the student
selected for each criterion in the rubric, in the format
``'criterion_name': 'option_name'``.
openassessment.upload_file
-----------------------------
The browser emits this event when a student successfully uploads an image file
as part of a response. Students complete the upload process before they submit
the response.
**Event Source**: Browser **Event Source**: Browser
``event`` **Member Fields**: **History**: Added 6 August 2014.
``event`` **Fields**:
.. list-table:: .. list-table::
:widths: 15 15 60 :widths: 15 15 60
...@@ -1849,9 +2047,17 @@ problem that is staff graded. ...@@ -1849,9 +2047,17 @@ problem that is staff graded.
* - Field * - Field
- Type - Type
- Details - Details
* - ``location`` * - ``fileType``
- string - string
- The location of the question whose prompt is being shown or hidden. - The MIME type of the uploaded file. Reported by the student's browser.
* - ``fileName``
- string
- The name of the uploaded file, as stored on the student's client
machine.
* - ``fileSize``
- int
- The size of the uploaded file in bytes. Reported by the student's
browser.
.. _AB_Event_Types: .. _AB_Event_Types:
...@@ -1862,8 +2068,8 @@ A/B Testing Events ...@@ -1862,8 +2068,8 @@ A/B Testing Events
Course authors can configure course content to present modules that contain Course authors can configure course content to present modules that contain
other modules. For example, a parent module can include two child modules with other modules. For example, a parent module can include two child modules with
content that differs in some way for comparison testing. When a student content that differs in some way for comparison testing. When a student
navigates to a module that is set up for A/B testing in this way, the student is navigates to a module that is set up for A/B testing in this way, the student
randomly assigned to a group and shown only one of the child modules. is randomly assigned to a group and shown only one of the child modules.
* Internally, a *partition* defines the type of experiment: comparing the * Internally, a *partition* defines the type of experiment: comparing the
effectiveness of video alone to text alone, for example. A course can include effectiveness of video alone to text alone, for example. A course can include
...@@ -1918,7 +2124,8 @@ If the student does not yet have an assignment, the server emits an ...@@ -1918,7 +2124,8 @@ If the student does not yet have an assignment, the server emits an
- Name of the group. - Name of the group.
* - ``partition_id`` * - ``partition_id``
- integer - integer
- Identifier for the partition, in the format ``xblock.partition_service.partition_ID`` where ID is an integer. - Identifier for the partition, in the format
``xblock.partition_service.partition_ID`` where ID is an integer.
* - ``partition_name`` * - ``partition_name``
- string - string
- Name of the partition. - Name of the partition.
...@@ -1947,25 +2154,31 @@ the child module that was shown to the student. ...@@ -1947,25 +2154,31 @@ the child module that was shown to the student.
- string - string
- ID of the module that displays to the student. - ID of the module that displays to the student.
.. _forum_events: .. _ora:
========================== ============================================
Forum Events Open Response Assessment Events (Deprecated)
========================== ============================================
``edx.forum.searched`` **History**: The events in this section recorded interactions with the
---------------------------------- prototype implementation of open response assessment (ORA) problem types. As of
May 2014, new courses no longer used this implementation for open response
assessments.
After a user executes a text search in the navigation sidebar of the Discussion tab of a course, the server emits an ``edx.forum.searched`` event. ``oe_hide_question`` and ``oe_show_question``
---------------------------------------------------------------------------
**Component**: Discussion Tab The browser emits ``oe_hide_question`` and ``oe_show_question`` events when the
user hides or redisplays a combined open-ended problem.
**Event Source**: Server **History**: These events were previously named ``oe_hide_problem`` and
``oe_show_problem``.
**History**: Added 16 May 2014. The ``corrected_text`` field was added 5 **Component**: Combined Open-Ended
Jun 2014.
``event`` **Fields**: **Event Source**: Browser
``event`` **Member Fields**:
.. list-table:: .. list-table::
:widths: 15 15 60 :widths: 15 15 60
...@@ -1974,22 +2187,122 @@ Jun 2014. ...@@ -1974,22 +2187,122 @@ Jun 2014.
* - Field * - Field
- Type - Type
- Details - Details
* - ``query`` * - ``location``
- string - string
- The text entered into the search box by the user. - The location of the question whose prompt is being shown or hidden.
* - ``page``
``rubric_select``
----------------------
**Component**: Combined Open-Ended
**Event Source**: Browser
``event`` **Member Fields**:
.. list-table::
:widths: 15 15 60
:header-rows: 1
* - Field
- Type
- Details
* - ``location``
- string
- The location of the question whose rubric is being selected.
* - ``selection``
- integer - integer
- Results are returned in sets of 20 per page. Identifies the page of - Value selected on rubric.
results requested by the user. * - ``category``
* - ``total_results``
- integer - integer
- The total number of results matching the query. - Rubric category selected.
* - ``corrected_text``
``oe_show_full_feedback`` and ``oe_show_respond_to_feedback``
------------------------------------------------------------------
**Component**: Combined Open-Ended
**Event Source**: Browser
``event`` **Member Fields**: None.
``oe_feedback_response_selected``
--------------------------------------------
**Component**: Combined Open-Ended
**Event Source**: Browser
``event`` **Member Fields**:
.. list-table::
:widths: 15 15 60
:header-rows: 1
* - Field
- Type
- Details
* - ``value``
- integer
- Value selected in the feedback response form.
``peer_grading_hide_question`` and ``peer_grading_show_question``
---------------------------------------------------------------------
.. I couldn't find these names in any js file. peer_grading_problem.js includes oe_hide or show_question.
The browser emits ``peer_grading_hide_question`` and
``peer_grading_show_question`` events when the user hides or redisplays a
problem that is peer graded.
**History**: These events were previously named ``peer_grading_hide_problem``
and ``peer_grading_show_problem``.
**Component**: Peer Grading
**Event Source**: Browser
``event`` **Member Fields**:
.. list-table::
:widths: 15 15 60
:header-rows: 1
* - Field
- Type
- Details
* - ``location``
- string - string
- A re-spelling of the query, suggested by the search engine, which was - The location of the question whose prompt is being shown or hidden.
automatically substituted for the original one. This happens only when
there are no results for the original query, but the index contains ``staff_grading_hide_question`` and ``staff_grading_show_question``
matches for a similar term or phrase. Otherwise, this field is null. -----------------------------------------------------------------------
.. staff_grading.js
The browser emits ``staff_grading_hide_question`` and
``staff_grading_show_question`` events when the user hides or redisplays a
problem that is staff graded.
**History**: These events were previously named ``staff_grading_hide_problem``
and ``staff_grading_show_problem``.
**Component**: Staff Grading
**Event Source**: Browser
``event`` **Member Fields**:
.. list-table::
:widths: 15 15 60
:header-rows: 1
* - Field
- Type
- Details
* - ``location``
- string
- The location of the question whose prompt is being shown or hidden.
.. _Instructor_Event_Types: .. _Instructor_Event_Types:
...@@ -2000,8 +2313,8 @@ Instructor Events ...@@ -2000,8 +2313,8 @@ Instructor Events
This section lists the events that the server emits as a result of course team This section lists the events that the server emits as a result of course team
interaction with the Instructor Dashboard in the LMS. interaction with the Instructor Dashboard in the LMS.
The schema definitions of each of these events include only the JSON fields that The schema definitions of each of these events include only the JSON fields
are common to all events. that are common to all events. See :ref:`common`.
* ``dump-answer-dist-csv`` * ``dump-answer-dist-csv``
* ``dump-graded-assignments-config`` * ``dump-graded-assignments-config``
...@@ -2274,3 +2587,6 @@ members also generate enrollment events. ...@@ -2274,3 +2587,6 @@ members also generate enrollment events.
server emits a ``edx.course.enrollment.deactivated`` for each unenrollment. server emits a ``edx.course.enrollment.deactivated`` for each unenrollment.
For details about the enrollment events, see :ref:`enrollment`. For details about the enrollment events, see :ref:`enrollment`.
.. _Creating a Peer Assessment: http://edx.readthedocs.org/projects/edx-open-response-assessments/en/latest/
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment