Install our app for a better experience!
Guide Beginner 5 min read

Administrator Setup Guide

Last updated Oct 28, 2025

Administrator Setup Guide

Quick Setup (5 Minutes)

Setting up PrepareBuddy LTI integration is simple and follows industry standards. Use our universal configuration URL for automatic setup, or follow the manual instructions for any LMS platform.

Prerequisites

Before you begin: - Administrative access to your LMS - Contact information for PrepareBuddy support to obtain credentials - Basic understanding of your LMS's external tool configuration

Getting Your Credentials

To set up the integration, you'll need credentials from PrepareBuddy:

  1. Email: support@preparebuddy.com
  2. Include in your request:
  3. Institution name
  4. LMS platform (Canvas, Blackboard, etc.)
  5. Technical contact information

  6. Estimated number of students

  7. You'll receive within 24 hours:

  8. Consumer Key (e.g., "preparebuddy_lms")
  9. Shared Secret (secure random string)
  10. Configuration instructions specific to your setup

Most modern LMS platforms support automatic configuration using our universal configuration URL:

https://preparebuddy.com/lti/config/

Benefits of Universal Configuration

  • Automatic Setup: All settings configured automatically
  • Consistent Experience: Same configuration across platforms
  • Easy Updates: Automatic updates when we enhance features
  • Reduced Errors: Eliminates manual configuration mistakes

Platform-Specific Instructions

Canvas by Instructure

  1. Navigate to Admin → Developer Keys
  2. Click + Developer Key → + LTI Key
  3. Configuration Method: "By URL"
  4. Configuration URL: https://preparebuddy.com/lti/config/
  5. Consumer Key: (provided by PrepareBuddy)
  6. Shared Secret: (provided by PrepareBuddy)
  7. Click Save
  8. Set State to ON
  9. Go to Account → Settings → Apps
  10. Click + App and select "PrepareBuddy" from the list

Method 2: Manual Configuration

  1. Navigate to Admin → Developer Keys
  2. Click + Developer Key → + LTI Key
  3. Configuration Method: "Manual Entry"
  4. Fill in the following:
  5. Name: PrepareBuddy
  6. Launch URL: https://preparebuddy.com/lti/launch/
  7. Consumer Key: (provided by PrepareBuddy)
  8. Shared Secret: (provided by PrepareBuddy)
  9. Privacy Level: Public
  10. Domain: preparebuddy.com
  11. Extensions: Enable "Course Navigation"
  12. Click Save and set State to ON

Blackboard Learn

  1. Navigate to Admin Panel → Building Blocks → LTI Tool Providers
  2. Click Register Provider Domain
  3. Provider Domain: preparebuddy.com
  4. Provider Domain Status: Approved
  5. Default Configuration: Set to Yes
  6. Send User Data: Both User Name and Email Address
  7. Send Role: Yes
  8. Consumer Key: (provided by PrepareBuddy)
  9. Shared Secret: (provided by PrepareBuddy)
  10. Click Submit

Moodle

  1. Navigate to Site Administration → Plugins → Activity Modules → External Tool
  2. Click Manage Tools
  3. Configure Tool Manually:
  4. Tool Name: PrepareBuddy
  5. Tool URL: https://preparebuddy.com/lti/launch/
  6. Consumer Key: (provided by PrepareBuddy)
  7. Shared Secret: (provided by PrepareBuddy)
  8. Custom Parameters: user_email=$Person.email.primary
  9. Privacy Settings:
  10. Share launcher's name with tool: Always
  11. Share launcher's email with tool: Always
  12. Accept grades from the tool: Always
  13. Click Save Changes

D2L Brightspace

  1. Navigate to Admin Tools → External Learning Tools
  2. Click New Link
  3. Link Configuration:
  4. Title: PrepareBuddy
  5. URL: Use configuration URL method
  6. Configuration URL: https://preparebuddy.com/lti/config/
  7. Key: (provided by PrepareBuddy)
  8. Secret: (provided by PrepareBuddy)
  9. Security Settings: Use default settings
  10. Click Save and Close

Google Classroom

  1. Navigate to Admin Console → Apps → Additional Google Services
  2. Find Classroom Add-ons and enable it
  3. Contact PrepareBuddy support for Google Classroom-specific setup instructions
  4. Our team will provide you with the necessary OAuth configuration

Testing Your Setup

After configuration, test the integration:

1. Create Test Course

Create a test course with a few sample students (or use sandbox/test accounts).

2. Add PrepareBuddy Assignment

  1. Create a new assignment
  2. Set Submission Type to "External Tool"
  3. Select "PrepareBuddy" from the available tools
  4. Set Points Possible (e.g., 100)
  5. Save Assignment

3. Test Student Experience

  1. Student Login: Have a test student log into the LMS
  2. Click Assignment: Student should be redirected to PrepareBuddy
  3. Account Verification: Verify the student sees their real email address
  4. Complete Activity: Have student complete a quiz or test
  5. Grade Verification: Check that grade appears in LMS gradebook within 1 minute

4. Expected Results

✅ Student launches PrepareBuddy without additional login
✅ Student sees existing PrepareBuddy account (if they have one)
✅ Quiz/test scores automatically appear in LMS gradebook
✅ Scores are accurate and timely

Security Configuration

Required Settings

  • HTTPS: Always use HTTPS in production
  • Domain Restriction: Restrict to preparebuddy.com domain
  • Grade Passback: Enable to receive automatic grades
  • User Information: Enable sharing name and email for account linking
  • Privacy Level: Public (allows proper account linking)
  • Launch in New Window: Optional (iframe launch is supported)
  • Custom Parameters: Enable for enhanced account linking

Troubleshooting Common Setup Issues

"Tool Not Available" Error

Cause: Tool not properly installed at course level
Solution: Install PrepareBuddy at the account/institution level, not just course level

"Invalid Consumer Key" Error

Cause: Consumer key doesn't match between LMS and PrepareBuddy
Solution: Verify exact match of consumer key (case-sensitive)

"Launch Fails with 400 Error"

Cause: Missing required parameters
Solution: Ensure privacy settings allow sharing name and email

"Grades Not Syncing"

Cause: Grade passback not enabled
Solution: Enable "Accept grades from tool" in your LMS configuration

"Students See Wrong Account"

Cause: Email not being passed correctly from LMS
Solution: Verify privacy settings and custom parameters for email sharing

Advanced Configuration

Custom Parameters

Add these custom parameters for enhanced functionality:

user_email=$Person.email.primary
canvas_user_login_id=$Canvas.user.loginId
user_full_name=$Person.name.full
course_id=$CourseSection.sourcedId

Institution-Level Deployment

For large institutions:

  1. Install at Account Level: Configure PrepareBuddy at the institution level
  2. Default Settings: Set up default configurations for all courses
  3. Training Materials: Provide teacher training on creating assignments
  4. Support Documentation: Share our teacher and student guides

Multiple Environment Setup

If you have multiple environments (test, staging, production):

  1. Request Multiple Keys: Contact support for environment-specific credentials
  2. Separate Configurations: Use different consumer keys for each environment
  3. Testing Protocol: Always test in lower environments before production deployment

Monitoring and Maintenance

Regular Checks

  • Monthly: Verify tool is still accessible and functioning
  • Semester Start: Test with new courses and students
  • After LMS Updates: Verify integration still works after LMS platform updates

Logging and Monitoring

  • LMS Logs: Monitor your LMS logs for LTI-related errors
  • PrepareBuddy Logs: We monitor our side and can provide reports upon request
  • Student Feedback: Monitor for student access issues

Support Escalation

If you encounter issues:

  1. Level 1: Check our troubleshooting guide
  2. Level 2: Email support@preparebuddy.com with:
  3. LMS platform and version
  4. Error messages or screenshots
  5. Steps to reproduce the issue
  6. Level 3: Phone support at 1-800-PREPARE for urgent issues

Success Metrics

After successful setup, you should see:

  • 95%+ Launch Success Rate: Students can consistently access PrepareBuddy
  • Automatic Account Linking: Students see their real email addresses
  • Real-time Grade Sync: Grades appear in LMS within 10 seconds
  • Minimal Support Tickets: Few student access issues
  • Universal Compatibility: Same experience across all courses

Next Steps

Once setup is complete:

  1. Teacher Training: Share our Teacher Workflow Guide
  2. Student Communication: Share our Student Experience Guide
  3. Feature Documentation: Review available PrepareBuddy Features
  4. Support Resources: Bookmark our Troubleshooting Guide

Contact Support

  • Email: support@preparebuddy.com (< 24 hour response)
  • Phone: 1-800-PREPARE (1-800-773-7273)
  • Live Chat: Available at preparebuddy.com during business hours
  • Documentation: Complete technical documentation at docs.preparebuddy.com

Your successful integration helps create a seamless learning experience for students and reduces administrative overhead for instructors.

Tags
setup administrator configuration credentials
On this page
Quick actions
Back to Administrator Setup Edit this page Get help