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)

Setting up the new Veracross API (V3) as another data source will enable accurate alternate block schedule syncing. Full instructions are listed below, but here is a quick summary: 

1. Add SchoolCal as an integration partner from the "Identity and Access Management" homepage in Axiom with the appropriate scopes (see scopes below)

2. Go to SchoolCal Connections and add the Client ID and Client Secret fields from Veracross to SchoolCal

Here is a short video that walks through the process: https://www.loom.com/share/a65b92a92fcb4ac18f8423f22126cc87

Step-by-step instructions:

1. In Axiom, make sure you have the "Oauth_App_Admin" security role added to your account.

2. Navigate to the "Identity and Access Management" homepage in Axiom. In the "Add Integration Partner" section, scroll towards the bottom where you will find SchoolCal listed. Press the "Start Integration" link:

4. On the Axiom detail screen that pops up, you should see SchoolCal listed as the "partner" and the email address aaron@schoolcal.co populated in the contact field. If so, go ahead and press "Add OAuth Application"

5. While still on the detail screen and after you've added the record, go to the "Scopes" tab and add these 16 scopes:  

List Academics: Calendar Rotation Days

Read Academics: Calendar Rotation Day

List Academics: Class Meeting Times

Read Academics: Class Meeting Times

List Academics: Classes

Read Academics: Class

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: Enrollments

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: Teams

Read Athletics: Team

List Classes

Read Classes

List Courses

Read Course

List Events: Athletics

Read Events: Athletic

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 Staff/Faculty

Read Staff/Faculty

List Students

Read Students

List Summer: Class Meeting Times

Read Summer: Class Meeting Time

List Summer: Classes

Read Summer: Class

List Summer: Course

Read Summer: Courses

List Summer Enrollments

Read Summer Enrollments

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).