Users: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 1: Line 1:
{| class="wikitable"  
== Users Variable Documentation (Reimplementation) ==
 
{| class="wikitable" 
!Name !!Datatype !!Description
!Name !!Datatype !!Description
|-  
|- 
!id 
!id  
|int(11)
|int(11)  
|Primary key of the entry in table, auto increments by default
|Primary key of the entry in table, auto increments by default
|-  
|- 
!name
!username
|varchar(255)
|varchar(255)  
|User name of the respective user (formerly name)
|- 
!crypted_password  
|varchar(40)  
|Password of the respective user
|- 
!role_id  
|int(11)  
|Role which this user corresponds to FK into ROLES table.  Examples are super_admin, admin, instructor, etc.
|- 
!password_salt  
|varchar(255)  
|
|- 
!name
|varchar(255)  
|Registered full name of the user, e.g., Lastname, firstname (formerly fullname)
|- 
!email  
|varchar(255)  
|Registered email of the respective user.
|- 
!parent_id  
|int(11)  
|Parent of the respective user; corresponding to the user who created this user.  The value of this field is the primary key in the users table for the parent user, e.g., 2 if the parent is the super-admin (username admin).
|- 
!private_by_default  
|tinyint(1)  
|If the user is private by default; essentially Boolean. It seems that this is not used in the system, don't know what it was intended to mean.  Could be removed.
|- 
!email_on_submission  
|tiny_int(1)  
|If user is to be e-mailed when something they reviewed is resubmitted.
|- 
!is_new_user  
|tiny_int(1)  
|Determines whether the user has logged in before; if not, upon login the user should be presented with the new-user agreement.
|- 
!handle  
|varchar(255) 
|A handle is an alternate name by which the user would want to be known, e.g., on the wiki, if this assignment involves writing on a wiki.  This allows the user to appear anonymous.  In the code, this is sometimes known as the "default handle", because users can also create assignment-specific handles.
|- 
!time_zone_pref
|varchar(255) 
|Timezone that times should be displayed in when the user logs in.
|- 
!public_key
|mediumtext
|Public key used for data-encryption by user.  This is used and should stay in the table, though whether the use is meaningful is not clear.
|- 
!copy_of_emails
|tinyint(1)
|Whether this user wants to receive copies of e-mails sent for all assignments they are participating in.  This is only implemented for instructors.  Instructors would enable it so they start getting copies of all emails being sent related to their assignments.  It is a way that the instructor can be reassured that emails are in fact being sent.
|- 
!institution_id
|int(11)
|id of the institution that the user is associated with
|} 
 
== Users Variable Documentation (2023 version) ==
 
{| class="wikitable" 
!Name !!Datatype !!Description
|- 
!id  
|int(11)  
|Primary key of the entry in table, auto increments by default
|- 
!name  
|varchar(255)  
|User name of the respective user
|User name of the respective user
|-  
|- 
!crypted_password 
!crypted_password  
|varchar(40)
|varchar(40)  
|Password of the respective user
|Password of the respective user
|-  
|- 
!role_id 
!role_id  
|int(11)
|int(11)  
|Role which this user corresponds to FK into ROLES table. Examples are super_admin, admin, instructor, etc.
|Role which this user corresponds to FK into ROLES table.  Examples are super_admin, admin, instructor, etc.
|-  
|- 
!password_salt 
!password_salt  
|varchar(255)
|varchar(255)  
|
|
|-  
|- 
!fullname 
!fullname  
|varchar(255)
|varchar(255)  
|Registered full name of the user, e.g., Lastname, firstname
|Registered full name of the user, e.g., Lastname, firstname
|-  
|- 
!email 
!email  
|varchar(255)
|varchar(255)  
|Registered email of the respective user.
|Registered email of the respective user.
|-  
|- 
!parent_id 
!parent_id  
|int(11)
|int(11)  
|Parent of the respective user; corresponding to the user who created this user. The value of this field is the primary key in the users table for the parent user, e.g., 2 if the parent is the super-admin (username admin).
|Parent of the respective user; corresponding to the user who created this user.  The value of this field is the primary key in the users table for the parent user, e.g., 2 if the parent is the super-admin (username admin).
|-  
|- 
!private_by_default 
!private_by_default  
|tinyint(1)
|tinyint(1)  
|If the user is private by default; essentially Boolean. It seems that this is not used in the system, don't know what it was intended to mean. Could be removed.
|If the user is private by default; essentially Boolean. It seems that this is not used in the system, don't know what it was intended to mean.  Could be removed.
|-  
|- 
!mru_directory_path 
!mru_directory_path  
|varchar(128)
|varchar(128)  
|To allow the user to log back in to the same directory that (s)he logged out from before.
|To allow the user to log back in to the same directory that (s)he logged out from before.
|-  
|- 
!email_on_review 
!email_on_review  
|tiny_int(1)
|tiny_int(1)  
|Whether the user should be e-mailed when a new review is received for their work.
|Whether the user should be e-mailed when a new review is received for their work.
|-  
|- 
!email_on_submission 
!email_on_submission  
|tiny_int(1)
|tiny_int(1)  
|If user is to be e-mailed when something they reviewed is resubmitted.
|If user is to be e-mailed when something they reviewed is resubmitted.
|-  
|- 
!email_on_review_of_review 
!email_on_review_of_review  
|tiny_int(1)
|tiny_int(1)  
|Whether the user should be e-mailed when one of their reviews is meta-reviewed by another reviewer.
|Whether the user should be e-mailed when one of their reviews is meta-reviewed by another reviewer.
|-  
|- 
!is_new_user 
!is_new_user  
|tiny_int(1)
|tiny_int(1)  
|Determines whether the user has logged in before; if not, upon login the user should be presented with the new-user agreement.
|Determines whether the user has logged in before; if not, upon login the user should be presented with the new-user agreement.
|-  
|- 
!master_permssion_granted 
!master_permssion_granted  
|tiny_int(4)
|tiny_int(4)  
|If the user has the master user permission is granted. What?! What does master permission mean?! Well, doesn't matter, because this field is set but not read in existing code.
|If the user has the master user permission is granted.  What?! What does master permission mean?!  Well, doesn't matter, because this field is set but not read in existing code.
|-  
|- 
!handle 
!handle  
|varchar(255)  
|varchar(255) 
|A handle is an alternate name by which the user would want to be known, e.g., on the wiki, if this assignment involves writing on a wiki. This allows the user to appear anonymous. In the code, this is sometimes known as the "default handle", because users can also create assignment-specific handles.
|A handle is an alternate name by which the user would want to be known, e.g., on the wiki, if this assignment involves writing on a wiki.  This allows the user to appear anonymous.  In the code, this is sometimes known as the "default handle", because users can also create assignment-specific handles.
|-  
|- 
!digital_certificate 
!digital_certificate  
|mediumtext
|mediumtext 
|Digital certificate generated for the user to protect his password. This is never read and could be removed.
|Digital certificate generated for the user to protect his password.  This is never read and could be removed.
|-  
|- 
!timezonepref
!timezonepref
|varchar(255)  
|varchar(255) 
|Timezone that times should be displayed in when the user logs in.
|Timezone that times should be displayed in when the user logs in.
|-  
|- 
!public_key
!public_key
|mediumtext
|mediumtext
|Public key used for data-encryption by user. This is used and should stay in the table, though whether the use is meaningful is not clear.
|Public key used for data-encryption by user.  This is used and should stay in the table, though whether the use is meaningful is not clear.
|-  
|- 
!copy_of_emails
!copy_of_emails
|tinyint(1)
|tinyint(1)
|Whether this user wants to receive copies of e-mails sent for all assignments they are participating in. This is only implemented for instructors. Instructors would enable it so they start getting copies of all emails being sent related to their assignments. It is a way that the instructor can be reassured that emails are in fact being sent.
|Whether this user wants to receive copies of e-mails sent for all assignments they are participating in.  This is only implemented for instructors.  Instructors would enable it so they start getting copies of all emails being sent related to their assignments.  It is a way that the instructor can be reassured that emails are in fact being sent.
|-  
|- 
!institution_id
!institution_id
|int(11)
|int(11)
|id of the institution that the user is associated with
|id of the institution that the user is associated with
|}  
|} 


== E/R diagram of tables referencing users table  ==
== E/R diagram of tables referencing users table  ==
The following image shows the tables referencing users table
The following image shows the tables referencing users table
[[File:Users_export.png]]
[[File:Users_export.png]]
Line 93: Line 165:
== E/R diagram of tables users table is referencing to ==
== E/R diagram of tables users table is referencing to ==
The users table is not referenced by any other tables
The users table is not referenced by any other tables


Back to [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Database Tables] Main page.
Back to [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Database Tables] Main page.

Latest revision as of 03:33, 9 December 2025

Users Variable Documentation (Reimplementation)

Name Datatype Description
id   int(11)   Primary key of the entry in table, auto increments by default
username varchar(255)   User name of the respective user (formerly name)
crypted_password   varchar(40)   Password of the respective user
role_id   int(11)   Role which this user corresponds to FK into ROLES table.  Examples are super_admin, admin, instructor, etc.
password_salt   varchar(255)  
name varchar(255)   Registered full name of the user, e.g., Lastname, firstname (formerly fullname)
email   varchar(255)   Registered email of the respective user.
parent_id   int(11)   Parent of the respective user; corresponding to the user who created this user.  The value of this field is the primary key in the users table for the parent user, e.g., 2 if the parent is the super-admin (username admin).
private_by_default   tinyint(1)   If the user is private by default; essentially Boolean. It seems that this is not used in the system, don't know what it was intended to mean.  Could be removed.
email_on_submission   tiny_int(1)   If user is to be e-mailed when something they reviewed is resubmitted.
is_new_user   tiny_int(1)   Determines whether the user has logged in before; if not, upon login the user should be presented with the new-user agreement.
handle   varchar(255)  A handle is an alternate name by which the user would want to be known, e.g., on the wiki, if this assignment involves writing on a wiki.  This allows the user to appear anonymous.  In the code, this is sometimes known as the "default handle", because users can also create assignment-specific handles.
time_zone_pref varchar(255)  Timezone that times should be displayed in when the user logs in.
public_key mediumtext Public key used for data-encryption by user.  This is used and should stay in the table, though whether the use is meaningful is not clear.
copy_of_emails tinyint(1) Whether this user wants to receive copies of e-mails sent for all assignments they are participating in.  This is only implemented for instructors.  Instructors would enable it so they start getting copies of all emails being sent related to their assignments.  It is a way that the instructor can be reassured that emails are in fact being sent.
institution_id int(11) id of the institution that the user is associated with

 

Users Variable Documentation (2023 version)

Name Datatype Description
id   int(11)   Primary key of the entry in table, auto increments by default
name   varchar(255)   User name of the respective user
crypted_password   varchar(40)   Password of the respective user
role_id   int(11)   Role which this user corresponds to FK into ROLES table.  Examples are super_admin, admin, instructor, etc.
password_salt   varchar(255)  
fullname   varchar(255)   Registered full name of the user, e.g., Lastname, firstname
email   varchar(255)   Registered email of the respective user.
parent_id   int(11)   Parent of the respective user; corresponding to the user who created this user.  The value of this field is the primary key in the users table for the parent user, e.g., 2 if the parent is the super-admin (username admin).
private_by_default   tinyint(1)   If the user is private by default; essentially Boolean. It seems that this is not used in the system, don't know what it was intended to mean.  Could be removed.
mru_directory_path   varchar(128)   To allow the user to log back in to the same directory that (s)he logged out from before.
email_on_review   tiny_int(1)   Whether the user should be e-mailed when a new review is received for their work.
email_on_submission   tiny_int(1)   If user is to be e-mailed when something they reviewed is resubmitted.
email_on_review_of_review   tiny_int(1)   Whether the user should be e-mailed when one of their reviews is meta-reviewed by another reviewer.
is_new_user   tiny_int(1)   Determines whether the user has logged in before; if not, upon login the user should be presented with the new-user agreement.
master_permssion_granted   tiny_int(4)   If the user has the master user permission is granted.  What?! What does master permission mean?!  Well, doesn't matter, because this field is set but not read in existing code.
handle   varchar(255)  A handle is an alternate name by which the user would want to be known, e.g., on the wiki, if this assignment involves writing on a wiki.  This allows the user to appear anonymous.  In the code, this is sometimes known as the "default handle", because users can also create assignment-specific handles.
digital_certificate   mediumtext  Digital certificate generated for the user to protect his password.  This is never read and could be removed.
timezonepref varchar(255)  Timezone that times should be displayed in when the user logs in.
public_key mediumtext Public key used for data-encryption by user.  This is used and should stay in the table, though whether the use is meaningful is not clear.
copy_of_emails tinyint(1) Whether this user wants to receive copies of e-mails sent for all assignments they are participating in.  This is only implemented for instructors.  Instructors would enable it so they start getting copies of all emails being sent related to their assignments.  It is a way that the instructor can be reassured that emails are in fact being sent.
institution_id int(11) id of the institution that the user is associated with

 

E/R diagram of tables referencing users table 

The following image shows the tables referencing users table

E/R diagram of tables users table is referencing to

The users table is not referenced by any other tables

Back to Database Tables Main page.