Coursedog

Submit a Ticket My Tickets
Welcome
Login  Sign up

Real-time Integration Enablement - (Curriculum) Courses & Programs

Overview

The following outlines how to turn on and evaluate the curriculum integration for the real-time updating and syncing of courses & programs.


Merge Settings

In Merge settings, under "Real-Time Integration Schedule", add programs and courses under entities that should sync in real-time:


You can add both, or only add programs or courses if you only want one of the two to sync in real-time.


Then ensure in the "Realtime-specific merge settings overrides" modal, under "Integration Steps to Execute" that the "Should Coursedog send updates to the SIS" step is set to "Yes"


Note: It is okay if the nightly integration settings have "Should Coursedog Send Updates to the SIS" set as "No" if you do NOT want updates being triggered nightly: 



We also recommend setting the default source of truth to Always Coursedog when attempting to sync data from CD → PS: 

However, this is not required if the SIS will remain the source of truth.


Program Field Exceptions

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


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

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


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


Roles

In curriculum, go to Roles → Courses and Roles → Programs to set the following two permissions to true

  1. View Course Integration Status
  2. View Program Integration Status

            

These permissions will allow you to view the integration status banner on each course & program, and see if any real-time merges succeeded or failed.




Creating New Effective-Dated Revision

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. After editing this field, click save and it will automatically trigger Coursedog to create a new revision. Additionally, any save will trigger the real-time integration (assuming the merge settings are configured correctly).

Current Effective Date:



New Effective Date:


New Revision available in CD after the user has saved:



Sending Real-Time Updates of Programs

With real-time integrations enabled for programs, a merge will be trigged every time a user clicks on the save changes button:


However, if the Allow Integration field  is not set to "Yes", then the merge will skip the "Sync with SIS step":




So in order to have the updates sync to the SIS, the program must be saved with the Allow Integration? field set to "Yes".


Each update will sync both the program and the program specializations and will update the associated tables in the SIS. 



Updated Tables

Each update will sync both the program and the program specializations and will update the following tables in PS:


- `ACAD_PLAN_TBL`

- `ACAD_SUBPLN_TBL`

- `ACAD_PLAN_OWNER`


After Saving

After the user clicks save, 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. 


Note: In curriculum, there is not a "syncing with SIS" icon to indicate a course or program in currently in the middle of syncing.



Sending Real-time Updates of Courses

Real-time updates of courses work the same as programs, in that they are triggered by clicking save on the course page.

Allow Integration Field

The Allow Integration field must be set to Yes for the integration to successfully send an update to PS.


Updated Tables


Each save will update the following tables in PS:


- `CRSE_CATALOG`

- `CRSE_CATALOG_OFFER`

- `CRSE_CATALOG_CMPNT`

- `SSR_CRS_MILESTN`

Did you find it helpful? Yes No

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