Enterprise Portal Blackboard API User Guide

Updated January 30, 2024 15:53

If you haven’t done so already, please start the API integration in Blackboard by following this guide: ExamSoft (Enterprise) Blackboard API Integration guide.

Configure the Integration details

Input your Blackboard host URL; then, select the Verify URL button.
Select the Configure button.
You’ll select different values from Blackboard to pass into ExamSoft.
- Course ID Type: Course value from Blackboard which will be passed into ExamSoft as the Course ID. CourseID is recommended here.
- External ID Type: User value from Blackboard which will be passed into ExamSoft as the External ID.
  Note: Only applicable to clients using our SAML integration.
- User ID Type: User value from Blackboard which will be passed into ExamSoft as the Student ID.
The bottom section allows you to select student roles from Blackboard to include in the sync into ExamSoft.
- With the Student role selected, you may not need to make additional adjustments.
- If you want to add an additional role, select the + Add a student role button.
For any additional role, select the checkbox for each role; then, confirm your selection with the Save button.
With all selections confirmed, select the Save button on the Configure page.

Edit the Course Sync List

Select the Edit Courses button.
To add courses to the sync list, select Import Courses.
With the modal window open, Drag & Drop a file into the tool, or choose one a file using the file picker. This will query Blackboard for the courses contained in your XLS/XLSX file.
- Import Type: Choose Add, Remove, or Replace depending on the behavior you want.
  - Add: Adds new courses to the list and leaves any existing courses on the sync list intact.
  - Remove: Removes courses from the sync list based on the course IDs in the file.
  - Replace: Removes all courses from the sync list and replaces them with only the courses from the file.
- Download Template provides an example advising how to format your import file.
Using the Drag & Drop method will auto-process the file. Using the file picker requires you to select the Upload button once you’re ready to import your courses into the tool.
Close the modal window; then, you’ll see the Course Sync List with the course(s) you added.
Select a course and add a Start Date, End Date, and Department Name to each course using the Assign Department and Assign Dates links at the bottom of the screen.
Note: All three values are required for a course to sync to the ExamSoft system.
Once you’re done, select the Close button.

Syncing Courses

With your courses added to the Course Sync List, you can sync them to your ExamSoft portal with the Sync now button.
To schedule an automated daily sync, select the Edit Schedule button.
Toggle the Auto Sync either ON or OFF, and choose the specific time you’d like the sync to process.
Select Save when you’re done.

Sync History

To view previous syncs and any errors, select the View Sync History button.
The amount under the Successes or Failures columns are totals. To see the errors, select a blue number under the Failures column.
Each button downloads a CSV file with detailed information on each failure.
Some errors may necessitate another sync, but others can be cleared by correcting specific data.