Standard Integration Configuration for Curriculum Management

Tiffany Winters

Modified on: Tue, Jul 12, 2022 at 8:22 PM

Table of Contents

Overview
Deprecated IDs
Related Articles

Overview

There are two primary entities in Curriculum Management: Courses (Curriculum) and Programs. These entities require careful discussion with your Coursedog Customer Success team to determine the best approach to data management depending on your SIS and the capabilities of your integration. That said, the settings are generally configured as follows:

If the data is editable in Coursedog, we'll mark the field as “Always Coursedog”.
If the field is internal to Coursedog, we'll mark the field as “Always Coursedog”.
If the field is not editable in Coursedog and comes through the integration with the SIS, we’ll mark the field as “Always Institution”.

Deprecated IDs

Overview | Source of Truth for Deprecated IDs | Adding Field-Specific Exceptions

Overview

PATH: Admin Dashboard > Merge Settings

Curriculum Courses and Programs each have deprecated ID fields that will need to be accounted for if your integration includes POSTs.
Work with your Coursedog Customer Success team to ensure these deprecated IDs are set up correctly.

Source of Truth for Deprecated IDs

The source of truth – and whether or not you need to create a field exception for a deprecated ID field – will vary depending on your integration.

For Courses (Curriculum)

Integrations that support course POSTs include Jenzabar EX, Banner, Colleague, and PeopleSoft.

Deprecated ID Fields	Source of Truth for Integrations that Support Course POSTs	Source of Truth for Integrations that DO NOT Support Course POSTs
Deprecated Id (deprecatedId)	Always Coursedog	Always Institution
Deprecated Course Group Id (deprecatedCourseGroupId)	Always Coursedog	Always Institution
Course Group Id (courseGroupId)	Always Coursedog	Always Institution

For Programs

Deprecated ID Fields	Source of Truth for Integrations that Support Program POSTs (PeopleSoft Only)	Source of Truth for Integrations that DO NOT Support Course POSTs
Deprecated Id (deprecatedId)	Always Coursedog	Always Institution
Deprecated Program Group Id (deprecatedProgramGroupId)	Always Coursedog	Always Institution
Program Group Id (programGroupId)	Always Coursedog	Always Institution

Adding Field-Specific Exceptions

Overview

If the default source of truth listed for the entity – Courses (Curriculum) or Program – doesn’t match the suggested source of truth for the deprecated ID, you will need to add the deprecated ID as a field-specific exception.

How to Do It

To configure the source of truth for the deprecated ID fields, simply:

Navigate to Admin Dashboard > Merge Settings.
Select the entity from under “Type-Specific Settings”.
Under “Field-specific exceptions”, add the deprecated ID.
If a field is not available to select from the menu of options, scroll to the bottom of the dropdown menu and select “Add Custom Exception”; input the label (e.g. Deprecated Id) and Path (e.g. deprecatedId); and click “Save”.
Set the “Source of truth” as outlined in the above table.