32 Configuring the LTI 1.3 Plugin with your LMS

As a network manager, begin by visiting your LTI 1.3 settings page (click Network Admin > Integrations > LTI 1.3 Settings or visit https://[PRESSBOOKS DOMAIN]/wp-admin/network/admin.php?page=pb_lti_settings) and ensuring that you have a RSA Key Pair (public/private). Values should be generated and filled in for PressbooksEDU clients automatically upon activation of the plugin. If you do not see values in the RSA Public Key and RSA Private Key fields, please contact premium support. The private key should never be shared with anyone. You will need to exchange the corresponding public key with LMSes or other platforms you’d like to connect with.

Navigate to your LMS-specific instructions:

  1. Canvas
  2. Blackboard
  3. Moodle
  4. D2L/Brightspace

Canvas

We recommend that you begin by reading Canvas’ documentation for configuring an LTI 1.3/Advantage tool. Once you are familiar with the basic steps described there:

IN CANVAS

  1. Log into your Canvas account as an administrator and visit Admin > Site Admin > Developer Keys > + Developer Key > + LTI Key.
    LTI Developer Keys menu in Canvas
    LTI Developer Keys menu in Canvas

    You will see a menu with several required fields (screenshot below):

    LTI Key Configuration Menu in Canvas
    LTI Key Configuration Menu in Canvas
  2. Enter the following values into the required fields, replacing [PRESSBOOKS DOMAIN] with the root URL of your Pressbooks network (i.e. university.pressbooks.pub):
    • Redirect URIs: https://[PRESSBOOKS DOMAIN]/format/lti/launch
    • Target Link URI: https://[PRESSBOOKS DOMAIN]/format/lti/launch
    • OpenID Connect Initiation Url: https://[PRESSBOOKS DOMAIN]/format/lti/login
    • JWK Method: Select ‘Public JWK’. Open a new tab in your browser and go to: https://[PRESSBOOKS DOMAIN]/format/lti/public_jwk. This page will display a value that looks something like:
      {"keys":[{"kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"sR53yGj4JjY6BLpUACKiP36m2ejHrAJiBNnndskdkUkmAZBL7LAzqW_kEBh3P2yjyssHFlLfmMGwIAgAqHGIcVjRdJ_gRn28ZgnLynVdvzhFPanxxp2vfmWt7t08tenH-72ovlRQxOSNrDw4Y878142mE5UclG8hl_oubIc1gsSbLO548BkT0VVG--yWaKy8YG3b0XKzAphaOZEIk02Hdn13hPCStS4LM5Pv5lhIgOOZ89B-ZYM2zvhLBBBGBsHKyIn6GD_kSrEsiXUFsi8YPhfkKqa9YC5ifVr97Q5PLcVrUZ16XgLyD0joJXEv6ceCRY1uJh4U4QZZY4lo8vcHhw","kid":"pressbooks"}]} Enter the value inside the square brackets on your network’s public_jwk page into Canvas’ “Public JWK” field. In the example above, the expected value would be only the part that has been bolded. Do not use the actual value above (it’s only an example) when configuring your network in Canvas; use the relevant part of the value that appears on your network’s /format/lti/public_jwk page.
    • LTI Advantage Services: Enable all desired toggles. If you intend to use Pressbooks to create graded assignments, we recommend that you select at least ‘Can create and view assignment data in the gradebook associated with the tool.’; ‘Can view assignment data in the gradebook associated with the tool.’; ‘Can view submission data for assignments associated with the tool.’; ‘Can create and update submission results for assignments associated with the tool.’; ‘Can retrieve user data associated with the context the tool is installed in.’ and ‘Can update public jwk for LTI services.’
    • Additional Settings: Enter your [PRESSBOOKS DOMAIN] as the Domain value (i.e. university.pressbooks.pub) and change the ‘Privacy Level’ to “Public”. This will allow Pressbooks to receive username and email values from the LMS, which avoids the creation of duplicate accounts for existing users and makes sure that users created via LTI can be identified within the Pressbooks platform.
      Additional settings menu for Canvas LTI 1.3 tool setup
    • Placements: There are no required placements for the Pressbooks LTI 1.3 plugin. If you’d like to allow instructors to manually create LTI links or graded assignments for individual chapters, rather than using the Common Cartridge import method, you should add ‘Link Selection’ and ‘Assignment Selection’ as placement options.
      Recommended placements in Canvas
  3. Make sure the state of the tool is set to ON. Store the client ID value visible in the Details column of your new key for the next step.
    Client ID value visible in Canvas unter the 'Details' Column
    The Client ID value for an LTI 1.3 application (visible in Canvas under the ‘Details’ Column)
  4. In Canvas, go to the account, subaccount, and/or course that you’d like Pressbooks to be available in as an LTI 1.3 app.
    • Click Settings > Apps > + App.
    • Choose By Client ID as configuration type and enter the Client ID of the Developer Key (from the previous step).
      Add an app menu from Canvas
      The location you should enter the Client ID of your LTI tool is shown above
    • Store and save your deployment ID(s) for the next step.
      Sample Deployment ID for an LTI 1.3 app configured in Canvas
      Sample Deployment ID for an LTI 1.3 app configured in Canvas

IN PRESSBOOKS

  1. In Pressbooks, go to Network Admin > Integrations > LTI Consumers > Add new. Network managers can access this page directly at https://[PRESSBOOKS DOMAIN]/wp-admin/network/admin.php?page=pb_lti_consumers&action=new
  2. You will see a form with several expected field values:
    New LTI Consumer menu in Pressbooks
    New LTI Consumer menu in Pressbooks

    Enter the following information in the form fields. Replace [CANVAS DOMAIN] with the URL of your Canvas instance [i.e. canvas.university.edu]:

    • Platform root URL: https://canvas.instructure.com (This value will always be used as the platform rootl URL for production instances of Canvas, even if your institution hosts their Canvas instance at a domain that you control. The only exceptions are if you are configuring Pressbooks on a test or beta instance of Canvas, in which cases the platform root url will be https://canvas.test.instructure.com or https://canvas.beta.instructure.com, respectively.)
    • Client ID: Client ID from LTI 1.3 ‘Developer key’ from Canvas (see step 3 in the previous section)
    • Auth login URL: https://[CANVAS DOMAIN]/api/lti/authorize_redirect
    • Auth token URL: https://[CANVAS DOMAIN]/login/oauth2/token
    • Key set URL: https://[CANVAS DOMAIN]/api/lti/security/jwks
    • Deployment ID(s): Canvas application deployment ID or IDs (stored in step 4 of the previous section)

Blackboard

Note: To configure Pressbooks as an LTI 1.3/Advantage tool with Blackboard, you will need a Client ID value, which will be provided by Pressbooks support staff. Contact premium support to receive this value if you do not already have it.

IN BLACKBOARD

  1. In Blackboard, click System Admin > LTI Tool Providers > Register LTI 1.3 Tool. Enter the [Client ID] value provided by Pressbooks support staff and click ‘submit’
  2. Copy the ‘Deployment ID‘ value for the newly registered tool. You will need this value to complete tool registration in Pressbooks. A sample value is shown below (you should use the value created in your Blackboard instance).
  3. Make sure the following values are selected:
    • Tool Status: Approved
    • User Fields to Send: Check Role in Course, Name, Email Address.
    • Allow grade service access: Yes
    • Allow Membership Service Access: Yes
  4. Click ‘Submit

IN PRESSBOOKS

  1. In Pressbooks, go to: Network Admin > Integrations > LTI Consumers > Add new. Alternatively, network managers can access this page directly at https://[PRESSBOOKS DOMAIN]/wp-admin/network/admin.php?page=pb_lti_consumers&action=new
  2. Enter the following values:
    • Platform root URL: https://blackboard.com
    • Client ID: Client ID value provided by Pressbooks support staff
    • Auth login URL: https://developer.blackboard.com/api/v1/gateway/oidcauth
    • Auth token URL: https://developer.blackboard.com/api/v1/gateway/oauth2/jwttoken
    • Key set URL: https://developer.blackboard.com/api/v1/management/applications/[CLIENT_ID]/jwks.json (replace CLIENT_ID with the Client ID value provided by Pressbooks support staff)
    • Deployment ID(s): Deployment ID value from Blackboard tool registration (step 2 of previous section)
      New LTI Consumer menu in PressbooksNew LTI Consumer menu in Pressbooks
  3. Click ‘Save Changes

This video shows the LTI 1.3 registration process from beginning to end for Blackboard:

Moodle

IN MOODLE

  1. Log as an administrator and go to: Site Administration > Plugins > Manage tools > configure a tool manually
    Configure a tool manually in Moodle menu
    Where to find the ‘configure a tool manually’ option in Moodle
  2. You will see a form with several requested fields.
    Moodle LTI 1.3 tool configuration menu
    Moodle LTI 1.3 tool configuration menu

    Fill the form out with the following values, replacing PRESSBOOKS DOMAIN with the root URL of your Pressbooks network (i.e. university.pressbooks.pub):

    • Tool name: Pressbooks LTI 1.3 (or similar)
    • Tool URL: https://[PRESSBOOKS DOMAIN]
    • LTI version: LTI 1.3
    • Public key: Copy and paste the public key from your Pressbooks installation located at Network Settings > LTI 1.3 settings or directly visible to network managers at https://[PRESSBOOKS DOMAIN]/wp-admin/network/admin.php?page=pb_lti_settings
    • Initiate login URL: https://[PRESSBOOKS DOMAIN]/format/lti/login
    • Redirection URI(s): https://[PRESSBOOKS DOMAIN]/format/lti/launch
    • Services:
      • IMS LTI Assignment and Grade Services: Use this service for grade sync and column management
      • IMS LTI Names and Role Provisioning: Use this service to retrieve members’ information as per privacy settings
      • Tool Settings: Use this service
    • Save changes
  3. Retrieve the tool connector information from your newly configured LTI 1.3 application in Moodle:
    LTI tool configuration menu in Moodle
    Where to find the LTI tool configuration menu in Moodle

    You will then see a set of values that you will use to configure the tool in Pressbooks:

    Sample LTI tool configuration in Moodle
    Sample LTI tool configuration details in Moodle
  4. [Only for Moodle versions prior to 3.9.0] Add client_id parameter to the login URL:
    • Edit the the tool configuration:
      Sample editing LTI tool created
    • Add ?client_id=<YOUR_CLIENT_ID> at the end of the Login URL:
      Add the client_id query parameter at the end of the Login URL

IN PRESSBOOKS

  1. In Pressbooks, log as a network manager and go to: Network Admin > Integrations > LTI Consumers > Add new. Network managers can access this page directly at https://[PRESSBOOKS DOMAIN]/wp-admin/network/admin.php?page=pb_lti_consumers&action=new
  2. You will see a new consumer form which requests several values to complete configuration. Enter the following values:
    • Connection Name: Moodle LMS (or similar)
    • Platform root URL: The Platform ID value provided by Moodle
    • Client ID: The Client ID value provided by Moodle
    • Auth login URL: The Authentication request URL value provided by Moodle
    • Auth token URL: The Access token URL value provided by Moodle
    • Key set URL: The Public keyset URL value provided by Moodle
    • Deployment ID(s): The Deployment ID value provided by Moodle

Desire2Learn/Brightspace

Jordan Snider from D2L/Brightspace has provided the following 5 minute demo video showing how to configure an LTI 1.3 tool in Brightspace:

In the Register a Tool section, these values are specific to the the institution. Therefore, the framework for the values you see on the video must be replicated, but using the your Pressbooks network URL (as in, your institutional URL would replace ‘integrations.pressbooks.network’ that you see in the demo video above).

That being said, these are the values you would input:
Domain: https://[PRESSBOOKS DOMAIN]
Redirect URIs: https://[PRESSBOOKS DOMAIN]/format/lti/launch
OpenID Connect URL: https://[PRESSBOOKS DOMAIN]/format/lti/login
Keyset URL: https://[PRESSBOOKS DOMAIN]/format/lti/public_jwk

License

Icon for the Creative Commons Attribution 4.0 International License

The Pressbooks Network Manager's Guide by Pressbooks is licensed under a Creative Commons Attribution 4.0 International License, except where otherwise noted.

Share This Book