Coursedog

Submit a Ticket My Tickets
Welcome
Login  Sign up

INTEGRATIONS: Managing Integration Errors

Table of Contents

Overview
Merge Error Types
Best Practices
Ways to Review Merge Errors
Troubleshooting Errors
Related Articles 

Overview

This article captures an overview of merge error types; merge error best practices; as well as ways to receive, view, and resolve integration errors.

Merge Error Types

Unique to SIS | Shared Across Multiple SISs | General Integration Failure 

There are a few different categories of merge errors. They can be specific to your SIS; issues shared across multiple SISs; and general integration failures.

 

Unique to SIS

These are documented, by each available SIS, here. These guides can be downloaded and printed for your convenience.

 

Shared Across Multiple SISs

Some of the more common issues are noted here

 

General Integration Failure 

  • These are different from merge errors caused by the specific data or contents of a merge.

  • Network, infrastructure, system, load, and several other external factors can cause instability and integration failures.

  • Persistent integration difficulties should be discussed with your Coursedog Customer Success Manager, Coursedog Support, your integration provider, and your internal IT infrastructure team.   

Best Practices

  • Monitor your merge error reports regularly (after nightly syncs or once a week during active scheduling) to catch and resolve these issues. 

  • Admins and Super Admins should also have the "View Section Integration Status" permission enabled (under Roles) in order to take advantage of viewing the Integration Errors report in the Reporting console. 

Ways to Review Merge Errors

Overview | Merge Notification Emails | Integration Errors Report
Admin Dashboard Merge Report | Section 

Overview

You can review errors in four different places:

  • Merge Notification Emails

  • Integration Errors reports

  • Admin Dashboard Merge Report

  • Section Editor

 

Merge Notification Emails

PATH: Admin > Merge Notifications

 

Overview

  • In order to receive merge notifications, you will need to sign up via the “Merge Notifications” page located within the Admin dashboard.

  • At least one user at your institution should sign up to receive notifications daily. 

 

How to Do It

  1. Click “+ User”. 

  2. Type in the email address of the user who should receive merge notifications.

  3. In the “notification setting” dropdown, select how frequently you would like to receive notifications: “send daily” (i.e. An email will be sent nightly after the automated synchronization executes) or “send if issue” (i.e. An email will only be sent when synchronization issues are encountered).

Sample Emails

Once you are set to receive merge notifications, you will receive emails from Coursedog with details regarding the synchronization.

 

Email Indicating a Successful Nightly Merge

Emails Indicating Merge Errors

The two emails below capture four sets of merge errors: 

  1. 2 out of 21 nightly merges did not succeed.

  2. 8 out of 35 realtime merges did not succeed. 

  3. 1 of the 14 nightly merge errors was due to a fatal error persisting SIS and Coursedog data. Learn more here

  4. 13 of the 14 nightly merge errors were due to being unable to fetch data from the SIS. Learn more here.

Email Attachment

Although the body of the email will summarize your report, it will also include a multi-page PDF attachment with additional information and direct links to Coursedog for more details concerning each merge. 

 

Integration Errors Report

PATH: Academic Scheduling > Reports > Integration Errors

  • The Reports Dashboard in Academic Scheduling includes a tab for Integration Errors.

  • The Integration Errors report will display a list of all sections that encountered an error during the last integration. Each row is clickable, so users can open up the section editor directly.

Admin Dashboard Merge Report

PATH: Admin > Merge Report

Overview

After each nightly sync, Coursedog automatically produces a merge report, which can be found in the merge dashboard in the admin panel (it is likely that only a few users will have access to this, specifically admins and IT). 

Integration Dashboard

  • For each merge, you can click on "View Report Details", which takes you to the Integration Dashboard.

  • The merge dashboard shows the status of each step of the integration, along with all errors that occurred that prevented the merge from completing successfully.

  • Most errors will occur during the “POST Updates to SIS” phase, and the report will detail the exact error response that your SIS provides to us to help IT folks understand why the SIS is rejecting Coursedog’s update requests.

Section Editor

  • Sections displayed in the Section Editor will show a "red" error icon if that section has experienced an integration error during the last merge.

  • If a section has both a conflict and an integration error, the section row will only display the icon for the integration error (as there is only space for one icon). This icon is only visible to users who have the View Section Integration Status permission.

Troubleshooting Errors

Go here for merge error FAQs and troubleshooting as well as links to all SIS-specific merge error guides.

 

Related Articles

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.