6.7.4. Course Team Events

This section lists events that are generated by interactions on the instructor dashboard. Users who have the Admin or Staff role can select Instructor in the LMS to access the instructor dashboard.

For a list of events generated by learner interactions in the LMS other than on the instructor dashboard, see Student Events. For a complete, alphabetical list of events, see the Alphabetical Event List.

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 time, and member fields in addition to the common context or event fields.

6.7.4.1. Cohort Events (Course Team)

In addition to the cohort events that are generated when cohorts are created and users are assigned to them (see Cohort Events (Student)), actions by course team members also generate cohort-related events.

For more information about student cohorts, see Using Cohorts in Your Courses in the Building and Running an edX Course guide.

6.7.4.1.1. edx.cohort.creation_requested

When a course team member manually creates a cohort on the Cohorts page of the instructor dashboard, the server emits an edx.cohort.creation_requested event.

Event Source: Server

History: Added 7 Oct 2014.

event Member Fields:

Field Type Details
cohort_id number The numeric ID of the cohort.
cohort_name string The display name of the cohort.

6.7.4.1.2. edx.cohort.user_add_requested

When a course team member adds a student to a cohort on the Cohorts page of the instructor dashboard, the server emits an edx.cohort.user_add_requested event. Course team members can add students to a cohort individually, or by uploading a .csv file of student cohort assignments.

Event Source: Server

History: Added 7 Oct 2014.

event Member Fields:

Field Type Details
cohort_id number The numeric ID of the cohort.
cohort_name string The display name of the cohort.
previous_cohort_id number

The numeric ID of the cohort that the user was previously assigned to.

Null if the user was not previously assigned to a cohort.

previous_cohort_name string

The display name of the cohort that the user was previously assigned to.

Null if the user was not previously assigned to a cohort.

user_id number The numeric ID (from auth_user.id) of the added user.

6.7.4.2. Course Management Events

Course management events include events that are emitted when a member of the course team performs actions relating to course team staffing or student administration on the instructor dashboard in the LMS. In addition, see Course Reporting Events and Grading-Related Events.

6.7.4.2.1. add-instructor and remove-instructor

Component: Instructor Dashboard

Event Source: Server

event Member Fields:

Field Type
instructor string

6.7.4.2.2. add-or-remove-user-group

Component: Instructor Dashboard

Event Source: Server

event Member Fields:

Field Type
event string
event_name string
user string

6.7.4.2.3. delete-student-module-state and rescore-student-submission

Component: Instructor Dashboard

Event Source: Server

event Member Fields:

Field Type
course string
problem string
student string

6.7.4.2.4. rescore-all-submissions and reset-all-attempts

Component: Instructor Dashboard

Event Source: Server

event Member Fields:

Field Type
course string
problem string

6.7.4.2.5. reset-student-attempts

Component: Instructor Dashboard

Event Source: Server

event Member Fields:

Field Type
course string
old_attempts string
problem string
student string

6.7.4.3. Course Reporting Events

Events are emitted when course team members request reports of various types from the instructor dashboard in the LMS. The following reporting events contain fields in addition to the common fields, unless it is otherwise indicated.

6.7.4.3.1. edx.instructor.report.downloaded

The browser emits an edx.instructor.report.downloaded event when the user selects a report link on the instructor dashboard to download a report.

History: Added 8 May 2015.

Component: Instructor Dashboard

Event Source: Browser

event Member Fields:

Field Type Details
report_url string The URL to the report file.

6.7.4.3.2. 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:

Field Type Details
report_type string The type of report that was requested.

6.7.4.3.3. get-student-progress-page

The server emits a get-student-progress-page event when the user clicks the View Progress Page link on the Student Admin page of the instructor dashboard.

Component: Instructor Dashboard

Event Source: Server

event Member Fields:

Field Type
course string
instructor string
student string

6.7.4.3.4. Discussion Role List Events

Discussion role list events are emitted when a course team member selects a specific discussion role on the Membership page of the instructor dashboard to view the list of users who currently have this role.

  • list-forum-admins
  • list-forum-community-TAs
  • list-forum-mods

Component: Instructor Dashboard

Event Source: Server

event Member Fields:

Field Type
course string

6.7.4.3.5. Discussion Role Management Events

Discussion role management events are emitted when a course team member with Admin privileges adds a user to, or removes a user from, a particular discussion role in the Course Team Management section of the instructor dashboard Membership page.

  • add-forum-admin
  • add-forum-community-TA
  • add-forum-mod
  • remove-forum-admin
  • remove-forum-community-TA
  • remove-forum-mod

Component: Instructor Dashboard

Event Source: Server

event Member Fields:

Field Type
course string

6.7.4.3.6. Course Reporting Events Containing only Common Fields

The following reporting events contain only fields that are common to all events. For more information about the common fields, see Common Fields.

  • dump-answer-dist-csv
  • dump-graded-assignments-config
  • dump-grades
  • dump-grades-csv
  • dump-grades-csv-raw
  • dump-grades-raw
  • list-beta-testers
  • list-instructors
  • list-staff
  • list-students

Event Source: Server

6.7.4.5. Instructor Enrollment Events

In addition to the enrollment events that are generated when students enroll in or unenroll from a course, actions by course team members also generate enrollment events.

  • When a course author creates a course, his or her user account is enrolled in the course and the server emits an edx.course.enrollment.activated event.

  • When a user with the Admin or Staff role enrolls in a course, the server emits edx.course.enrollment.activated. The server emits edx.course.enrollment.deactivated events when these users unenroll from a course.

  • When a user with the Admin or Staff role uses the Batch Enrollment feature to enroll students or other course team members in a course, the server emits an edx.course.enrollment.activated event for each enrollment. When this feature is used to unenroll students from a course, the server emits a edx.course.enrollment.deactivated for each unenrollment.

    For events emitted as a result of a batch enrollment, the username and context.user_id identify the course team member who made the change, and the event.user_id identifies the student who was enrolled or unenrolled.

The student_courseaccessrole table lists all users who have a privileged role or roles in the course.

For details about student enrollment events, see Enrollment Events.

6.7.4.6. Timed and Proctored Exam Development and Administration Events

Special exams are a type of course exam that includes timed exams, proctored exams, and practice proctored exams. These exam types offer more complicated functionality than other assignment types in graded subsections, and they emit additional events. Special exam events provide information about special exams included in courses and learners’ interactions with those special exams.

  • Proctored exams have a time limit and they require learners to install and run monitoring software while taking the exam. After a learner completes a proctored exam, a team of reviewers determines whether the learner complied with all of the exam rules based on records generated by the monitoring software.
  • Practice proctored exams allow learners to become familiar with the monitoring software that they will use during an actual proctored exam. The way that a learner experiences a practice proctored exam is identical to a proctored exam. In a practice proctored exam, the monitoring software does not send exam records to reviewers.
  • Timed exams have a time limit. Learners do not install or use monitoring software when they take a timed exam.

Practice proctored exams follow a workflow that is similar to proctored exams but do not include a review of the exam attempt. Timed exams also follow a similar workflow but do not include any proctoring software or review of the exam attempt.

The following diagram shows the workflow for a proctored exam.

A diagram showing the workflow for a proctored exam.

For more information about timed exams and proctored exams, see Offering Timed Exams and Proctored Exam Overview.

Some special exam events are emitted when learners interact with exams. For more information, see Timed Exam and Proctored Exam Events.

Because special exams include similar functions and behavior, they share some similar events. For example, the edx.special_exam.proctored.allowance.created, edx.special_exam.practice.allowance.created, and edx.special_exam.timed.allowance.created events include identical fields.

This section includes descriptions of the following events.

6.7.4.6.1. edx.special_exam.proctored.allowance.created, edx.special_exam.practice.allowance.created, and edx.special_exam.timed.allowance.created

The server emits this event when a course team grants an exception to the standard exam rules for an individual learner.

History: Added 01 Dec 2015.

event Member Fields:

Field Type Details
allowance_key string The type of allowance granted.
allowance_user_id number The identifier of the learner who has been granted the allowance.
allowance_value string The specific details of the allowance granted.
exam_content_id string The primary identifier of the subsection that contains the exam.
exam_default_time_limit_mins number The standard amount of time, in minutes, that learners have to complete the exam.
exam_id number The primary identifier of the exam.
exam_is_active Boolean Indicates whether the special exam is currently available for learner attempts.
exam_is_practice_exam Boolean Indicates whether the special exam is a practice proctored exam.
exam_is_proctored Boolean Indicates whether the special exam is a proctored exam.
exam_name string The title of the exam in the course page, taken from the subsection title.

6.7.4.6.2. edx.special_exam.proctored.allowance.deleted, edx.special_exam.practice.allowance.deleted, and edx.special_exam.timed.allowance.deleted

The server emits this event when a course team removes an exception to the standard exam rules that was previously granted to an individual learner.

The event fields for this event are the same as the event fields for the edx.special_exam.{special exam type}.allowance.created event. For more information, see edx.special_exam.proctored.allowance.created, edx.special_exam.practice.allowance.created, and edx.special_exam.timed.allowance.created.

History: Added 01 Dec 2015.

6.7.4.6.3. edx.special_exam.proctored.created, edx.special_exam.practice.created, and edx.special_exam.timed.created

The server emits this event when a course team creates a proctored exam in Studio.

History: Added 01 Dec 2015.

event Member Fields:

Field Type Details
exam_content_id string The primary identifier of the subsection that contains the exam.
exam_default_time_limit_mins number The standard amount of time, in minutes, that learners have to complete the exam.
exam_id number The primary identifier of the exam.
exam_is_active Boolean Indicates whether the special exam is currently available for learner attempts.
exam_is_practice_exam Boolean Indicates whether the special exam is a practice proctored exam.
exam_is_proctored Boolean Indicates whether the special exam is a proctored exam.
exam_name string The title of the exam in the course page, taken from the subsection title.

6.7.4.6.4. edx.special_exam.proctored.updated, edx.special_exam.practice.updated, and edx.special_exam.timed.updated

The server emits this event when a course team alters a proctored exam in Studio.

The event fields for this event are the same as the event fields for the edx.special_exam.{special exam type}.created event. For more information, see edx.special_exam.proctored.created, edx.special_exam.practice.created, and edx.special_exam.timed.created.

History: Added 01 Dec 2015.

6.7.4.6.5. psychometrics-histogram-generation (Deprecated)

Component: Instructor Dashboard

Event Source: Server

History: The chart feature intended to emit these events was never enabled on the edX Edge or edx.org instructor dashboard.

event Member Fields:

Field Type
problem string