Differences between revisions 17 and 25 (spanning 8 versions)

Student Records and Assignment Management Systems

give - assignment submission, autotesting and marking system
sms - student records management system


give Manual	give FAQ	sms Manual	sms FAQ	Xmark

give & sms Installation

give and sms are interconnected. Create give environment and sms database in the class account as follows:

ssh into the class account with X11 forwarding: ssh -Y
sms is a tcl/tk app that requires X windows. Running tcl/tk app with X windows is slow. Better ways are:
- VNC on a CSE login server
- VLAB
Run the installation script:
% give-install -new
% ~give/stable/bin/give-install -new
- if ~give/stable/bin is not part of $PATH
% ksh give-install -new
- if your login shell is zsh
% give-install -new term
- if the term is not the same as the system-wide term, term example 20T3
The installation perform the following tasks:
- Create $WORK ($HOME/term.work e.g. ~/20T3.work)
- Create give.spec (if doesn't exists) in
  - $HOME (does not override existing one)
  - $WORK (does not override existing one)
  (read about give.spec)
- Create .giverc in $HOME (overrides existing one)
- Create sms database ($SMSDB) under $WORK (can be postponed)
- Download student enrolment data (read about importing nss data below)
- Add $SMSDB environment variable to $WORK/.giverc
The installation can be paused before sms database is created.
- Create the database by running sms directly:
- e.g.
- sms ~/20T3.work/20T3db.sms
- or
- sms
  - using the value stored in $SMSDB
- Resume the installation with this command:
  give-install -update
Download student enrollment data
- Add course records
  - For combined courses, create the database in the primary class account, add a record for each course.
- Add student records
  - Top menu bar: Student → Add Student Records → External Source
  - or second menu bar: Add from NSS
    From NSS (without classes) - The download will not overwrite class changes in sms
If there are classes in NSS, an enum field (tut, lab or tut_lab) will automatically be created in sms after the above downloads.
Enter this field when asked for a group field by the give-install script. This field is used by give for assignment submissions.
(Read about &subkey and &subgroup)
After installing give, update the give environment:
% . ~/.giverc
and insert the line above to the class account's .profile, if not already.
Check that $HOME/give.spec contain the correct configuration for the current term.
- Look out for &period is not still set to a previous term. Example
```
&period=19T3
```
Check the environment variables: $GIVEPERIOD, $WORK, $SMSDB
% echo $GIVEPERIOD

-  ⇤ ← Revision 17 as of 2018-02-21 07:44:29 → 
  Size: 3933
  Editor: MeichengWhale
  Comment:
+   ← Revision 25 as of 2023-02-22 09:59:36 → ⇥
  Size: 4028
  Editor: MeiChengWhale
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 9:
-||<#FFFFAD> [[https://www.cse.unsw.edu.au/~give/Documents/Manual/give_html/index.html|give Manual]] ||<#FFFFAD> [[https://www.cse.unsw.edu.au/~give/Documents/Faq/give_html/index.html|give FAQ]] ||<#FFFFAD> [[https://www.cse.unsw.edu.au/~give/Documents/Manual/sms_html/index.html|sms Manual]] ||<#FFFFAD> [[https://www.cse.unsw.edu.au/~give/Documents/Faq/sms_html/index.html|sms FAQ]] ||<#FFFFAD> [[http://www.cse.unsw.edu.au/~give/Admindata/tutors/xmark.html|Xmark]]||<#FFFFAD> [[http://www.cse.unsw.edu.au/~give/Admindata/tutors/vnc.html|VNC]]||
+||<#FFFFAD> [[https://cgi.cse.unsw.edu.au/~give/Documents/Manual/give_html/index.html|give Manual]] ||<#FFFFAD> [[https://cgi.cse.unsw.edu.au/~give/Documents/Faq/give_html/index.html|give FAQ]] ||<#FFFFAD> [[https://cgi.cse.unsw.edu.au/~give/Documents/Manual/sms_html/index.html|sms Manual]] ||<#FFFFAD> [[https://cgi.cse.unsw.edu.au/~give/Documents/Faq/sms_html/index.html|sms FAQ]] ||<#FFFFAD> [[http://www.cse.unsw.edu.au/~give/Admindata/tutors/xmark.html|Xmark]]||
 Line 14:
-. ssh into the class account with X11 forwarding: `ssh -Y`
+. ssh into the class account with X11 forwarding: ~+`ssh -Y`+~
 Line 16:
-   (!) sms is a tk app that requires [[http://taggi.cse.unsw.edu.au/FAQ/Accessing_CSE_login_servers/|X windows]].
   Running tk app with X windows is slow. Better ways are:
+   (!) sms is a [[https://www.tcl.tk/|tcl/tk]] app that requires [[http://taggi.cse.unsw.edu.au/FAQ/Accessing_CSE_login_servers/|X windows]].
   Running tcl/tk app with X windows is slow. Better ways are:
 Line 23:
-   `% give-install -new`
+   ~+`% give-install -new`+~
 Line 25:
-   `% ~give/stable/bin/give-install -new`
      ~- ''if ~give/stable/bin is not part of $PATH'' -~
+   ~+`% ~give/stable/bin/give-install -new`+~
      ''if ~+`~give/stable/bin`+~ is not part of ~+`$PATH`+~''
 Line 28:
-   `% ksh give-install -new`
      ~- ''if your login shell is zsh'' -~
+   ~+`% ksh give-install -new`+~
      ''if your login shell is zsh''
 Line 31:
-   `% give-install -new YYsN`
      ~- ''if the session is not the same as the system-wide session'' -~
+   ~+`% give-install -new `''`term`''+~
      ''if the term is not the same as the system-wide term, term example 20T3''
 Line 35:
-      * Create `$WORK` (`$HOME/YYsN.work` e.g. `~/12s2.work`)
      * Create `give.spec` (if doesn't exists) in
        * `$HOME` ~-''(does not override existing one)''-~
        * `$WORK` ~-''(does not override existing one)''-~
+      * Create ~+`$WORK`+~ (~+`$HOME/`''`term`''.`work`+~ e.g. ~+`~/20T3.work`+~)
      * Create ~+`give.spec`+~ (if doesn't exists) in
        * ~+`$HOME`+~ ~-''(does not override existing one)''-~
        * ~+`$WORK`+~ ~-''(does not override existing one)''-~
 Line 40:
-      * Create `.giverc` in `$HOME` (overrides existing one)
      * Create sms database under `$WORK` (can be postponed)
+      * Create ~+`.giverc`+~ in ~+`$HOME`+~ (overrides existing one)
      * Create sms database (~+`$SMSDB`+~) under ~+`$WORK`+~ (can be postponed)
 Line 43:
-      * Add `$SMSDB` (e.g. `~/YYsN.work/YYsNdb.sms`) to `$HOME/.giverc`
+      * Add ~+`$SMSDB`+~ environment variable to ~+`$WORK/.giverc`+~
 Line 48:
-      . `% sms ~/YYsN.work/YYsNdb.sms`
        ~- ''or'' -~
      . `% sms`
         ~- ''(if `$SMSDB` is set to the current session)'' -~
+      . e.g.
      . ~+`sms ~/20T3.work/20T3db.sms`+~
      . ''or''
      . ~+`sms`+~
        ''using the value stored in ~+`$SMSDB`+~''
-Line 54:
+Line 55:
-      `% give-install -update`
+      ~+`give-install -update`+~
-Line 59:
+Line 60:
-      . For combined courses, create the database in the primary class account, add a record for each course.
+        . For combined courses, create the database in the primary class account, add a record for each course.
-Line 62:
+Line 63:
-      . Top menu bar: '''''Student''''' &rarr; '''''Add Student Records''''' &rarr; '''''External Source'''''
      . or second menu bar: '''''Add from NSS'''''
+        . Top menu bar: '''''Student''''' &rarr; '''''Add Student Records''''' &rarr; '''''External Source'''''
        . or second menu bar: '''''Add from NSS'''''
-Line 65:
+Line 66:
-      '''''From NSS''''' or '''''From NSS (without classes)''''' The latter is used if swapping student to another class in sms.
+        '''''From NSS (without classes)''''' - The download will not overwrite class changes in sms
-Line 69:
+Line 70:
-   Enter this field when asked for a group field by the installation script. This field is used by give for assignment submissions.
+   Enter this field when asked for a group field by the ~+`give-install`+~ script. This field is used by give for assignment submissions.
-Line 73:
+Line 74:
-. After installing give, update the environment to the new session:
+. After installing give, update the give environment:
-Line 75:
+Line 76:
-   `% . ~/.giverc`
+   ~+`% . ~/.giverc`+~
-Line 77:
+Line 78:
-   and insert the line above to the class account's `.profile`.
+   and insert the line above to the class account's `.profile`, if not already.
-Line 79:
+Line 80:
-. Check that the `give.spec` file in `$HOME` contain the correct configuration for the current session.
      * Look out for `&period` set to a previous session.
+. Check that ~+`$HOME/give.spec`+~ contain the correct configuration for the current term.
      * Look out for ~+`&period`+~ is not still set to a previous term. Example
      {{{
&period=19T3
      }}}
-Line 82:
+Line 86:
-. Check the environment variables: `$GIVEPERIOD`, `$WORK`, `$SMSDB`
+. Check the environment variables: ~+`$GIVEPERIOD`+~, ~+`$WORK`+~, ~+`$SMSDB`+~
-Line 84:
+Line 88:
-   `% echo $GIVEPERIOD`
+   ~+`% echo $GIVEPERIOD`+~