The School-Configurable Final Grade Summary Document

Updated Jul 13, 2020

Published 07/10/2020

What is a Final Grade Summary?

A Final Grade Summary is essentially a transcript that displays posted grades instead of transcript items. The most common use case for this kind of document is the generation of Middle School Transcripts.

Overview

The new school-configurable Final Grade Summary document is one of a core set of school-configurable academic documents available to Veracross schools for the 2020-2021 school year and beyond.

Schools electing to purchase custom Final Grade Summary documents or retain existing Final Grade Summary documents cannot use the school-configurable Final Grade Summary document simultaneously.

We strongly discourage schools switching between the school-configurable document and a custom document more frequently than once per school year to avoid unnecessary delays and labor charges.

Design

The new school-configurable Final Grade Summary document is the result of extensive analysis. We analyzed the Final Grade Summary documents currently in use by a representative sample set of more than 20 Veracross schools in order to identify the key data points and design elements critical to creating an effective Final Grade Summary. Pairing those two items with the common adjustment requests our document engineers receive allowed us to build a set of school-configurable parameters that enable schools to take control of their document - no VC engineer required.

The new school-configurable Final Grade Summary document is built on the new Document Layouts architecture, allowing Axiom users to configure and manage multiple versions or layouts of the document for different use cases.

Examples

The following example configurations are mocked up on vcdemo_client. Feel free to create new layouts there when familiarizing yourself with the functionality.

Middle School Transcript Configuration

Parameters List

Below is a comprehensive list of the document layout configuration parameters available for the school-configurable Final Grades Summary document. Parameters are listed as they appear in Axiom.

"General" Category

Parameter	What it does	Possible Values
Official?	Toggles between "Unofficial" and "Official" prefixes on document title (unless using Title Override) Toggles display of "Unofficial" watermark Toggles display of signature image	0 (off) 1 (on)
Show Logo?	Toggles the display of the logo image	0 (hide) 1 (show)
Logo URL	Designates the logo image displayed in the upper-left corner	Direct link (URL) to a hosted image
Logo Width	Designates the size of the logo image in pixels (maintains aspect ratio of source image)	Integers (120 is standard)
Accent Color: Text	Designates the color of the text displayed on section header bars	Hex color codes
Accent Color: Background	Designates the color of the background displayed on section header bars	Hex color codes
Page Layout	Designates the page size of the document	page landscape a4 a4_landscape NOTE: "Page" is equivalent to "Letter" or 8.5 in x 11 in
Grade Levels	Designates the grade levels and corresponding grades tables displayed	Grade Level IDs
Date Format	Designates the format used for dates being displayed (all dates must use the same format)	Uses Strftime values (case-sensitive) %m/%d/%Y or %D %v %F
Classification for Dates & Notes	Designates the person classification used as the data source for: Date Enrolled Graduation Date Notes	Person Classification IDs

"Header" Category

Parameter	What it does	Possible Values
Title Override	Overrides the standard document title displayed	Characters
School Name	Designates the value displayed on the school name line (header, upper right)	Characters
School Address 1	Designates the text displayed for line 1 of school address (header, upper right)	Characters
School Address 2	Designates the text displayed for line 2 of school address (header, upper right)	Characters
School Address 3	Designates the text displayed for line 3 of school address (header, upper right)	Characters
School Phone	Designates the text displayed for school phone number (displayed on the same line as website, separated by a pipe)	Characters
School Website	Designates the text displayed for school website (displayed on the same line as school phone, separated by a pipe)	Characters
Show CEEB Code?	Toggles the display of the CEEB Code	0 (off) 1 (on)
CEEB Code Label	Designates the text displayed for the school CEEB Code label	Characters
School CEEB Code	Designates the text displayed for school CEEB Code	Characters

"Numeric Grades Table" Category

Parameter	What it does	Possible Values
School Year Sort Direction	Toggles the sort direction of school years displayed on the numeric grades table	asc (acsending) dsc (descending)
Table Enrollments	Designates which courses are displayed on the grades table	Options to Filter by Course Type: all (any enrollment that is marked "show on report card") academic_classes (course type = Academic) non_academic_classes (course type = Non-Academic) athletic_classes (course type = Athletic Program) non_athletic_non_homeroom (course type ≠Athletic Program OR Homeroom) other_program_classes (course type = Other Program) extended_care_classes (course type = Extended Care) summer_classes (course type = Summer) Options to Filter by Class Status: active_classes (class status is "Active" OR "Complete") active_academic_classes (classes where course type = "Academic" AND status = "Active" OR "Complete") graded_classes (classes where grading method = "Numeric", "Qualitative", OR "Pass/Fail") Options to Return a Single Class Value: homeroom (the homeroom class the student is enrolled in) advisory (the advisory class the student is enrolled in) dorm (the dorm class the student is enrolled in) NOTE: Single class values will only return one class, even if a student is enrolled in multiple classes that fit the criteria. Single Class parameter values can yield unintended results based on the state of the underlying data - schools are advised to proceed with caution and consult with their Account Manager.
Table Enrollments GP Specific	Should be set to "1" when building a term-specific report (as opposed to a cumulative report) When "1": Works in conjunction with the Table Enrollments parameter to display only classes for which an enrollment exists for the grading period associated with the report	0 (false) 1 (true)
Course Column Type	Designates which database value will be displayed in the course cells on the numeric grades table	course_description class_description
Show Teacher Column?	Toggles the display of the teacher name column on the numeric grades table	0 (hide) 1 (show)
Teacher Column Label	Designates the text displayed for the teacher column label on the header bar of the numeric grades table	Characters
Teacher Column Name Format	Designates the format for the teacher names displayed in the teacher cells of the numeric grades table	name_prefix first_name first_initial first_initial_with_period middle_name middle_initial middle_initial_with_period last_name last_name_with_comma last_name_suffix_with_comma preferred_name preferred_name_initial name_suffix *Syntax for combining:* separate values with a comma, include spaces e.g. last_name_with_comma, first_name
Show Enrollment Level Column?	Toggles the display of the enrollment level column on the numeric grades table	0 (hide) 1 (show)
Enrollment Level Label	Toggles the display of the enrollment level column on the numeric grades table	0 (hide) 1 (show)
Grading Periods	Designates which grading period types will be displayed as columns on the numeric grades table	reporting_grading_period mid_periods minor_periods major_periods final_period minor_major_periods mid_minor_periods minor_final_periods major_final_periods minor_major_final_periods
Grading Periods Format	Designates the format for the grading periods displayed in the grading period columns of the numeric grades table	abbreviation description
Grade Fields: Number of Decimal Places	Designates the number of decimal places displayed for numeric grades	0 1 2
Numeric Grade Field	Designates which database value will be displayed in the grade cells on the numeric grades table	posted_grade assignment_posted_grade
Numeric Grade Field Type	Designates the format for the term grade values displayed in the grade cells of the numeric grades table	letter_grade grade (percentage)
Show Term Exam Column?	Toggles the display of the term exam column on the numeric grade table	0 (hide) 1 (show)
Show Final Exam Column?	Toggles the display of the final exam column on the numeric grades table	0 (hide) 1 (show)
Exam Grade Field Type	Designates the format for the term and final exam grade values displayed in the grade cells of the numeric grades table	letter_grade grade (percentage)
Show Credits Earned Column?	Toggles the display of the credits earned column on the numeric grades table	0 (hide) 1 (show)
Credits Earned Column Label	Designates the text displayed for the credits earned column label on the header bar of the numeric grades table	Characters
Show Credits Earned Per Year?	Toggles the display of the credits earned yearly total on the numeric grades table	0 (hide) 1 (show)
Credits Earned Per Year Label	Designates the text displayed next to the credits earned yearly total on the numeric grades table	Characters
Show Cumulative Credits Earned Per Year?	Toggles the display of the YTD credits earned yearly total on the numeric grades table	0 (hide) 1 (show)
Cumulative Credits Earned Per Year Label	Designates the text displayed next to the YTD credits earned yearly total on the numeric grades table	Characters
Show Cumulative Credits Earned Total?	Toggles the display of the cumulative credits earned total on the numeric grades table	0 (hide) 1 (show)
Total Credits Earned Label	Designates the text displayed next to the cumulative credits earned total on the numeric grades table	Characters
Show Days Enrolled?	Toggles the display of the yearly days enrolled value on the numeric grades table	0 (hide) 1 (show)
Days Enrolled Label	Designates the text displayed next to the yearly days enrolled value on the numeric grades table	Characters
Show Days Absent?	Toggles the display of the yearly days absent value on the numeric grades table	0 (hide) 1 (show)
Days Absent Label	Designates the text displayed next to the yearly days absent total on the numeric grades table	Characters
Days Absent Format	Designates the format for the yearly days absent values displayed on the numeric grades table	all excused unexcused
Show Days Tardy?	Toggles the display of the yearly days tardy value on the numeric grades table	0 (hide) 1 (show)
Days Tardy Label	Designates the text displayed next to the yearly days tardy total on the numeric grades table	Characters
Days Tardy Format	Designates the format for the yearly days tardy values displayed on the numeric grades table	all excused unexcused

"Student Info" Category

Parameter	What it does	Possible Values
Student Information Label	Designates the text displayed in the header bar of the student information table	Characters
Name Format	Designates the format displayed for student name values	name_prefix first_name first_initial first_initial_with_period middle_name middle_initial middle_initial_with_period last_name last_name_with_comma last_name_suffix_with_comma preferred_name preferred_name_initial name_suffix *Syntax for combining:* separate values with a comma, include spaces e.g. last_name_with_comma, first_name
Show Student ID?	Toggles the display of the student's student ID	0 (hide) 1 (show)
Student ID Label	Designates the text displayed for the student ID value label	Characters (the value of the "Label Separator" parameter will be appended automatically)
Show Gender?	Toggles the display of the student's gender	0 (hide) 1 (show)
Gender Label	Designates the text displayed for the student gender value label	Characters
Show Birth Date?	Toggles the display of the student's date of birth	0 (hide) 1 (show)
Date of Birth Label	Designates the text displayed for the student date of birth value label	Characters
Show Household Address?	Toggles the display of the student's household address information	0 (hide) 1 (show)
Address Label	Designates the text displayed for the student household address value label	Characters
Show Date Enrolled?	Toggles the display of the start date value of the person classification specified for the "Classification for Dates & Notes" parameter in the "General" category	0 (hide) 1 (show)
Date Enrolled Label	Designates the text displayed for the student date enrolled value label	Characters
Show Graduation Date?	Toggles the display of the end date value of the person classification specified for the "Classification for Dates & Notes" parameter in the "General" category	0 (hide) 1 (show)
Graduation Date Label	Designates the text displayed for the student graduation date value label	Characters
Withdrawal Date Label	Designates the text displayed for the student withdrawal date value label	Characters NOTE: Date Withdrawn will display in place of graduation date, if it exists.
Show Graduation Year?	Toggles the display of the graduation year value	0 (hide) 1 (show) NOTE: Graduation Year values will be pulled from the person record (ENR History).
Graduation Year Label	Designates the text displayed for the student graduation year value label	Characters

"Grade Point Averages" Category

Parameter	What it does	Possible Values
Show GPA Section?	Toggles the display of the GPA section	0 (hide) 1 (show)
GPA Label	Designates the label displayed in the header bar on the GPA table.	Characters
Show Year Specific GPA in Sidebar?	Toggles the display of year specific GPAs in the document sidebar	0 (hide) 1 (show)
Year Specific GPA	Designates which GPA configuration is used to render the year specific GPA displayed on the document	GPA Configuration IDs NOTE: These GPAs will display in the sidebar next to the hardcoded Grade Level label they are associated with.
Show Weighted Cumulative GPA?	Toggles the display of the weighted cumulative GPA in the document sidebar	0 (hide) 1 (show)
Cumulative Weighted GPA	Designates which GPA configuration is used to render the weighted cumulative GPA displayed on the document	GPA Configuration IDs
Cumulative Weighted GPA Label	Designates the text displayed for the weighted cumulative GPA in the document sidebar	Characters
Show Unweighted Cumulative GPA?	Toggles the display of the unweighted cumulative GPA in the document sidebar	0 (hide) 1 (show)
Cumulative Unweighted GPA	Designates which GPA configuration is used to render the unweighted cumulative GPA displayed on the document	GPA Configuration IDs
Cumulative Unweighted GPA Label	Designates the text displayed for the unweighted cumulative GPA in the document sidebar	Characters
Show Year Specific GPA in Grades Table?	Toggles the display of year specific GPAs in the grades table	0 (hide) 1 (show)
Year Specific GPA in Grades Table Label	Designates the text displayed for the year specific GPA in the grades table label	Characters
Show Cumulative Weighted GPA in Grades Table?	Toggles the display of weighted cumulative GPA in the grades table	0 (hide) 1 (show)
Cumulative Weighted GPA in Grades Table Label	Designates the text displayed for the weighted cumulative GPA in the grades table label	Characters
Show Cumulative Unweighted GPA in Grades Table?	Toggles the display of unweighted cumulative GPA in the grades table	0 (hide) 1 (show)
Cumulative Unweighted GPA in Grades Table Label	Designates the text displayed for the unweighted cumulative GPA in the grades table label	Characters

"Grade Scales" Category

Parameter	What it does	Possible Values
Show Grade Scale?	Toggles the display of the grade scale table	0 (off) 1 (on)
Grade Scale Label	Designates the text displayed in the header bar of the grade scale table	Characters
Grade Scale IDs	Designates the grade conversion scales displayed in the grade scale table	Grade Conversion Scale ID(s) *Syntax for multiple:* comma separated, no spaces e.g. 4,5,6

"Notes" Category

Parameter	What it does	Possible Values
Show Transcript Notes?	Toggles the display of the notes box in the document sidebar	0 (off) 1 (on)
Transcript Notes Label	Designates the text displayed in the header bar of the notes box	Characters

"Signature Section" Category

Parameter	What it does	Possible Values
Show Signature?	Toggles the display of the the signature image	0 (off) 1 (on)
Signature Image URL	Designates the image displayed on the signature line	Direct link (URL) to a hosted image
Signature Description	Designates the text displayed below the signature line	Characters

"Footer" Category

Parameter	What it does	Possible Values
Footer Text	Designates the text displayed in the footer of the document	Characters (2000 character limit)
Print Date Label	Designates the text displayed for the print date value label	Characters
Show Print Date in Footer?	Toggles the display of the print date in the footer (print date is included below the signature image by default)	0 (off) 1 (on)