Skip to main content
Integration Errors & Scopes

Diagnose SIS Integration Error on Orah

Pratyush Chowdhary avatar
Written by Pratyush Chowdhary
Updated over 2 weeks ago

Understanding the Integration Error Note

This article lists possible sync errors that could arise with your SIS (Student Information System). We will keep adding more as we encounter it.

Error Indicator Colors:

  • Yellow ⚠️ Warning: This indicates that there is an issue, but the sync will continue to run. However, some data might be missing. Example :

    • "Skipped sync for staff 3292923 due to missing email."

  • Red ⚠️ Error: Indicates a critical issue that stops the sync process. No data will be fetched until the error is resolved. Example :

    • "Unauthorized: You do not have access to this route."

How to Address These Errors:

  • Yellow Warnings: Review the specific message to identify what data might be missing or if any action is needed. The sync will complete, but you may need to correct or add missing information.

  • Red Errors: These are critical errors that prevent the sync from completing. Carefully read the error message to determine necessary corrective action, such as updating credentials, permissions, or data.

Examples of Error :

Error

Reason

Bad Request: The refresh token was not valid

Warning: RED

Diagnose: Re-authorize Blackbaud connection in Orah

Service Unavailable: Unable to reach Blackbaud Servers, please try again later. HTTP error from resource: http://api.sky.blackbaud.com/school...

Warning: RED

Diagnose: This is an error from Blackbaud side, please reach out to your SIS Blackbaud.

Unable to sync listDorms. This requires at least one of the following roles in the Education Management system: Dorm Group Manager, Dorm Supervisor, Pending Dorm Supervisor.

Warning: YELLOW

Diagnose: Provide the admin user with the required role access in your SIS.

Skipped sync for staff xyz due to missing email

Warning: YELLOW

Diagnose: Add email to staff profile in your SIS


Scope & Permissions :

Blackbaud

Scope & Permissions for Blackbaud

Endpoint Name

Sync Object

Required Roles
(at least one)

coreSchoolLevels

Attendance History, Group, House

SKY API Data Sync, Any Manager Role

listDorms

House

Dorm Group Manager, Dorm Supervisor, Pending Dorm Supervisor

academicSections

Group

Academic Group Manager

academicsStudentsBySection

group

Academic Group Manager, Teacher

athleticTeams

Group

Athletic Group Manager, Team Schedule Manager, Coach, Pending Coach

activitiesSections

Group

Activity Group Manager

advisoriesSections

Group

Sky API Advisory Group Manager

extendedUsers

Student & Contacts

SKY API Data Sync

userById

Student & Contacts

SKY API Data Sync

coreOfferingTypes

Attendance History, Roll (Pull)

Academic Group Manager, Platform Manager, Schedule Manager

coreYears

Group

Academic Group Manager, Schedule Manager, Platform Manager, Any Manager Role

excusedTypes

Attendance History, Pass (Push), Roll(Pull)

SKY API Basic, Any Manager Role

coreGradeLevels

Student & Contacts

Academic Group Manager, Schedule Manager, Platform Manager, Any Manager Role

attendance

Attendance History, Roll (Pull), Roll(Push)

Attendance Manager

venuesBuildings

Group, Location

Team Schedule Manager, Coach, Athletic Group Manager, Pending Coach

scheduledMeetings

Attendance History, Roll (Pull), Group (Meeting Times)

Academics Group Manager, Advisory Group Manager, Platform Manager, Activity Group Manager, Athletic Group Manager, Scheduling Manager

tableTypes

Contact Relationship type filters

- (Still in beta so no roles specified)

tableTypeValues

Contact Relationship type filters

- (Still in beta so no roles specified)


Veracross

Scopes and Permissions for Veracross

Sync Object

Required scopes (all are needed)

house

boarding.dorms.students:list, boarding.dorms:list

staff

staff_faculty:list, households:list

Student

students:list, households:list, parents:list, contact_info:list

Contact

households:list, parents:list, contact_info:list, relationships:list

Attendance History

classes:list, classes.attendance:list

Roll (Pull)

classes.attendance:list, classes.attendance:list, classes.attendance:update, master_attendance:list, master_attendance:update

Roll (Push)

classes.attendance:list, classes.attendance:update

Roll (Push - Daily attendance)

master_attendance:list, master_attendance:update

Pass

classes:list, academics.classes.meeting_times:list, classes.attendance:list, classes.attendance:update, master_attendance:list, master_attendance:update

Group (Academics, Advisories, Homeroom)

staff_faculty:list, classes:list, academics.enrollments:list

Group (Athletics)

staff_faculty:list, classes:list, athletics.rosters:list

Group (Programs)

staff_faculty:list, classes:list, programs.enrollments:list

Group Meeting (Academics)

academics.classes.meeting_times:list

Group Meeting (Programs)

programs.classes.meeting_times:list


Synergetic

Scopes and permissions for Synergetic

Endpoint

Sync Object

/apiportal/v1/staff

Staff

/apiportal/v1/studentcontact

Contact

/apiportal/v1/student

Student, House

/apiportal/v1/lookuptables/luFileType

Group

/apiportal/v1/Student/{id}/class

Group

/apiportal/v1/timetable

Group

/apiportal/v1/timetabledefinition

Group

/apiportal/v1/studentattendance/student/{id}

Attendace History

For any error that says unknown or unable to reach the server, please connect to your SIS first as they would have more knowledge about it. Do reach us at support@orah.com for any issues.

Did this answer your question?