Blackboard Learn Setup Guide
Overview
This comprehensive guide walks you through setting up PrepareBuddy LTI integration in Blackboard Learn. The setup process takes approximately 10-15 minutes and works with both Blackboard Learn SaaS and Self-Hosted installations.
Prerequisites
Before beginning: - System Administrator Access: Required to install LTI tool providers - PrepareBuddy Credentials: Contact support@preparebuddy.com for your consumer key and shared secret - Blackboard Version: Works with Blackboard Learn 9.1 SP14+ and Ultra Experience
Blackboard Learn Original Experience
Step 1: Access Building Blocks
- Log into Blackboard as a System Administrator
- Navigate to Admin Panel → Building Blocks
- Select LTI Tool Providers
Step 2: Register Provider Domain
- Click Register Provider Domain
- Provider Domain: Enter
preparebuddy.com - Provider Domain Status: Select "Approved"
- Default Configuration: Set to "Yes"
- Click Submit
Step 3: Configure LTI Tool Provider
- Click Register LTI 1.1 Provider
- Provider Domain:
preparebuddy.com - Tool Provider Key: Enter key provided by PrepareBuddy
- Tool Provider Secret: Enter secret provided by PrepareBuddy
- Tool Provider Status: "Approved"
Step 4: Set User Information Fields
Configure what information is sent to PrepareBuddy: - Send User Data: "Send user data over any connection" - User Fields to Send: Select all: - Role in Course - Name - Email Address - User ID - Allow Membership Service Access: Yes (for roster information)
Step 5: Configure Tool Settings
- Tool Provider URL:
https://preparebuddy.com/lti/launch/ - Tool Provider Key: (from Step 3)
- Tool Provider Secret: (from Step 3)
- Send User Data: Both "User Name" and "Email Address"
- Send Role: Yes
- Allow Grading: Yes (for automatic grade passback)
Step 6: Custom Parameters (Optional)
Add these for enhanced functionality:
user_email=@X@user.batch_uid@X@
user_full_name=@X@user.full_name@X@
course_id=@X@course.course_batch_uid@X@
user_role=@X@membership.role@X@
Step 7: Submit and Test
- Click Submit to save configuration
- Test with a sample course and user
Blackboard Learn Ultra Experience
Step 1: Access LTI Tool Management
- Navigate to Administrator Panel
- Select Integrations → LTI Tool Providers
- Click Register LTI 1.3 Tool (preferred) or Register LTI 1.1 Tool
For LTI 1.3 (Recommended)
- Tool Name: PrepareBuddy
- Domain: preparebuddy.com
- Tool URL:
https://preparebuddy.com/lti/launch/ - Login URL:
https://preparebuddy.com/lti/login/ - Keyset URL:
https://preparebuddy.com/lti/jwks/ - Custom Parameters:
user_email=$Person.email.primary user_name=$Person.name.full
For LTI 1.1 (Legacy)
- Tool Name: PrepareBuddy
- Domain: preparebuddy.com
- Tool URL:
https://preparebuddy.com/lti/launch/ - Key: (provided by PrepareBuddy)
- Secret: (provided by PrepareBuddy)
Step 2: Configure Placements
Enable these placement options: - Course Content: Yes (for assignments) - Course Tool: Yes (for navigation) - Assessment: Yes (for graded activities)
Step 3: Set Privacy and Grade Settings
- User Privacy Level:
- Send user name: Yes
- Send email address: Yes
- Send role: Yes
- Grade Settings:
- Accept grades: Yes
- Grade column creation: Automatic
Course-Level Configuration
For Instructors: Adding PrepareBuddy Content
Method 1: Web Link (Most Common)
- Navigate to your course
- Content → Build Content → Web Link
- Name: Enter assignment name
- URL: Select "This link is to a Tool Provider"
- Tool Provider: Select "PrepareBuddy"
- Enable Evaluation: Yes (for grading)
- Points Possible: Enter maximum points
- Make Available: Yes
Method 2: Assignment
- Assessments → Assignment
- Assignment Name: Enter descriptive name
- Instructions: Add any specific instructions
- Submission Details:
- Submission Type: "Tool Provider submission"
- Tool Provider: Select "PrepareBuddy"
- Grading:
- Points Possible: Set maximum points
- Enable Evaluation: Yes
Method 3: Content Item (Ultra)
- Content → Create → Tool
- Select "PrepareBuddy" from available tools
- Configure assignment details
- Set point value and due date
Advanced Configuration Options
Custom Parameters for Enhanced Features
Add these parameters for improved functionality:
# Basic user information
bb_user_id=@X@user.pk_string@X@
bb_username=@X@user.batch_uid@X@
bb_user_email=@X@user.email@X@
bb_user_fullname=@X@user.full_name@X@
# Course information
bb_course_id=@X@course.pk_string@X@
bb_course_name=@X@course.course_name@X@
bb_course_batch_uid=@X@course.course_batch_uid@X@
# Membership information
bb_user_role=@X@membership.role@X@
bb_user_available=@X@membership.available@X@
Grade Passback Configuration
For automatic grade synchronization:
- Enable Evaluation: Must be "Yes" on assignments
- Points Possible: Must be set (cannot be 0)
- Grade Settings: Configure how grades are handled:
- Multiple Attempts: Choose highest, latest, or average
- Grade Display: Points, percentage, or letter grade
- Grade Visibility: When grades become visible to students
Content Security Settings
Configure security for your institution:
- SSL Settings: Require HTTPS for all communications
- Domain Restrictions: Limit to preparebuddy.com
- IP Restrictions: Contact PrepareBuddy for current IP ranges
- User Data Handling: Review what data is shared
Testing Your Setup
Create Test Environment
- Test Course: Create or use existing test course
- Test Users: Create test instructor and student accounts
- Test Assignment: Create simple PrepareBuddy assignment
Test Workflow
- Instructor Test:
- Create assignment using PrepareBuddy tool
- Verify tool configuration options appear
-
Confirm grading settings are available
-
Student Test:
- Access assignment as test student
- Verify automatic login to PrepareBuddy
- Complete a simple assessment
- Check grade appears in Blackboard gradebook
Expected Results
✅ Tool appears in instructor's tool provider list
✅ Student launches PrepareBuddy seamlessly
✅ Student sees correct email address and account
✅ Grades sync automatically within 1-2 minutes
✅ Grade values are accurate and properly scaled
Blackboard-Specific Features
Grade Center Integration
PrepareBuddy grades appear in Blackboard's Grade Center: - Automatic Columns: Grade columns created automatically - Grade History: Track grade changes over time - Bulk Operations: Apply bulk operations to LTI grades - Export Options: Include in grade exports and reports
Deep Linking Support
If enabled, instructors can: - Select specific PrepareBuddy content when creating assignments - Customize the student experience per assignment - Link directly to particular assessments or tests
Mobile App Compatibility
The integration works with: - Blackboard Student App: Full functionality on mobile - Blackboard Instructor App: Grade monitoring and management - Mobile Web: Complete feature access via mobile browsers
Analytics Integration
PrepareBuddy usage appears in: - Course Statistics: External tool usage tracking - Student Activity: Time spent and engagement metrics - Performance Analytics: Assignment completion and success rates
Common Blackboard Issues
"Tool Provider Not Available"
Cause: Tool not registered or approved at system level Solution: 1. Verify tool is registered in Building Blocks → LTI Tool Providers 2. Check provider domain status is "Approved" 3. Ensure tool provider status is "Approved"
"User Data Not Sending"
Cause: User information sharing not properly configured Solution: 1. Check "Send User Data" settings in tool configuration 2. Verify "User Fields to Send" includes name and email 3. Test with different user roles (instructor vs. student)
"Grades Not Appearing in Grade Center"
Cause: Grade passback not enabled or configured properly Solution: 1. Ensure "Allow Grading" is enabled in tool configuration 2. Verify assignment has "Enable Evaluation" set to Yes 3. Check that "Points Possible" is set to a value > 0
"SSL/Security Errors"
Cause: HTTPS configuration or certificate issues Solution: 1. Verify all PrepareBuddy URLs use HTTPS 2. Check institutional SSL certificate requirements 3. Test with different browsers to isolate issues
Version-Specific Notes
Blackboard Learn 9.1 (Original)
- Uses Building Blocks interface
- Requires LTI Tool Provider registration
- Custom parameters use @X@variable@X@ syntax
- Grade passback via XML
Blackboard Learn Ultra
- Modern interface for tool management
- Supports both LTI 1.1 and 1.3
- Simplified configuration process
- Enhanced mobile compatibility
Blackboard Learn SaaS vs. Self-Hosted
SaaS (Managed Hosting): - Standard configuration applies - Automatic updates included - Standard security settings
Self-Hosted: - May require custom firewall rules - Additional security considerations - Manual updates needed
Maintenance and Monitoring
Regular Maintenance Tasks
- Monthly: Test tool accessibility and grade sync
- After Blackboard Updates: Verify continued functionality
- Semester Start: Test with new courses and users
Monitoring Points
- Grade Center: Monitor automatic grade entries
- System Logs: Check for LTI-related errors
- User Feedback: Track instructor and student issues
Update Procedures
- Tool Updates: Automatic via our registered domain
- Configuration Changes: Manual updates may be required
- Version Upgrades: Test after Blackboard version upgrades
Support Resources
Blackboard-Specific Support
- Blackboard Help: help.blackboard.com
- Community Forums: community.blackboard.com
- Administrator Documentation: help.blackboard.com/Administrator
PrepareBuddy Support
- Email: support@preparebuddy.com
- Phone: 1-800-PREPARE (1-800-773-7273)
- Priority Support: Available for institutional deployments
Technical Documentation
- LTI Standards: imsglobal.org/activity/learning-tools-interoperability
- Blackboard LTI Guide: help.blackboard.com/LTI
- Integration Examples: Available upon request
Success Metrics
A successful Blackboard integration should demonstrate: - 95%+ Launch Success: Consistent student access - Real-time Grade Sync: Grades appear within 2 minutes - Proper Account Linking: Students see correct email addresses - Cross-browser Compatibility: Works in all supported browsers - Mobile Functionality: Full features on mobile devices
Regular monitoring ensures continued success and early identification of any issues.
