The School-Configurable "Academic Document" Document

Updated Oct 27, 2020
Published 06/25/2020

If your school is interested in more information about the school-configurable "Academic Document" document, please contact your account manager.

Overview

The new school-configurable "Academic Document" document is one of a core set of school-configurable documents available to Veracross schools for the 2020-2021 school year and beyond.

The school-configurable "Academic Document" document allows schools to configure both report cards and progress reports in a variety of ways, including the ability to configure numeric, narrative, and simple qualitative layouts.

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

Design

The new school-configurable "Academic Document" document is the result of extensive analysis. We analyzed the report card and progress report documents currently in use by a representative sample set of 50 Veracross schools in order to identify the key data points and design elements critical to creating an effective report card/progress report. 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 documents - no VC engineer required.

The new school-configurable "Academic Document" 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. Read more about document layouts here.

Visual Examples

Below are four common report card/progress report types that have been generated using the school-configurable "Academic Document" document. This functionality has been enabled on the vcdemo_client database, so feel free to create new layouts there when familiarizing yourself with the functionality.  

Numeric Configuration

Numeric w/ Comments Configuration

Comment-based Configuration

Class-based Qualitative Configuration

Rubric-based Qualitative Report Card Configuration

Parameters List

Below is a comprehensive list of the document layout configuration parameters available for the school-configurable "Academic Document" document. Parameters are listed as they appear in Axiom and organized by parameter category (subtotal header values on the document-layout record).

"Header" Category

ParameterWhat it doesPossible Values
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)
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 School Year in Header?
  • Toggles the display of the school year value in the header
  • 0 (hide)
  • 1 (show)
Show Grading Period in Header?
  • Toggles the display of the grading period value in the header
  • 0 (hide)
  • 1 (show)
Title Override
  • Overrides the standard document title displayed
  • Characters
Date Format
  • Designates the format used for dates being displayed (all dates must use the same format)
Print Date Label
  • Designates the text displayed for the print date value label
  • Characters
Show Print Date in Header?
  • Toggles the display of the print date in the header
  • 0 (hide)
  • 1 (show)
Show Grade Scale?
  • Toggles the display of the grade scale(s)
  • 0 (hide)
  • 1 (show)
Grade Scale Label
  • Designates the text displayed for the grade scale table label
  • Characters
Grade Scale IDs
  • Designates which grade scale(s) are displayed on the document


"GPA Info" Category

ParameterWhat it doesPossible 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
GPA Grading Periods
  • Designates which grading period types will be represented as columns in the GPA 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
Show Grading Period GPA?
  • Toggles the display of GPAs for major grading periods
  • 0 (hide)
  • 1 (show)
Grading Period GPA Label
  • Designates the text displayed for the grading period GPA label
  • Characters
Grading Period GPA
  • Designates which GPA configuration is used to render the major grading period GPAs displayed on the document
Show Year Specific GPA?
  • Toggles the display of the year specific GPA
  • 0 (hide)
  • 1 (show)
Year Specific GPA Label
  • Designates the text displayed for the year specific GPA label
  • Characters
Year Specific GPA
  • Designates which GPA configuration is used to render the year specific GPA displayed on the document


"General" Category

ParameterWhat it doesPossible Values
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
Show PDF Header?
  • Toggles the display of header information (student name on left, report title centered, school name on right) on PDF export for multi-page reports (PDF header will begin on page 2 and be displayed on all subsequent pages)
  • 0 (hide)
  • 1 (show)
Show PDF Footer?
  • Toggles the display of footer information (“Page {#}”; centered) on PDF export for multi-page reports (PDF footer will be displayed on all pages)
  • 0 (hide)
  • 1 (show)
Accent Color: Text
  • Designates the color of the text displayed on section header bars
Accent Color: Background
  • Designates the color of the background displayed on section header bars
Label Separator
  • Designates the character(s) displayed after labels in the Student Information area
  • Characters (common examples below)
    • :
    • -


"Student Info" Category

ParameterWhat it doesPossible Values
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 single space
  • e.g. name_prefix first_name middle_initial_with_period last_name_suffix_with_comma
Show Student Grade?
  • Toggles the display of the student's current grade level value
  • 0 (hide)
  • 1 (show)
Student Grade Label
  • Designates the text displayed for the student grade value label
  • Characters (the value of the "Label Separator" parameter will be appended automatically)
Student Grade
  • Designates how the student's current grade value is displayed on the document
  • abbreviation
  • description
  • long_description
Show Household Address?
  • Toggles the display of the student's household address information
  • 0 (hide)
  • 1 (show)
Household Address Label
  • Designates the text displayed for the student household address value
  • Characters
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 Student ID?
  • Toggles the display of the student's student ID
  • 0 (hide)
  • 1 (show)
Report Period Date Format
  • Designates the date format used for report period start and end dates
  • Uses Strftime values (case-sensitive)
    • %b %d
    • %m/%d/%Y or %D
  • Start and end dates will be separated by a hyphen automatically
Reporting Period Label
  • Designates the label displayed next to the reporting period start/end dates
  • Characters (the value of the "Label Separator" parameter will be appended automatically)
Show Reporting Period Start Date?
  • Toggles the display of the start date for the grading period associated with the report
  • 0 (hide)
  • 1 (show)
Show Reporting Period End Date?
  • Toggles the display of the end date for the grading period associated with the report
  • 0 (hide)
  • 1 (show)
Advisor Label
  • Designates the text displayed for the advisor name value label
  • Characters (the value of the "Label Separator" parameter will be appended automatically)
Homeroom Label
  • Designates the text displayed for the homeroom teacher name value label
  • Characters (the value of the "Label Separator" parameter will be appended automatically)
Show Advisor?
  • Toggles the display of advisor information (Advisor Label & Advisor Name)
  • 0 (hide)
  • 1 (show)
Advisor Name Format
  • Designates the format for the advisor name displayed on the document
  • 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 single space
  • e.g. name_prefix last_name
Homeroom Name Format
  • Designates the format for the homeroom teacher name displayed on the document
  • 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 single space
  • e.g. name_prefix last_name


"Attendance Info" Category

ParameterWhat it doesPossible Values
Show Attendance Table?
  • Toggles the display of the attendance table
  • 0 (hide)
  • 1 (show)
Attendance Label
  • Designates the text displayed in the header bar on the attendance table
  • Characters
Attendance Grading Periods
  • Designates which grading period types will be represented as columns in the attendance 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
Show Attendance Decimals?
  • Toggles the formatting of attendance values to display/not display decimals
  • 0 (hide)
  • 1 (show)
NOTE: The document will not automatically round values. If you use fractional attendance values, this parameter should be set to "1"
Show Tardies Row?
  • Toggles the display of the tardies row on the attendance table
  • 0 (hide)
  • 1 (show)
Show Excused Tardies Row?
  • Toggles the display of the excused tardies row on the attendance table
  • 0 (hide)
  • 1 (show)
Show Unexcused Tardies Row?
  • Toggles the display of the unexcused tardies row on the attendance table
  • 0 (hide)
  • 1 (show)
Show Absences Row?
  • Toggles the display of the absences row on the attendance table
  • 0 (hide)
  • 1 (show)
Show Excused Absences Row?
  • Toggles the display of the excused absences row on the attendance table
  • 0 (hide)
  • 1 (show)
Show Unexcused Absences Row?

  • Toggles the display of the unexcused absences row on the attendance table
  • 0 (hide)
  • 1 (show)


"Numeric Grades Table" Category

ParameterWhat it doesPossible Values
Show Grades Table?
  • Toggles the display of the numeric grades table
  • 0 (hide)
  • 1 (show)
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)
Show Course Column?
  • Toggles the display of the course column on the numeric grades table
  • 0 (hide)
  • 1 (show)
Course Column Label
  • Designates the text displayed for the course column label on the header bar of the numeric grades table
  • Characters
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
  • NOTE: This configuration option must be set, even if you do not display numeric grades.
  • 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 single space
  • e.g. name_prefix last_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
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)
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 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)


"Class Detail" Category

ParameterWhat it doesPossible Values
Show Class Section?
  • Toggles the display of the class section area of the document 
  • 0 (hide)
  • 1 (show)

NOTE: If you want to display any of the following, this parameter should be set to "1":

  • curriculum comments
  • student comments
  • qualitative grades by class
  • other grade 1
  • other grade 2
Class Section Enrollments
  • Designates which courses are displayed in the class section area
  • 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.

Class Section Page Breaks
  • Designates the page break behavior used with the class section when printing the document
  • always (before each class section, force a page break)
  • sometimes (try to prevent a class section from splitting across multiple pages - Default setting)
  • never (no special page break logic)
Class Section Course Type
  • Designates which database value will be displayed in the course cells in the class section area
  • course_description
  • class_description
Show Class Name in Class Section?
  • Toggles the display of class name values in the class section area
  • 0 (hide)
  • 1 (show)
Show Teacher in Class Section?
  • Toggles the display of teacher name values in the class section area
  • 0 (hide)
  • 1 (show)
Class Section 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 Class Section Enrollments parameter to display only classes for which an enrollment exists for the grading period associated with the report
  • 0 (false)
  • 1 (true)
Show Other Grade 1?
  • Toggles the display of other grade 1 values in the class section area
  • 0 (hide)
  • 1 (show)
Other Grade 1 Label
  • Designates the text displayed for the other grade 1 label in the class section area
  • Characters
Show Other Grade 2?
  • Toggles the display of other grade 2 values in the class section area
  • 0 (hide)
  • 1 (show)
Other Grade 2 Label
  • Designates the text displayed for the other grade 2 label in the class section area
  • Characters
Show Curriculum Comment?
  • Toggles the display of curriculum comments in the class section area
  • 0 (hide)
  • 1 (show)
Curriculum Comment Label
  • Designates the text displayed above curriculum comments in the class section area
  • Characters
Show Student Comment?
  • Toggles the display of student comments in the class section area
  • 0 (hide)
  • 1 (show)
Student Comment Label
  • Designates the text displayed above student comments in the class section area
  • Characters
Show Qualitative Grades?
  • Toggles the display of qualitative grades in the class section area
  • 0 (hide)
  • 1 (show)
Show Qualitative Scales?
  • Toggles the display of qualitative scales in the class section area
  • 0 (hide)
  • 1 (show)
Qualitative Scales IDs
  • Designates the qualitative scales displayed in the class section area
Use Proficiency Levels as Columns?
  • Toggles columns between representing grading periods and proficiency levels in the class section area
  • 0 (hide)
  • 1 (show)
Grading Periods
  • Designates which grading period types will be displayed as columns in the class section area
  • 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 in the class section area
  • abbreviation
  • description
Proficiency Level Format
  • Designates the format for the proficiency levels displayed in the grading period columns in the class section area
  • abbreviation
  • description
Show Rubric Criteria Notes
  • Toggles the display of rubric criteria notes in the class section area
  • 0 (hide)
  • 1 (show)


"Qualitative Detail" Category

ParameterWhat it doesPossible Values
Show Qualitative Section?
  • Toggles the display of the qualitative detail area
  • 0 (hide)
  • 1 (show)
Qualitative Section Page Breaks
  • Designates the page break behavior used with the qualitative section when printing the document
  • always (before each qualitative section, force a page break)
  • sometimes (try to prevent a qualitative section from splitting across multiple pages - Default setting)
  • never (no special page break logic)
Show Qualitative Scales?
  • Toggles the display of qualitative scales in the qualitative detail area
  • 0 (hide)
  • 1 (show)
Qualitative Scales Label
  • Designates the text displayed in the qualitative scales header in the qualitative detail area
  • Characters
Qualitative Scales IDs
  • Designates the qualitative scales displayed in the qualitative detail area
Group Rubrics By Category?
  • Toggles the grouping of rubrics by category in the qualitative detail area
  • 0 (hide)
  • 1 (show)
Show Teacher Name?
  • Toggles the display of teacher name values in the qualitative detail area
  • 0 (hide)
  • 1 (show)
Show Only Primary Teacher?
  • Toggles the  in the qualitative detail area
  • 0 (hide)
  • 1 (show)
Curriculum Comments Label
  • Designates the text displayed above curriculum comments in the qualitative detail area
  • Characters
Show Curriculum Comments?
  • Toggles the display of curriculum comments in the qualitative detail area
  • 0 (hide)
  • 1 (show)
Show Criteria Comments?
  • Toggles the display of criteria comments in the qualitative detail area
  • 0 (hide)
  • 1 (show)
Criteria Column Label
  • Designates the text displayed above student comments in the qualitative detail area
  • Characters
Use Proficiency Levels as Columns?
  • Toggles columns between representing grading periods and proficiency levels in the qualitative detail area
  • 0 (hide)
  • 1 (show)
Grading Periods
  • Designates which grading period types will be displayed as columns in the qualitative detail area
  • 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 in the qualitative detail area
  • abbreviation
  • description
Proficiency Level Format
  • Designates the format for the proficiency levels displayed in the grading period columns in the qualitative detail area
  • abbreviation
  • description
Show Criteria Notes?
  • Toggles the display of rubric criteria notes in the qualitative detail area
  • 0 (hide)
  • 1 (show)
Copyright © 2019 Veracross. All rights reserved.