...
Upon course section creation in Campus Cafe, establish a corresponding section in Brightspace. The course template must be created directly in Brightspace prior.
Upon student enrollment in Campus Cafe, establish a Brightspace account for a student in Brightspace if one does not already exist.
Upon student enrollment in Campus Cafe, register the student for the corresponding section in Brightspace.
Upon instructor assignment to course in Campus Cafe, establish a Brightspace account for an instructor in Brightspace if one does not already exist.
Upon instructor assignment to course in Campus Cafe, associate the instructor with the corresponding course section in Brightspace.
Upon a change to the first or last name of an instructor or student in Campus Cafe, change the name in Brightspace.
Upon a change to the email address of an instructor or student in Campus Cafe, change the email in Brightspace.
Calculate last day of attendance based on assignments and discussions in Brightspace and show this day in Campus Cafe.*
Import individual assignment grades from Brightspace to Campus Cafe.*
Transfer Final Course Grades from Brightspace to Campus Cafe.*
...
Log in to Brightspace
Click the gear (settings) icon
Under Organization Related, click Org Unit Editor
Click New Create Org Unit
In the Type box select Semester
In the Name box enter a description for the semester such as Fall 2020
In the Code box enter the semester code from Campus Cafe (e.g. 202110)
In the Parent ID enter the Brightspace parent (typically 6606)
Click Create
Establish Course Templates in Brightspace
...
Parameter | Value | |
---|---|---|
BRIGHTSPACE_ALL_GRADES_DATA_SET_ID | The ID number of the Brightspace Data Hub All Grades Data Set (See instructions: Retrieving Brightspace PluginId and DataSetId values) | Leave blank |
BRIGHTSPACE_API_NAME | CC_D2L | |
BRIGHTSPACE_API_VERSION | 1.25 | |
BRIGHTSPACE_APPLICATION_ID | The application ID created during register an app | |
BRIGHTSPACE_APPLICATION_KEY | The key created during register an app | |
BRIGHTSPACE_ASSIGNMENT_SUBMISSION_DETAILS_PULGIN | The ID number of the Brightspace Data Hub Assignment Submissions Detail Data Set (See instructions: Retrieving Brightspace PluginId and DataSetId values) | Leave blank |
BRIGHTSPACE_ASSIGNMENT_SUBMISSIONS_PULGIN | The ID number of the Brightspace Data Hub Assignment Submissions Data Set (See instructions: Retrieving Brightspace PluginId and DataSetId values)Leave blank | |
BRIGHTSPACE_ASSIGNMENT_SUMMARY_PULGIN | The ID number of the Brightspace Data Hub Assignment Submissions Summary Data Set (See instructions: Retrieving Brightspace PluginId and DataSetId values) | BRIGHTSPACE_AUTO_Leave blank |
BRIGHTSPACE_AUTO_QUEUE_ITEMS | If set to Y, the system will auto-queue course sections created prior to the number of days specified in BRIGHTSPACE_OFFERING_DAYS_ACTIVE_BEF_BEG. The course sections will then be created in Brightspace the number of days prior to the course start date specified in BRIGHTSPACE_OFFERING_DAYS_ACTIVE_BEF_BEGIN. | |
BRIGHTSPACE_BASE_URL | The login URL for Brightspace similar to https://<your-school-code>.brightspace.com | |
BRIGHTSPACE_COPY_CONTENT | Optional: Configure the connector so that when a Brightspace class is created, it will copy the course content from a master course. The master course in Brightspace must have a course code prefix starting with the value entered here. For example, the master courses in Brightspace start with Master_, enter "Master_" for this value. | |
BRIGHTSPACE_CREATE_UPDATE_USER | A "Y" indicates that the connection will create a Brighspace user account for a student or faculty if one is not found in Brightspace already. An "N" will direct the connection not to create a Brightspace account. Without an account, the individual will not be able to be associated with a class in Brightspace. | |
BRIGHTSPACE_CUTOVER_SEMESTER | The Campus Cafe semester code that represents the first semester for which to transfer information from Campus Cafe to Brightspace will occur. For example, 202110 | |
BRIGHTSPACE_DAYS_ACTIVE_AFT_END | Number of days after course end date that enrollments remain active. Enter 0 as default. | |
BRIGHTSPACE_DAYS_ACTIVE_BEF_BEGIN | Number of days before course begin date that enrollments become active. Enter 0 as default. | |
BRIGHTSPACE_DAYS_ADJUST_OFFRG_BEGIN_DATE | Days to adjust offering begin date from CC course date. Enter 0 as default. | |
BRIGHTSPACE_DAYS_ADJUST_OFFRG_END_DATE | Days to adjust offering end date from CC course date. Enter 0 as default. | |
BRIGHTSPACE_DISCUSSION_POSTS_PULGIN | The ID number of the Brightspace Data Hub Discussion Posts Data Set (See instructions: Retrieving Brightspace PluginId and DataSetId values)Leave blank | |
BRIGHTSPACE_EMAIL | An alert will be sent to this email if an error occurs. | |
BRIGHTSPACE_GRADE_OBJECTS_PULGIN | The ID number of the Brightspace Data Hub Grade Objects Data Set (See instructions: Retrieving Brightspace PluginId and DataSetId values) | Leave blank |
BRIGHTSPACE_IMPORT_APPLICATION_ID | Same as BRIGHTSPACE_APPLICATION_ID | |
BRIGHTSPACE_IMPORT_APPLICATION_KEY | Same as BRIGHTSPACE_APPLICATION_KEY | |
BRIGHTSPACE_IMPORT_BASE_URL | Same as BRIGHTSPACE_BASE_URL | |
BRIGHTSPACE_IMPORT_HOURS_TO_OVERWRITE_FINAL_GRADE | Enter 0 to prevent final grade changes. If set to zero (0), once a final course grade is imported from Brightspace, it will not be overridden by future imports from Brightspace (e.g. if an instructor assigns a final course grade of a B and then later changes it to an A, Campus Cafe will record the B.) Otherwise, enter the number of hours after the last day of the course that a new final grade will be accepted to replace an existing final grade. | |
BRIGHTSPACE_IMPORT_SEMESTER_MINIMUM | The Campus Cafe semester code that represents the first semester for which to transfer information from Campus Cafe to Brightspace will occur. For example, 202110 | |
BRIGHTSPACE_IMPORT_USER_ID | The user id generated during the Register App phase | |
BRIGHTSPACE_IMPORT_USER_KEY | The user key generated during the Register App phase | |
BRIGHTSPACE_INSTRUCTOR_ADD_ONLY | Only add instructors, allows manually changing D2L inst role and adding inst not in CC. Enter N by default. | |
BRIGHTSPACE_INSTRUCTOR_ROLE | Brightspace role associated with instructors. Enter Instructor as default. Case sensitive | |
BRIGHTSPACE_LDA_GRADE_ITEM_NAME_PREFIX | The prefix of gradable items in Brightspace that signal participation to determine the last day of attendance (LDA) in Campus Cafe. For example, if these items begin with ATTEN_ enter ATTEN in this box.Leave blank | |
BRIGHTSPACE_MAX_RETRY_ATTEMPTS | Number of times to try processing an entry. Enter 2 as default. | |
BRIGHTSPACE_OFFERING_DAYS_ACTIVE_BEF_BEGIN | Enter a number representing days. Course sections created in Campus Cafe, will be created in Brightspace this number of days or fewer prior to the course section start date. | |
BRIGHTSPACE_PARENT_ORG_D2LID | Enter the Brightspace numerical code of the institution's parent organization. Typically, this code is 6066. | |
BRIGHTSPACE_QUIZ_ATTEMPTS_PULGIN | The ID number of the Brightspace Data Hub Assignment Quiz Attempts Data Set (See instructions: Retrieving Brightspace PluginId and DataSetId values) | |
BRIGHTSPACE_QUIZ_INCLUDE_COMPLETED_ONLY | Enter Y to import only completed quizzes as assignments in Campus Cafe. Enter a N to exclude them. | |
BRIGHTSPACE_REMOVE_FROM_QUEUE_DAYS | Number of days after processing entry should remain on queue. Enter 30 as default. | |
BRIGHTSPACE_RETRY_MINUTES | Number minutes to wait before reprocessing an entry. Enter 30 as default. | |
BRIGHTSPACE_SEND_USER_CREATION_EMAIL | Enter Y for Brightspace to send an email to a user created in Brightspace by the connector. The email contains the user's Brightspace account information. | |
BRIGHTSPACE_STUDENT_ROLE | Brightspace role associated with students. Enter Learner as default. Case sensitive. If using 4 student roles separate names by || (ex. a||b||c||d). The role meanings are defined by position (position meanings: a-default, b-hold, c-before course begin date, d-after course end date). | |
BRIGHTSPACE_TIMEZONE | Enter the time zone. US/Eastern; US/Central; US/Mountain or US/Pacific Case sensitive | |
BRIGHTSPACE_UPDATE_USER_EMAIL | A "Y" indicates that if an individual's email changes in Campus Cafe, the connection should also update the individual's email in Brightspace. An "N" indicates that updates to an individual's email address in Campus Cafe will not update in Brightspace. | |
BRIGHTSPACE_UPDATE_USERNAME | A "Y" indicates that the connection will replace the individual's Brightspace username with his or her Campus Cafe username if different. An "N" indicates that Campus Cafe will not attempt to change the individual's Brightspace username to match his or her Campus Cafe username. If your institution already has Brightspace in place and wishes to preserve existing Brightspace usernames, set this to "N." | |
BRIGHTSPACE_USER_ID | The user id generated during the Register App phase | |
BRIGHTSPACE_USER_KEY | The user key generated during the Register App phase |
Refresh the cache by navigating to Admin > System Tasks > Refresh Data Cache
Retrieving Brightspace PluginId and DataSetId values for Data Import
Open browser and sign into Brightspace. Using same browser do the following:
Brightspace Data Sets - PluginId
Use the below link replacing myschool.brightspace.com with the matching segment of your school’s Brightspace login:
https://myschool.brightspace.com/d2l/api/lp/1.15/dataExport/bds/list
A JSON file should now be displayed in your browser. For each Web App Config listed below search for the text in your browser. You should find the text as a value for a Name: variable. On the line above you should see the name PluginId: - copy the value of this variable (excluding quotes) and paste it into the corresponding Campus Café Web App Configuration.
An example of these values: e0856750-abf2-4f1b-9c3a-ad82a0cfedc2
BRIGHTSPACE_ASSIGNMENT_SUBMISSION_DETAILS_PULGIN
Search for: Assignment Submission Details Differential
BRIGHTSPACE_ASSIGNMENT_SUBMISSIONS_PULGIN
Search for: Assignment Submissions Differential
BRIGHTSPACE_ASSIGNMENT_SUMMARY_PULGIN
Search for: Assignment Summary Differential
BRIGHTSPACE_DISCUSSION_POSTS_PULGIN
Search for: Discussion Posts Differential
BRIGHTSPACE_QUIZ_ATTEMPTS_PULGIN
Search for: Quiz Attempts Differential
BRIGHTSPACE_GRADE_OBJECTS_PULGIN
Search for: Grade Objects Differential
Brightspace Advanced Data Sets - DataSetId
Use the below link replacing myschool.brightspace.com with the matching segment of your school’s Brightspace login:
https://myschool.brightspace.com/d2l/api/lp/1.13/dataExport/list
A JSON file should now be displayed in your browser. For the Web App Config listed below search for the text in your browser. You should find the text as a value for a Name: variable. On the line above you should see the name DataSetId: - copy the value of this variable (excluding quotes) and paste it into the corresponding Campus Café Web App Configuration.
An example of this value: c1bf7603-669f-4bef-8cf4-651b914c4679
BRIGHTSPACE_ALL_GRADES_DATA_SET_ID
Search for: All Grades
Authenticate the Connection (API Test Tool)
This is a one-time process to establish the connection.
Log in to Brightspace
Navigate to https://apitesttool.desire2learnvalence.com
Host: The log in URL for Brightspace similar to <your-school-code>.brightspace.com/ (do not include https://)
Port: 443
HTTPS: Checked
App ID: The Application ID created earlier
App Key: The Application Key created earlierClick Authenticate
A confirmation page asking you to confirm the connection should appear
Click Continue
A new page will appear
Copy the User ID for future use
Copy the User Key for future use
Enter Brightspace User and Key in Campus Cafe
This is a one-time process to establish the connection.
Log in to Campus Cafe
Navigate to Admin > Web App Config
Locate the Parameter BRIGHTSPACE_USER_ID and enter the User ID created through the Brightspace API Test Tool
Locate the Parameter BRIGHTSPACE_USER_KEY and enter the User Key created through the Brightspace API Test Tool
Refresh the cache by navigating to Admin > Refresh Data Cache > reload data
Configure Campus Cafe LMS Option
This is a one-time process to establish the connection.
Log in to Campus Cafe
Navigate to Admin > System Setup > Custom Control
Locate ProgramId Moodle, Sequence 1, Parameter 1- (Brightspace uses the same foundational settings in Campus Cafe as Moodle)
In the Parameter Value 10 box enter a Y
Click Save
Refresh the cache by navigating to Admin > Refresh Data Cache
Contact Campus Cafe to Activate Connection
Contact Campus Cafe support to activate the connection.
Manually Sync Enrollment Data
By default, data transfer between Campus Cafe and Brightspace occurs in near real-time. To manually launch the connection complete the below.
Log in to Campus Cafe
Navigate to Registrar > LMS Management
The number next to Unprocessed Queue Entries Count indicates the number of enrollment waiting to sync
Click Click Here to Manually Run Brightspace queue processor for 100 entries
If necessary, click Click Here to Manually Run Brightspace queue processor for 100 entries again to process the next 100 entries and repeat until nothing remains in queue
Queue History Log
The queue history log shows the results of synchronization attempts between Campus Cafe and the LMS. For example, if a student's enrollment is not initiated in the LMS, the history log will show why.
Access the log
Log in to Campus Cafe
Navigate to Registrar > LMS Management
Click Queue History Log
Assignment and Final Course Grades Import
This function requires the Brightspace Data Hub module sold separately by D2L.
For final course grades to be imported into Campus Cafe, the final course grade must exist in the Campus Cafe quality points maintenance setup.Assignment Icon in Campus Cafe Custom Control Moodle, Sequence 2, Parameter 6 controls whether the sync will overwrite existing grades in Campus Cafe (not including I or W grades).
The following options are available by navigating to Registrar > LMS Management
Run Participation and Grade Import after Retrieving Latest Import Data: Clicking this will load Brightspace activities, graded items and final course grades from Brightspace into Campus Cafe. The assignments are visible by clicking the assignments icon on the student's enrollment history screen. The final course grades will be placed in the student's enrollment in Campus Cafe. The process also updates the last day of attendance in Campus Cafe.
Run Grade Import after Retrieving Latest Import Data: Clicking this will load only Brightspace graded items and final course grades from Brightspace into Campus Cafe. The process does not update the last day of attendance in Campus Cafe.
Run Participation and Grade Import using Files Manually Downloaded: Not in use. For use by Campus Cafe support only.
Exclude Course and its Enrollments from the Integration
A specific course may be excluded from the integration. The course will not be created in Brightspace and students not enrolled.
In Campus Cafe navigate to the course section (Registrar > Course Finder > Magnifying glass next to course)
Click the Codes tab
Check the Exclude From LMS Integration box
Click Save
Multiple Campus Cafe Course Sections Associated with Single Brightspace Offering
Your institution may combine students from multiple discrete Campus Cafe class sections, each with their own roster, meeting times, etc., into one Brightspace offering. This is often done so the instructor does not need to independently maintain the same academic content across multiple Brightspace offerings.
Such classes require special handling.
In Brightspace, navigate to the Course and then Course Administration > Course Offering Information
Set the Course Offering code to something not used by any other Brightspace offering
In Campus Cafe navigate to the course section (Registrar > Course Finder > Magnifying glass next to course)
Click the Codes tab
In the LMS Course Code Override box enter the SIS ID number you entered in Brightspace
Repeat steps 3-5 for each Campus Cafe section
Click Save
Brightspace To Campus Cafe Import
To import Brightspace data into Campus Cafe using the Campus Cafe/Brightspace integration, you must have access to the Brightspace Data Hub tool in your Brightspace environment. Before running the import process complete import configurations in Campus Cafe. These are parameters in Web App Config that begin with BRIGHTSPACE_IMPORT_. You also need to identify your Brightspace data files (See instructions: Retrieving Brightspace PluginId and DataSetId values).
What is imported
Grades
Graded Items - Brightspace graded items are saved in the Enrollment Assignment table. These can be viewed through the enrollment listing page by clicking on the Assignments icon. The grade and date the grade was assigned in Brightspace are stored. The Final Calculated grade from Brightspace is also stored in the enrollment (RGENRL.GRADEBOOK_ACAD_CUM_POINTS) and is displayed on the enrollment listing page next to the Assignments icon.
Final Grade - Brightspace graded item 'Final Letter Grade' is saved in the enrollment table. The final grade (RGENRL.FINAL_GRADE) and final grade date (RGENRL.FINAL_GRADE_CHANGE_DATE) values are saved. Configuration BRIGHTSPACE_IMPORT_HOURS_TO_OVERWRITE_FINAL_GRADE can be used prevent final grades from being overwritten in Campus Cafe.
Participations
Participations are saved in the Enrollment Assignment table. These can be viewed through the enrollment listing page by clicking on the Assignments icon. The student's participation date is stored. The last attended date for the enrollment (RGENRL.LAST_ATTEND_DATE) is also updated to be the most recent participation date. The following participations are imported from Brightspace:
Assignment Submissions
Discussion Posts
Quiz Attempts
Options to Run the Brightspace to Campus Cafe import process
Participation import integrations use Brightspace differential data files. These files are generated every ## hours (usually every 24 hours but it can be different) and contain only the changes that took place in the prior ## hours. The import process uses the most recent differential file each time it runs. The import process needs to be run at least once every ## hours. However, it is recommended to run it at three (3) different times to make sure the data is captured. For example, if your differentials are generated every 24 hours then run the import after the files are generated and then at 8 and 16 hours after that time. Running the same import multiple times will not create duplicate participations.
Grade import integration files include grade changes for the prior 3 days. Therefore, grade imports would be missed if you had more than 3 days between a successful import integration.
Each time the import integration is run an email is generated providing overall counts of records imported and any messages about the run.
There are three different ways to run the Brightspace to Campus Cafe import process.
...
Scheduled job: A quartz job can be set up to automatically run the import on your preferred schedule. Please contact the Campus Cafe help desk to have this job set up. This option always uses the most recent differential file from Brightspace.
...
Run on demand: This option can be found under Campus Cafe menu option: Registrar>LMS Management (the options only display if you have made the BRIGHTSPACE_IMPORT_ configurations). On the lower half of this page there are options to run the 'Participation and Grade' import and a separate Grade only import. Both of these always use the most recent differential file from Brightspace.
...
Brightspace Final Grade Synchronization (Manual Import Process)
Final Grades may also be imported via the LMS Management menu without differential files. This is completed by running the process manually using the Final Grade Synchronization option. This option can be found under Campus Cafe menu option: Registrar>LMS Management (the options only displays if you have made the BRIGHTSPACE_IMPORT_ configurations). It is located at the bottom of the page.
Final grade values from Brightspace must match values in the Campus Cafe Quality Points table in order to import. Additionally, final grades in Brightspace must be released.
...
Navigate to Registrar > LMS Management
...
Click on Final Grade Synchronization (Brightspace import options must be configured in Web App Config)
...
Select the Semester to Synchronize from the drop-down
...
Optional: Enter the Course Number to import grades for a specific course
...
Optional: Check the Report Only box to run the grade report in non-update mode. This will generate the grades that will be imported in the Process Output Messages box, but will not update grades on the students' records.
...
Click Synchronize to begin the process
...
Authenticate the Connection (API Test Tool)
This is a one-time process to establish the connection.
Log in to Brightspace
Navigate to https://apitesttool.desire2learnvalence.com
Host: The log in URL for Brightspace similar to <your-school-code>.brightspace.com/ (do not include https://)
Port: 443
HTTPS: Checked
App ID: The Application ID created earlier
App Key: The Application Key created earlierClick Authenticate
A confirmation page asking you to confirm the connection should appear
Click Continue
A new page will appear
Copy the User ID for future use
Copy the User Key for future use
Enter Brightspace User and Key in Campus Cafe
This is a one-time process to establish the connection.
Log in to Campus Cafe
Navigate to Admin > Web App Config
Locate the Parameter BRIGHTSPACE_USER_ID and enter the User ID created through the Brightspace API Test Tool
Locate the Parameter BRIGHTSPACE_USER_KEY and enter the User Key created through the Brightspace API Test Tool
Refresh the cache by navigating to Admin > Refresh Data Cache > reload data
Configure Campus Cafe LMS Option
This is a one-time process to establish the connection.
Log in to Campus Cafe
Navigate to Admin > System Setup > Custom Control
Locate ProgramId Moodle, Sequence 1, Parameter 1- (Brightspace uses the same foundational settings in Campus Cafe as Moodle)
In the Parameter Value 10 box enter a Y
Click Save
Refresh the cache by navigating to Admin > Refresh Data Cache
Contact Campus Cafe to Activate Connection
Contact Campus Cafe support to set up the automatic processing job. This job will process items on the queue every 10 minutes.
Manually Sync Enrollment Data
By default, data transfer between Campus Cafe and Brightspace occurs about every ten minutes. However, the queue may be manually processed at any time by following the steps below.
Log in to Campus Cafe
Navigate to Registrar > LMS Management
The number next to Unprocessed Queue Entries Count indicates the number of items waiting to sync
Select “Click Here to Manually Run Brightspace queue processor for 100 entries”
If necessary, select “Click Here to Manually Run Brightspace queue processor for 100 entries” again to process the next 100 entries and repeat until nothing remains in queue
Queue History Log
The queue history log shows the results of synchronization attempts between Campus Cafe and the LMS. For example, if a student's enrollment is not initiated in the LMS, the history log will show why.
Access the log
Log in to Campus Cafe
Navigate to Registrar > LMS Management
Click Queue History Log
Final Course Grades Import
This function requires the Brightspace Data Hub module sold separately by D2L.
Note |
---|
Students must have a value assigned in the Brightspace course final grade for the grade to be imported to Campus Cafe. Blank grades will be imported as 'F' grades. All Canvas final grades must match values on the Quality Points table in Campus Cafe. |
Custom Control Moodle 2-6 controls whether the sync will overwrite existing grades in Campus Cafe (not including I or W grades). Set this to Y to permit overwriting of existing grades or N to prevent existing grades in Campus Cafe from being replaced by the grade import.
Final grade values from Brightspace must match values in the Campus Cafe Quality Points table in order to import. Additionally, final grades in Brightspace must be released.
Navigate to Registrar > LMS Management
Click on Final Grade Synchronization at the bottom of the page (BRIGHTSPACE_IMPORT options must be configured in Web App Config for this option to appear)
Select the Semester to Synchronize from the drop-down
Optional: Enter the Course Number to import grades for a specific course
Optional: Check the Report Only box to run the grade report in non-update mode. This will generate the grades that will be imported in the Process Output Messages box, but will not update grades on the students' records.
Warning |
---|
Before running this process in update mode, be sure all final grades have been posted and released in Brightspace. Running the grade synchronization process with blank final grades will result in a grade of ‘F' posting to the student’s record in Campus Cafe. Running the grade synchronization prior to releasing the grades in Brightspace will result in an error message and no grades will be imported. |
Click Synchronize to begin the process
Click Refresh Job Output to view updates on the progress and which grades have been processed in the Process Output Messages box.
Exclude Course and Enrollments from the Integration
A specific course may be excluded from the integration. The course will not be created in Brightspace, and student enrollments will not be sent to Brightspace.
In Campus Cafe navigate to the course section (Registrar > Course Finder > Magnifying glass next to course)
Click the Codes tab
Check the Exclude from LMS Integration box
Click Save
Multiple Campus Cafe Course Sections Associated with Single Brightspace Offering
Your institution may combine students from multiple discrete Campus Cafe class sections, each with their own roster, meeting times, etc., into one Brightspace offering. This is often done so the instructor does not need to independently maintain the same academic content across multiple Brightspace offerings.
Such classes require special handling.
In Brightspace, navigate to the Course and then Course Administration > Course Offering Information
Set the Course Offering code to something not used by any other Brightspace offering
In Campus Cafe navigate to the course section (Registrar > Course Finder > Magnifying glass next to course)
Click the Codes tab
In the LMS Course Code Override box enter the SIS ID number you entered in Brightspace
Repeat steps 3-5 for each Campus Cafe section
Click Save