Documentation

The learning module table structure

Table fields

Training course

Field Description Type Required Default
ID The course ID. Int Yes  
TIMESTAMP_X The time when the course was last modified. Datetime   Current
ACTIVE Active state flag (Y|N). Char(1) Yes Y
CODE Mnemonic identifier. String(50)    
NAME The course name. String(255) Yes  
SORT Sort index. Int Yes 500
PREVIEW_PICTURE The picture ID in the preview file table. Int    
PREVIEW_TEXT Short course description. Text    
PREVIEW_TEXT_TYPE The type of short course description (text/html). String(4) Yes Text
DESCRIPTION Description. Text    
DESCRIPTION_TYPE The description type (text/html). String(4) Yes Text
ACTIVE_FROM The date from which the course is active. Datetime    
ACTIVE_TO The date from which the course is inactive. Datetime    

Chapters

Field Description Type Required Default
ID The chapter ID. Int Yes  
TIMESTAMP_X The date when the chapter was last modified. Datetime   Current
ACTIVE Active state flag (Y|N). Char(1) Yes Y
COURSE_ID The course ID. Int Yes  
CHAPTER_ID The parent chapter ID, or root if not specified. Int    
NAME The chapter name. String(255) Yes  
CODE Mnemonic identifier. String(50)    
SORT Sort index. Int Yes 500
PREVIEW_PICTURE The picture ID in the preview file table. Int    
PREVIEW_TEXT Short chapter description. Text    
PREVIEW_TEXT_TYPE The type of short description (text/html). String(4) Yes Text
DETAIL_PICTURE The picture ID in the detail view file table. Int    
DETAIL_TEXT Detailed description. Text    
DETAIL_TEXT_TYPE The type of detailed description (text/html). String(4) Yes Text

Lessons
Уроки

Field Description Type Required Default
ID The lesson ID. Int Yes  
TIMESTAMP_X The time when the lesson was last modified. Datetime   Current
DATE_CREATE The date when the lesson was created. Datetime Yes Current
CREATED_BY The ID of the user who has created the lesson. Int Yes Current user.
ACTIVE Active state flag (Y|N). Char(1) Yes Y
COURSE_ID The course ID. Int Yes  
CHAPTER_ID The chapter ID. If not specified, the lesson is not bound to chapter. Int    
NAME The lesson name. String(255) Yes  
SORT Sort index. Int Yes 500
PREVIEW_PICTURE The picture ID in the preview file table. Int    
PREVIEW_TEXT Short lesson description. Text    
PREVIEW_TEXT_TYPE The type of short description (text/html). String(4) Yes Text
DETAIL_PICTURE The picture ID in the detail view file table. Int    
DETAIL_TEXT Detailed description. Text    
DETAIL_TEXT_TYPE The type of detailed description (text/html). String(4) Yes Text

Questions

Field Description Type Required Default
ID The question ID. Int Yes  
TIMESTAMP_X The time when the question was last modified. Datetime   Current
ACTIVE Active state flag (Y|N). Char(1) Yes Y
LESSON_ID The lesson ID. Int Yes  
QUESTION_TYPE The question type (S - single choice, M - multiple choice). Char(1) Yes S
NAME The question name. String(255) Yes  
SORT Sort index. Int Yes 500
DESCRIPTION Description. Text    
DESCRIPTION_TYPE The description type (text/html). String(4) Yes Text
FILE_ID The picture/file ID in the file table. Int    
SELF Indicates if the question is self-check (Y/N). Char(1) Yes Y
POINT Score. Int Yes 10

Variants of answers

Field Description Type Required Default
ID The answer ID. Int Yes  
QUESTION_ID The question ID. Int Yes  
SORT Sort index. Int Yes 10
ANSWER Variant of answer. Text Yes  
CORRECT Indicates if the answer is correct (Y/N). Char(1) Yes  
FEEDBACK Comment to the answer. Text    

Tests

Field Description Type Required Default
ID The test ID. Int Yes  
COURSE_ID The course ID. Int Yes  
TIMESTAMP_X The time when the test was last modified. Datetime   Current
SORT Sort index. Int Yes 500
ACTIVE Active state flag (Y|N). Char(1) Yes Y
NAME The test name. String(255) Yes  
DESCRIPTION Description. Text    
DESCRIPTION_TYPE The description type (text/html). String(4) Yes Text
ATTEMPT_LIMIT Maximum count of attempts. 0 means unlimited. Int Yes  
TIME_LIMIT Testing session time limit (min). 0 means unlimited. Int    
COMPLETED_SCORE The required percent of correct answers for the test to be passed. Int    
QUESTIONS_FROM Indicates which questions are included in test: A - from the whole course, C - from each chapter, L - from each lesson. Char(1) Yes A
QUESTIONS_AMOUNT Number of questions in test. Int Yes  
RANDOM_QUESTIONS Indicates the random order of questions (Y|N). Char(1) Yes Y
RANDOM_ANSWERS Indicates the random order of answers (Y/N). Char(1) Yes Y
APPROVED Whether results are checked automatically (Y|N). Char(1) Yes Y
INCLUDE_SELF_TEST Whether self-check questions are included (Y/N). Char(1) Yes N
PASSAGE_TYPE The test process design:

0 - the student cannot switch to the next question without answering the current one, and cannot change their answers;

1 - the student can switch to the next question without answering the current one but cannot change their answers;

3 - the student can switch to the next question without answering the current one, and can change their answers.

Char(1) Yes 0

Test attempts

Field Description Type Required Default
ID The attempt ID. Int Yes  
TEST_ID The test ID. Int Yes  
STUDENT_ID The ID of the user who is currently taking the test. Int Yes  
DATE_START The time when a test started. Datetime Yes Current
DATE_END The time when a test was completed. Datetime    
STATUS The attempt status: B - started, D - aborted, F - completed. Char(1) Yes B
SCORE Score. Int    
MAX_SCORE Maximum score. Int   Automatically
QUESTIONS Number of questions in an attempt. Int   Automatically

Examination schema

Field Description Type Required Default
ID The result ID. Int Yes  
ATTEMPT_ID The attempt ID. Int Yes  
QUESTION_ID The question ID. Int Yes  
RESPONSE The student answer. Text    
POINT Score. Int Yes  
ANSWERED The question is answered (Y/N). Char(1) Yes N
CORRECT The question is answered correctly (Y/N). Char(1) Yes N

Grade book

Field Description Type Required Default
ID The record ID in the grade book. Int Yes  
STUDENT_ID The ID of the user who is currently taking the test. Int Yes  
TEST_ID The test ID. Int Yes  
RESULT The result score. Int    
MAX_RESULT Maximum result score. Int   Automatically
COMPLETED The test is completed (Y/N). Char(1) Yes N
ATTEMPTS Number of attempts allowed. Int.   Automatically

Certificates

Field Description Type Required Default
ID The certificate ID. Int Yes  
STUDENT_ID The user ID. Int Yes  
COURSE_ID The course ID. Int Yes  
TIMESTAMP_X The time when the certificate was modified. Datetime   Current
DATE_CREATE The time when certificate was created. Datetime    
ACTIVE Active state flag (Y|N). Char(1) Yes Y
SORT Sort index. Int Yes 500
FROM_ONLINE The certificate was obtained via an online training course (Y/N). Char(1) Yes Y
PUBLIC_PROFILE The certificate will be published in the profile (Y/N). Char(1) Yes Y
SUMMARY The number of points collected while taking all tests of the course. Int Yes  
MAX_SUMMARY Maximum number of points collected while taking all tests of the course. Int Yes Automatically

Student profile

Field Description Type Required Default
USER_ID The user ID. Int Yes  
TRANSCRIPT Random numeric identifier. Int Yes Automatically
PUBLIC_PROFILE Whether profile is public or not (Y/N). Char(1) Yes N
RESUME The student resume. Text    
© «Bitrix24», 2001-2024