Preparing for Onboarding

There are a few prerequisite actions that your school will need to complete with respect to your SIS and Calendaring platforms prior to setting up SchoolCal. See more information below about each relevant task.

• For Veracross schools: Acquire Veracross API V2 credentials by requesting them from Veracross and Add SchoolCal as a partner for your AP3 instance
• For Google schools: Delegate domain-wide authority to SchoolCal’s service account in your school's                Google Workspace account
• For Google schools: Create a SchoolCal user account in your school's Google Workspace account

You may complete these as early as you’d like; we recommend getting started with them at least a week (and preferably two) before your intended onboarding date as the first will require Veracross’ response.

Acquire Veracross API V2 credentials (from VC)

To get a Veracross API V2 username and password, you should submit a case to Veracross requesting API credentials. As indicated by Veracross’ Legacy API configuration overview, you should include the following in that case:

Vendor Name: SchoolCal

Vendor Main Contact: Aaron Vogelzang

Vendor Contact Email Address: aaron@schoolcal.co

Veracross should then provide these credentials to you via secure link.

Add SchoolCal to  Veracross API V3

1. Login to Veracross/Axiom and go to the "Identity and Access Management" homepage
2. 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. 
3. 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), you can then go to the "scopes" tab and add the following scopes (sorry it's such a long list!):

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

Create a SchoolCal user account in Google Workspace

1. Create a new user in Google. This user will be the "calendar owner" and creator of the events that get created. You can call the user "SchoolCal Admin" or something like that ("schoolcal@school.org", etc). We'll need to login into SchoolCal with this user during onboarding (so we'll need the login creds). 

2. Create a "Custom Admin Role" in google admin console (https://admin.google.com/ac/roles). You can call it something like, "Calendar Administrator". The role needs the following permissions:

-  USERS -> "READ" access to 

- CALENDAR -> "ALL SETTINGS"

The role should have 11 privileges assigned. 

Press the "assign members" button and assign your schoolcal user to this role. During the onboarding, we're going to login and authenticate to SchoolCal with this account (so keep the login credentials handy). 

When SchoolCal creates events in Google Calendar, it has to specify which user account should “own” the events. This user name will eventually appear on all SchoolCal created events in Google Calendar, as seen in the examples below.

If you eventually decide to change which account is used by SchoolCal you can, although it requires a few steps to avoid event duplication.