Template and Guideline to Document in LM Project

download Template and Guideline to Document in LM Project

of 23

Transcript of Template and Guideline to Document in LM Project

  • 8/3/2019 Template and Guideline to Document in LM Project

    1/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 1 (23)

    LrnEnv Database Table Specification

    Summary

    This document provides enter the summary of the purpose of the document here.

    Scope of distribution

    1. All members of LrnEnv project.Revision history

    Version By Changes/comments Date

    1 Songrit Created dd/mm/yyyy

  • 8/3/2019 Template and Guideline to Document in LM Project

    2/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 2 (23)

    1.IntroductionTable template

    Column Data type Description Possible values

    2.Main Concept Tables2.1 Course Related tablesCURRICULUM: Information about curriculum

    Column Data type Description Possible values

    CurId autosmllint Curriculumn Id 1-32K

    Dept smallint Department Id of department that administrates the curriculum FK.DEPARTMENT.DeptId

    Level char-1 Level of the curriculum LrnEnv defined, FK.LOCAL_CODE

    For example

    'u' Undergraduate'm' Master's

    'd' Doctoral

    CurNameEn vchar Name of the curriculum in English

    CurNameTh vchar Name of the curriculum in Thai

    SemBegin smallint First semester that the curriculum becomes effective FK.SEMESTER.SemId

    SemEnd smallint Last semester that the curriculum is used -1 if currently used or the end semester is unknownFK.SEMESTER.SemId

    Updated DateTime Last update time of the curriculum, including course listing and

    TQF requirement

    OtherInfo.... Other information on Curriculum

  • 8/3/2019 Template and Guideline to Document in LM Project

    3/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 3 (23)

    CRC_COURSE: Information about courses in curriculum

    Column Data type Description Possible values

    CurId smallint Curriculmn Id FK.CURRICULUM.CurId

    CrsId autoint Course Id in curriculum FK.COURSE.CrsId

    COURSE: Information about each course

    Column Data type Description Possible values

    CrsId autoint Course Id Positive integer

    Dept smallint Department Id of department that administrates course FK.DEPARTMENT.DeptId

    Code char-10 Course code University course code in uppercase

    TitleEn vchar Course title in English

    TitleTh vchar Course title in Thai

    DescEn vchar Course description in English

    DescTh vchar Course description in Thai

    Prerequisite vchar Pre-requisite, textual information of course code(s)

    Corequisite vchar Co-requisite, textual information of course code(s)Aim vchar Aim of course

    Purpose vchar Purpose of course development

    Credit smallint Number of credits

    TeachHr vchar Teach hours with optional descriptive information Either free text or integer (hrs/week)

    SelfHr vchar Self study hours with optional descriptive information Either free text or integer (hrs/week)

    PracticeHr vchar Practice hours with optional descriptive information Either free text or integer (hrs/week)

    ConsultHr vchar Consultation hours with optional descriptive information Either free text or integer (hrs/week)

    Type char-1 Course type LrnEnv defined, FK.

    For example

    'l' Laboratory style

    't' Teach/lecture based'p' Problem based

    TQFState char-1 State on TQF-related data of the course. The value here only

    applies to TQF related data of the course. Only the content

    manager of the department that hosts the course can change this

    state. This is to prevent the problem of locking/unlocking a

    'l' Locked, only content manager can edit the TQF related data

    'u' Unlocked, course owner can edit TQF related data

  • 8/3/2019 Template and Guideline to Document in LM Project

    4/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 4 (23)

    general course in many curricula of many departments.

    StudentEval vchar Strategy of course evaluation by student (part of TQF.3) Free text

    TeachingEval vchar Strategy of teachning evaluation (part of TQF.3) Free text

    OutcomeReview vchar Outcome standard review (part of TQF.3) Free text

    PerfReview vchar Performance improvement review and plan (part of TQF.3) Free text

    UpdatedBy int UnivId of the person who makes the last update to course oroutcomes of to course FK.User.UnivId

    Updated DateTime Last update time

    CLASS: Information about teaching class (or section) of course

    Column Data type Description Possible values

    ClassId autoint Class Id Positive integer

    CrsId int Course Id FK.COURSE.CrsId

    Link int Class link Id, used for defining a group of related classes during

    material/announcement posting

    0 if there is no linked class

    FK.CLASS_LINK.CLinkId

    Sem smallint SemId of semester that the course opens FK.SEMESTER.SemId

    Section char-4 Section of this class

    NumWeek smallint Number of weeks in class, including midterms and final 1-24

    LangPref char-1 Language preference on displaying course information 'e' English

    't' Thai

    Dept smallint Department Id of department that administrates course FK.DEPARTMENT.DeptId

    Code char-10 Course code University course code in uppercase

    Title vchar Course title From either COURSE.TitleEn or COURSE.TitleTh, depending

    on LangPref

    Type char-1 Course type LrnEnv defined, FK.

    For example

    'l' Laboratory style

    't' Teach/lecture based'p' Problem based

    JoinPolicy char-1 Allowed join policy of student 'a' Automatic import from registration database, no manual add

    'i' Automatic import from registration database, allow

    instructor to manually add students

    'm' Instructor manually add new students

  • 8/3/2019 Template and Guideline to Document in LM Project

    5/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 5 (23)

    'o' Self register, open to everybody

    'p' Self register, using class password to join

    'r' Self register, must be approved by instructor

    JoinPassword char-16 Join password 16-bytes hash of password

    RegStudent smallint Number of registered students

    OthrStudent smallint Number of other active students (e.g. sit-in)The value of fields Dept, Code, Title, Type are derived from COURSE table for performance

    CLASS_INSTRUCTOR: Information about instructor of an opening class

    Column Data type Description Possible values

    ClassId int Class Id FK.CLASS.ClassId

    Instructor int UnivId of instructor FK.USER.UnivId

    Role char-1 Role of the instructor LrnEnv defined. FK.TEACH_ROLE

    For example

    'l' Technician

    'o' - Observer

    'p' Primary instructor's' Secondary instructor

    't' Teaching assistant

    JoinStatus char-1 Joining status 'l' Left

    'j' Joined

    'p' Pending to approval

    WeekInvolved char-3 Bit array of weeks that the instructor involves in the class Bit array (24 bits), the first bit represents the first week

    0 Not involved

    1 Involved

    Load smallint Load of the instructor from 100% 0-100

    LastAccess* DateTime Last time instructor accessed the class

    Joined DateTime Time instructor joined the classLeft* DateTime Time instructor left the class Must be >= Joined

    CLASS_LINK: Information about predefined material sharing between classes

    Column Data type Description Possible values

  • 8/3/2019 Template and Guideline to Document in LM Project

    6/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 6 (23)

    ClinkId autoint Class link Id Positive integer

    ClassId int Class Id FK.CLASS.ClassId

    CLASS_STUDENT: Information about student in an opening class

    Column Data type Description Possible valuesClassId int ClassId FK.CLASS.ClassId

    Student int UnivId of student FK.USER.UnivId

    Status char-1 Status of the student LrnEnv defined. FK.

    For example

    'o' Other status

    'r' Registered

    'w' Withdrew

    JoinStatus char-1 Joining status 'l' Left

    'j' Joined'p' Pending to approval

    LastAccess* DateTime Last time student accessed the class

    Joined DateTime Time student joined the class

    Left* DateTime Time student left the class Must be >= Joined

    CLASS_EVENT: Information about event in class calendar

    Column Data type Description Possible values

    CEvntId autoint Class event Id Positive integer

    ClassId int Class Id FK.CLASS.ClassId

    Associate int UnivId of instructor who is primarily associated with the event FK.USER.

    Start Time Start time of the event

    End Time Stop time of the event

    Day char-1 Day of week 0 Not using day (using date)1 Monday

    2 Tuesday

    3 Wednesday4 Thursday

    5 Friday

  • 8/3/2019 Template and Guideline to Document in LM Project

    7/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 7 (23)

    6 Saturday

    7 Sunday

    FromDate Date Start date range

    UntilDate Date End date range

    Recur char-1 Recurring pattern 'o' One time

    'w' Weekly

    Location vchar Location of the event Free text

    Activity char-1 Activity type LrnEnv defined FK.

    For example,

    'c' Class cancelled

    'h' Office hour

    'l' Laborary

    's' Tutorial session

    't' Lecture/Teach

    CLASS_ANNOUNCE: Information about class-specific announcement

    Column Data type Description Possible valuesCAnnId autoint Class announcement Id Positive integer

    ClassId int Class Id FK.CLASS.ClassId

    Title vchar Title of the announcement Free text

    Detail vchar Detail of the announcement Free text

    Event int Link to class event Id 0 if not linked to any event in class calendar

    FK.CLASS_EVENT.CevntId

    Updated DateTime Last update time of the announcement

    PostFrom DateTime Post announcement from this time

    PostUntil DateTime Post announcement until this time Must be > PostFrom

    SNLink! Social network cross posting fields, not yet finalized

    CLASS_MATERIAL: Information about material used in class

    Column Data type Description Possible values

    CMatId autoint Class material Id Positive integer

    ClassId int Class Id FK.CLASS.ClassId

  • 8/3/2019 Template and Guideline to Document in LM Project

    8/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 8 (23)

    MatId int Material Id FK.MATERIAL.MatId

    Desc vchar Class dependent description of the material Free text

    WeekUsed char-3 Bit array of weeks that material is used in class Bit array of 24 bits, first bit represents the first week

    0 Not used

    1 Used

    Created DateTime Time the material is linked to the class

    Updated DateTime Time the material is last updated Must be >= Created

    CFoldId int Folder that material is contained FK.CLASS_MATERIAL_FOLDER.CFoldId

    CLASS_MATERIAL_FOLDER: Information about class material folder structure

    Column Data type Description Possible values

    CFoldId autoint Class folder Id Positive integer

    ClassId int Class Id FK.CLASS.ClassId

    Parent autoint Parent folder Id 0 if root folder

    Name vchar Name of the folder

    Order char-1 Default sorting order of materials in the folder Lower case = ascending, Upper case = descending

    'n' Material name't' Material type

    'c' Created time

    'u' Last updated time

    's' Material size

    CLASS_WEEK: Information about each week in class

    Column Data type Description Possible values

    ClassId int Class Id FK.CLASS.ClassId

    Week smallint Week number 1-24

    Topic vchar Description of topic(s) being taught in the class in a given week Free text

    OS_CACHE[OsId, ]Information about caching information of a particular course

    Column Data type Description Possible values

  • 8/3/2019 Template and Guideline to Document in LM Project

    9/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 9 (23)

    In this section, there are 2 other sets of tables with the same schemas, prefixing with OLD_ and ARC_ stands for old and archive. Old set storesinformation about courses in previous semesters but still visible for users. Archive set stores information about courses in long-past semesters and not

    visible to all users.

    2.2 User Related TablesUSER: Information about each userColumn Data type Description Possible values

    UnivId autoint University Id Positive integer

    TitleEn vchar Title in English

    TitleTh vchar Title in Thai

    FNameEn vchar First name and middle initial in English

    FNameTh vchar First name in Thai

    LNameEn vchar Last name in English

    LNameTh vchar Last name in Thai

    MainRole char-1 Main role of the user 'f' Supporting staff'i' Instructor

    's' Student

    LangPref char-1 Language preference to display messages 'e' English

    't' Thai

    Blocked char-1 Is user blocked? 'a' Allow normal access, no block

    'b' Blocked cannot login

    'p' Partially blocked, can login and retrieve own profile, but

    cannot participate in any class

    LastLogin* DateTime Last login time

    USER_PROFILE: Information about user detailed profileColumn Data type Description Possible values

    UnivId int University Id FK.USER.UnivId

    Dept smallint Affiliate department FK.DEPARTMENT

    NationalId vchar National card Id or Passport Id

    Nationality vchar Nationality

  • 8/3/2019 Template and Guideline to Document in LM Project

    10/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 10 (23)

    Photo uuid UUID of the photo of user

    PermAddr vchar Permanent address Free text

    CurAddr vchar Current address

    PriEmail vchar Primary email

    SecEmail vchar Secondary email

    PriPhone vchar Primary phone numberSecPhone vchar Secondary phone number

    SNLink1 vchar Social network link #1

    SNLink2 vchar Social network link #1

    USER_MATERIAL: Information about material used in user page

    Column Data type Description Possible values

    UMatId autoint User material Id Positive integer

    UserId int User Id FK.USER.ClassId

    MatId int Material Id FK.MATERIAL.MatId

    Desc vchar Description

    Created DateTime Time the material is linked to the classUpdated DateTime Time the material is last updated Must be >= Created

    MATERIAL_ACCESS: Information about the status of material on user perspective.

    Column Data type Description Possible values

    MatId int Material Id FK.MATERIAL.MatId

    UnivId int University Id FK.USER.UnivId

    ClassId int Class Id, material can be accessed by either class-associated or

    user-associated page

    0 if accessing non-class-associated material

    FK.CLASS.ClassId

    UserId int User Id, material can be accessed by either class-associated or

    user-associated page

    0 if accessing non-user-associated material

    FK.USER.UnivIdLastAccess* DateTime Time of last access Null If never accessed

    NumAccess smallint Number of accesses 0 Never access

    Positive integer

    Flags char Various flags on the material from user view bit encoded

    0 means such flag is unset

  • 8/3/2019 Template and Guideline to Document in LM Project

    11/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 11 (23)

    1 means such flag is set

    1st LSB Important

    2nd LSB Get back later

    3rd

    LSB Like4th - 8th LSB bit LrnEnv defined FK. , all set to 0

    Rate smallint Rating of the material -1 Not yet rated

    0-5 0 to 5 stars

    Note vchar Personal note on the material

    READ_CLASS_ANNOUNCE: Information about the class announcement that has been read by user

    Column Data type Description Possible values

    CAnnId int Class announcement Id FK.CLASS_ANNOUNCE.CAnnId

    UnivId int University Id FK.USER.UnivId

    PORTFOLIO: Information about portfolio of users

    Column Data type Description Possible valuesUnivId int University Id FK.USER.UnivId

    ClassId int Class Id 0 if the entry is not class-related

    Author int University Id of the one who added the entry, which can be self

    or instructor in class

    FK.USER.UnivId

    Created DateTime Created time of the entry

    EventDate* Date Time of the events.

    For class related entries, it will be the last day of the semester

    Null if not link to time

    Desc vchar Description

    URL vchar Link to related resource

    Type smallint Type of entry (e.g. class reflection, competition, award,

    contribution, etc).

    LrnEnv defined FK.

  • 8/3/2019 Template and Guideline to Document in LM Project

    12/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 12 (23)

    2.3 MaterialMATERIAL: Information about a piece of material or object

    Column Data type Description Possible values

    MatId autoint Material Id Positive integer

    Title vchar Title of materialDesc vchar Additional description of the material

    MatType smallint Material type FK.MATERIAL_TYPE

    Size autoint Size of the material (in KiloBytes) Positive number if material is stored as files

    0 other types of materials (link, physical book, etc.)

    Path uuid Path in the system to the material, it can be a single file or

    directory of files

    If material does not have associate files, uuid = all 0's

    Revision smallint Revision of the material Positive integer

    NumLinks smallint Number of links on this material Non-negative

    Created DateTime Time the material (regardless of the revision) is created

    Updated DateTime Time the material is last updated Must >= Created

    Owner int UnivId of the owner

    OLD_REV_MATERIAL: Information about an old revision (not active) of material

    Column Data type Description Possible values

    MatId int Material Id FK.MATERIAL.MatId

    Revision smallint Revision of the material Must be < MATERIAL.Revision of the same MatId

    Path uuid Path in the system to the material

    2.4 Assignment and Score Related TablesASSIGNMENT: Information about assignment in class

    Column Data type Description Possible values

    AssnId autoint

    ClassId int Class of assignment FK

    WeekAssigned char-3 Bit array of weeks that assignment is associated in class. Bit array of 24 bits, first bit represents the first week

  • 8/3/2019 Template and Guideline to Document in LM Project

    13/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 13 (23)

    Probably covering assignment, progress report, submission,

    demo, etc. It is up to the instructor to which weeks to check

    0 Unassigned

    1 Assigned

    Title vchar Title of the assignment Free text

    Desc vchar Description Free HTML text

    FileName vchar-255 File name of the attached file (once user downloads it) 255 character filename

    FileSize int File size information (in KiloBytes) Positive integer

    FilePath uuid File path in the system UUID

    URL vchar URL to external content or information URL

    Type char Type of assignment LrnEnv defined FK. (Self test, Homework, Exam, Quiz, )

    MinMember smallint Minimum number of members in a group 1-255

    MaxMember smallint Maximum number of members in a group 1-255

    MaxSubmit smallint Maximum number of submissions 0 : no need to submit the assignment

    1-255: number of submissions allowed

    MaxScore fixed(4.2) Maximum score on this assignment Non-negative number

    Weight fixed(3.2) Weight of this assignment toward overall 100-points Non-negative number

    Publish char-1 Whether the score is published, visible to students 'y' Published, students will see own score

    'n' No, only instructor(s) will see scores of students

    PublishOrder smallint The published order that appears to users (sort order in scoreannouncement page)

    Positive integer

    PostBy int UnivId of poster FK.USER

    PostDate DateTime Timestamp of posting

    DisplaySince DateTime Start of announcement display Must be >= PostDate

    DisplayUntil DateTime End of announcement display Must be > DisplaySince

    DueDate DateTime Due timestamp of the assignment Must be > DisplaySince

    ASSIGN_GROUP: Information about assignment group

    Column Data type Description Possible values

    AsgpId autoint Assignment group Id Positive integerAssnId int Assignment Id FK.ASSIGNMENT

    Name vchar Group name Free text

    Lead int UnivId of group lead 0 if there is no lead (for example, when created by instructor)

    FK.USER

    Submit char Submission flag 'y' Already submitted the assignment

  • 8/3/2019 Template and Guideline to Document in LM Project

    14/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 14 (23)

    'l' Late submission

    'n' Not yet submit the assignment

    ASSIGN_GROUP_MEMBER: Information about member in assignment group

    Column Data type Description Possible valuesAsgpId int Assignment group Id FK.ASSIGN_GROUP

    AssnId int Assignment Id (useful for checking if member is already in

    another group for the same assignment)

    FK.ASSIGNMENT

    Member int UnivId of member FK.USER

    Role char-1 Role of the member 'l' Leader

    'm' Granted member

    'r' Request to join group

    ASSIGN_SUBMIT: Information about the assignment submission

    Column Data type Description Possible values

    AssmId autoint Assignment submission Id

    AssnId int Assignment Id FK.ASSIGNMENT

    SubmitBy int UnivId of the submitter FK.USER

    AsgpId int Assignment group Id FK.ASSIGN_GROUP

    -1 if the assignment is for individual

    SubmitAt DateTime Time of submission

    FileName vchar-255 File name of the attached file 255 character filename

    FileSize int File size information (in KiloBytes) Positive integer

    FilePath uuid File path in the system UUID

    URL vchar URL to external content or information URL

    Note vchar Submitter's note of submission Free text

    Status char-1 'g' Graded'o' Superceded by newer submission

    'p' Pending for grading

    's' Suspecious of dishonest

  • 8/3/2019 Template and Guideline to Document in LM Project

    15/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 15 (23)

    ASSIGN_SCORE: Information about received score for each assignment

    Column Data type Description Possible values

    AssnId int Assignment Id

    Student int UnivId of student FK.USER

    Earn fixed(4.2) Earned score

    Penalty fixed(4.2) Penalty (e.g. late penalty, dishonest penalty)Score fixed(4.2) Final score, computed from Earn - Penalty Must be

  • 8/3/2019 Template and Guideline to Document in LM Project

    16/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 16 (23)

    2.5 SocialANNOUNCE: Information about global announcement

    Column Data type Description Possible values

    AnnId autoint Announce Id Positive integer

    TitleEn vchar Title in English Free textTitleTh vchar Title in Thai Free text

    DescEn vchar Detailed description in English Free HTML text

    DescTh vchar Detailed description in Thai Free HTML text

    URL vchar URL to the external content or information URL

    PostBy int UnivId of poster FK.

    PostDate DateTime Timestamp of posting

    DisplaySince DateTime Start of announcement display Must be >= PostDate

    DisplayUntil DateTime End of announcement display Must be > DisplaySince

    Scope char-1 Scope of distribution bit encoded

    0 means not distribute to specific group

    1 means distribute to group1st LSB Student group

    2nd LSB Instructor group

    3rd

    LSB Guest group4th - 8th LSB bit Undefined, all set to 0

    Type char-1 Type of announcement LrnEnv defined FK. (System related, University related,)

    Effect char-1 Special effect of the announcement LrnEnv defined

    2.6 Thai Qualification FrameworkLEARN_OUTCOME: Information about each desired learning outcome

    Column Data type Description Possible values

    LrnOutId smallint Learning outcome Id 1-32K

    LrnOGrpId smallint Learning outcome group Id FK.LEARN_OUTCOME_GRP.LrnOGrpId

    Outcome vchar Brief description of the outcome (shown in report)

    Detail vchar Elaboration, example of outcome (help to understand)

  • 8/3/2019 Template and Guideline to Document in LM Project

    17/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 17 (23)

    DefineDept smallint Department and level of outcome definition. It affects the

    mandatory requirement. If it is defined at university level, it is

    mandatory for every curriculum, otherwise it is optional.

    0 if it is at university wide level

    FK.DEPARTMENT.DeptId

    Sharable char-1 If the outcome can be shared by other departments. If

    DefineDept = 0 (university wide), this column must be sharable

    'y' Yes, can be shared

    'n' - No, cannot be shared

    UpdatedBy int UnivId of the person who makes the last update FK.User.UnivId

    Updated DateTime Last update time

    Order int Order of outcome in group, new outcome is appended at the

    end (for displaying in list)

    Positive number, order values unique within group

    L1Achieve vchar Description of level 1 achievement of this outcome (lowest

    level of achievement)

    Free text

    L2Achieve vchar Description of level 2 achievement of this outcome Free text

    L3Achieve vchar Description of level 3 achievement of this outcome Free text

    L4Achieve vchar Description of level 4 achievement of this outcome Free text

    L5Achieve vchar Description of level 5 achievement of this outcome (highest

    level of achievement)

    Free text

    LEARN_OUTCOME_GRP: Information about each learning outcome group

    Column Data type Description Possible values

    LrnOGrpId autosmllint Learning outcome group Id 1-32K

    OutcomeGrp vchar Brief description of the outcome group (shown in report)

    Detail vchar Elaboration, example of outcome group (help to understand)

    DefineDept smallint Department and level of the group definition. If university

    wide, it is a mandatory for every curriculum, otherwise, it is

    optional.

    0 if it is at university wide level

    FK.DEPARTMENT.DeptId

    Shareable char-1 If the group can be shared by other departments. If DefineDept

    = 0 (university wide), this column must be sharable

    'y' Yes, can be shared

    'n' - No, cannot be shared

    UpdatedBy int UnivId of the person who makes the last update FK.User.UnivIdUpdated DateTime Last update time

    Order int Order of group, new group is appended at the end (for display

    in list)

    Positive number, order values unique within group

  • 8/3/2019 Template and Guideline to Document in LM Project

    18/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 18 (23)

    DEPT_OUTCOME_SET: Information about learning outcome selected by a department to be in its pool of outcomes

    Column Data type Description Possible values

    DeptId smallint Department Id FK.DEPARTMENT.DeptId

    LrnOutId smallint Learning outcome FK.LEARN_OUTCOME.LrnOutId

    LEARN_OUTCOME_CUR: Information about learning outcome in a curriculum

    Column Data type Description Possible values

    CurId smallint Curriculum Id FK.CURRICULUM.CurId

    LrnOutId smallint Learning outcome Id. Value from LrnOutId available in

    DEPT_OUTCOME_SET where department of CurId = DeptId

    FK.LEARN_OUTCOME.LrnOutId

    Group smallint Outcome group number that this outcome belongs to. This

    value may or may not be the same as defined inLEARN_OUTCOME_GRP. University wide outcome groups

    should come first (and thus have the same value). Then local

    group can be appended. This is the group number shown in the

    TQF report and when defing outcomes of courses.

    Positive value

    This column depends on LrnOutId and thus make the table not3NF. But we do not want to have extra table., All outcome with

    the same value of LrnOGroupId must have the same LrnOGrpId

    and vice versa

    Order smallint Order in group, this value may or may not be the same as

    defined in LEARN_OUTCOME. University wide outcomes

    should come first (and thus have the same value). This is the

    order number shown in the TQF report

    Positive value

    Unique within records with the same CurId and Group

    PEDAGOGY: Information about pedagogical method used in class

    Column Data type Description Possible values

    PedId smallint Padagogy Id 1-32K

    Pedagogy vchar Name of the pedagogy Free text

    Desc vchar Description of pedagogy Free text

    UpdatedBy int UnivId of the person who makes the last update FK.User.UnivIdUpdated DateTime Last update time

    LEARN_ASSESS: Information about learning assessment method

    Column Data type Description Possible values

  • 8/3/2019 Template and Guideline to Document in LM Project

    19/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 19 (23)

    LAssId smallint Learning assessment Id 1-32K

    Assessment vchar Name of the assessment Free text

    Desc vchar Description of assessment Free text

    UpdatedBy int UnivId of the person who makes the last update FK.User.UnivId

    Updated DateTime Last update time

    COURSE_OUTCOME: Information about learning outcome and its desired level in each course

    Column Data type Description Possible values

    COutId autoint Course outcome Id Positive integer

    CrsId int Course Id FK.COURSE.CrsId

    CurId smallint Curriculum that outcome is defined. This column is needed

    since a course can be shared among different curriculums, each

    has different set of outcomes

    FK.CURRICULUM.CurId

    LrnOutId smallint Required learning outcome. FK.LEARN_OUTCOME.LrnOutId

    LrnOutId must be in a row of LEARN_OUTCOME_CUR that

    has the same CurId

    Level smallint Expected level of learning outcome 1-5 where 1 is the lowest and 5 is the highest levelInvolvement smallint Involvement level of this course on this outcome.

    Corresponding to blank, hollowed circle, solid circle on report

    0 none

    1 minor

    2 major

    CLASS_WEEK_OUTCOME: Information about which week(s) a desired learning outcome is achieved in class

    Column Data type Description Possible values

    ClassId int Class Id FK.CLASS.ClassId

    LrnOutId smallint Learning outcome. Should be one of outcomes defined in

    COURSE_OUTCOME that the Class belongs to.

    FK.LEARN_OUTCOME.LrnOutId

    WeekAchieved char-3 Bit array of weeks that the learning outcome is achieved in the

    class

    Bit array (24 bits), the first bit represents the first week

    0 Not archieved

    1 Achieved

  • 8/3/2019 Template and Guideline to Document in LM Project

    20/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 20 (23)

    CLASS_WEEK_PEDAGOGY: Information about which week(s) a pedagogy is used in class

    Column Data type Description Possible values

    ClassId int Class Id FK.CLASS.ClassId

    PedId smallint Pedagogy FK.PEDAGOGY.PedId

    WeekUsed char-3 Bit array of weeks that the pedagogy is used in the class Bit array (24 bits), the first bit represents the first week

    0 Not used1 Used

    CLASS_WEEK_ASSESS: Information about which week(s) an assessment is used in class

    Column Data type Description Possible values

    ClassId int Class Id FK.CLASS.ClassId

    LAssId smallint Learning assessment FK.LEARN_ASSESS.LAssId

    WeekUsed char-3 Bit array of weeks that the learning assessment is Used in the

    class

    Bit array (24 bits), the first bit represents the first week

    0 Not used

    1 Used

    CLASS_OBJECTIVE: Information about which an behavioral objective that student should achieve in class

    Column Data type Description Possible values

    CObjId autoint Class objective Id Positive integer

    ClassId int Class Id FK.CLASS.ClassId

    Objective vchar Description of behavioral objective Free text

    Week char-3 Bit array of weeks that objective is due to achieve by students Bit array (24 bits), the first bit represents the first week

    0 Not used

    1 Used

    UpdatedBy int UnivId of the person who makes the last update FK.User.UnivId

    Updated DateTime Last update time

    OBJECTIVE_OUTCOME: Information about which relationship between objective and outcome

    Column Data type Description Possible values

    CObjId autoint Class objective Id FK.CLASS_OBJECTIVE.CObjId

    LrnOutId smallint Learning outcome FK.LEARN_OUTCOME.LrnOutId

  • 8/3/2019 Template and Guideline to Document in LM Project

    21/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 21 (23)

    2.7 Role and permission

    3.Metadata, variables3.1 Data, metadata used by other main conceptsMATERIAL_TYPE: Information about the properties of each material type

    Column Data type Description Possible values

    MTypeId autoint Material type Id Positive integer

    TypeEn vchar Name of material type in English

    TypeTh vchar Name of material type in Thai

    Streamable char-1 Whether the materials of this type can be streamed 'y', 'n' Yes, NoDownloadable char-1 Whether the materials of this type can be downloaded 'y', 'n' Yes, No

    Sharable char-1 Whether the materials of this type can be shared 'y', 'n' Yes, No

    Printable char-1 Whether the materials of this type can be printed 'y', 'n' Yes, No

    Commentable char-1 Whether the materials of this type can be commented 'y', 'n' Yes, No

    FACULTY: Information about each academic faculty

    Column Data type Description Possible values

    FacId autosmllint Faculty Id 1-32K

    NameEn vchar Name in English

    NameTh vchar Name in Thai

    DEPARTMENT: Information about each academic department

    Column Data type Description Possible values

    DeptId autosmllint Department Id 1-32K

  • 8/3/2019 Template and Guideline to Document in LM Project

    22/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 22 (23)

    NameEn vchar Name in English

    NameTh vchar Name in Thai

    Faculty smallint Faculty Id FK.FACULTY.FacId

    SEMESTER: Information about academic semester

    Column Data type Description Possible values

    SemId autosmllint Semester Id. The value of semId is ordered chronologically ,

    starts at '1/2550' with SemId = 1

    1-32K

    Desc char Display format of semester Example: '1/2554', 's/2554'

    Status char-1 Status of the semester, only one row can have 'current' status 'a' Archival (past, cannot change anything)

    'p' Previous (past, can modify something)

    'c' Current

    'n' Next semester (future, can prepare data)

    'f' Far future semester (futre, cannot do anything as yet)

    LOCAL_CODE: Information about one character code used in tablesColumn Data type Description Possible valuesCodeId autoint Local code Ie Positive integer

    Key char-1 The value of the key Single character

    Table vchar The table name where the key value appears Table name (only name)

    Column vchar The column name of the table where the key value appears Column name (of the above table) that the key is used

    Value vchar Associated value May empty, if no value associated

    DescEn vchar Description of the key in English May empty, if no description

    DescTh vchar Description of the key in Thai May empty, if no description

    3.2 Role and Permission COURSE_ROLE_SET[CrsRoleId, DescEn, DescTh]

  • 8/3/2019 Template and Guideline to Document in LM Project

    23/23

    LrnEnv Project Enter The Description of The Document Here

    Last modified on Document filename Version Page

    dd/mm/yyyy LrnEnvDB.doc 1 23 (23)

    4.GUI

    5.Activities, logging