Table of Contents
Overview
Do not Fetch SIS data during real-time integrations
Fetch SIS data during real-time integrations
Related Articles
Overview
There are two different suggested ways to set up real-time merges. Which one you follow depends on whether or not your institution wishes to fetch and merge SIS data during real-time integrations.
Do not Fetch SIS data during real-time integrations
Use Cases
There are couple instances where an institution might not want to fetch SIS data during a real-time integration:
- Coursedog is the source of truth, which means Coursedog always has the most up-to-date data.
- The institution wants to speed up the time it takes to complete a real-time merge.
Notes
When using this configuration, Coursedog is not fetching SIS data. This means we do not check to see if the section exists in the SIS. Coursedog relies solely on the existence of an "SIS ID" field to determine if Coursedog should attempt an update or create operation. The "SIS ID" fields are defined here:
- Sections: callNumber
- Relationships: groupId
- Programs: rawSisId
- Courses: rawCourseId
Settings
LOCATION: Admin Dashboard > Merge Settings > Real-time Integration Schedule > Configure Merge Settings Overrides
If you DO NOT want to fetch and merge SIS data during your real-time integration, make sure your configuration is as follows:
Fetch SIS data during real-time integrations
Use Cases
An institution might want to fetch SIS data during a real-time integration if the SIS contains certain fields for which the SIS is the source of truth, which means the SIS always has the most up-to-date data.
Notes
- This configuration allows for the following to occur:
- Changes to the data in your SIS can be merged with data in Coursedog and persisted into the Coursedog database during real-time merge operations.
- Real-time merges will always check if an SIS version of an object exists when determining whether the integration should send a create or update operation.
- Avoid specifying a term in the "realtime-specific merge settings overrrides" settings because doing so will prevent real-time merges for terms not listed. Instead, leave the default selection – "All terms" – in place.
Settings
LOCATION: Admin Dashboard > Merge Settings > Real-time Integration Schedule > Configure Merge Settings Overrides
If you wish to fetch and merge SIS data during real-time integrations, make sure your configuration is as follows:
