Onboarding

Once you have completed the relevant steps in preparation for onboarding, onboarding will be a simple process of providing information so that SchoolCal can connect to your SIS and calendaring system. Data won't start syncing until you explicitly enable it, but this process will get you one step closer to syncing. Choose your SIS and calendaring system below and follow the instructions to get started:

Veracross

Primary Data Source - Veracross API (V2)

Optional - Secondary Data Source - Veracross API (V3)

Google

Veracross

Veracross API (V2)

You will need three pieces of information to set up the API V2 connection to Veracross, two of which Veracross should have provided to you. Once you have your Veracross API V2 username and password, you can begin onboarding in SchoolCal:

1. When asked for your Veracross API V2 client id, enter the school short name you use with Veracross (the abbreviation within your URL; the orange part, here: axiom.veracross.com/schoolshortname/#/homepage/main).

2. Enter the Veracross API V2 username and password you received from Veracross in their respective fields.

3. Press Save!

Veracross API (V3)

This is the most current list of Scopes for the API v3. Veracross has changed the way that you add scopes. We hope to make this a little easier. 

For new schools only, please first add the new OAuth partner:

Login to Veracross/Axiom and go to the "Identity and Access Management" homepage
From the IAM homepage, add SchoolCal as an "integration partner". SchoolCal can be found in the list of partners in the middle of the page, towards the bottom of the list. Press the "Start Integration" button. NOTE: you may need to add the security role of "OAuth_App_Admin" and refresh the page in order for the "start integration" button to appear.
After pressing the "Start Integration" button, you should be presented with a screen that shows you the SchoolCal name, and my email address. From there, press the "Add OAuth Application" button (green button, top right). Then continue as follows.

Click the SchoolCal instance (on the left) and grab the number of your instance which may be found in the URL:

2. Click on this query: https://axiom.veracross.com/#/query/1274635 and edit the "Oauth Application Fk" to match the number above and run the query.

3. From the lightning bolt menu, batch update the status of all to be "Yes".

That will enable all of the scopes

The scopes list is updated from time to time so please verify that your list is accurate:

List Academics: Calendar Rotation Days

Read Academics: Calendar Rotation Day

List Academics: Class Schedules

List Academics: Class Meeting Times

Read Academics: Class Meeting Time

List Academics: Classes

Read Academics: Class

List Academics: Block Groups

Read Academics: Block Group

List Academics: Configuration - Block Schedules

Read Academics: Configuration - Block Schedule

List Academics: Configuration - Block Meetings Times

Read Academics: Configuration - Block Meeting Time

List Academics: Configuration - Blocks/Periods

Read Academics: Configuration - Blocks/Period

Read Academics: Blocks by Group

List Academics: Blocks by Group

List Academics: Grading Periods

Read Academics: Grading Period

List Academics: Rotation Days

Read Academics: Rotation Day

List Academics: Courses

Read Academics: Course

List Academics: Departments

Read Academics: Department

List Academics: Enrollments

Read Academics: Enrollment

List Academics: Classes - Permissions

Read Academics: Classes - Permission

List Academics: Rooms

Read Academics: Room

List Academics: Subjects

Read Academics: Subject

List Athletics: Rosters

Read Athletics: Roster

List Athletics: Sports

Read Athletics: Sport

List Athletics: Team Practice Schedules

List Athletics: Teams

Read Athletics: Team

List Classes

Read Classes

List Courses

Read Course

List Event Groups

Read Event Group

List Events: Athletics

Read Events: Athletic

List Events: Attendance

Read Event: Attendance

List Events

Read Event

List Extended Care: Class Meeting Times

Read Extended Care: Class Meeting Time

List Extended Care: Classes

Read Extended Care: Class

List Extended Care: Courses

Read Extended Care: Course

List Extended Care: Registrations

Read Extended Care: Registration

List Programs: Class Meeting Times

Read Programs: Class Meeting Time

List Programs: Classes

Read Programs: Class

List Programs: Courses

Read Programs: Course

List Programs: Enrollments

Read Programs: Enrollment

List Resource Reservations: Reservations

Read Resource Reservations: Reservation

List Resource Reservations: Resources

Read Resource Reservations: Resource

List Staff/Faculty

Read Staff/Faculty

List Students

Read Student

List Summer: Class Meeting Times

Read Summer: Class Meeting Time

List Summer: Classes

Read Summer: Class

List Summer: Courses

Read Summer: Course

List Summer Enrollments

Read Summer Enrollment

6. While keeping the axiom detail screen still open in a separate tab, navigate to the SchoolCal settings page. Enter the respective credentials for both V2 and V3 API and press "Save".

Google

You have already completed most of the steps for connecting with Google in your preparation for onboarding. To complete your  SchoolCal Connections:

1. Click the "Manage Connections" button by the Google account and authorize with the new Google account that you set up for the purposes of SchoolCal during your onboarding preparations (we recommend schoolcal@yourschooldomain).