Enterprise Portal Blackboard API User Guide

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

  1. Login to your ExamSoft portal.
  2. Select Admin, then Global Settings.
  3. Select LMS Settings.
  4. Under LMS Type, select Blackboard API. Then, select the Save button.

 

Configure the Integration details

Configure the Integration details

  1. Input your Blackboard host URL; then, select the Verify URL button.
    Exam Soft - Frame 92.jpg
  2. Select the Configure button.
    Exam Soft - Frame 93.jpg
  3. You’ll select different values from Blackboard to pass into ExamSoft.
    Exam Soft - Frame 94.jpg
    • 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.
  4. 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.
      Exam Soft - Frame 95.jpg
  5. For any additional role, select the checkbox for each role; then, confirm your selection with the Save button.
    Exam Soft - Frame 97.jpg
  6. With all selections confirmed, select the Save button on the Configure page.
    Exam Soft - Frame 96.jpg
Edit the Course Sync List

Edit the Course Sync List

  1. Select the Edit Courses button.
    Exam Soft - Frame 98.jpg
  2. To add courses to the sync list, select Import Courses.
    Exam Soft - Frame 99.jpg
  3. 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.
    Exam Soft - Frame 100.jpg
    • 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.
      Exam Soft - Frame 101.jpg
  4. 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.
    Exam Soft - Frame 102.jpg
  5. Close the modal window; then, you’ll see the Course Sync List with the course(s) you added.
    Exam Soft - Frame 103.jpg
  6. 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.
    Exam Soft - Frame 104.jpg
  7. Once you’re done, select the Close button.
    Exam Soft - Frame 105.jpg
Syncing Courses

Syncing Courses

  1. With your courses added to the Course Sync List, you can sync them to your ExamSoft portal with the Sync now button.
    Exam Soft - Frame 106.jpg
  2. To schedule an automated daily sync, select the Edit Schedule button.
    Exam Soft - Frame 107.jpg
  3. Toggle the Auto Sync either ON or OFF, and choose the specific time you’d like the sync to process.

    Exam Soft - Frame 108.jpg
  4. Select Save when you’re done.
Sync History

Sync History

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

 

Was this article helpful?
3 out of 4 found this helpful

Articles in this section