Skip to main content

LMS: Blackboard

Updated

Introduction

SmarterID is added as an external tool LTI tool using the open source OSCELOT LTI building block as outlined in the requirements below. This step-by-step guide will walk through the complete installation process as suggested by the SmarterID team. If you wish to deviate from this installation, please consult your SmarterID representative to ensure the deviation will not impact the ability for the tool to function properly.

Requirements

  • Blackboard 9.0 or greater
    In order for SmarterID to operate correctly you must be running Blackboard 9.0 or greater, running either Blackboard in house or via Blackboard hosting.
     

  • BasicLTI Building Block
    The open source Basic LTI building block (v3.0.0+) for Blackboard must be installed.  This building block extends the LTI functionality within Blackboard and provides some specific hooks required for SmarterID to operate properly.  Links have been provided below for further information about the block.  A special thank you goes out to Stephen Vickers for publishing this block for the community.

    Detailed Overview, including installation information: http://projects-archive.oscelot.org/gf/project/bb-basiclti/

    Block Download: http://projects-archive.oscelot.org/gf/project/bb-basiclti/frs/

  • Javascript Hacks Tool Building Block
    The open source Javascript Hacks Tool for Blackboard must be installed.  Javascript Hacks for Blackboard (a.k.a JS Hacks) is a building block which allows for the injection of arbitrary HTML/Javascript into many pages in Blackboard, providing a platform to modify Blackboard in ways not easily possible before. Links have been provided below for further information about the block.

    Detailed Overview, including installation information: http://projects-archive.oscelot.org/gf/project/jshack/

    Block Download: http://projects-archive.oscelot.org/gf/project/jshack/frs/?action=FrsReleaseBrowse&frs_package_id=360

    We suggest downloading the most recent version of the building block. As of the writing of this guide the most recent version was v1.0.9.

Installation

 

Obtain SmarterID LTI Keys

SmarterID LTI keys can be obtained via the SmarterID administrative area, to login to your account and locate your keys please follow these steps:

  1. Navigate to your SmarterID administrative area in your browser. Your SmarterID administrator was provided your account special administrative area URL. If you do not have this information please contact them.
  2. Enter your username and password and click Login.
  3. Once logged in, click Settings in the upper right, then click Integration Settings.
    bb_install_image_3.png
  4. Find the integration that you need to update, typically there will only be one integration. Then in the Actions menu, select Integration settings. This will drawer open the settings form, you will use the information on this form in subsequent steps below.

When moving to the next section, please open a new tab or browser window so you can easily reference the SmarterID integration settings when prompted to.

Install the LTI Building Block

  1. Download the building block
  2. Navigate to the Building Block installation area and install the building block as you would normally.
  3. Once installed, make the block available.

Install the Javascript Hacks Building Block

  1. Download the building block
  2. Navigate to the Building Block installation area and install the building block as you would normally.
  3. Once installed, make the block available.

Install Javascript Snippet

SmarterID requires the LMS to have a snippet of Javascript on all pages so it can seamlessly communicate with the underlying identity service. This snippet of Javascript is very similar to what is used when embedding Google Maps or other embeddable services into web applications. Follow the steps below to complete the installation of the snippet into your Moodle environment.

 

  1. Click the System Admin menu item.
    install_java1.png
  2. From within the Building Blocks area, click the Building Blocks link.
    install_java2.png
  3. Click the Manage Javascript Hacks menu item.
    install_java3.png
  4. Click the Create Hack button.
    install_java4.png
  5. With the Hack Details section complete the following required fields.
    1. Name: SmarterID
    2. Description: SmarterID
    3. Identifier: smarterid

      install_java_5.png
  6. Within the Injected Content section, complete the fields as follows:
    1. Snippet:
      Screen_Shot_2020-11-14_at_1.05.28_PM.pngScreen_Shot_2020-11-14_at_1.06.01_PM.png
      In the script above, the value of the deploymentSid will need to be your actual deployment id that was provided to you from SmarterServices. So the value {Your DeploymentSid} would be replaced with the actual id.

    2. Injection Point: Top Frame (jsp.topFrame.start)

      install_java8.png
  7. Click Save Hack.
    install_java_9.png

 

Register SmarterID

  1. Click the System Admin menu item.
    register1.png
  2. From within the Building Blocks area, click the Building Blocks link.
    register2.png
  3. Locate the Basic LTI Tools building block and then click settings.
    register3.png
  4. Before we register SmarterID, we need to ensure all the services required are properly configured. Click the Services option to review the services setup.register_4.png
  5. Review the services that are currently setup. The services highlighted in yellow below are the key services that need to be configured just like the image, if you are missing the "Assessments" service, please continue to the next step. If you have all the required services and they are setup properly, you can continue to step 5.register_5.png
  6. If missing the "Assessments" service it will need to be added. To do this follow these steps: 
    1. Click Register New Service.
      register_6.1.png
    2. Enter "org.oscelot.blackboard.lti.services.Assessment" for the name value and click Submit.
      register_6.2.png
    3. Next, make sure the status is set to enabled by checking the box next to the service and then selecting Enabled.
      register_6.3.png
  7. Click the Tools button to return back to the list of tools.
    register_7.png
  8. Now verify the System Settings are properly set for SmarterID to function. Click the System Settings button to review these settings.
    register_8.png
  9. Ensure the System Settings are set as follows: 
    1. Under Services the following options are checked: Outcomes, Memberships, and Setting. This is the only setting on this page that MUST be set correctly.
      register_9.png
    2. Review any of the other settings to ensure they are setup properly based on your institutions preferences. 
    3. Click Submit.
  10. Click the Register New Tool button to now begin adding the tool.
    register_10.png
  11. Click the By XML tab.
    register_11.png
  12. Paste the XML in the large text box labeled XML descriptor.
    Screen_Shot_2020-11-14_at_1.21.21_PM.pngScreen_Shot_2020-11-14_at_1.21.43_PM.pngScreen_Shot_2020-11-14_at_1.22.10_PM.pngScreen_Shot_2020-11-14_at_1.22.29_PM.pngScreen_Shot_2020-11-14_at_1.22.57_PM.png
     
  13. Click Submit
  14. From the options menu next to the new registration, click Edit registration.
    register_12.png
  15. In the Connection Details section, the consumer key and shared secret need to be populated. Go back over to your SmarterID integration settings page from earlier in this process to obtain these values and enter them in these fields. Once that is complete, click Submit.
    register_13.png
  16. From the LTI tools list view, check the box next to the newly registered tool and then click the Course tool menu and select Add as course tool.
    register_14.png
  17. From the LTI tools list view again, check the box next to the newly registered tool and then click the Status menu and select Enable.
    register_15.png
  18. Depending on how the default availably was setup for the tool the tool will be added to all courses. If enabled, the tool can be found in the Tools section of a course and will look like the image below. Clicking the link will launch the user directly into their SmarterID account.register_16.png