Last updated: April 21, 2023.
LTI 1.3 Integration
The Class Blackboard LTI integration can be done in three stages:
- Creating the integration and registering it
- Adding a placement for the tool
- Launching Class from the LMS
The initial stage in configuring an LTI 1.3 integration involves creating a fresh integration in the Class Admin Portal and registering it in the Bb Developer’s Portal. Regardless of the placement of your preference or whether you are conducting traditional or UEF courses, all Bb/Class integrations must follow these steps.
Stage One: Instructions for creating and registering the LTI 1.3 integration
For the creation and registration of your LTI integration, you will need to login to your Class Admin Page and the Blackboard’s Developer Portal
1.
Navigate to the Class Admin Page for your organization by going to: https://SUBDOMAIN.class.com/react/adminsettings and replacing “subdomain” with the subdomain that was set up for your organization upon implementing Class. Login, then select the integrations menu item on your left. Note: You must have admin permissions.
2.
Locate and press the Create button at the top right corner to create a new LTI Integration.
3.
Provide an integration name. This name is only to designate the integration instance within the Admin panel and is not externally visible. Select Blackboard as the LMS from the dropdown menu. Choose the LT1 1.3 option.
4.
Click the Next button. Keep this browser tab open and open a new browser tab. We will be copying data back and forth between Class and Blackboard.
5.
In the new Browser Tab go to Blackboard’s Developer Portal: http://developer.blackboard.com/
6.
Sign Up for an account or Log In if you already have one
7.
Once logged in, click Register a Rest or LTI application
8.
Fill in Application Name (that will be the Tool Name that you will see in Bb)
9.
Fill in Description
10.
Go back to the Class Admin Portal and copy the OIDC Initiate Login URL
11.
Paste the OIDC Initiate Login URL into the Domain textbox, erasing the https:// and everything after class.com (/v1/lti-launch/redirect)
12.
Toggle On the “My Integration supports LTI 1.3” option
13.
Paste the Login Initiation URL (that corresponds to the Class Admin Portal: OIDC Initiate Login URL), you should still have it in your clipboard.
14.
Refer back to the Class Admin Portal and use the copy function to copy the Tool Redirect URL and paste it into the Tool Redirect URL(s) field in Bb
15.
Refer back to the Class Admin portal and use the copy function to copy the JWKS URL and paste it into the Tool JWKS URL field in Bb
16.
Signing Algorithm field in Bb remains as RS256
17.
Click the Register Application button to complete the LTI 1.3 configuration.
18.
On the next page copy the Application key.
19.
Go back to the Class Admin Page and paste it on the Learn App Key text box.
20.
Switch between Bb and Class to copy/paste the following fields:
-
- From Bb, copy Secret, paste into the Class Admin Portal Learn App Secret field
- From Bb, copy the Application ID, paste into the Class Admin Portal Client ID field
- From Bb, copy OIDC auth request endpoint, paste into the Class Admin Portal OIDC Authentication Endpoint field
- From Bb, copy the Auth token endpoint, paste into the Class Admin Portal OAuth2 Token Endpoint field
- Do not copy the Public keyset URL from Bb yet
21.
On the Bb developer site, click DONE
22.
Select your application, click on the ellipsis and Edit
23.
From Bb, copy the Public keyset URL, paste into the Class Admin Portal Blackboard JWKS Endpoint field.
24.
On the Class Admin Page click the Save button
Stage Two: Tool Placements in Bb Learn
After creating the integration, you will need to set up the Class LTI 1.3 placements in Blackboard Learn. Blackboard Learn enables the addition of placements at either the Developer’s Portal level or at the Blackboard Admin Panel level. Placements at the Developer’s Portal level will be identical for all Bb Learn instances when the tool is added, and placements at the Blackboard Admin Panel level will be determined at the Blackboard Learn instance level.
This documentation will go over three different placement options for the Class app
- Option 1 : adding the Class App as a Bb course tool on the Developer’s Portal
- Option 2 : adding the Class App as a course tool on the Bb Admin Panel
- Option 3 : adding the Class App as an extension in a UEF course
Blackboard Learn allows for placements to be added at the Developer site level, which means that every time the tool is added to a Learn instance it will have the same placements; or at the Blackboard Admin Panel level, which means that placements will be determined at the Blackboard instance level.
Option 1: Instructions for adding the Class App as a Bb course tool on the Developer’s Portal
(registering a placement that will appear in all Bb instances)
1.
On the Bb developer site, click on your application’s ellipsis menu (…)
2.
Select Manage Placements
3.
Click Register
4.
Add Placement Name (i.e. Class for Zoom)
5.
On the Type label, select Course Tool from the drop down menu
6.
Check Allow students access
7.
Refer to the Class Admin Panel and under your integration, copy the redirect-url
8.
Paste it on the Target link URI
9.
10.
Click on the Register Placement Button
11.
Open another tab with the Bb admin panel
12.
Select LTI Tool Providers
13.
Click Register LTI1.3 Advantage Tool
14.
Go back to the Bb Developer Site, click on My Applications from the top menu, and copy the Application ID
15.
On the Bb Administrator Panel, paste the Application ID inside the Client ID textbox
16.
Click Submit
17.
Scroll down and on the Tool Status, select Approved and click the Submit button
18.
Verify that Role in Course, Name and Email Address are checked
19.
You will get a success message
Option 2: Instructions for adding the Class App as a course tool on the Bb Admin Panel
(registering a placement at the instance level)
1.
Open a tab with the Bb admin panel
2.
Select LTI Tool Providers.
3.
Click on the arrow next to your tool’s name and select Manage Placement
4.
Click the Create Placement button
5.
Add the Label (this will be visible in the course), the handle (unique id for the placement), and select Availability to Yes
6.
Select Course content tool
7.
To get the Target Link URI, refer to the Class Admin Panel and copy the redirect-url.
8.
Go back to the Bb Admin Panel and paste it into Target Link URI
9.
Click the Submit button
Option 3: Instructions for adding Class as a left menu tool in Ultra courses (leveraging the Ultra extension placement)
To add the Class App as an Ultra Extension you will need to:
- Step 1: Create a REST API Integration
- Step 2: Register an Ultra Extension placement at the instance level on the Bb Admin Panel
- Step 3: Register a Course Content Tool placement at the instance level on the Bb Admin Panel
Premium API access is needed for this configuration, more information here: https://docs.anthology.com/rest-apis/learn/uef/requesting-premium-apis .
Step 1 : Create REST API Integration
1.
Open a tab with the Bb admin panel
2.
Select REST API Integrations
3.
Click Create Integration
4.
On the Bb developer site, copy your application’s ID
5.
Go back to the Bb Admin Panel and paste it in the Application ID textbox
6.
Click the Browse… button to add a Learn User that has admin access to your Bb learn instance
7.
Allow End User Access
8.
Set Authorize To Act As User to yes
9.
Click Submit
10.
Make your integration available
Step 2 : Register an Ultra Extension placement at the instance level on the Bb Admin Panel
1.
Open a tab with the Bb admin panel
2.
Select LTI Tool Providers
3.
Click on the arrow next to your tool’s name and select Manage Placement
4.
Click the Create Placement button
5.
Add the Label (this will be visible in the course)
6.
Add the handle, the handle will need to be class-uef-placement. To ensure proper functioning of the placement, it is crucial to accurately copy the handle as described.
7.
Select Availability to Yes
8.
Select Type as Ultra Extension
9.
To get the Target Link URI, refer to the Class Admin Page and copy the redirect-url.
10.
Go back to the Bb Admin Panel and paste it into Target Link URI erasing everything after class.com and adding /v1/lti/learn-uef
11.
Click the Submit button
Step 3: Register a Course Content Tool Placement
1.
Open a tab with the Bb admin panel
2.
Select LTI Tool Providers
3.
Click on the arrow next to your tool’s name and select Manage Placement
4.
Click the Create Placement button
5.
Add the Label (this will be visible in the course)
6.
Add the handle, the handle will need to be: class-course-content-placement. To ensure proper functioning of the placement, it is crucial to accurately copy the handle as described.
7.
Select Availability to Yes
8.
Select Type as Course Content Tool
9.
To get the Target Link URI, refer to the Class Admin Page and copy the redirect-url.
10.
Go back to the Bb Admin Panel and paste it into Target Link URI erasing everything after class.com and then adding /v1/lti/course
11.
On Icon URL paste: https://class-test.blackboard.com/public/blti_icons/_110_1/cropped-class-favicon_1-192×192.png
12.
Click the Submit button
Stage Three: Launching Class from the LMS
Once you have successfully registered the placement, you will need to launch the Class from the LMS. To accomplish this, you must enter a course where you are an instructor. It’s important to note that the first instructor who clicks on the LTI link will initiate the creation of the Class session and will become its owner. The method for launching the Class may vary based on the placement that you have selected.
Launch Class as a Course Tool in an Ultra Course View
Follow these steps for launching Class if you added the app as a Course Tool (either at the Developer´s Site level or the Bb Admin Panel level) and you have an Ultra Course View
1.
Click View course and Institution Tools
2.
Click Class for Zoom
Launch Class as a Tool Link in an Original Course View
Follow these steps for launching Class if you added the app as a Course Tool (either at the Developer´s Site level or the Bb Admin Panel level) and you have an Original Course View
1.
Click on the plus sign, tool link
2.
Add a Name, under Type choose Class for Zoom (or the name you gave to the Class tool)
3.
Select Available to Users and Click the Submit button
4.
Click on the Tool Link that you just created
Launch Class as an Ultra Extension in an Ultra course view
Follow these steps for launching Class if you added the app as an Ultra Extension
1.
Click the link for Class that appears on your left hand menu inside a course
Instructions for LTI 1.1
Please note: Below will display the steps on how to set up a new LTI 1.1 integration.
1.
Go to your Class Administrator settings. Login and then select the Integrations tab.
Note: You must have Class Admin access and permissions.
2.
Click the Create button.
3.
Provide an Integration Name. This name is only to designate the integration instance within the Admin panel and is not externally visible. Select Blackboard as the LMS from the dropdown menu. Choose the LT1 1.1 option.
4.
Copy the URL
5.
Keep this browser tab open and open a new browser tab. We will be copying data back and forth between Class and Blackboard.
6.
On the new tab go to the Bb admin panel
7.
Select LTI Tool Providers.
8.
Click Manage Global Properties.
9.
Under Default Configuration, make sure that Send user data only over SSL is selected
10.
Verify that the User Fields to Send are on for Role in Course, Name and Email Address.
11.
And check that Allow Membership Service Access is set to Yes
12.
Click Submit
13.
Click Register LTI 1.1 Provider
14.
Paste the URL (that you copied from the Class Admin Panel) into the ProviderDomain textbox, erasing the http:// and everything after class.com (/lti-launch/redirect)
15.
Copy the Consumer Key from the Class Admin Panel
16.
Paste it into the Tool Provider Key
17.
Copy the Shared Secret from the Class Admin Panel
18.
Paste it into the Tool Provider Secret
19.
Configure Send User Data
20.
Configure User Fields to Send
21.
Configure Allow Membership Service Access and Click Submit
Setup Class LTI 1.1 in LMS:
1.
Open a tab with the Bb admin panel
2.
Select LTI Tool Providers
3.
Click on the arrow next to your tool’s name and select Manage Placement
4.
Click the Create Placement button
5.
Add the Label (this will be visible in the course), the handle (unique id for the placement), and select Availability to Yes
6.
Select Course content tool
7.
To get the Target Link URI, refer to the Class Admin Panel and copy the URL
8.
Go back to the Bb Admin Panel and paste it into Target Link URL and click the Submit button.
Contact our Support Team
Support Number: 888-975-1112 | 24/7 End-user support | Premium SLA: 24 hours | Standard SLA: 72 hours
Class Support Services Guide