| Table of Contents | ||
|---|---|---|
|
About CourseKey Integration
...
Contact CourseKey to obtain your School IDs, Auth Keys and Time Zones for each set
Establish course sites in Campus Cafe using STParm RCCONO if you do not have sites set up already.
All courses must have an associated course site in Campus Cafe
| Note |
|---|
Cautions
|
Campus Cafe STParm Configuration
...
Parameter | Description |
COURSEKEY_API_NAME | Enter CC_CKY |
COURSEKEY_AUTO_QUEUE_ITEMS | If set to Y, the system will queue courses and enrollments created prior to the number of days specified in COURSEKEY_COURSE_DAYS_ACTIVE_BEF_BEGIN and COURSEKEY_ENROLLMENT_DAYS_ACTIVE_BEF_BEGIN for creation in CourseKey. |
COURSEKEY_AWARDED_TIME_ATTENDANCE_NAMES | Attendance Names for courses that use the Awarded Time default value. List multiple CourseKey attendance names separated by |. For example: Flexible Lab|Blended Capstone |
COURSEKEY_AWARDED_TIME_MINUTES | Default awarded time in seconds for asynchronous assignments |
COURSEKEY_BASE_URL | If connecting to the CourseKey test environment enter https://staging.thecoursekey.com |
COURSEKEY_COURSE_ADMINS | List of course admin Campus Cafe ID numbers separated by |. Users will be made admins to all CourseKey integration courses. |
COURSEKEY_COURSE_DAYS_ACTIVE_BEF_BEGIN | Number of days before course begin date that courses are setup in CourseKey |
COURSEKEY_COURSE_NAME_FORMAT | Controls the short name of the course section created in CourseKey. Variables supported are @SEMESTER@, @COURSE_NUMBER@, @COURSE_SECTION@, @COURSE_TITLE@ and @SEMESTER_DESCRIPTION@. For example, for the Fall 2021 class (Intro to Math, MTH101, Section 4 setting this value to @COURSE_NUMBER@ - @COURSE_SECTION@: @COURSE_TITLE@ in @SEMESTER_DESCRIPTION@ would create the section in Canvas called "MTH101 - 4: Intro to Math in Fall 2021" |
COURSEKEY_COURSE_OWNER | CouseKey username (email) of course owner. Must be valid user for all CoursKey Auth Keys. |
COURSEKEY_COURSE_TITLE_FORMAT | Controls the long title of the course section created in CourseKey. Variables supported are @SEMESTER@, @COURSE_NUMBER@, @COURSE_SECTION@, @COURSE_TITLE@ and @SEMESTER_DESCRIPTION@. For example, for the Fall 2021 class (Intro to Math, MTH101, Section 4 setting this value to @COURSE_NUMBER@ - @COURSE_SECTION@: @COURSE_TITLE@ in @SEMESTER_DESCRIPTION@ would create the section in Canvas called "MTH101 - 4: Intro to Math in Fall 2021" |
COURSEKEY_CUTOVER_SEMESTER | The Campus Cafe semester numerical code (e.g. 20210) of the first semester to sync between Campus Cafe and CourseKey |
COURSEKEY_EMAIL | Email account that should receive Campus Café CourseKey Connector error notifications. Can enter multiple emails separated by commas. |
COURSEKEY_ENROLLMENT_DAYS_ACTIVE_AFT_END | Enrollments will stop syncing after the course end date if this is set to 0. Set a higher number for enrollments to stop syncing after the course end date. For example, set 5, enrollments would stop syncing file days after the course end date. |
COURSEKEY_ENROLLMENT_DAYS_ACTIVE_BEF_BEGIN | Enrollments will sync for registrations starting the entered number of days prior to the course start date. Registrations that occur prior to this date will not be processed in CourseKey unless COURSEKEY_AUTO_QUEUE_ITEMS is set to Y. |
COURSEKEY_EXPORT_BASE_URL | If connecting to the CourseKey test environment enter services-dev.thecoursekey.com |
COURSEKEY_EXPORT_TIME_ATTENDED_DAYS_PRIOR | The number of days of attendance to retrieve from CourseKey and import to Campus Cafe. This should be double the amount of the frequency you run the export. For example, if you run the export daily, then the minimum value here would be 2. This will allow the process to 2 chances at retrieving time attended. |
COURSEKEY_INSTRUCTOR_ADD_ONLY | If set to Y, the connector will only add instructors from Campus Cafe courses to CourseKey sections. If set to N, the connector will add instructors and remove them from CourseKey courses if removed from Campus Cafe courses. |
COURSEKEY_NO_ATTENDANCE_SESSION_SYNC | CourseKey attendance names that do not sync sessions with CourseKey. List multiple CourseKey attendance names separated by | For example: Flexible Lab|Blended Capstone |
COURSEKEY_REMOVE_FROM_QUEUE_DAYS | How long to keep a technical log of sync actions. Campus Cafe recommends "30" |
COURSEKEY_SEND_EMAIL_TO_NEW_USER | If set to Y, CourseKey will send newly created users in CourseKey an email with instructions for logging in |
COURSEKEY_SET_USER_PASSWORD | Users created by the connector in CourseKey will have their password set to their Campus Cafe password. If no Campus Cafe password exists, the password will be set to the Campus Cafe maintenance password. |
COURSEKEY_TIMEZONE | Enter the timezone of your institution. US/Eastern; US/Central; US/Mountain or US/Pacific Case sensitive |
COURSEKEY_USE_LMS_EXCLUDE_FLAG | If set to Y, then courses with the Exclude from LMS box checked will not be included in the integration |
...
Navigate to Registrar > LMS Management
Click Switch to CourseKey View
In the Semester Box enter the Campus Cafe semester code (e.g. 202110)
Optionally, to limit the enrollments all sections of a course, in the Course box enter the full course code (e.g. MTH100)
Optionally, to limit the enrollments to a single section of a course, in the Section box enter the section number (e.g. 14)
Click Add Enrollments to API Queue
Queue courses to be created in
...
CourseKey
You can direct Campus Cafe to create all courses for an entire semester or specific course or specific section.
...
The system will send an email to the email address listed in the Web App Config COURSEKEY_EMAIL, every time the import is run. The email will provide a summary of records imported as well as any errors for records that were unable to updated in Campus Cafe.
Asynchronous vs. Synchronous Course Last Date Attended Import
To allow LDA/Last Participation date from either Canvas or CourseKey to be imported in for Asynchronous courses but leaving the manual attendance functionality active for synchronous courses, Custom Control LDA_INSTRUCTION_METHODS is used to include certain course instruction methods to import LDA dates and exclude non-listed instruction methods from the import. An administrator may input multiple instruction method codes in a comma separated format that they wish for the LMS integration to import LDA for. Leaving the control blank will not import LDA dates by default.
There is an overnight process that will copy the LDA from the Student Attendance Data (ATSENT) to Student Enrollment Data (RGENRL) for the courses with the instruction methods defined in the Custom Control; which allows for the attendance being taken in either an asynchronous automatically or synchronous manner manually through the course roster to appear in the student finder and other reports.
Importing of Canvas or CourseKey Participation/attendance grades must be turned on for this to take effect.
Added Permission 1278 when set to NA to prevent a user from entering attendance for students after their enrollments' Last Date Attended. Removing NA will allow a user to enter/change attendance after and LDA is entered or automatically imported from an LMS integration.