31 Configuring the LTI 1.3 Plugin

Configuring Pressbooks as an LTI Tool with Your LMS

As a network manager, you should 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.

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: Copy the JSON key value displayed in the “Keys” section and paste it in field “Public JWK”.
    • LTI Advantage Services: Enable all desired toggles
    • Additional Settings: Set 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 in Canvas
    • Placements: Enable any desired placements (i.e. Link Selection, Assignment Selection, etc.). If you intend to use Pressbooks to create graded assignments, make sure to add ‘Assignment Selection’.
  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
    • 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

In order to configure Pressbooks as an LTI 1.3/Advantage tool with Blackboard, you will need to be an LMS administrator on a production instance of Blackboard, or have created an account withe the appropriate permissions at https://developer.blackboard.com. Once you have appropriate permissions in an instance of Blackboard, follow the steps described to configure Pressbooks as an LTI 1.3 tool.

IN BLACKBOARD

  1. Log into Blackboard and add a new application by clicking My Applications > Add a new Application.
    Add an application in Blackboard
    Add an application in Blackboard
  2. Fill out the form with the following values, replacing PRESSBOOKS DOMAIN with the root URL of your Pressbooks network (i.e. university.pressbooks.pub):
    • Application Name: Pressbooks LTI 1.3 (or similar)
    • Description: Pressbooks LTI 1.3 tool (or similar)
    • Domain(s): [PRESSBOOKS DOMAIN]
    • Group: [Select your Blackboard account]
    • My Integration supports LTI 1.3: ON
    • Login Initiation URL: https://[PRESSBOOKS DOMAIN]/format/lti/login
    • Tool Redirect URL(s): https://[PRESSBOOKS DOMAIN]/format/lti/launch
    • Tool JWKS URL: https://[PRESSBOOKS DOMAIN]/format/lti/public_jwk
    • Signing Algorithm: RS256
      Register a new application in Blackboard with LTI 1.3 support enabled
      Register a new application in Blackboard with LTI 1.3 support enabled

      Once you have added your App you will see a modal displaying the App settings (Keep this browser tab open).

      New API Key screen in Blackboard
      New API Key screen in Blackboard
  3. In Blackboard, click System Admin > LTI Tool Providers > Register LTI 1.3 Tool. Fill out the form with the following values:
    • Client ID: Enter the [APPLICATION ID] from the previous step and click Submit.
    • Tool Status: Approved
    • User Fields to Send: Check Role in Course, Name, Email Address.
    • Allow grade service access: Yes
    • Allow Membership Service Access: Yes
    • Save the Deployment ID visible here as you will need it to complete the configuration in Pressbooks.
    • 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
    New LTI Consumer menu in Pressbooks
    New LTI Consumer menu in Pressbooks
  2. Enter the following values:
    • Platform root URL: Issuer value from step 2 in Blackboard
    • Client ID: Client ID value from step 2 in Blackboard
    • Auth login URL: OIDC auth request endpoint value from step 2 in Blackboard
    • Auth token URL: Auth token endpoint value from step 2 in Blackboard
    • Key set URL: Public keyset URL value from step 2 in Blackboard
    • Deployment ID(s): Deployment ID value from step 3 in 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

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 a brief 5 minute demo showing how to configure an LTI 1.3 tool in Brightspace:

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