Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
If connecting to the CourseKey production environment enter https://api.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
If connecting to the CourseKey production environment enter services.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

...