User

Use

The User models stores a user of Talos.

Fields

• Username
  • Automatically set to the user's email (DEPRECATED: All logins are done through email, this field is not used and is kept for backwards compatibility)
• First Name
• Last Name
• Email
• Password
  • An encrypted hash is stored -- your password is not readable and is secure.
• Groups
  • The Permission Groups a user is a part of.  Please see other portions of the documentation to get an overview of how permissions work.
• User Permissions
  • The Permissions a user is directly assigned.  Please see other portions of the documentation to get an overview of how permissions work.
• Is Staff
  • A flag indicating whether or not the user is considered 'staff'.  If this is true, they are granted access to the backend administration portal -- this should not be granted to all staff of your school, and only to people you wish to be able to administrate through the backend of Talos.
• Is Active
  • A flag indicating whether the user is considered 'active'.  If this is false, the user will be unable to login.  Instead of deleting accounts, it is preferred to mark a user as inactive.
• Is Superuser
  • A flag indicating whether the user is considered a 'superuser'.  If this is true, the user is automatically granted all permissions in the system.
• Last Login
  • A field storing the date of the user's last login.  All login information (including full logs with IP Addresses, and full User-Agent strings) is stored through a separate model.
• Date Joined
  • A field storing when the user account was created.
• Avatar
  • A field containing an image which is a user's avatar image.
• Tags
  • A field containing the fields that are related for this user.
• Two Factor Required
  • A flag indicating whether two factor authentication is required for a user.  This is helpful in the case of a user you know to be insecure -- this allows you to obligate this user to utilize two factor authentication.

Student

Use

This model stores all Student specific information about an individual (it is linked to a User model meaning it is impossible to create a student account without making a related account).

Fields

• User
  • The user account associated with this user.
• Student ID
  • A student's identification string -- this can be any combination of characters that is less than 16 characters.
• OFCL
  • A student's official class designation -- this can be any combination of characters that is less than 16 characters.
• Cohort
  • A student's graduation year (indicated by the fall year).  If a student were graduating in June 2022, their cohort would be 2021.
• Requirement Table
  • The graduation requirement table in use for this student.  Please see the "Courses" module documentation for more information as to how this is used.
• Permanent Record
  • This is a field containing a permanent record as a PDF.  This is downloadable by users with a given permission flag.
• Sex
  • This field indicates a student's sex.  This fields supports any character (single character), i.e., you may use more than simply 'M' and 'F' if desired.
• Meal Code
  • This field indicates the student's meal code, if it is in use and a useful piece of information by district.  Access to view this variable can be controlled through a permission.
• Birthdate
  • This field indicates the student's birthdate.  Access to view this variable can be controlled through a permission.
• Remote Group
  • This indicates a Group Letter (A-D), used for remote learning.  Access to view this variable can be controlled through a permission.
• Remote Mode
  • This indicates a Mode (Remote or Blended), used for remote learning.  Access to view this variable can be controlled through a permission.
• Remote Seat
  • This indicates a Seat (any character).  Access to view this variable can be controlled through a permission.

Teacher

Use

This models stores all information regarding teachers.  Unlike students, it is possible to have a teacher without a linked user account.

Fields

• User
  • The associated user account.
• Teacher
  • A string indicating the teacher's designation on uploaded files, for a NYCDOE school, this is conventionally all uppercase, like "JOHN" for example.

Parent

Use

This model stores all information regarding a specific parent.

Fields

• Authorization Code
  • This is a field with a number of distinct choices.
  • Choices:
    • Unknown
    • Disciplinary contact with EMC / APC / SM primary
    • Disciplinary contact with EMC / APC
    • Emergency contact with APC / SM
    • Emergency contact with APC
    • Authorized to pick up child (APC)
    • School mailings (SM)
    • Court order (No access to child or records)
    • Deceased
    • Emergency contact (EMC)
• Relation Code
  • This is a field with a number of distinct choices.
  • Choices:
    • Unknown
    • Mother
    • Father
    • Grandparent
    • Sister / brother
    • Other relative
    • Step parent
    • Surrogate parent
    • Foster parent
    • Agency
    • Ward of State
    • Other legal guardian
    • Non relative
    • Emancipated youth
• Written Language
  • The preferred language of written materials for this parent.  This can be any 0-2 character string (if you are in the NYCDOE, this can correspond to all NYCDOE language codes).
• Spoken Language
  • The preferred language of spoken interactions for this parent.  This can be any 0-2 character string (if you are in the NYCDOE, this can correspond to all NYCDOE language codes).
• User
  • The user the parent is associated with.  This is an optional field.
• Students
  • The students associated with this parent, this can hold an arbitrary number of relations.
• Parent ID
  • An identification number of the parent.  This should be unique per parent and can be autoassigned by Talos if your underlying system (if you have one) does not provide such a value.
• Address
• Phone One (Home Phone)
• Phone Two (Cell Phone)
• First Name
• Last Name
• In Underlying System?
  • A flag indicating whether or not this parent is present in an underlying system.
• Email
  • An email, this is an optional field.
• Duplicate
  • A flag set automatically by the system if this is the same parent as another parent in the system but with different Parent ID.

Parent Request

Use

A model storing a request for a parent account.

Fields

• State
  • A field storing the state of the given request.
  • Choices:
    • Pending
    • Approved
    • Denied
• First Name
• Last Name
• Email
• Student ID

Variable Type

Use

A Variable Type stores a given type of variable to associate with a student.

Fields

• Name
• Default
  • The default value for the variable (a string)

Variable

Use

A Variable model stores the actual value of a variable for a given user.

Fields

• User
  • The user the variable is associated with.
• Variable Type
  • The variable type that the variable is associated with.
• Value
  • The value of the variable itself (string of no more than 64 characters).

Talos Tag

Use

A Talos Tag represents a custom Tag that Talos attaches to users and is used as an integration in other modules.

Fields

• Color
  • A field indicating what color you would like the tag to render as.
  • Choices:
    • Bluish Purple
    • Green
    • Teal
    • Yellow
    • Red
    • Light Grey
    • Dark Grey
    • Light Grey
• Add Permissions
  • Groups with the ability to give users this tag.
• Remove Permissions
  • Groups with the ability to take this tag away from users.
• View Permissions
  • Groups with the ability to view this tag on a user.
• No Qualified For Courses
  • A flag which, if  checked, indicates that the tagged student will be automatically not qualified for any special qualified for courses.  Please see the documentation for the "Courses" module for more information.