Blackboard User Integration (Q2/Q4 2017, Q2/Q4 2018, SaaS)

INSTALLATION AND SETUP INSTRUCTIONS FOR USER INTEGRATION FEATURES

1. Download the User Integration Building Block
   1. Navigate to Account > Integration Settings (section) > Blackboard Integration > Building Blocks tab.
   2. Find the Blackboard Release version applicable to your institution and download the .ZIP file by clicking on the text link.
      
      
2. The .ZIP file contains two (2) files
   1. EUIBB-9.1.SPXXXXXX.war: This is the building block file for the user integration and is discussed later in this document. The file name in the package will package will display the Blackboard version you selected for download.
   2. EvaluationKITKeys.txt: This .txt file contains the keys for the configuration of the USER integration.
3. EXTRACT all files from the .ZIP file
   1. Note: The .ZIP file is NOT a building block, you will need to extract and upload the .War file.
4. Follow these steps to install the User Access Features of the Building Block
   1. Log in to Blackboard as the Blackboard System Administrator.
   2. Click on System Admin tab.
   3. Click Building Blocks under the Integrations section.
      
      
   4. Click Installed Tools on the Building Blocks page.
      
      
   5. Click Upload Building Blocks and the Install Building Blocks page will open.
      
      
   6. Click Browse and locate the EvaluationKIT EUIBB-9.1.XXXXXX.war OR EUIBB-BbLearn_SaaS.war file, which was included in the .ZIP file you downloaded from your Course Evaluations & Surveys account.
   7. Click Submit to upload the file to Blackboard.
   8. Once the block has been uploaded, click OK to return to the Manage Building Blocks page.
   9. Find the Course Evaluations & Surveys User Access Building Block within the list of Building Blocks. If the status of the Building Block is Inactive, change to Available, and then select one of the following approaches in the next section to turn on the display of the specific user access method(s).
   10. Click Settings option on the Building Block to configure the Building Block.
       
       
   11. Find the EvaluationKITKeys.txt file from the .ZIP file you downloaded from your Course Evaluations & Surveys Account.
   12. This information may already be populated. Compare the information in Blackboard with the information in the .txt file. If the information is not populated, copy the information from the .txt file into the Building Block Settings for the URL, Consumer Key, and Secret Key.
       
       NOTE: this information is NOT the same as the key and secret used for the Data Integration.
   13. Click Submit.
5. Configure the User Access Module on the My Institution Page: This will allow you to configure functionality for the module text, list of surveys to take, and automated survey notification that displays to students (e.g., the survey notification message).
   1. In Blackboard, Click on the System Admin tab; then, under Communities, click on Tabs and Modules.
   2. Click on Modules.
   3. Search for Course Evaluations & Surveys Course Evaluations, and down arrow and then select Edit Properties.
      
      
   4. Edit the Module Title as you want it to appear for users in the module.
   5. Under the Availability section, select System Availability = Yes.
      1. Find the Allow Asynchronous Loading checkbox and make sure the checkbox is NOT selected. If it is, deselect this option.
   6. When completed, click Submit.
   7. In Course Evaluations & Surveys, navigate to Account > Integration Settings (section) > Blackboard Integration > User Integration tab to configure the behavior of the Module:
      1. For Student Users (users enrolled in Course Evaluations & Surveys as a Student)
         1. The Survey Notification
         2. The Module text to students
         3. Display of the Course List in the Module to students
      2. For Administrator Users (users enrolled in Course Evaluations & Surveys as a Administrators and CES Administrators)
         1. Display Link to Course Evaluations & Surveys
         2. The Module text to Administrators
      3. For Instructor Users (users enrolled in Course Evaluations & Surveys as an Instructor)
         1. Display Link to Course Evaluations & Surveys
         2. The Module text to Instructors

         NOTE

         Course Evaluations & Surveys will automatically check a user’s role in Course Evaluations & Surveys and display the appropriate survey notification, module information/text, etc. If a user is NOT enrolled in Course Evaluations & Surveys the Module will be automatically hidden in Blackboard.
   8. Module Configuration Options for Student Users (Details)
      
      
      
      
      1. Display Survey Notification within Blackboard: This feature allows you to enable a Survey Notification that automatically displays to students within Blackboard for only those students with an active survey to take (otherwise Survey Notifications aren't displayed). Survey Notifications will display within Blackboard only where you have enabled the Course Evaluations & Surveys Course Evaluations module. Additionally, the Survey Notification includes a Go To Survey button to take the student directly to their surveys.
         1. Display Checkbox: Enables/disables the automated Survey Notification to display to students in Blackboard.
         2. Header Text: Customize the header text of the survey notification.
         3. Body Text: Customize the Notification body text, with plain text, or you can insert HTML.
         4. Go to Survey button text: Customize the button text for the Go To Survey button.
         5. Do it Later button text: Customize the button text for the Do it Later button.
            1. Show Do it Later button: Show/hide the Do it Later button. Exclude the Do it Later option will remove this option from the survey notification. This will force the student to complete ALL active surveys they have to complete before being able to interact with their My Institution Page in Blackboard. In other words, this option will lock the student out of the My Institution Page until they complete ALL of their surveys. Also, if you would like to force students to complete their surveys before accessing their courses, make sure to follow this process for all tabs where students can access their courses (e.g., Courses Tab) and enable the module there too.
            2. Remove Do it Later Button: Automate hiding the Do it Later button X days before the survey ends.
            3. Do it Later Button text: Customize the text of the Do it Later button.
         6. Display Course List in Module: This feature allows you to automatically display to students the list of their courses where they have an active survey to complete. The list of courses displays within the Course Evaluations & Surveys Course Evaluations module within Blackboard. When enabled, the course name in the module is clickable and will take the student directly to their surveys. If the student doesn’t have any active surveys this module will be automatically hidden.
            
            
         7. Take Student Direct to Course Survey: This option takes the student directly to the survey for their course (provided the course information is aligned with Course Evaluations & Surveys). If unchecked, the student will go to their Student Dashboard in Course Evaluations & Surveys. This option is also used for the Survey Notification "Go to Survey" button.
      2. The last step is to add this module to your My Institution page, or additional tabs in Blackboard. Go to Tabs and Modules; then, Tabs, and edit Default Content (and Layout) to add this Module by selecting BOTH the Displayed and Required boxes.
         
         
6. (Optional) Follow these steps to make available User Access as a Course Tool: This option will present Course Evaluations & Surveys as a Course Tool in courses, and take the student directly to their Course Evaluations & Surveys Dashboard, or if course unique IDs are aligned between Bb and Course Evaluations & Surveys AND the direct to survey option is selected; then, the student will go directly to the survey for the course.
   1. Click Course Settings from the System Admin tab in Bb.
   2. Click on Course Tools.
   3. Select Building Block Tools to Filter By in the dropdown.
   4. Find Course Evaluations & Surveys Course Evaluations, select the ON checkbox to activate the link to Course Evaluations & Surveys within a course, which is located on the Course Tools Page in courses.
   5. When completed, click Submit.
7. (Optional) Follow these steps to make available User Access as a link in the Course Menu navigation in a Blackboard Course:
   1. Click Course Settings from the System Admin tab in Bb.
   2. Click on Course Menu & Structures.
   3. Select Tool Link in the dropdown.
   4. Add the desired menu name for the link.
   5. Select Course Evaluations & Surveys Course Evaluations from the Type dropdown.
   6. When completed, click Submit.
      
      
8. All data transfers behind the scenes are secure using Web Services along with encrypted SSL encryption for security purposes.
   1. The EUIBB Building Block has security information embedded in it that relates to your CES Administrator Username and the corresponding Blackboard Username accessing this feature. Please contact Course Evaluations & Surveys Support if you need to make changes to usernames or if you get an authentication error message.