Sakai Admin Setup

If you are planning to conduct testing, we welcome you to do so in our testing environment, staging.perusall.com.  Staging is only for testing and should not contain any real course or student data.

Disclaimer: Data on staging may be removed at any time.
 

Step 1: Install Perusall 1.3

To set up Perusall as a tool in your Sakai instance, navigate to Admin Home > Worksite Setup > Administration workspace > External Tools, and select Install LTI 1.x Tool.

Fill out the following fields as shown below, and then click Save changes.

• Tool Title: Perusall
• Allow tool title to be changed: Allow.
• Allow custom icon to be changed: Do not allow.
• Button Text: Perusall
• Allow button text to be changed: Allow.
  • Description: The Perusall social learning platform.
• Tool Status: Enabled.
• Tool Visibility: Visible.
• Launch URL:

  • https://app.perusall.com/ltia/launch

• Allow launch URL to be changed: Do not allow.
• Allow launch key to be changed: Do not allow.
• Allow launch secret to be changed: Do not allow.
• Allow frame height to be changed: Do not allow.
• Configuration dialog when tool is selected: Bypass configuration dialog.
• Privacy Settings:
  • Send User Names to External Tool: Enabled.
  • Send Email Addresses to External Tool: Enabled.
• Services:
  • Allow External Tool to return grades: Enabled.
  • Allow External Tool to create grade columns: Enabled.
  • Provide Roster to External Tool: Enabled.
  • Allow External Tool to store setting data: Enabled.
• Tools can generally accept direct LTI Launches or a Content-Item / Deep-Link Selection launches. It is not common, but some tools can handle both types of launch at one endpoint.
  • The tool URL can receive an LTI launch: Enabled.
  • The tool can receive a Content-Item or Deep-Link launch: Enabled.
• Indicate where these tools are placed in Sakai.
  • Allow the tool to be selected from Lessons: Enabled.
  • Allow the tool to be one of the assignment types: Enabled.
  • Allow the tool to be placed in site-level navigation: Enabled.
• Launch in Popup: Always launch in Popup
• Debug Launch: Never launch in debug mode
• If you select LTI 1.3 support while inserting a tool, after the tool is saved, you will be presented the Sakai configuration information information to copy back to the tool. You can view this information in the tool view screen if you edit the tool information.
  • Tool supports LTI 1.3
• LTI 1.3 Tool Keyset URL (provided by the tool)

  • https://app.perusall.com/ltia/jwks

• LTI 1.3 Tool OpenID Connect/Initialization Endpoint (provided by the tool)

  • https://app.perusall.com/ltia/oidc

• LTI 1.3 Tool Redirect Endpoint(s) (comma separated and provided by the tool)

  • https://app.perusall.com/ltia/launch

• Type of LTI 1.1 Launch to Use: Inherit System-Wide Default.
• Press Save.

Click on the Perusall Title to reveal the tool details.  Save these for the next (and final step):

Step 2: Add your LTI Platform through the Institution Dashboard

Please follow the steps below to finalize your integration by adding the Perusall LTI 1.3 tool information from your LMS to our list of LTI Platforms using your Institution Dashboard. 

• Register for an account.

• Contact Perusall support, and point us to an institutional web page that shows your name, email address and title/affiliation.

  If you are using staging.perusall.com, please register for a staging account, provide the verification details above, and when you contact Perusall support, please let us know you'd like access to the Staging institution dashboard.

• Once Perusall has confirmed your request, you will see Institution Dashboard on your Perusall home page (to the left of Get Help), and you can navigate to Settings > LTI 1.3 integrations > Add a new LTI 1.3 integration.  Select your LMS type (Sakai), and insert your:
  • LTI 1.3 Issuer for this Platform
  • LTI 1.3 Client ID
  • LTI 1.3 Platform OIDC Authentication URL
  • LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL
  • LTI 1.3 Platform OAuth2 Well-Known/KeySet URL
  • Deployment ID (default is 1 unless you've replaced it)
• Click Ok to finalize your placement, and Save Changes. 

Learn more about your Institution dashboard features.

How can I test the integration?

Once your credentials have been entered into our platform list, you can test the integration by following Sakai Instructor Setup & Sakai Integration Features.

LTI 1.3 courses offer a new grade sync feature: LMS gradebook column management.  Learn more about grade sync in LTI 1.3 courses. 

For a full list of frequently asked questions regarding our LTI 1.3 integrations, see 1.3 FAQ.

Please whitelist messages coming from @perusall.com and @mg.perusall.com to ensure users are able to receive our emails.