Tool deployment

Deployments allow sharing of registered tools in Brightspace to specific org units or decedents of parent org units. When deploying a tool you specify the extensions available, along with all the applicable security settings.

You can access the deployments in a few ways. After registering a tool, a pop-up message confirms your new learning tool details. In the pop-up message there is a View Deployments button, and contains the following fields:

  • Client Id: The ID used in OAuth2 authentication to make requests to the services (Names and Roles, Assignment and Grade)
  • Brightspace Keyset URL: Where Brightspace keys are stored. Tools require this during the registration and are used during launch (D2L signs the launch message and the tool validates D2L's signature with this)
  • Brightspace OAuth2 Access Token URL: Where tools go to retrieve new access tokens for OAuth2 service requests
  • OpenId Connect Authentication Endpoint: The end point where Brightspace sends the login response to
  • Brightspace OAuth 2 Audience: The intended recipient of the token
  • Issuer: The URL of the Brightspace instance; Tool validates that we set this as the issuer when we sign our launch message
  • A check box is available to allow LTI Administrators to set if all links below that level are automatically set to Open as External Resource.

Users will see the same button if they click to edit or view a registration that already exists. Users can also access all deployments by accessing the org-level External Learning Tools page, under the LTI Advantage tab:

Once the tool is successfully deployed, you receive a Deployment Id. This is a GUID-based globally unique ID for this specific deployment. It is used to uniquely reference this specific deployment of a registered tool, and may be required by the tool during setup.

Registered tools can have multiple deployments. Each individual deployment can be unique, supporting the ability for different LTI extensions and Security Settings per deployment. But the key piece is that a deployment is what shares the learning tool to courses. You will see the usual Add Org Units sharing button at the bottom of the creation screen for deployments; this is how your new tool is made available to your courses.

Substitution and Custom Parameters can also be created at the Deployment level and cascade down to the link level. If parameters are created at the Registration level, they are visible at the Deployment and link levels, but are greyed out and not editable. If a parameter is created at both the Registration and Deployment level, the Deployment parameter is used in the LTI launch.

Creating the LTI Links

Once you successfully create a tool, you need to create the LTI links. Links can be created for use in the org unit(s) from the deployment, or users with permissions can create individual links at the org level where the tool is deployed to. In cases where a tool requires multiple LTI links to be created per course/for many courses, the tool would provide a deep linking workflow to enable users to quickly and easily create the links.

Most integrations create the LTI links via deep linking for you. But on occasion you may need to create an LTI link manually, known as an ad-hoc link. You can create these in two ways:

1. From the deployment page of a newly deployed tool, by clicking View Links.

Note: Links created for a deployment appear in all courses the deployment is shared to.

Substitution and Custom Parameters can also be created at the Link level. If parameters are created at the Registration or Deployment level, they are visible at the link level, but are greyed out and not editable. If the same parameter is created at the Registration, Deployment and link level, the link parameter is used in the LTI launch.

2. Directly from the External Learning Tool page in a course, under LTI Advantage, you can add new links. Items highlighted and clickable in blue are links you can edit created at the course level. Greyed out link names are links created at the deployment level and cannot be edited at the course level. Note that ad-hoc links created at the org unit will not be visible from the deployment level.

Note: The following workflows result in a link defaulting to Open as External Resource regardless of the Deployment setting:

  • Lessons experience - if a link is added from Content > Existing Activities > External Learning Tools
  • Brightspace Editor: Quicklinks created via CIM