Overview

Each type of list comes with a type of Rule Parser that governs how to extract a subset of relevant users to include in the list.

Student Rule Parser

The Student Rule Parser is used for student lists.

Operands

• grade
  • Number representing the grade of a student (given current school year and term settings).  Should be used in conjunction with operators that support numerical operation.
• ofcl
  • String representing the ofcl of a student.  Should be used in conjunction with operators that support string operation.

Operators

Numerical Operator(s)

• =
  • Numerical test for equality
• <
• >
• <=
• >=

String Operators(s)

• equals
  • String test for equality

Parent Rule Parser

The Parent Rule Parser is used for parent lists.

Operands

• students_grades
  • An operand that returns a list of grades of the children of a given parent.  If a parent has a student in 2 grades, both will be included, etc.  Should be used with operators that work on lists.
• students_ofcl
  • An operand that returns a list of ofcls of the children of a given parent.  If a parent has a student in 2 ofcls, both will be included, etc.  Should be used with operators that work on lists.
• written_language
  • The preferred written language of the parent.  Should be used with operators that work on strings.
• spoken_language
  • The preferred spoken language of the parent.  Should be used with operators that work on string.

Operators

List Operator(s)

• contains
  • Returns true if and only if a list contains a specific value

String Operator(s)

• equals
  • String test for equality

Staff Rule Parser

In progress, staff lists are currently not supported.