Data dictionary 1.0

Unizin Common Data Model


UCDM Entities

Academic Term

A calendar session in which classes are instructed.

Code Description
instr_begin_date The date and time when instruction begins.
instr_end_date The date and time when instruction ends.
name The human readable name for the academic term.
session_name The human readable name for the academic term.
session_type The type of session for your Academic term, usually describing the length of the term. (option set)
term_begin_date The date and time when the academic term formally begins.
term_end_date The date and time when the academic term formally ends.
term_type The type of Academic term. (option set)
top

Annotation

A web resource with a body, which is a comment or other descriptive resource, and a single target that the body is somehow about.

Code Description
author_id The Person record who originally authored the Annotation.
author_name The name of the Person who originally authored the Annotation.
body_value The contents of the Annotation's body.
created_date The date on which the Annotation was originally created.
has_teacher_only_comments Indicates whether the Annotation is from a teacher ('true') or not ('false').
is_anonymous Denotes whether the Annotation was made anonymously.
is_hidden Indicates whether the Annotation is hidden from view by students.
learner_activity_result_id The Learner activity result in which this Annotation was made.
message_character_count The number of characters in the Annotation.
message_line_count The number of lines in the Annotation.
message_size_bytes The message size, in bytes, of the Annotation.
message_word_count The number of words in the Annotation.
updated_date The date on which the Annotation was last updated.
top

Conversation

An interchange of concepts or ideas between two or more actors in an unstructured manner without a defined topic.

Code Description
course_offering_id The Course offering context in which the conversation took place, if any.
has_attachments Denotes whether the Conversation has any attachments.
has_media_objects Denotes whether the Conversation has any media objects.
learner_group_id The Learner group context in which the conversation took place, if any.
subject The subject of the conversation, if any.
top

Conversation Message

A discrete piece of information sent as part of a Conversation.

Code Description
author_id The author of the message.
body The contents of the message.
conversation_id The Conversation in which the message took place.
course_offering_id The Course offering context in which the Conversation message took place, if any.
created_date The date on which the message was first created.
has_attachments Denotes whether the message contains any attachments.
has_media_objects Denotes whether the message contains any media objects.
is_system_generated Denotes whether the message was automatically generated by a system, rather than a Person.
learner_group_id The Learner group context in which the Conversation message took place, if any.
message_character_count The message length in characters.
message_line_count The message length in lines.
message_size_bytes The message size in bytes.
message_word_count The message length in words.
top

Course Grade

The grade that a learner receives as part of their participation in a given Course section enrollment.

Code Description
course_section_id The Course section for which the Course grade is given.
created_date The date on which the Course grade was first created.
current_score The most recently calculated and visible score.
final_score The final calculated and visible score.
hidden_current_score The most recently calculated score that is not yet visible.
hidden_final_score The final calculated score that is not yet visible.
person_id The Person to whom this Course grade is given.
status The status of the Course grade (option set)
updated_date The date on which the Course grade was most recently updated.
top

Course Offering

An institutional offering of organized subject matter and learner activities chosen by learners in an academic term.

Code Description
available_credits Measured in Carnegie units, the amount of credit available to a student who successfully meets the objectives of the Course Offering.
course_no The official reference number portion of a Course offering Id. This number normally designates the level of the course as well as the level of the individual expected to enroll in the course. E.g. "101" in "BIO 101."
course_subj The alphabetic abbreviation of the academic department or discipline offering the course. It is one part of the total Course offering Id number. E.g., "BIO" in "BIO 101."
created_date The date the Course offering was created.
description The Course Offering description.
is_public Indicates whether the Course offering is publicly visible.
status The workflow state of the Course offering, usually in relation to its availability for teaching and learning. (option set)
syllabus_content The syllabus content for this Course offering.
term_id The globally unique, SIS-generated internal ID for the term to which the course offering belongs.
title The title of the Course Offering.
top

Course Section

An administrative and instructional sub-organization of a Course offering. Instructors may be assigned to one or more sections of a particular Course offering.

Code Description
academic_term_id The Academic term to which this Course section belongs.
course_offering_id The course offering to which this Course section belongs.
created_date The date & time that the Course section was created.
delivery_mode The delivery mode for the instruction given in this Course Section. (option set)
is_accepting_enrollments If true, the Course section is accepting enrollments.
is_default If true, the Course section is the default Course section.
max_enrollment Maximum number of students who can be enrolled in the Course Section.
section_number The unique number of a particular Course section.
status The workflow state of the Course section, usually in relation to its availability for teaching and learning. (option set)
updated_date The date & time that the Course section was updated.
top

Course Section Enrollment

The association of a Person to an organization, usually defined by a particular role.

Code Description
completed_date The date & time that the Course section enrollment was completed by the student.
course_section_id The Course section to whom this Course section enrollment applies.
created_date The date & time that the Course section enrollment was created.
credits_earned The number of credits the Person actually earned in the Course section.
credits_taken The number of credits the Person intended to earn in the Course section.
entry_date The timestamp when the Person started this role in the Course section.
exit_date The timestamp indicating when the Person ended this role in the Course section.
person_id The Person to whom this Course section enrollment applies.
role The role of the Person in the Section, as defined by a UCDM option set. (option set)
status The status of the Person in their role as a member of this Course section. (option set)
updated_date The date & time that the Course section enrollment was updated.
top

Discussion

An interchange of concepts or ideas between two or more actors in a structured manner with a defined topic.

Code Description
author_id The Person who originally authored the Discussion.
body The body (content) of the Discussion.
course_offering_id The Course offering in which the Discussion is delivered.
created_date The date on which the Discussion was first created.
delayed_post_date The date on which the Discussion was delayed posting.
deleted_date The date on which the Discussion was deleted.
discussion_type The type of discussion: 'default(blank)', 'side_comment', 'threaded'. Threaded indicates that replies are threaded where side_comment indicates that replies in the discussion are flat. (option set)
editor_id The Person who most recently edited the Discussion.
is_locked Denotes whether the Discussion is locked or not.
is_pinned Denotes whether the Discussion is pinned or not.
last_reply_date The date on which the Discussion's most recent Discussion entry was created.
learner_activity_id The Learner activity of which the Discussion is part.
learner_group_id The Learner group in which the Discussion is delivered.
message_length The number of characters of the Discussion's Body.
posted_date The date on which the Discussion was posted.
status The current status of the Discussion. (option set)
title The title of the Discussion.
type The Discussion topic type, values can include 'blank' and 'announcement'. (option set)
updated_date The date on which the Discussion was last updated.
top

Discussion Entry

A response to a given Discussion, given by a single Person.

Code Description
body The body (content) of the Discussion entry.
created_date The date on which the Discussion entry was first created.
deleted_date The date on which the Discussion entry was deleted.
discussion_id The Discussion in which this entry is located.
message_length The length of the Discussion entry's Body, in number of characters.
parent_discussion_entry_id The parent Discussion entry of the current Discussion entry, if applicable in a threaded discussion.
person_id The Discussion entry author.
position The position of the Discussion entry relative to other Discussion entries for this Discussion.
status The current status of the Discussion entry. (option set)
updated_date The date on which the Discussion entry was most recently updated.
top

File

An object that contains information in a self-contained manner. Files may be documents, images, recordings, and so on.

Code Description
can_be_locked Denotes whether the File may be locked or not.
content_type The type of content that defines the File.
conversation_id The Conversation in which the File was attached.
conversation_message_id The particular Conversation message in which the File was attached.
conversation_person_id The Person who uploaded the File in the Conversation.
course_offering_id The Course offering to which the File is associated.
created_date The date on which the File was initially created.
deleted_date The date on which the File was deleted.
display_name The name displayed for the File.
learner_activity_group_id The learner activity group to which the File is associated.
learner_activity_id The Learner activity to which the File is associated.
learner_activity_result_id The learner activity result to which the File is associated.
learner_group_id The Learner group with which the File is associated.
locked_date The date on which the File was locked.
md5 The MD5 hash that uniquely identifies the contents of the File.
owner_entity_type The type of Entity that owns the File. Values may include: learner activity, conversation message, course offering, learner group, quiz, quiz result, learner activity result, and person.
owner_id The Person who owns the File, if different than the uploader.
quiz_id The Quiz with which the File is associated.
quiz_result_id The Quiz result with which the File is associated.
replacement_file_id The File for which this File is a replacement.
root_file_id The File of which the given File is a child.
size The size, in bytes, of the File.
status The current status of the File. (option set)
unlocked_date The date on which the File was unlocked.
updated_date The date on which the File was last updated.
uploader_id The Person who originally uploaded the File.
viewed_date The date on which the File was last viewed.
wiki_id The Wiki with which the File is associated.
top

Grading Period

A defined length of time that will culminate in a grade.

Code Description
close_date The date on which the Grading period closes.
created_date The date on which the Grading period was initially created.
end_date The date on which the Grading period ends.
grading_period_group_id The group to which the Grading period belongs.
start_date The date on which the Grading period begins.
status The status of the Grading period.
title The title of the Grading period.
updated_date The date on which the Grading period was most recently updated.
weight The weighting of the Grading period against other Grading periods in the Course offering.
top

Grading Period Grade

The grade awarded to a Person for a given Grading period.

Code Description
course_section_id The Course section for which the grading period grade is given.
created_date The date on which the Grading period grade was first created.
current_score The most recent and visible calculated grade.
final_score The finalized and visible calculated grade.
grading_period_group_id The Grading period group for which the grade is given.
grading_period_id The Grading period for which the grade is given.
hidden_current_score The most recent calculated grade, before it is made visible.
hidden_final_score The finalized calculated grade, before it is made visible.
person_id The Person to whom this Grading period grade is given.
status The current status of the Grading period grade. (option set)
updated_date The date on which the Grading period grade was last updated.
top

Grading Period Group

A grouping of related Grading periods.

Code Description
course_offering_id The Course offering in which the Grading period group exists.
created_date The date on which the Grading period group was first created.
status The current status of the Grading period group. (option set)
title The title of the Grading period group.
updated_date The date on which the Grading period group was last updated.
top

Institutional Affiliation

The association of a Person to an academic institution, and the description of the general or primary capacity in which they act at that institution.

Code Description
directory_block A variable used to describe Persons who are currently electing to block their directory information as per FERPA, or those who previously had a block but are requesting it be removed. A `null` value indicates that the related person does not have a FERPA directory block, and values may be shared in accordance with standard data agreements. This block is only valid for institutional affiliated records. (option set)
person_id The person affilitated with the University.
top

Learner Activity

An assignment, task, piece of work, or other activity that is as part of a course of study.

Code Description
all_day_date The date which the Learner activity is due.
allowable_submission_types The valid submission type(s) for the Learner activity. Presented as a comma-separated list if more than one type is allowed.
course_offering_id The Course offering Id to which this learner activity belongs.
created_date The date & time the learner activity was created.
description The description of the learner activity, described in a way that the learner can understand.
drop_rule Indicates whether and how the Learner activity can be dropped from a Learner activity group.
due_date The date the learner activity is due.
grade_type The method used to assess the learner activity. This is a metric type from which a score is derived. (option set)
has_peer_reviews Indicates whether peer reviewing is enabled for this Learner activity.
has_peer_reviews_assigned Indicates whether peer reviewing is enabled for this Learner activity.
is_all_day Indicates whether the student has all day to complete the Learner activity, in which case the Learner activity result must be submitted before midnight.
is_anonymous_peer_reviews Indicates whether the Learner activity results for this Learner activity are anonymously peer reviewed.
is_automatic_peer_reviews Indicates whether peer reviews are automatically assigned via an algorithm (as opposed to instructor-assigned peer review.)
is_grade_group_students_individually Indicates whether students who submit Learner activity results for this Learner activity as a group will still receive an individual grade.
is_hidden Indicates whether students can see grades on the Learner activity or not.
learner_activity_group_id The identifier of the Learner activity group to which this Learner activity belongs.
locked_date The date & time when the learner activity is locked, indicating that students can no longer start the learner activity.
peer_review_count The number of peers assigned to review a Learner activity result for this Learner activity, if using algorithmic assignment.
peer_reviews_due_date The date & time when peer reviews of the Learner activity's Learner activity results must be completed.
points_possible The maximum number of points that can be earned on this Learner activity.
position The position of the Learner activity in a Learner activity group.
possible_points The number of possible points for the learner activity.
status Current status of the learner activity (option set)
title The title or name of the learner activity.
unlocked_date The date the student was informed about an learner activity or that an automated system displays the learner activity as available for completion.
updated_date The date & time the learner activity was updated.
visibility The visibility of the Learner activity to students in a Course section. Possible values can include, for example, that the Learner activity is visible to everyone or to only subsets of students. (option set)
top

Learner Activity Group

A group of learner activities as part of a course design.

Code Description
course_offering_id The Course offering Id to which this Learner activity group belongs.
created_date The date on which the Learner activity group was first created.
default_learner_activity_name The default name to assign to the Learner activities that fall under this group.
drop_highest_amount Number of highest scored assignments which can be dropped form the group. Set to '0' when none should be dropped. Defaults to '0'.
drop_lowest_amount Number of lowest scored assignments which can be dropped from the group. Set to '0' when none should be dropped. Defauts to '0'.
group_weight The weighting of the Learner activity group against other groups in the Course offering.
name Name of the Learner activity group.
position The position of the Learner activity group in a Course offering.
status Current state of the learner activity group. (option set)
updated_date The date on which the Learner activity group was last updated.
top

Learner Activity Group Grade

The score awarded to a Person in a particular Learner activity group.

Code Description
created_date The date on which the Learner activity group grade was first created.
current_score The most recently calculated and visible grade.
final_score The final and visible grade.
hidden_current_score The most recently calculated grade that is not yet visible.
hidden_final_score The finalized grade that is not yet visible.
learner_activity_group_id The Learner activity group for which the group score is given.
status The current status of the Learner activity group grade. (option set)
updated_date The date on which the Learner activity group grade was last updated.
top

Learner Activity Override

A rule or set of rules that overrides the default conditions of a learner activity for a particular audience of students.

Code Description
all_day_date The date version of the due date if the IsDueOnDay attribute is true.
all_day_type Indicates whether this Learner activity override's "Due date as a day" value overrides the Learner activity's "Due date as a day" value. (option set)
course_section_id Foreign key to the Course section with which the override is associated.
created_date The date on which the learner activity override was created.
due_date The new due date if the "Due date is overridden" value is True.
learner_activity_id Foreign key to the learner activity with which the override is associated.
learner_activity_version The version of the learner activity to which this override applies.
learner_group_id Foreign key to the the Learner group with which the override is associated.
locked_date The new Locked date if the "Locked date is overridden" value is true.
overridden_due_date True if a learner activity's original "Due date" value has been overridden.
overridden_locked_date True if a learner activity's original "Locked date" value has been overridden.
overridden_unlocked_date True if a learner activity's original "Unlocked date" value has been overridden.
quiz_id Foreign key to the assessment with which the override is associated.
quiz_version The version of the assessment to which this override applies.
status Current state of the learner activity override. (option set)
title The title of the learner activity override.
type Defines to which Entity the learner activity override is applied. (option set)
unlocked_date The new Unlocked date if the "Unlocked date is overridden" value is True.
updated_date The date & time the learner activity override was updated.
top

Learner Activity Result

The result of a learner engagement with a learner activity.

Code Description
attempt The number of attempts made to submit the Learner activity result, including this one.
body Text content for the Learner activity result.
created_date The date on which the Learner activity result was created.
grade Letter grade mapped from the score by the grading scheme.
grade_state Indicates the state of the grade for this Learner activity result. Values may include, for example, not graded, auto graded, and human graded.
gradebook_status Indicates whether the current result is the one used in calculating gradebook scores. (option set)
graded_date Timestamp of when the Learner activity result was graded.
grader_id Foreign key to the person who graded the learner activity result.
grading_status Denotes where the Learner activity result is in the grading process. (option set)
has_admin_comment Indicates whether the Learner activity result has an administrator comment attached to it.
has_rubric_assessment Pertinent only for graded Learner activity results. Its value is set to 'true' if the Learner activity result is associated with a Rubric that has been assessed for at least one student, otherwise is set to 'false'. Defaults to 'NULL'.
is_excused Indicates whether this Learner activity result is excused or not.
is_grade_anonymously Indicates whether the Learner activity result was graded anonymously or not.
is_processed Pertinent when there is a File associated with the Learner activity result. By default, this attribute is 'false'. When a Learner activity result has a File associated with it, upon submitting the Learner activity a snapshot is saved and its value is set to 'true'. Defaults to 'NULL'.
learner_activity_id Foreign key to Learner activity of which this is a result.
learner_group_id Foreign key to the learner group table
person_id Foreign key to person who submitted the learner activity result.
posted_at The date and time that the learner activity result was posted to the student. Value is null if it has not been posted.
process_attempts The number of times Learner activity results have been attempted.
published_grade Strings that reflect the grading type used.
published_score Numerical value of the actual score.
quiz_id Foreign key to the Quiz with which this Learner activity result is associated.
quiz_result_id Foreign key to the Quiz result Id to which this Learner activity result is associated.
response_date Timestamp of when the Learner activity result was was submitted
score Numberic grade given to the Learner activity result.
submission_comments_count The number of comment(s) written by the grader on the Learner activity result.
type Type of Learner activity result. Possible values are 'discussion_topic', 'external_tool', 'media_recording', 'online_file_upload', 'online_quiz', 'online_text_entry', 'online_upload' and 'online_url'. (option set)
updated_date The date & time the Learner activity result was updated.
url URL content for the Learner activity result.
top

Learner Group

A pedagogically-oriented group of learners in a course. This concept is distinct from Course section, which is an administrative grouping of learners.

Code Description
category The group's description by its users.
context_type The type of learning context in which this Learner group is situated. This could be a Course, Account, etc.
course_offering_id The Course offering Id to which this learner activity belongs.
created_date The date on which the learner group was created.
default_view The default presentation view for Learner groups.
deleted_date The date on which the learner group was deleted.
description A description of the particular Learner group.
is_public_contents Indicates whether any user may access the contents of the group (e.g., files).
join_level The criteria required to join a Learner group. This can be automatic joining, by invitation only, etc.
max_membership Maximum number of users that can be accommodated in a group.
name The name of the Learner group.
status Status of the learner group. (option set)
storage_quota Storage limit allowed per group.
updated_date The date on which the learner group was updated.
top

Learner Group Membership

The role in which a Person participates in a Learner group.

Code Description
created_date The date on which the Learner group membership was first created.
is_moderator Denotes if the Person is a moderator for the Learner group.
learner_group_id The Learner group in which the role exists.
person_id The Person participating in the Leaner group.
status The current status of the Learner group membership.
updated_date The date on which the Learner group membership was last updated.
top

Learning Outcome

Measurable statements that express student knowledge or a student skill.

Code Description
academic_term_id The Academic term in which the Learning outcome is assessed.
calculation_int If needed for the calculation method, the value of the variable.
calculation_method The method by which the Learning outcome is calculated.
course_offering_id The Course offering in which the Learning outcome is assessed.
created_date The date on which the Learner outcome was first created.
description A fully-formed description of the Learning outcome and its objectives.
display_name The name of the Learning outcome, as displayed in the LMS.
mastery_points The minimum number of points the learner must receive to achieve mastery in the Learning outcome.
points_possible The maximum number of points that a learner can receive on a Learning outcome.
short_desc A short description or title of the Learning outcome.
status The current status of the Learning outcome.
updated_date The date on which the Learner outcome was last updated.
vendor_guid The globally unique id (GUID) by which the Learning outcome is referred to.
top

Learning Outcome Group

A grouping of related Learning outcomes.

Code Description
academic_term_id The Academic term in which the Learning outcome group exists
course_offering_id The Course offering in which the Learning outcome group exists.
created_date The date & time the Learning outcome group was created.
description The description of the learning outcome group.
parent_group_id The Learning outcome group that is the parent of this group.
root_group_id The Learning outcome group that is associated with the root group in the group hierarchy.
status The workflow status of the learning outcome. Possible values are 'active' and 'deleted'. Defaults to 'active'.
title The title of the Learning outcome group.
updated_date The date & time the Learning outcome group was updated.
vendor_guid A custom GUID for the learning standard.
top

Learning Outcome Item Response

The result of a learner responding to a Learning outcome question.

Code Description
academic_term_id The Academic term in which the Learning outcome item response exists.
assessed_date The date & time the Learning outcome item response was assessed.
course_offering_id The Course offering in which the Learning outcome item response exists.
created_date The date & time the Learning outcome item response was created.
has_mastery A boolean indicating whether user achieved mastery for this question
has_original_mastery A boolean value indicating whether user achieved mastery.
learning_outcome_id The Learning outcome in which the Learning outcome item response exists.
number_attempts The total number of attempts, or learner activity results.
original_score The student's score on the first attempt.
percent Percent of maximum points possible for a Learning outcome, scaled to reflect any custom mastery levels that differ from the learning outcome.
person_id The Person in which the Learning outcome item response exists.
points_possible Total number of points possible.
quiz_id The Quiz with which the Learning outcome item response is associated.
quiz_item_id The Quiz item with which the Learning outcome item response is associated.
score The student's score on the question.
submitted_date The date & time the Learning outcome item response was submitted.
title The title of the Learning outcome item response.
updated_date The date & time the Learning outcome item response was updated.
top

Learning Outcome Result

The result of a learner being assessed on a Learner outcome.

Code Description
academic_term_id The Academic term in which the Learning outcome result takes place.
assessed_date The date & time the Learning outcome result was assessed.
attempts The total number of attempts, or learning activity results, by the user.
course_offering_id The Course offering in which the Learning outcomes result takes place.
created_date The date & time the Learning outcome result was created.
has_mastery A boolean indicating whether user achieved mastery.
has_original_mastery A boolean value indicating whether user achieved mastery.
is_hidden A boolean value indicating whether the Learning outcome result should be hidden from the Learning Mastery Gradebook and reports.
is_hide_points A boolean value indicating if Learning outcome result points should be hidden in the Learning Mastery Gradebook and reports. If enabled, then replace the points with the description of the highest scoring outcome criterion rating.
learner_activity_id Foreign key to the Learner activity with which the Learning outcome result exists.
learning_outcome_id The Learning outcome with which the Learning outcome result is associated
original_possible The total nubmer of possible points on the student's first attempt.
original_score The student's score on the first attempt.
percent Percent of maximum points possible for a Learning outcome, scaled to reflect any custom mastery levels that differ from the learning outcome.
person_id The Person who made the Learning activity result against which this Learning outcome is related.
points_possible Total number of points possible.
quiz_id The Quiz with which the Learning outcome result is associated.
score The user's score on the Lerning outcome result.
submitted_date The date & time the Learning outcome result was submitted.
updated_date The date & time the Learning outcome result was update.
top

Learning Outcome Rubric Criteria

The criteria by which a learner will be assessed on a given Learning outcome.

Code Description
academic_term_id The Academic term in which the Learning outcome rubric criteria is used.
course_offering_id The Course offering in which the Learning outcome rubric criteria is used.
description A description of the rubric Learning outcome criterion.
learning_outcome_id The Learning outcome in which the Learning outcome rubric criteria exists.
points_possible The total number of possible points associated with the rubric criterion.
top

Module

A means of organizing content to help control the flow of a course.

Code Description
course_offering_id The Course offering in relation to which the Module exists.
created_date The date & time the Module was created.
deleted_date The date & time the Module was deleted.
name The name of the Module.
position The position of the Module among other Modules in the Course offering.
prerequisite_module_id The prerequisite Module for the Module.
sequential A value indicating whether the Module items of this Module must be completed sequentially? Valid values are 'required', 'not_required', 'unspecified'.
status The workflow state for the Module. Possible values are 'locked', 'completed', 'unlocked' and 'started'. (option set)
unlocked_date The date & time the Module was unlocked.
updated_date The date & time the Module was updated.
top

Module Item

A specific piece of course content in a Module.

Code Description
completion_type Describes the type of completion event that must be achieved to consider item complete.
course_offering_id The Course offering in which this Module item is located.
created_date The date & time the Module item was created.
discussion_id The Discussion referenced by the Module item.
file_id The File referenced by the Module item.
learner_activity_id The Learner activity referenced by the Module item.
min_score If the completion type requires a minimum score, then this is the score that must be attained for completion.
module_id The parent Module of the the Module item.
person_id If the Module item is associated with a Discussion, File, Quiz, or Page, then this Person Id references the author of the Discussion, File, Quiz, or Page.
position The position of the Module item among other Module items in the Module.
quiz_id The Quiz referenced by the Module item.
status The workflow status of the Module item. (option set)
title The title of the Module item.
type The type of content linked to from this Module item. This can be a Learner activity, Attachment, Discussion topic, External tool, External URL, Learning outcome, Quiz, Rubric, Page, or Module subheader. (option set)
updated_date The date & time the Module item was updated.
url The URL associated with the Module item, if the Module item is an External URL or External tool.
wiki_page_id The Page referenced by the Module item.
top

Module Item Completion

An indication that a Person has completed a particular Module item.

Code Description
completion_status Denotes whether the completion event is complete or not. Possible values are 'complete' and 'incomplete'.
min_score If the completion type requires a minimum score, then this is the score that must be attained for completion.
module_item_id The Module item referenced by the Module item completion.
module_progression_id The Module progression referenced by the Module item completion.
requirement_type Describes the type of completion event that must be achieved to consider item complete.
score If the completion type requires a minimum score, this is the score that the user has currently achieved for completion.
top

Module Progression

The progress that a Person has made towards completing a specific Module.

Code Description
completed_date The date & time the Module progression was completed.
created_date The date & time the Module progression was created.
current_position The user's current position in the Module.
evaluated_date The date & time the Module progression was evaluated.
is_collapsed Whether or not the Module progression is collapsed for the user.
is_current The current state of the Module progression for the user.
lock_version The lock version of the Module progression.
module_id The Module for the Module progression.
person_id The Person whose Module progression this is.
status The workflow state of the Module progression for the user (option set)
updated_date The date & time the Module progression was updated.
top

Participant Session

A session in which Persons participate, such as a conference.

Code Description
actual_end_time The date & time that the Participant session actually ended.
actual_start_time The date & time that the Participant session actually started.
course_offering_id The Course offering referenced by the Participant session
created_date The date & time the Participant session was created.
duration The actual duration, in milliseconds, of the Participant session.
learner_group_id The Learner group referenced by the Participant session.
scheduled_end_time The date & time that the Participant session is scheduled to end.
scheduled_start_time The date & time that the Participant session is scheduled to start.
title The title of the Participant session.
type The Participant session type – usually, this refers to the type of tool used to deliver the Participant session.
updated_date The date & time the Participant session was updated.
top

Participant Session Role

The role in which a Person acts in a given Participant session.

Code Description
created_date The date & time the Participant session role was created.
participant_session_id The Participant session in which the participant participated.
person_id The Person who participanted in the Participation session.
role The role of the Person who participated in the Participant session. (option set)
updated_date The date & time the Participant session role was updated.
top

Person

An individual participating, in any capacity, in the design, delivery, or evaluation of teaching and learning processes and environments.

Code Description
act_composite Composite ACT score.
act_english Score on ACT English exam.
act_math Score on ACT Math exam.
act_reading Score on ACT Reading exam.
act_science Score on ACT Science exam.
active_duty Is the student/person an active duty member of the military? (option set)
col_gpa_cum The cumulative GPA of a post-secondary student through to their most recent term. This GPA score is intended to cover the whole career of a post-secondary student.
course_count Number of courses undertaken by student from date of SIS data availability to present, regardless of pass/fail.
edu_level_maternal The highest level of education attained by a person's mother or maternal guardian(s). (option set)
edu_level_parental The highest level of education attained by a person's parent or guardian(s). Use this if the available data is not specific to a mother/maternal guardian or father/paternal guardian. (option set)
edu_level_paternal The highest level of education attained by a person's father or paternal guardian(s). (option set)
email_address The university’s primary address for contacting a person by email.|
email_type The type of email address that is the primary method of contact for the person by email. (option set)
enrollment_level The enrollment type of this person (student) at your institution. (option set)
ethnicity The self-reported ethnicity of the student. (option set)
first_name Legal first name of the person.
hs_gpa Student’s reported cumulative high school grade point average. This value is intended to capture the primary GPA used by your institution to evaluate this student’s admission.
last_name Legal family name of the person
middle_name Legal middle name or names of the person.
phone_number The university’s primary number for contacting a person by phone.
phone_type The type of phone number that is the primary method of contact for the person by phone. (option set)
sat_math_combined The combined SAT Math score from the student's best sitting. A combined score combines the actual post-2016 score with concorded (translated) pre-2016 score.
sat_math_post_2016 The post-2016 SAT Math score from the student's best sitting.
sat_math_pre_2016 The non-concorded, pre-2016 SAT Math score from the student's best sitting.
sat_reading_post_2016 The post-2016 SAT Reading score from the student's best sitting.
sat_total_combined Total Combined SAT score. This score combines concorded Math, Reading, and Writing scores except if a Writing score is unavailable, in which case this score is null.
sat_verbal_pre_2016 The non-concorded, pre-2016 SAT Verbal score from the student's best sitting.
sat_verbal_reading_combined The combined SAT Verbal and Reading scores from the student's best sitting. A combined score combines the concorded (translated) pre-2016 Verbal score with the actual post-2016 Reading score.
sat_writing_combined The combined SAT Writing scores from the student's best sitting. A combined score combines the concorded (translated) pre-2016 Writing score with the actual post-2016 Writing score *except* if the pre-2016 Writing score is missing, in which case this field is `null`.
sat_writing_post_2016 The post-2016 SAT Writing score from the student's best sitting.
sat_writing_pre_2016 The non-concorded, pre-2016 SAT Writing score from the student's best sitting.
sex The legal sex of the person. (option set)
suffix Suffix for the person.
us_residency The person’s residency status in the United States. (option set)
veteran Is the student/person a military veteran (i.e., a retired member of the military who served on active duty)? (option set)
zip_code The zip code of the student’s permanent address at time of his or her application.
top

Quiz

A class of learner activity used to assess learner content mastery.

Code Description
allowed_attempts The number of attempts the student is allowed to try the Quiz. If there is not attempt limit, then the value is set to -1 or NULL.
course_offering_id The Course offering to which this Quiz belongs.
created_date The date & time that the Quiz was created.
deleted_date The date & time that the Quiz was deleted.
description The description of the Quiz.
due_date The date & time that the Quiz was due.
ip_filter Restricts access to the Quiz to computers in a specified IP address range.
is_allow_anonymous_submissions Indicates whether students are allowed to submit the quiz anonymously.
is_allow_go_back_to_previous_question Indicates whether the user may go back to previous Quiz items or may only go forward. Only valid if Display multiple Quiz items? is 'false'.
is_browser_lockdown_required Indicates whether the browser must be locked-down when the Quiz is taken.
is_can_be_locked Indicates whether the Quiz can be locked.
is_display_multiple_questions Indicates whether multiple Quiz items are displayed at a time.
is_shuffled_answer_display_order Indicates whether the answers for Quiz items are displayed in a consistent order or shuffled.
learner_activity_id Foreign key to Learner activity of this Quiz.
locked_date The date & time that the Quiz was locked for students.
points_possible The maximum number of points that can be earned.
published_date The date & time that the Quiz was published.
quiz_item_count The number of Quiz items in the Quiz.
scoring_policy Scoring policy for a Quiz that students can take multiple times. Is required and only valid if allowed_attempts > 1. (option set)
show_results Indicates whether Quiz results are shown to students. If Quiz results are always shown, then students can see their results after any attempt. If Quiz results are never shown, then students can never see their results. If students are allowed more than one Quiz attempt, then if Quiz results are always shown after the last attempt, students can always see their results but only after the last attempt. If students are allowed to see their Quiz results and the value is set to only show students once after their last attempt, then students are show their Quiz results once after their last attempt.
status Denotes where the Quiz is in its workflow. (option set)
time_limit The amount of time, in minutes, that the student is given to complete the Quiz. If there is no limit, the value is set to -1 or NULL.
title The title of the Quiz.
type The type of Quiz. (option set)
unlocked_date The date & time that the Quiz was unlocked for studnets.
updated_date The date & time that the Quiz was updated.
top

Quiz Item

A particular quiz item in a particular quiz.

Code Description
body The body content of the Quiz item.
correct_comments Comments to be displayed if the student answers the Quiz item correctly.
created_date The date & time that the Quiz item was created.
incorrect_comments Comments to be displayed if the student answers the Quiz item incorrectly.
is_regrade_option_available Indicates whether regrading is available for the Quiz item.
learner_activity_id Foreign key to the Learner activity of which this Quiz item's Quiz is a part.
name The name of the Quiz item.
neutral_comments Comments to be displayed regardless of how the student answers the Quiz item.
points_possible The number of points possible on the Quiz question.
position The position of the Quiz item in the Quiz item group.
quiz_id Foreign key to the Quiz of which this Quiz item is a part.
quiz_item_group_id Foreign key to the Quiz item group of which this Quiz item is a part.
quiz_item_type The type of Quiz item. (option set)
status The status of the Quiz item.
updated_date The date & time that the Quiz item was updated.
top

Quiz Item Group

A group of Quiz items.

Code Description
created_date The date & time that the Quiz item group was created.
name The name of the Quiz item group.
pick_count The number of Quiz items selected from this group that were used in the Quiz.
position The order in which the Quiz items from this group will be displayed in the Quiz relative to the other Quiz items in the Quiz from other groups.
quiz_id The Quiz to which this Quiz item group belongs.
quiz_item_points The number of points assigned to each Quiz item in the Quiz item group.
updated_date The date & time that the Quiz item group was updated.
top

Quiz Item Response

The learner response given for a particular quiz item.

Code Description
answer_match_left When a Quiz item is a matching question, then this is the value of the answer that is displayed to the left for students to match.
answer_match_right When a Quiz item is a matching question, then this is the value of the answer that is displayed to the right for students to match.
blank When a Quiz item is a fill in multiple blanks question, then this refers to the blank(s) in the question text.
body The body of the Quiz item response.
comments The contextual comments of a Quiz item response.
ending_range When the Quiz item is a numerical question and Numeric answer is of type 'range type', then this is the ending value for the range in which the answer must fall.
exact When the Quiz item is a numerical question and Numeric answer is of type 'exact type', then this is the value the answer must be equal to.
html The HTML markup of the Quiz item response.
incorrect_matches When a Quiz item is a matching question, then this is the list of distractors (incorrect answers), delimited by newlines, that will be seeded with the 'Answer match right' values.
margin When the Quiz item is a numerical question and Numeric answer is of type 'exact type', then this is the margin of error allowed for a student's answer.
numerical_answer_type When a Quiz item is a numerical question, then this denotes the type of numerical answer that is expected. Possible values are 'exact_answer' and 'range_answer'.
quiz_item_id The Quiz item to which this Quiz item response is responding.
starting_range When the Quiz item is a numerical question and Numeric answer is of type 'range type', then this is the starting value for the range in which the answer must fall.
text_after_answers When a Quiz item is a fill in the blank question, this is the text that follows the word that is blank.
weight A measure of the correctness of the Quiz item response. Incorrect answers should have a measure of 0; correct answers should have a non-negative measure.
top

Quiz Result

A learner response to a quiz.

Code Description
created_date The date & time the Quiz result was created.
due_date The date & time that the Quiz was due, after which the Quiz result is marked as late.
extra_attempts The number of times above the allowable threshold the student attempted the learner activity
extra_time The amount of extra time that the student was given, in minutes, to complete the Quiz.
finished_date The date & time that the user finished the Quiz.
fudge_points The number of points fudged on the Quiz result score. The values can be negative or positive.
is_student_viewed Indicates if the student has viewed the results of their learner activity result
kept_score If multiple attempts on the Quiz are allowed, then this is the score among the attempts that is kept and used for the student.
learner_activity_id The Learner activity associated with this Quiz result.
learner_activity_result_id The Learner activity result associated with this Quiz result.
person_id The Person record for the student who submitted this Quiz result.
points_possible The maximum number of points that can be earned on the Quiz for this is a result.
quiz_id The Quiz for which this is a student Quiz result.
result_date Identical to the Finished date – the date & time when the user finished the Quiz.
score The score of the Quiz result.
score_before_regrade The original score of the Quiz result before any regrading.
started_date The date & time that the user started the Quiz.
state_in_submission The state of the Quiz at the time it was submitted. The Quiz may have been unlocked after being locked; the Quiz result was submitted on time, which is to say the Quiz was never locked. (option set)
status The workflow state of the Quiz result. (option set)
submission_scoring_policy Indicates whether the score was manually overridden by the teacher to reflect the score of the previous attempt. The values will either indicate it was manually overridden, or be the scoring policy for the Quiz. (option set)
submission_source Indicates where the Quiz result was received from – these can be from the student or from an automated process.
time_taken The time taken, in milliseconds, for the students to complete the Quiz.
total_attempts The total number of attempts that the student made on the Quiz for which this is a quiz result.
updated_date The date & time the Quiz result was updated.
top

Role

The function assumed by a Person in a particular situation.

Code Description
base_role_type The fundamental role from which the Role is built. (option set)
created_date The date on which the Role was first created.
deleted_date The date on which the Role was deleted.
name The name of the Role.
status The current status of the Role. (option set)
updated_date The date on which the Role was last updated.
top

Wiki

A site that allows collaborative editing of its content and structure by its users.

Code Description
course_offering_id The Course offering Id of the Wiki page, if the Wiki page is part of a Course offering.
created_date The date on which the the Wiki was first created.
front_page_url The URL at which the front page of the Wiki resides.
has_no_front_page If true, the Wiki does not have a front page.
learner_group_id The Learner group of the Wiki page, if the Wiki page is assocaited with a Learner group.
parent_entity_type The type of Entity that owns the Wiki.
title The title of the Wiki.
updated_date The date on which the Wiki was last updated.
top

Wiki Page

A particular page in a Wiki.

Code Description
body The body (content) of the Wiki page.
comments_count The number of comments on the Wiki page.
could_be_locked Denotes whether the WIki page could be locked.
created_date The date on which the Wiki page was first created.
editing_roles The role(s) in which Persons may contribute to the Wiki page.
is_protected_editing Denotes whether the Wiki page only allows certain Person(s) to edit or revise.
person_id The Person who originally authored the Wiki page.
revised_date The date on which the Wiki page last had revisions to its Body.
status The current status of the Wiki page. (option set)
title The title of the Wiki page.
updated_date The date on which the Wiki page was last updated.
url The URL at which the Wiki page resides.
view_count The number of times the Wiki page has been viewed.
wiki_id The Wiki to which this Wiki page belongs.
top