Sample Software Documentation

Posted on Posted in TechWriteSample

This sample is available online at https://training.focusschoolsoftware.com/moodle/mod/wiki/view.php?pageid=6474

 

 Referral Codes & Actions enable the district to define which disciplinary actions are allowable for the incident selected on the referral form. Allowable actions are specific to the referral form’s discipline codes, and repeat offenses will include additional actions on the form. For ESE and/or 504 students, allowable actions are defined independently, including the allowable actions for repeat offenses.

 When school staff Add a Referral, they can only chose actions that the district has allowed for that code. Schools cannot enter an action length that exceeds the maximum or minimum in the district setup, nor can school staff use an expulsion code or assign more than 10 days for OSS. If the OSS length exceeds 10 days, the number will highlight in red. These features ensure that disciplinary actions are consistent across the district.

 Referral Codes & Actions also includes a restriction on re-entry option and school warnings for new enrollments and/or restricted students.

 Actions are created on the Actions tab in Referral Codes & Actions. Once the actions and the referral form’s discipline codes have been created, actions can be included with a discipline code on the Codes tab in Referral Codes & Actions.

 Note: For version 7.2, only allowable actions and maximum and minimum length per action is enforced. All other rules will be enforced in version 8.0.

 1. Set Up Discipline Actions

 Actions must be set up on the Actions tab in Referral Codes & Actions to be used in the Codes tab. Go to Referral Codes & Actions from the Discipline menu, then select the Actions tab. 

 
 
 

To add an action, use the empty fields at the top of the table. Hit enter to save the row and generate another set of open fields.

 

 
 Action table columns:  
 

Title: enter the action title that will display on the Referral Form.

 
 

Local Code: (optional) enter an locally-used identification that corresponds to this action.

 
 

State Code:  enter a one-character code representing the type of disciplinary action taken.

 
 

Severity: indicates if an incident involved serious bodily injury to a student, non-student, or both.

 
 

Allowed Profiles (View/Edit): indicate the profile user(s) with the permission to view/edit this action.

  
 

Days per Referral: enter maximum days (not exceeding 10) for a student’s out-of-school suspension.

 
 

Days per ESE Referral: enter maximum days (not exceeding 10) that ESE students can be suspended (OSS) for this action.

 
 

Days per 504 Referral: enter the minimum and maximum days (not exceeding 10) that 504 students can be suspended (OSS) for this action.

 
 

Days per Year: enter the maximum number of days  (not exceeding 10) that students can be suspended (OSS) for the full school year.

 
 

Days per ESE Year: enter the maximum number of days  (not exceeding 10) that ESE students can be suspended (OSS) for the full school year.

 
 

Days per 504 Year: enter the maximum number of days  (not exceeding 10) that 504 students can be suspended (OSS) for the full school year.

 
 

Warning Level (When to warn for ESE/504 Students): (optional) display a warning message when an ESE or 504 student has reach the entered number of suspension days.

 
 

Grade Level Minimum/Maximum: enter minimum and maximum grade levels to use this action.

 
 

Withdrawal Code – enter a state-defined code that indicates the status under which the student was expelled from the school.

 
 

Warn on New Enrollment: include a warning message when the student was expelled from their previous school, and are now enrolling into a different school.

 
 

Warning Message: enter text of the new enrollment message.

This warning will display if a student’s discipline history includes certain actions and tries to enroll into another school.

 
 

Restrict Re-Entry: (optional) prohibit students from re-entering certain district schools.

 
 

Re-Entry Message: text of the re-entry message.

This warning will display if a student’s discipline history includes certain actions and tries to enroll into another school.

 
 

School Exemptions for Re-Entry Restriction: the schools listed in this field are the alternative or center schools that will often take students with severe discipline histories, in lieu of expulsion.

 
 

Profile Exemptions for Re-Entry Restriction:

The profiles listed in this fields are the school staff who will often work with students at specific exemption schools.

 
 

Override Profile: profile types with overriding permissions.

 
 

School Years: the school years when the action is in use.

 

 

 

Setup Discipline Codes
 2. Add Discipline Codes & Allowable Actions 

Allowable actions are assigned to discipline codes on the Codes tab in Referral Codes & Actions.

To limit a discipline code’s allowable actions, add it to the Codes table; and select any existing actions in the Actions column.

 

Important Note:

Discipline codes added to Referral Codes & Actions must be identical to an existing discipline code in the Referral Form Setup. 

These are located in the Discipline Codes’ field setup of the Referral Form; the titles/shortcodes are listed in the bottom-left boxes “Pull-Down/Select Multiple Choice” and “Codes for Pull-Down/Select Multiple Choice.”

 

 

The same codes must be used for the Referral Form and the Codes table on Referral Codes & Actions.* 

 

From the Discipline menu select Codes & Actions  from the Setup section. Use the discipline codes from the referral form setup as a guide and add titles and codes one at a time, pressing enter to save eachrow.

Copy each referral form discipline description and enter it as the Title. Copy the associated discipline code and enter it as the code. If the code in the discipline codes setup does not match an option in the referral form an error will occur and that row of the codes table will turn red. Erroneous or mismatched titles will not register as an error or impede the functioning of codes table but may add to user confusion maintaining the tables.

To add a code, use the empty fields at the top of the table. Hit enter to save the row and generate another set of open fields.

Codes table columns:

 
Title: a name to identify the referral code that displays for users. Copy each referral form discipline description and enter it as the title.   
 

Code: the discipline code that matches entries to theReferral Form. Copy the associated discipline code and enter it as the code. 

 
 

Severity: this field may be used if the district defines severity levels associated with codes.

 
 Offense: used to distinguish between the occurrence of the same referral code more than once.  If the same code has different consequences (actions) based on the number of times the student has been referred for the code this column would be used.  
 

SESIR: check to indicate a SESIR code and should prompt additional SESIR fields to be completed.

 
 

Incident type: the three-character DOE code to indicate type of SESIR incident, when applicable.

 
 ISS Days: the minimum and maximum suspension days from an allowable action(s).

OSS Days: the minimum and maximum suspension days from an allowable action(s).

 
 Actions: selected disciplinary action(s) that are allowed to be assigned to this discipline code, which have been previously set up on the Actions tab.  
 

Allowed Profiles (View/Edit) – profile types(s) with permissions to use these discipline codes.

 
 Warn on New Enrollment: include a warning message when the student has received this discipline code and tries to re-enroll.  
 Warning Message: enter text of the new enrollment message if the student has the associated discipline code in discipline history.  
 

Restrict Re-Entry: (optional) prohibit students from re-entering certain district schools.

 
 Re-Entry Message: text of the re-entry message if the student has the associated discipline code in discipline history.  
 Override Profile: any profile types with overriding permissions to select actions and days different from what is assigned to this action.  
 School Years: the school years when the action is in use.  

Leave a Reply

Your email address will not be published. Required fields are marked *