...
Log in to Campus Café
Navigate to Admin > Web App. In the search box, enter Canvas to return the relevant values and update as follows:
CANVAS_API_NAME - Enter CC_CNVS
CANVAS_AUTO_QUEUE_ITEMS - If set to Y, the system will queue course sections created prior to the number of days specified in CANVAS_SECTION_DAYS_ACTIVE_BEF_BEGIN for creation in Canvas. The course sections will be created in Canvas the number of days prior to the course start date specified in CANVAS_SECTION_DAYS_ACTIVE_BEF_BEGIN.
CANVAS_BASE_URL – This is the URL of your Canvas instance. Example: https://someUniversity.instructure.com (Caution, do not include a / at the end)
CANVAS_CLIENT_ID – Client ID is the Developer ID number generated during the creation of a developer key in Canvas. Found on the Developer Keys page in Canvas.
CANVAS_CLIENT_SECRET – Key generated during the creation of a developer key in Canvas. Found on the Developer Keys page in Canvas. Note that the Client Secret is labeled “key” and will be hidden unless clicked.
CANVAS_COURSE_TITLE_FORMAT - Controls the name of the course section created in Canvas. 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"
CANVAS_CREATE_UPDATE_USER - "Y" indicates that the connection will create a Canvas user account for a student or faculty if one is not found in Canvas already. "N" will prevent the connection from creating a Canvas account. Without an account, the individual will not be able to be associated with a class in Canvas.
CANVAS_CUTOVER_SEMESTER - Campus Cafe semester numerical code (e.g. 20210) of the first semester to sync between Campus Cafe and Canvas.
CANVAS_EMAIL – Email account that will receive Campus Café Canvas Connector error notifications. Multiple emails may be entered, separated by commas. Required
CANVAS_ENROLLMENT_DAYS_ACTIVE_AFT_END - Number of days enrollments will stop syncing following the end of a course. If set to 0, enrollments will stop syncing at the course end date. Set a higher number for enrollments to stop syncing after the course end date. For example, if set to 5, enrollments will stop syncing five days after the course end date.
CANVAS_ENROLLMENT_DAYS_ACTIVE_BEF_BEGIN - Number of days enrollments will start syncing prior to the course start date. 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 Canvas.
CANVAS_FILE_PATH – Server location of a file that is used to store token information. Use “./token.obj” by default. It is possible to use another location for special circumstances.
CANVAS_INSTRUCTOR_ADD_ONLY - "Y" indicates that when an instructor is disassociated with a class in Campus Cafe the instructor will not be removed from the Canvas course. If your institution manually associates instructors or TAs with courses directly in Canvas, enter "Y" otherwise these individuals will be removed from their Canvas courses. "N" indicates that when an instructor is disassociated with a class in Campus Cafe the instructor will be removed from the Canvas course.
CANVAS_MAX_RETRY_ATTEMPTS - Enter a zero "0." This field is no longer used. Previously, specified the number of times the connector would attempt a sync action.
CANVAS_REDIRECT_URI – Enter the same value that was input in the developer key dialog (see above). For example: https://***-web.scansoftware.com/cafeweb/CanvasOauth2Callback
CANVAS_REMOVE_DOMAIN_FROM_USERNAME - Enter "Y" to remove the domain segment of the Campus Cafe username (e.g. bond@yourschool.edu would have a Canvas username of bond) from the Canvas username. Enter "N" to preserve the full username, including the domain.
CANVAS_REMOVE_FROM_QUEUE_DAYS - Number of days to keep a technical log of sync actions. Campus Cafe recommends "30."
CANVAS_RETRY_MINUTES - Number of minutes the connector will attempt a sync action if the first attempt fails. Campus Cafe recommends "30."
CANVAS_SECTION_DAYS_ACTIVE_BEF_BEGIN - Enter a number representing days. Individual course sections will be created in Canvas only if created in Campus Cafe this many days or fewer prior to the course section start date.
CANVAS_TIMEZONE - Time zone of your institution. US/Eastern; US/Central; US/Mountain or US/Pacific Case sensitive
CANVAS_UPDATE_USER_EMAIL - "Y" indicates that if an individual's email changes in Campus Cafe, the connection should update the individual's email in Canvas to match. "N" will signal to Campus Cafe not to update emails in Canvas.
CANVAS_UPDATE_USERNAME - "Y" indicates that the connection will replace the individual's Canvas username with his or her Campus Cafe username if different. "N" indicates that Campus Cafe will not attempt to change the individual's Canvas username to match his or her Campus Cafe username. If your institution already has Canvas in place and wishes to preserve existing Canvas usernames, set this to "N.
CANVAS_SEND_USER_CREATIONCONFIRMATION_EMAIL - Set to “Y” to force_self_registration call to Canvas that will send new user email from Canvas to any new users created through the APIY to have Canvas send a confirmation email to user after creation (see canvas documentation on pseudonym[send_confirmation]). Default - blank.
Contact Campus Café and request a server restart to load these values or wait overnight for the server to reboot automatically.
...