Blackboard Integration

Owned by Jeff Worford (Unlicensed)
Last updated: Nov 06, 2012
9 min read

Overview

This document will hep guide SmarterSurveys clients through the process of setting up, configuring and using the SmarterSurveys BasicLTI integration with Blackboard Learn.  This document is intended for Blackboard administrators.

There are three available options for integration with Blackboard:

  1. Course Tool:  The course tool allows the Blackboard administrator to include a tool within the Tools section of each course.  This tool will perform a Single Sign On (SSO) for the user directly into the SmarterSurveys system bypassing the need for authentication. 
  2. SSO Launch:  The SSO Launch option allows the Blackboard administrator to place a module within the system that can be place on the Institution dashboard and/or Course dashboard that contains a SSO link directly into the SmarterSurveys system.
  3. Detailed Module:  The Detailed Module option allows the Blackboard administrator to place a HTML module within the system that can be place on the Institution dashboard and/or Course dashboard that contains information about open and available surveys for students as well as response rates and report access for faculty.  This option provides a rich user experience with SmarterSurveys all from within the Blackboard module. 

Prerequisites

All options require a valid integration key and access code key from SmarterSurveys.  These keys are available free of charge and available upon request.  Please contact your account manager to setup a new integration. 

Course Tool 

  • Blackboard Learn 9.1 SP4 or later
  • Blackboard user Batch IDs must match Student or Faculty ID sent to SmarterSurveys.

SSO Launch

  • Blackboard Learn 9.0 or better
  • SPV Software BasicLTI Building Block

Detailed Module

  • Blackboard Learn 9.0 or better
  • SPV Software BasicLTI Building Block

 

Installation

Course Tool

Installation of the course tool utilizes the Blackboard BasicLTI Provider Tool Building Block including in versions 9.1 SP4 or later.  No third party building blocks are required to use this feature.  This feature allows Blackboard to pass SmarterSurveys the batch_id for  a logged in user.  SmarterSurveys looks this ID up within our system and if found, signs the user in and pushes them to the home screen within SmarterSurveys.

Setup of Basic LTI Provider

  1. Log into Blackboard as a System Administrator
  2. Switch to the System Admin tab
  3. Select the link Building Blocks from the Building Blocks module
  4. Click on the link Basic LTI Tool Providers
  5. Click the button Register Provider Domain
  6. For the Provider Domain Status, enter or select the following:
    1. For Provider Domain enter smartersurveys.com
    2. For Provider Domain Status, choose Approved
  7. For the Default Configuration, enter or select the following:
    1. For Default Configuration, set to Set globally
    2. For Tool Provider Key, enter the key provided by SmarterSurveys.
    3. For Tool Provider Secret, enter the secret key provided by SmarterSurveys.
  8. For Institution Policies, enter or select the following:
    1. For Send User Data, set to Send user data only over SSL
    2. For Send Context Identifiers As, choose Batch UID
    3. You can optionally set Show User Acknowledgment Message based on your institutional policy and preferences.  This will notify and confirm with the user before opening the SmarterSurveys system.  
  9. Submit the form to save your selections.

This will authorize Blackboard to access smartersurveys.com and to provide information to us using the BasicLTI specification.  It also sets the access key and secret for your integration. 

Manage Placements

Now that you have authorized Blackboard to send BasicLTI data to SmarterSurveys, you can manage where the tool is available within Blackboard.

  1. Click the down arrow next to smartersurveys.com to open the context menu
  2. Click the Manage Placements link
  3. Click the button Create Placement
  4. For Placement Information, enter or select the following:
    1. Enter a Label for the tool.  This is how it will show up to users.  Some good examples could be "End of Course Evaluations" or "SmarterSurveys Evaluations", etc.
    2. Provide a Description for the tool.
    3. Enter a unique Handle
    4. Select Student Tool for the type
    5. The SmarterSurveys icon can be obtained from http://images.smarterservices.com/logos/S%20Icon/web/s_icon_trans_green_200.png
  5. For the Tool Provider Information, enter or select the following:
    1. For Tool Provider URL, enter http://api.smartersurveys.com/ltilaunch
    2. The Key and Secret should be greyed out since these were provided in the Provider setup above.
  6. Submit the form to save your selections.

The SmarterSurveys tool should now be available via the tool menu in each course.

 

SSO Launch

As a prerequisite, the  SSO Launch requires that you have installed and activated the BasicLTI Tool Building Block provided by SPV Software.    More information about this building block including installation instructions can be found at http://www.spvsoftwareproducts.com/bb/basiclti/ .  This building block can be installed on version 9 or later. 

Setup of BasicLTI Tool

  1. Log into Blackboard as a System Administrator
  2. Switch to the System Admin tab
  3. Select the link Basic LTI tools from the Tools and Utilities module
  4. Click the button Register New Tool
  5. For the Name, enter or select the following:
    1. For Name, enter a name that will be used for the module. Some good examples are "End of Course Evaluations" or "SmarterSurveys Survey System".
  6. For the Connection Details, enter or select the following:
    1. For Launch URL, enter the following URL:  https://api.smartersurveys.com/ltilaunch
    2. For Tool Provider Key, enter the key provided by SmarterSurveys.
    3. For Tool Provider Secret, enter the secret key provided by SmarterSurveys.
  7. For Extension Services, enter or select the following:
    1. For Outcomes, set to Not used by tool
    2. For Memberships, choose Not used by tool
    3. For Setting, choose Not used by tool
  8. Submit the form to save your selections.

Edit Data Settings

  1. Click the down array next to the name of the registration you created in the previous step.
  2. In the context menu, click the link for Edit Data settings
  3. For Context Data, enter or select the following:
    1. Check Context ID
  4. For Personal Data, enter or select the following:
    1. For User ID, choose Required by tool
    2. For Value to use for user ID, select the value that represents the Student and Faculty ID uploaded into the SmarterSurveys system. 
    3. For User name, choose Not used by tool
    4. For Email, choose Not used by tool
  5. All other selections can be left at the default.
  6. Submit the form to save your selections.

Edit Launch Settings

  1. Click the down array next to the name of the registration you created in the first step.
  2. In the context menu, click the link for Edit Launch settings
  3. For Connect to Tool Options, enter or select the following:
    1. Select your option for Open tool in.  
      1. Frame - Will open SmarterSurveys within the Blackboard interface. *Recommended option
      2. New Window - Will open SmarterSurveys in a new browser window.
      3. iFrame - Will open SmarterSurveys in a modal window within the page that the link resides.
  4. Submit the form to save your selections.

Enable the Tool

  1. Click the down array next to the name of the registration you created in the first step.
  2. In the context menu, click the link for Enable

Your tool is now setup and enabled.

Creating a SSO Launch Module for Use in Blackboard

  1. Log into Blackboard as a System Administrator
  2. Switch to the System Admin tab
  3. Select the link Tabs and Modules from the Communities module
  4. Click the button Module
  5. For the General Properties, enter or select the following:
    1. For Title, enter a name that will be used for the module. Some good examples are "End of Course Evaluations" or "SmarterSurveys Survey System".
    2. For Module Type, select Basic LTI tool
    3. For Module Category, select My Blackboard
    4. Select preferred options to give a user the ability to personalize and detach the module.
  6. For the Availability, select your preferred options for availability on where it is available and who can view it. 
    1. To add it into the institution you need to enable System Availability
    2. To add it into a course, you need to enableAvailability for Use on a Course Module Page
    3. Enable Allow Asynchronous Loading.
    4. You can set Date and Time Restrictions if you only what this tool available to students and/or faculty during the administration period.
  7. Submit the form to save your selections.
  8. You will be taken to the Admin page for the newly created module.
  9. For Content details, enter or select the following:
    1. For Name of existing tool, select the tool that you registered by the Setup of BasicLTI Tool section above.
    2. Check Allow launch?
    3. Check Launch button?
  10. Submit the form to save your selections.

Once the module has been created you can include it within the Institution by default or allow instructors to include it in their courses.  There are many options for where this link can be inserted, if it can be moved, the default location, etc.  Refer to your Blackboard help for specifics on how to add a module.

SSO Launch Link Screenshot

 

 

Detailed Module

As a prerequisite, the Detailed Module option requires that you have installed and activated the BasicLTI Tool Building Block provided by SPV Software.    More information about this building block including installation instructions can be found at http://www.spvsoftwareproducts.com/bb/basiclti/ .  This building block can be installed on version 9 or later. 

Setup of BasicLTI Tool

  1. Log into Blackboard as a System Administrator
  2. Switch to the System Admin tab
  3. Select the link Basic LTI tools from the Tools and Utilities module
  4. Click the button Register New Tool
  5. For the Name, enter or select the following:
    1. For Name, enter a name that will be used for the module. Some good examples are "End of Course Evaluations" or "SmarterSurveys Survey System".
  6. For the Connection Details, enter or select the following:
    1. For Launch URL, enter the following URL:  https://api.smartersurveys.com/ltimodule
    2. For Tool Provider Key, enter the key provided by SmarterSurveys.
    3. For Tool Provider Secret, enter the secret key provided by SmarterSurveys.
  7. For Extension Services, enter or select the following:
    1. For Outcomes, set to Not used by tool
    2. For Memberships, choose Not used by tool
    3. For Setting, choose Not used by tool
  8. Submit the form to save your selections.

Edit Data Settings

  1. Click the down array next to the name of the registration you created in the previous step.
  2. In the context menu, click the link for Edit Data settings
  3. For Context Data, enter or select the following:
    1. Check Context ID
  4. For Personal Data, enter or select the following:
    1. For User ID, choose Required by tool
    2. For Value to use for user ID, select the value that represents the Student and Faculty ID uploaded into the SmarterSurveys system. 
    3. For User name, choose Not used by tool
    4. For Email, choose Not used by tool
  5. All other selections can be left at the default.
  6. Submit the form to save your selections.

Edit Launch Settings

  1. Click the down array next to the name of the registration you created in the first step.
  2. In the context menu, click the link for Edit Launch settings
  3. For Connect to Tool Options, enter or select the following:
    1. Select your option for Open tool in.  
      1. Frame - Will open SmarterSurveys within the Blackboard interface. *Recommended option
      2. New Window - Will open SmarterSurveys in a new browser window.
      3. iFrame - Will open SmarterSurveys in a modal window within the page that the link resides.
  4. Submit the form to save your selections.

Enable the Tool

  1. Click the down array next to the name of the registration you created in the first step.
  2. In the context menu, click the link for Enable

Your tool is now setup and enabled.

Creating a Detailed Module for use in Blackboard

  1. Log into Blackboard as a System Administrator
  2. Switch to the System Admin tab
  3. Select the link Tabs and Modules from the Communities module
  4. Click the button Module
  5. For the General Properties, enter or select the following:
    1. For Title, enter a name that will be used for the module. Some good examples are "End of Course Evaluations" or "SmarterSurveys Survey System".
    2. For Module Type, select Basic LTI tool
    3. For Module Category, select My Blackboard
    4. Select preferred options to give a user the ability to personalize and detach the module.
  6. For the Availability, select your preferred options for availability on where it is available and who can view it. 
    1. To add it into the institution you need to enable System Availability
    2. To add it into a course, you need to enable Availability for Use on a Course Module Page
    3. Enable Allow Asynchronous Loading.
    4. You can set Date and Time Restrictions if you only what this tool available to students and/or faculty during the administration period.
  7. Submit the form to save your selections.
  8. You will be taken to the Admin page for the newly created module.
  9. For Content details, enter or select the following:
    1. For Name of existing tool, select the tool that you registered by the Setup of BasicLTI Tool section above.
    2. For Content URL, enter https://api.smartersurveys.com/ltimodule
    3. For Content Type, choose HTML
    4. Leave Allow launch? unchecked
    5. Leave Launch button? unchecked
  10. Submit the form to save your selections.

Once the module has been created you can include it within the Institution by default or allow instructors to include it in their courses like any other available Blackboard module.  There are many options for where this link can be inserted, if it can be moved, the default location, etc.  Refer to your Blackboard help for specifics on how to add a module to the location where you want it added.

 

Faculty View of Detailed Module Screenshot

 

Student View of Detailed Module Screenshot