Register your Pressbooks Network as an LTI Tool

We are currently rolling out a new version of the LTI Content Integration. This chapter applies to networks using the new Pressbooks LTI plugin. For networks using the Pressbooks Results for LMS plugin, please refer to this part of the guide.

The easiest method to register your Pressbooks network as an LTI tool in your LMS is by using dynamic registration. At the time of writing, Moodle, D2L Brightspace, and Blackboard support dynamic registration. Canvas supports a JSON URL method that simplifies LTI configuration too. In this chapter, we describe how you can register your Pressbooks network as an LTI tool in each supported LMS: Canvas, Moodle, Blackboard, and D2L Brightspace.

Canvas

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
    2. Under Method select ‘Enter URLDropdown menu for selecting the configuration method
    3. In the JSON URL field, write https://[PRESSBOOKS DOMAIN]//format/lti/config (replacing the domain with the domain of your Pressbooks network)
    4. Click Save.
    5. 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)
    6. Navigate to Settings in the left sidebar menu.
      • Click Settings > Apps > + App.
      • Choose By Client ID as configuration type and enter the Client ID of the Developer Key (from the previous step). Click Submit.
        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 1.3 Platforms > Add new. Network managers can access this page directly at https://[PRESSBOOKS DOMAIN]/wp/wp-admin/admin.php?page=pb_lti_platforms (replacing the domain with the domain of your Pressbooks network)
      2. You will see a form with several expected field values: LTI Platform form in Pressbooks. See information below.
        Enter the following information in the form fields. Replace [CANVAS DOMAIN] with the URL of your Canvas instance [i.e. canvas.university.edu]:
        • Client ID: Client ID from LTI 1.3 ‘Developer key’ from Canvas (see step 6 in the previous section)
        • Audience: https://canvas.instructure.com (Note: always use https://canvas.instructure.com as the value for the Audience field, even when your institution hosts a 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 case the Audience value will be https://canvas.test.instructure.com or https://canvas.beta.instructure.com, respectively. The next values on this form use the URL of your actual Canvas domain, however.)
        • OIDC Auth URL: https://[CANVAS DOMAIN]/api/lti/authorize_redirect
        • Auth2 token URL: https://[CANVAS DOMAIN]/login/oauth2/token
        • Key set URL (Platform): https://[CANVAS DOMAIN]/api/lti/security/jwks
        • Deployment ID(s): Canvas application deployment ID or IDs (stored in step 4 of the previous section)
      3. Make sure to set the LTI Platform to Active.
        'Active' setting with checkbox selected.
      4.  Click Save Changes.

     

    Moodle

    In Moodle

      1. Log as an administrator and go to: Site Administration > Plugins > Manage tools
      2. In the Add Tool box, input the following tool URL:
        https://[PRESSBOOKS DOMAIN]/format/lti/registration
      3. Then, press the Add LTI Advantage button.
      4. You will see the following message:
        "You are about to register a Pressbooks network as a new LTI tool. Click the register button below to confirm:"
      5. Click Register and you should see a success message noting that to use this tool registration, a network manager must activate the platform in Pressbooks.
      6. Click Close and you will be returned to the ‘Manage Tools’ page.
      7. While still in Moodle, you also need to activate the newly added LTI tool. You will see the tool on the ‘Manage Tools’ page (with your Pressbooks network URL in the description):
      8. Click the Activate button.

    In Pressbooks

    1. In Pressbooks, go to: Administer Network > Integrations > LTI 1.3 Platforms. Alternatively, network managers can access this page directly at
      https://[PRESSBOOKS DOMAIN]/wp/wp-admin/network/admin.php?page=pb_lti_platforms
    2. You will see a new entry for your Moodle instance. Hover your cursor over it and click Edit.
    3. Check the Active checkbox.
    4. Click Save Changes. The connection is now configured.

     

    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 Membership Service Access: Yes
      4. Click Submit

    In Pressbooks

    1. In Pressbooks, go to: Administer Network > Integrations > LTI 1.3 Platforms. Alternatively, network managers can access this page directly at
      https://[PRESSBOOKS DOMAIN]/wp/wp-admin/network/admin.php?page=pb_lti_platforms
    2. You will see a new entry for your Blackboard instance. Hover your cursor over it and click Edit.
    3. Paste the Deployment ID value from the previous step in Blackboard into the Deployment Id(s) field.
    4. Ensure the checkbox for Active is checked.
    5. Click Save Changes. The connection is now configured.

 

D2L Brightspace

In Brightspace

    1. Navigate to the cogwheel icon in the top-right corner (‘Admin Tools’) and under ‘Organization related’ select Manage extensibility.
    2. Click LTI Advantage.
    3. Click the Register Tool button.
    4. Select the Dynamic option.
    5. In Tool initiation registration endpoint paste the following value: https://[PRESSBOOKS DOMAIN]/format/lti/registration
    6. Check the Configure Deployment box.
    7. Click Register.
    8. You will see the following message:  "You are about to register a Pressbooks network as a new LTI tool. Click the register button below to confirm:"
    9. Click Register and you should see a success message noting that to use this tool registration, a network manager must activate the platform in Pressbooks.
    10. Click Close and you will be returned to the list of LTI Advantage tools registered in Brightspace.
    11. Click the link to your newly added tool. Set it to Enabled and click the Save and Close button.

In Pressbooks

  1. In Pressbooks, go to: Administer Network > Integrations > LTI 1.3 Platforms. Alternatively, network managers can access this page directly at
    https://[PRESSBOOKS DOMAIN]/wp/wp-admin/network/admin.php?page=pb_lti_platforms
  2. You will see a new entry for your Brightspace/D2L instance. Hover your cursor over it and click Edit.
  3. Check the Active checkbox.
  4. Click Save Changes. The connection is now configured.

License

Icon for the Creative Commons Attribution 4.0 International License

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

Share This Book