As of July 12, 2021, this "Learn Veracross" site has been deprecated. It will remain live through December 2022, but will no longer be updated. All knowledge content has moved to the new Veracross Community. Please update your bookmarks.
Overview
The Veracross Data Importer allows schools to import courses into Axiom for academic use. This import type should be considered an importer only — it allows you to import new courses into Axiom but will not allow you to update existing courses.
On import completion, this process creates new courses within subjects in Axiom for use with academic modules.
Uploading courses involves the following two steps:
- Preparing the data for upload using the Course import type template, which is provided before data import on the Importer site.
- Uploading the data using the Veracross Data Importer.
Preparing the Data for Upload
The user must prepare a comma separated value (CSV) file containing all data to import. This file must contain all columns in the order listed below, even if no content is populated in the columns. If there is no content in a column, that row must be left blank.
Fields in the Import Type Template
The Course import type has a number of required fields, each of which is designated in the corresponding row in the Value Considerations column below.
| Column (Field) Name | Value Considerations |
|---|---|
| course_type | Required value. Text format. The Course Type of the course you are inserting. Available options are:
|
| course_id | Text format. The Course ID of the course that you are inserting. This value can be found in the Course ID column in a Course List query. This field has a character limit of 15 characters. |
| course_code | Text format. The Course Code of the course that you are inserting. This value can be found in the Course Code column in this Course List query. This field has a character limit of 15 characters. |
| description | Required value. Text format. The actual name of the Course being inserted. Find this as the Course Name in a Course List query. This field has a character limit of 100 characters. |
| subject | Required value. Numeric/text format. The subject that this course should be a part of. This field can be populated by one of two options:
|
| gender | Numeric/text format. The "Gender" of the course, if a gender is relevant (typically used in Athletics). This field can be populated by one of two options:
|
| include_on_report_card | Numeric/text format. This sets whether or not this course is included on student report cards. The options are:
If left blank, this field defaults to Yes. |
| Include_on_transcript | Numeric/text format. This sets whether or not this course is included on student transcripts. The options are:
If left blank, this field defaults to Yes. |
| include_in_gpa | Numeric/text format. This sets whether or not this course is considered when calculating student grade point average (GPA). The options are:
If left blank, this field defaults to Yes. |
| default_term_credit_hours | Numeric format. This sets the default value for the number of credits a class is worth that exists within this course. This value can be found in the Default Term Credit Hours column in this Course List query. |
| assignment_group | Numeric format. This sets what assignment group the course being inserted belongs to (read more about assignment groups in our documentation). This value can be found as the Assignment Group column in this Course List query. |
| catalog_title | Text format. This sets the catalog title for this course. This value can be found as the Catalog Title column in this Course List query. The character limit for this field is 100 characters. |
| link_style | Hex code format. This value designates the color in which this course appears in schedule documents. This value may be found as the Link Style column in this Course List query. A hex code is a string of six alpha-numeric characters following a # that denotes a specific color. Each of these characters can be a number between 0-9 or a letter between A-F. Learn more about hex codes here. |
| notes | Text format. This populatted the noted field on the Course record for the Course that is being inserted. This field has a character limit of 8,000 characters. |
| sort_key | Numeric format. This value determines the sort key for the course. This value can be found in the Sort Key column in this Course List query. |
| available_for_request | Numeric/text format. This sets whether or not this course is available for request. The options are:
If left blank, this field defaults to Yes. |
| curriculum_type | Text format. This sets the curriculum type of the course being inserted. Available options are:
These options, with the exception of the "None" option, may be prepended with the word "by" without issue. |
| grade_input_method | Text format. This sets the grading method for grades that are entered to the course being inserted. Available optons are:
|
| include_in_scheduler | Numeric/text format. This sets whether or not this course is included in the Scheduler tool if your school uses this functionality. The options are:
If left blank, this field defaults to Yes. |
| include_in_parent_teacher_conferences | Numeric/text format. This sets whether or not this course allows for the scheduling of related Parent/Teacher Conferences. The options are:
If left blank, this field defaults to Yes. |
| allow_wait_list | Numeric/text format. This sets whether or not this course allows for the use of wait lists. The options are:
If left blank, this field defaults to No. |
| default_block_group | Numeric/text format. This sets the block group that defaults to classes that are a part of this course. This field can be populated by one of two options:
|
| default_grade_conversion_scale | Numeric/text format. This sets the grade conversion scale that appears as default in classes within the course being inserted. This field can be populated by one of two options:
|
Additional Considerations
In addition to the criteria set in the table above, the Course import type has a number of additional considerations that should be taken into account:
- this import type is an importer only — it will insert new courses but not update existing courses
- to check for duplicates, the course import type will look through the system to find if any courses already exist that have all the following fields as identical: course_id, subject, and course_description. If any courses exist that exactly match all three of these fields, that new course is not created and is, instead, skipped over, as the system determines that it is a duplicate.