Outcomes LTI 1.3 and Rest API for Blackboard LMS

This article provides instructions for configuring the Outcomes LTI 1.3 and REST API for Blackboard LMS. Outcomes for Blackboard LMS uses LTI 1.3 for secure user authentication and Blackboard LMS REST APIs for grade and data transfer between the LMS and Outcomes.

All LTI configuration steps in LMS must be completed by a Blackboard LMS system administrator with appropriate administrative privileges. The Target Link URI and INSTITUTIONID values are unique to each institution’s Outcomes environment and will be provided by your account team once Outcomes has been provisioned for your Blackboard LMS.

Set up Outcomes LTI Tool

Login to Blackboard LMS with an admin account.
Open the Admin screen, then select LTI Tool Providers.
Select Register LTI 1.3/Advantage Tool.
Change Client ID to de9b8b7f-60d2-40fa-a5c3-5502af3f8bc0.
Select Submit.
Select Yes for the Allow grade service access option.
Select Submit.

Note

All LTI configuration options in Blackboard LMS must done by a user with admin privileges. If your institution is an Evaluate user you may already have this LTI Tool added. Skip ahead to Add LTI Tool Placement(s)

System Tool

Navigate to the LTI 1.3 tool previously setup in the steps above in LTI Tool Providers named Anthology REST.LTI - A. If you previously set up an LTI connect with Evaluate you may see historical name Anthology Evaluate for LTI tool.

Table 1. Field Requirements

Label	Outcomes for Blackboard LMS
Description	optional field
Handle Handle uniquely identifies the placement. If Outcomes has multiple placements, create a unique Handle that identifies each placement.	Outcomes_Blackboard
Availability	Yes
Type	System Tool
Launch in New Window	Checked
Target Link URI	Target Link URI value will be unique to each institution and will consist of two parts. Follow the template below to create your own value: https://sampleuniversity.campuslabs.com/outcomes Your institution's URL should start with https:// and end with .com/outcomes.
Tool Provider Custom Parameters	user_name=@X@user.id@X@ realm={COPY/PASTE THE TARGET LINK URI FIELD}

Course Content Tool

Table 2. Field Requirements

Label	anthology-outcomes
Description	optional field
Handle Handle uniquely identifies the placement. This tool handle MUST be set to anthology-outcomes in order for UEF to work.	anthology-outcomes
Availability	Yes
Type	Course content tool
Launch in New Window	NOT checked
Target Link URI	Target Link URI value will be unique to each institution and will consist of two parts. Follow the template below to create your own value: https://sampleuniversity.campuslabs.com/outcomes Your institution's URL should start with https:// and end with .com/outcomes.
Tool Provider Custom Parameters	user_name=@X@user.pk_string@X@ course_identifier=@X@course.pk_string@X@ realm=https://outcomes-api.campuslabs.com/lti/{INSTITUTIONID}

Ultra Extension

Table 3. Field Requirements

Label	UEF Course Nav Link - Outcomes
Description	optional field
Handle Handle uniquely identifies the placement. If Outcomes has multiple placements, create a unique Handle that identifies each placement.	OutcomesCourseNav
Availability	Yes
Type	Ultra extension
Launch in New Window	NOT checked
Target Link URI	https://outcomes-api.campuslabs.com/lti/uef/{INSTITUTIONID}
Tool Provider Custom Parameters	user_name=@X@user.pk_string@X@ realm=https://outcomes-api.campuslabs.com/lti/uef/{INSTITUTIONID}

REST API Integrations Instructions

A REST API Integration must be added for both Anthology REST.LTI – A and Campus Labs Outcomes.

Procedure. Anthology REST.LTI – A

Go to Blackboard LMS System Admin Panel.
Select REST API Integrations.
Select Create Integration.
In the Application Id field, paste de9b8b7f-60d2-40fa-a5c3-5502af3f8bc0.
Select a user with administrator permissions as the Learn User.
Check Yes for Available, End User Access, and Authorized To Act As User.

Procedure. Campus Labs Outcomes

Go to Blackboard LMS System Admin Panel.
Select REST API Integrations.
Select Create Integration.
In the Application Id field, paste c38216d5-5709-4dd2-a909-251a06323a58.
Select a user with administrator permissions as the Learn User.
Check Yes for Available, End User Access, and Authorized To Act As User.