Brightspace (LMS)
  • 20 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Brightspace (LMS)

  • Dark
    Light
  • PDF

Article Summary

About the Brightspace API

Campus Cafe provides a connection to D2L's Brightspace learning management system using the D2L Valence API. Clients must contract directly with D2L for use of the Brightspace platform. 

API Functions

  • 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.*

The connection does not import attendance from the Brightspace attendance module into Campus Cafe.

*Requires the Brightspace Data Hub module.

Brightspace Configuration

The following steps must be completed in Brightspace before completing the integration configuration in Campus Cafe.

Establish Semester in Brightspace

This process should be completed any time a new semester is set up in the Campus Cafe.

Brightspace must have semesters configured and coded to match corresponding semesters in Campus Cafe. The API does not automatically complete semester setup in Brightspace. It must be done manually prior to the creation of courses in Campus Cafe for that semester.New Semester Screen in Brightspace

  1. Log in to Brightspace
  2. Click the gear (settings) icon
  3. Under Organization Related, click Org Unit Editor
  4. Click New Org Unit
  5. In the Type box select Semester
  6. In the Name box enter a description for the semester such as Fall 2020
  7. In the Code box enter the semester code from Campus Cafe (e.g. 202110)
  8. In the Parent ID enter the Brightspace parent
  9. Click Create

Establish Course Templates in Brightspace

This process should be completed any time a new course (not section) is set up in the Campus Cafe catalog semester.

Brightspace must be configured with course templates for each course that will be created in Campus Cafe. The API does not automatically create course templates in Brightspace to allow institutions to adhere to their own unique business processes. Templates must be created manually prior to the creation of courses in Campus Cafe.Course Template Creation Button

  1. Log in to Brightspace
  2. Click the gear (settings) icon
  3. Under Course Related click Course Management
  4. Click Create a new Course Offering or Template
  5. Choose the radio button next to Create a new template or Create a new course offering based on an existing template
  6. Click Next
  7. In the Course Template Name enter a description of the course such as Intro to Mathematics
  8. In the Course Template Code enter the Campus Cafe code exactly as it appears in Campus Cafe. For example MTH101. Ensure the code matches exactly and does not contain spaces if there are no spaces in Campus Cafe
  9. Click Next

Course Offerings in Brightspace

This process should be completed for any courses created directly in Brightspace rather than through the connector.

The connector automatically creates course offerings in Brightspace. The Brightspace offerings are created when, in Campus Cafe, an instructor is assigned to the course or a student is registered. 

If a Brightspace course offering is created directly in Brightspace, institutions must enter the Course Offering Code for the course to prevent the connector from creating a duplicate course.

  1. In Brightspace, navigate to the Course and then Course Administration > Course Offering Information
  2. Set the Course Offering Code. The code is constructed from the Campus Cafe Semester Code, Course Number, and Course Section with a tilde between each field (Term~CourseNumber~CourseSection). For example, the course CIS123, Section 1 offered in the term 202010 would be “202010~CIS123~1”.
  3. Click Save

Update Brightspace Users

To match users between the two systems, the connector relies on the Campus Cafe ID number being entered as the Brightspace user's Org Defined ID. 

Caution
Institutions already using Brightspace should ensure all existing users have Org Defined IDs associated with them to prevent the creation of duplicate accounts.

To set an Org Defined ID in Brightspace

  1. Log in to Brightspace
  2. Click the gear (settings) icon
  3. Under User Related click Users
  4. Locate the desired user (or click the magnifying glass to display all users)
  5. Click the name of the user
  6. In the Org Defined ID box enter the user's Campus Cafe ID number
  7. Click Save

Register App in Brightspace

This is a one-time process to establish the connection.

  1. Log in to Brightspace
    Register an App Screen in Brightspace
  2. Click the gear (settings) icon
  3. Under Organization Related click Manage Extensibility 
  4. Ensure you are on the ID Key Authorization tab
  5. Click Register an App
    Application Name: Campus Cafe
    Trusted URI: https://apitesttool.desire2learnvalence.com/ (ensure the final slash is included)
    Major Version: 1
    Minor Version: 0
    Description: Optionally enter a note about the connection
    Enable this application: Checked
  6. Accept the terms and click Register Application
  7. Copy the Application ID for future use
  8. Next to Application Key click Show and copy the Application Key for future use
  9. Ensure that you are logged into your Brightspace environment
  10. Open the API Test Tool: https://apitesttool.desire2learnvalence.com/
  11. Replace the host field with your Brightspace URL
  12. Replace the Application ID and Application Key fields with the values -from Steps 7-8
  13. Click Authenticate
  14. Copy the User ID for future use
  15. Copy the User Key for future use
  16. Ensure that the application is enabled


Campus Cafe Configuration

Complete the steps below to establish the Campus Cafe configuration settings.

Configure Campus Cafe Class Drop Configuration

The connection to Campus Cafe runs on a schedule where it processes any enrollment changes made since the last run. As such, the system requires that records of drops and replacements (swaps) be preserved. 

  1. Log in to Campus Cafe
  2. Navigate to Admin > System Setup > Custom Control
  3. Local ProgramID WEBDROPLGC
  4. Click the pencil next next to WEBDROPLGC Seq 1 Parm 1
  5. In Parameter Value 1 enter Y
  6. In Parameter Value 2 enter Y
  7. Click Save
  8. Refresh the cache by navigating to Admin > Refresh Data Cache > reload data

Configure Course End-Times and Nickname/Preferred Name Settings

The connection allows for the adjustment of course end-times.  Default is set to 0:00 z time; however, this may be adjusted from 0 to 2359 to account based on when you want the courses to end in Brightspace.  Additionally, the integration may now be configured to bring in the Campus Cafe Nickname as the Preferred Name in Brightspace/D2L.  If set to Y and no Nickname exists in Campus Cafe, the First Name will be sent as the Preferred Name.

Configuring Course End-Times

  1. Log in to Campus Cafe
  2. Navigate to Admin > System Setup > Custom Control
  3. Locate ProgramID MOODLE
  4. Click the pencil icon next to Moodle Seq 2 Parm 9
  5. Update the course end-times (HHMM) to a value from 0 to 2359
    1. Default is set to 0

Configuring Nickname Preferences

  • Log in to Campus Cafe
  • Navigate to Admin > System Setup > Custom Control
  • Locate ProgramID MOODLE
  • Click the pencil icon next to Moodle Seq 2 Parm 10
  • Enter Y to send Nickname as Preferred Name
  • Enter N to ignore Nickname field in Campus Cafe and only send First Name as preferred name
    • Default is set to N

Configure Campus Cafe Web App Configuration

This is a one-time process to establish the connection. Adjustments must only be made if the desired functionality needs to be adjusted due to a business process change.

  1. Log in to Campus Cafe
  2. Navigate to Admin > System Setup > Web App
  3. Use the search box to filter on "Brightspace" and configure the parameters listed below.
    ParameterValue
    BRIGHTSPACE_ALL_GRADES_DATA_SET_IDThe ID number of the Brightspace Data Hub All Grades Data Set
    (See instructions: Retrieving Brightspace PluginId and DataSetId values)
    BRIGHTSPACE_API_NAMECC_D2L
    BRIGHTSPACE_API_VERSION1.25
    BRIGHTSPACE_APPLICATION_IDThe application ID created during register an app
    BRIGHTSPACE_APPLICATION_KEYThe key created during register an app
    BRIGHTSPACE_ASSIGNMENT_SUBMISSION_DETAILS_PULGINThe ID number of the Brightspace Data Hub Assignment Submissions Detail Data Set
    (See instructions: Retrieving Brightspace PluginId and DataSetId values)
    BRIGHTSPACE_ASSIGNMENT_SUBMISSIONS_PULGINThe ID number of the Brightspace Data Hub Assignment Submissions Data Set
    (See instructions: Retrieving Brightspace PluginId and DataSetId values)
    BRIGHTSPACE_ASSIGNMENT_SUMMARY_PULGINThe ID number of the Brightspace Data Hub Assignment Submissions Summary Data Set
    (See instructions: Retrieving Brightspace PluginId and DataSetId values)
    BRIGHTSPACE_AUTO_QUEUE_ITEMSIf 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_URLThe login URL for Brightspace similar to https://<your-school-code>.brightspace.com
    BRIGHTSPACE_COPY_CONTENTOptional: 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_USERA "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_SEMESTERThe 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_ENDNumber of days after course end date that enrollments remain active. Enter 0 as default.
    BRIGHTSPACE_DAYS_ACTIVE_BEF_BEGINNumber of days before course begin date that enrollments become active. Enter 0 as default.
    BRIGHTSPACE_DAYS_ADJUST_OFFRG_BEGIN_DATEDays to adjust offering begin date from CC course date. Enter 0 as default.
    BRIGHTSPACE_DAYS_ADJUST_OFFRG_END_DATEDays to adjust offering end date from CC course date. Enter 0 as default.
    BRIGHTSPACE_DISCUSSION_POSTS_PULGINThe ID number of the Brightspace Data Hub Discussion Posts Data Set
    (See instructions: Retrieving Brightspace PluginId and DataSetId values)
    BRIGHTSPACE_EMAILAn alert will be sent to this email if an error occurs.
    BRIGHTSPACE_GRADE_OBJECTS_PULGINThe ID number of the Brightspace Data Hub Grade Objects Data Set
    (See instructions: Retrieving Brightspace PluginId and DataSetId values)
    BRIGHTSPACE_IMPORT_APPLICATION_IDSame as BRIGHTSPACE_APPLICATION_ID
    BRIGHTSPACE_IMPORT_APPLICATION_KEYSame as BRIGHTSPACE_APPLICATION_KEY
    BRIGHTSPACE_IMPORT_BASE_URLSame as BRIGHTSPACE_BASE_URL
    BRIGHTSPACE_IMPORT_HOURS_TO_OVERWRITE_FINAL_GRADEEnter 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_MINIMUMThe 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_IDThe user id generated during the Register App phase
    BRIGHTSPACE_IMPORT_USER_KEYThe user key generated during the Register App phase
    BRIGHTSPACE_INSTRUCTOR_ADD_ONLYOnly add instructors, allows manually changing D2L inst role and adding inst not in CC. Enter N by default.
    BRIGHTSPACE_INSTRUCTOR_ROLEBrightspace role associated with instructors. Enter Instructor as default. Case sensitive
    BRIGHTSPACE_LDA_GRADE_ITEM_NAME_PREFIXThe 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.
    BRIGHTSPACE_MAX_RETRY_ATTEMPTSNumber of times to try processing an entry. Enter 2 as default.
    BRIGHTSPACE_OFFERING_DAYS_ACTIVE_BEF_BEGINEnter 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_D2LIDEnter the Brightspace numerical code of the institution's parent organization. Typically, this code is 6066.
    BRIGHTSPACE_QUIZ_ATTEMPTS_PULGINThe ID number of the Brightspace Data Hub Assignment Quiz Attempts Data Set
    (See instructions: Retrieving Brightspace PluginId and DataSetId values)
    BRIGHTSPACE_QUIZ_INCLUDE_COMPLETED_ONLYEnter Y to import only completed quizzes as assignments in Campus Cafe. Enter a N to exclude them.
    BRIGHTSPACE_REMOVE_FROM_QUEUE_DAYSNumber of days after processing entry should remain on queue. Enter 30 as default.
    BRIGHTSPACE_RETRY_MINUTESNumber minutes to wait before reprocessing an entry. Enter 30 as default.
    BRIGHTSPACE_SEND_USER_CREATION_EMAILEnter 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_ROLEBrightspace 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_TIMEZONEEnter the time zone. US/Eastern; US/Central; US/Mountain or US/Pacific Case sensitive
    BRIGHTSPACE_UPDATE_USER_EMAILA "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_USERNAMEA "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_IDThe user id generated during the Register App phase
    BRIGHTSPACE_USER_KEYThe user key generated during the Register App phase

  4. Refresh the cache by navigating to Admin > System Tasks > Refresh Data Cache > reload cached data.

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

  1. BRIGHTSPACE_ASSIGNMENT_SUBMISSION_DETAILS_PULGIN
    • Search for: Assignment Submission Details Differential
  2. BRIGHTSPACE_ASSIGNMENT_SUBMISSIONS_PULGIN
    • Search for: Assignment Submissions Differential
  3. BRIGHTSPACE_ASSIGNMENT_SUMMARY_PULGIN
    • Search for: Assignment Summary Differential
  4. BRIGHTSPACE_DISCUSSION_POSTS_PULGIN
    • Search for: Discussion Posts Differential
  5. BRIGHTSPACE_QUIZ_ATTEMPTS_PULGIN
    • Search for: Quiz Attempts Differential
  6. 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

  1. 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. 

  1. Log in to Brightspace
  2. 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 earlier
  3. Click Authenticate
  4. A confirmation page asking you to confirm the connection should appear
  5. Click Continue
  6. A new page will appear
  7. Copy the User ID for future use
  8. 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. 

  1. Log in to Campus Cafe
  2. Navigate to Admin > Web App Config
  3. Locate the Parameter BRIGHTSPACE_USER_ID and enter the User ID created through the Brightspace API Test Tool
  4. Locate the Parameter BRIGHTSPACE_USER_KEY and enter the User Key created through the Brightspace API Test Tool
  5. 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. Campus Cafe Setting to Set Brightspace as LMS Option

  1. Log in to Campus Cafe
  2. Navigate to Admin > System Setup > Custom Control
  3. Locate ProgramId Moodle, Sequence 1, Parameter 1- (Brightspace uses the same foundational settings in Campus Cafe as Moodle)
  4. In the Parameter Value 10 box enter a Y
  5. Click Save
  6. Refresh the cache by navigating to Admin > Refresh Data Cache > reload data

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.

  1. Log in to Campus Cafe
  2. Navigate to Registrar > LMS Management
  3. The number next to Unprocessed Queue Entries Count indicates the number of enrollment waiting to sync
  4. Click Click Here to Manually Run Brightspace queue processor for 100 entries
  5. 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

  1. Log in to Campus Cafe
  2. Navigate to Registrar > LMS Management
  3. 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.

  1. In Campus Cafe navigate to the course section (Registrar > Course Finder > Magnifying glass next to course)
  2. Click the Codes tab
  3. Check the Exclude From LMS Integration box
  4. 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.

  1. In Brightspace, navigate to the Course and then Course Administration > Course Offering Information
  2. Set the Course Offering code to something not used by any other Brightspace offering
  3. In Campus Cafe navigate to the course section (Registrar > Course Finder > Magnifying glass next to course)
  4. Click the Codes tab
  5. In the LMS Course Code Override box enter the SIS ID number you entered in Brightspace
  6. Repeat steps 3-5 for each Campus Cafe section
  7. 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: 

  1. 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.
  2. 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:

  1. Assignment Submissions
  2. Discussion Posts
  3. 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.

1. 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.   

2. 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.

3. Run on demand for a historical data set - 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. This option is similar to the 'Run on demand' option, but it will let you run a prior set of differential files. This option should be used if the previous import was unsuccessful, before the next set of differential files were generated.

To use this option, click on 'Click Here to Refresh Differential Files Available for processing'. After a few moments, the drop-down menu below this link will populate with the historical differential files still available in Brightspace. The dropdown is a list of timestamps of when the differential files were created. The timestamps are displayed in UTC time. Select the file with the historical UTC time you wish to import and then click 'Run Participation Import for Time'. This process will take several (3-5) minutes to run and will only run the Participation import using the historical differential file selected. Once the process is complete, an email with a summary of the job results will be sent to the email address listed in Web App Config BRIGHTSPACE_EMAIL and you may receive a runtime error screen in Campus Cafe.  This indicates the job was successfully run and is complete but may have taken longer than expected. Once you have received the email and the job is complete, you may select the next file you wish to process. 

Each file you wish to process will need to be run separately. Grade import files do not have differential files, which is why we always include the prior 3 days of grades when running the default import job.

The current differential file timestamp is not included in the dropdown, to run current differential use option 2 (listed above).

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.

  1. Navigate to Registrar > LMS Management
  2. Click on Final Grade Synchronization (Brightspace import options must be configured in Web App Config)
  3. Select the Semester to Synchronize from the drop-down
  4. Optional: Enter the Course Number to import grades for a specific course
  5. 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.  
  6. Click Synchronize to begin the process
  7. Click Refresh Job Output to view updates on the progress and which grades have been processed in the Process Output Messages box.



Was this article helpful?

Need Translation?