Directory Info | Tech Docs
Contents
Application Details
Developer: Joe Gautreau | Programmer / Web Application Developer | jgautreau@judsonisd.org | (210) 945-5558
Development Platform: ColdFusion MX 7, SQL Server, Model-Glue Framework, CSS Layout
Development Server: Testweb
Development Database: ERCSQL
Production Server: Web1
Production Database: ERCSQL2K5
Launch Date: September 12, 2007
Application Overview
Directory Info was developed to allow the Public Information Office (Sean Hoffman) to give campuses a way to specify what personal data about students is allowed to be released to outside sources via Public Information Requests. A campus employee goes into the system, students from their school are shown and they can make changes to the default allowed information. The Public Information Office then goes in when a request for info is made and chooses a campus to get an excel file for, the system recognizes what can and cannot be given out and generates a file accordingly.
To sum it all up, the Directory Info application allows simple management of student personal data, both on the campus level and district office level.
Roles
There are three different types of roles for this application.
Administrator - This individual can view / edit and download data district-wide.
Data Entry - This campus individual can edit and view data based on campus ID. Thus allowing them to edit and view data for students at their campus, based on the form returned to the campus by the parents in the student handbook.
User - The user is allowed simply to view students information based on campus ID. Thus only allowing them to see data for students at their campus.
Database Schema
Below you will find the Student Directory Info database schema along with a short description for each table.
Student: This table is populated via a nightly stored procedure (SQL) which you can learn more about in the notes section. This table stores all active student data needed.
Campus: This table is related to the Student table. This table store campus name and ID information.
DirectoryInfo: This table is used to store any values for a student where the parent does or does not want their student's data being given out. It relates to the Student table on studentID.
Flow
Student Directory Info Data Flow Document - Click to download the PDF.
Extract File Data Flow Document - Click to download the PDF.
CFC's & Functions
Student.cfc
init:
- Purpose: When called this function returns an instance of the entire object / cfc with all methods available.
- Arguments: None
- Return Type: CFC
LookupStudents:
- Purpose: This function takes any number of search parameters and performs a search of all students matching the passed in criteria. It returns a query with the studentID, student name, grade, birthdate and a cleared flag.
- Arguments: studentID (numeric), firstname (string), lastname (string), searchType (numeric), locationID (numeric)
- Return Type: Query
getStudent:
- Purpose: This function grabs a student along with their allowed release data based on the studentID and locationID passed in. A query result set is returned.
- Arguments: locationID (numeric), studentID (numeric)
- Return Type: Query
updateStudent:
- Purpose: This function loops over the fieldnames and values passed in, and seperates them into two different lists. First thing done is to delete the student's existing record in the DirectoryInfo table to ensure that the student always only has one record and there is no conflicting values. Following that the query to insert the new record is processed. If any piece of this transaction fails no data will be damaged. A true/false flag (boolean) is then returned as the result.
- Arguments: fieldNamesValues (comma delimited string), studentID (numeric)
- Return Type: Boolean
generateExtract:
- Purpose: This function returns a query result set of students for a campus with the specified fields the user wants returned. This data result set shows only the data allowed by the parent to be distributed or given out for each student.
- Arguments: fields (comma delimited string), campusID (numeric)
- Return Type: Query
getCampuses:
- Purpose: This function returns a query result set of campuses with the campus name and campus ID.
- Arguments: None
- Return Type: Query
Notes
A nightly process run through a SQL stored procedure, runs nightly to grab all active student data from Student Plus, and dumps it into a table called Student in the Student Directory Info database.