Table of Contents
Overview
Merge Settings
Viewing Integration Status
Creating a New Effective-Dated Revision
Sending Real-Time Updates of Programs
Sending Real-time Updates of Courses
Related Articles
Overview
Coursedog supports bi-directional Curriculum integration for a limited set of SIS integrations as defined here.
For those that are supported, the directions below describe how to enable real-time integration for Curriculum entities such as Courses and Programs.
Merge Settings
PATH: Admin > Merge Settings > Real-Time Integration Schedule
Step 1: Select “Yes” under “Should merges run in real-time?”
Step 2:
Under “What entities should be synced in realtime?”, indicate which entities you would like to sync in real-time.
For Curriculum, you can add courses (Curriculum) and/or programs depending on your need.
Step 3:
Select “Configure Merge Settings Overrides” to open the "Realtime-specific merge settings overrides" modal.
Under "Integration Steps to Execute", ensure "Should Coursedog send updates to the SIS" is set to "Yes".
Additional Note
If you have real-time integrations on, you must have nightly integrations on as well. This is because if for some reason the real-time merge fails to be sent (such as due to a network outage, SIS system maintenance, or integration infrastructure maintenance), then the only mechanism that will attempt to re-send that missed event is the nightly sync. It provides the safety net and assurance that the integration data is posted to the SIS.
Step 4:
If you are also editing data in your SIS, ensure “Default source of truth” is set to”Resolve as Coursedog”.
If you are not editing data in your SIS and can confirm all edits are done in Coursedog, ensure “Default source of truth” is set to “Always Coursedog”.
Step 5: Update field exceptions as outlined in the “Program Field Exceptions” and “Course Field Exceptions” sections below.
Program Field Exceptions
Always Institution
Ensure that the following fields are specified as alwaysInstitution as these fields are used to map data between systems:
Raw SIS ID
Specialization Raw SIS ID (specific to PeopleSoft customers)
Program Group ID
Always Coursedog
Ensure that the following fields are specified as alwaysCoursedog, as these fields are used to map data created in Coursedog with unique IDs that don't exist in the SIS.
Deprecated Coursedog ID
Deprecated Coursedog Group ID
Course Field Exceptions
Always Institution
Ensure that the following fields are specified as alwaysInstitution as these fields are used to map data between Coursedog and the SIS.
Raw SIS ID
Course Group Id
Always Coursedog
Ensure that the following fields are specified as alwaysCoursedog, as these fields are used to map data created in Coursedog with unique IDs that don't exist in the SIS.
Deprecated Coursedog ID
Deprecated Coursedog Group ID
Viewing Integration Status
Overview
Admins can determine which roles at your institution are able to view integration status for courses and programs.
Integration status will appear as a banner on the applicable course or program’s page.
How to Do It
In order to allow different roles to view the integration status banner on each course and program – and to see if any real-time merges succeeded or failed – follow the below steps:
Navigate to Curriculum Management > Settings > Roles > (Select Role).
Under “Courses”, ensure “View Course Integration Status” is set to “Allow”.
Under “Programs”, ensure “View Program Integration Status” is set to “Allow”.
Creating a New Effective-Dated Revision
Overview
To create a new effective dated revision, you only have to edit the Effective Date OR Effective Term field (depending on your integration/SIS) on the program or course.
You can do that by going to Curriculum > Course > (Open Course) or Curriculum > Program > (Open Program).
After editing this field, click save and it will automatically trigger Coursedog to create a new revision.
Any saves will also trigger a real-time integration (assuming your merge settings are configured to do so).
Learn more about effective dating in Curriculum here.
Sending Real-Time Updates of Programs
Overview | Allow Integration | After Saving | Updated Tables (PeopleSoft Only)
Overview
With real-time integrations enabled for programs, a merge will be triggered every time a user clicks on the “save changes” button under “Actions” after editing a program.
Allow Integration
If the “Allow Integration to Sync to SIS” field is set to “No”, then the merge will skip the "Sync with SIS step".
If the field isn’t on the template or is on it but isn’t set or is set to “Yes”, updates will sync to the SIS.
Each update will sync both the program and the program specializations and will update the associated tables in the SIS.
After Saving
After the user clicks “Save Changes”, the real-time integration will be triggered, but it might take up to a minute for the operation to be fully processed.
You can check the integration status by refreshing the page and looking at the Integration Status Banner, or by going into Admin > Merge Reports.
In Curriculum, there is not a "syncing with SIS" icon to indicate a course or program is currently in the middle of syncing.
Updated Tables (PeopleSoft Only)
Each update will sync both the program and the program specializations and will update the following tables in PeopleSoft:
ACAD_PLAN_TBL
ACAD_SUBPLN_TBL
ACAD_PLAN_OWNER
Sending Real-time Updates of Courses
Overview | Allow Integration Field | Updated Tables (PeopleSoft Only)
Overview
Real-time updates of courses work the same as programs, in that they are triggered by clicking “Save Changes” under “Actions” on the course page.
Allow Integration Field
The “Allow Integration Sync to SIS” field must be set to “Yes” for the integration to successfully send an update to your SIS.
Updated Tables (PeopleSoft Only)
Each save will update the following tables in PeopleSoft:
CRSE_CATALOG
CRSE_CATALOG_OFFER
CRSE_CATALOG_CMPNT
SSR_CRS_MILESTN