How to: Configure Canvas Integration with Tegrity AAIRS

The Tegrity / Canvas integration is based on Basic Learning Tools Interoperability (Basic LTI). Basic LTI is a communication protocol defined by the IMS Global Learning Consortium; for more details about Basic LTI, visit http://www.imsglobal.org/lti/. Integrating Tegrity and Canvas consists of the following steps:

Each step is described below.

Create a Canvas External Tool at Account Level for Tegrity SSO Basic LTI Link

You will need the following information for this task:

  • TegrityCustomerNumber = unique Tegrity Customer Number for your Tegrity instance in the format of XXXX-XXXX-XXXX
  • TegrityIntegrationSharedSecret = unique Tegrity Shared Secret associated with the Tegrity Customer Number
  1. As an Admin, log into Canvas.
  2. Under Courses, click the account name link.
  3. Click ‘Settings’ link in the left navigation area.
  4. Click ‘External Tools’ tab.
  5. Click ‘Add External Tool’ button.
  6. On the Edit External Tool dialog, enter the following (without bullets):
    • Name:  Tegrity Recordings
    • Customer Key:  TegrityCustomerNumber
    • Shared Secret:  TegrityIntegrationSharedSecret
    • Match By:  URL
    • URL:  https://aairs.tegrity.com/Service/RedirectCMSLink.aspx
    • Privacy:  Public
    • Custom Fields / Parameters:
      • application_type=Tegrity
      • mapping=Canvas
      • courseid_parameter=lis_course_offering_sourcedid
      • userid_parameter=lis_person_sourcedid
  7. Description: Tegrity SSO Link
  8. Click ‘Save Tool Settings’ button.

NOTE: If the AAIRS authorization connector below includes “UserIdOrigin”:”3″, then the custom field/parameter “userid_parameter=lis_person_sourcedid” must be changed to “userid_parameter=custom_canvas_user_login_id”

 

Configure Tegrity AAIRS Integration with Canvas

You will need the following information for this task:

  • Canvas API access token – Click here for more information on obtaining an access token.

Authorization

  1. Login to your Tegrity instance as an admin.
  2. Click on the Manage AAIRS link under the Integration section.
  3. Click on the Edit link under the Authorization section.
  4. Drag the Canvas connector from the right column (Available Connectors) to the left column (Currently Used Connectors).
Canvas Connector - Click to enlarge

Canvas Authorization Connector – Click to enlarge

  1. Enter the following values in the Canvas Connector:
    • Title: Title for this connector (ex: Canvas BLTI)
    • Canvas FQDN: Your Canvas URL (omit http:// or https://)
    • Access Token:  The Canvas API access token you generated in Canvas
    • User Id Origin: Choose one of the following:
      • Internal – Use the Internal Canvas user ID
      • SIS – Use the user’s SIS ID
      • Note:  This requires that all users MUST have an SIS ID value set.)
      • Login – Use the user’s Canvas login ID
      • Note: This requires a change to the External Tool Custom Parameters and may require Tegrity make a change to your service.
    • Course Id Origin: Choose one of the following:
      • Internal – Use the Internal Canvas course ID
      • SIS – Use the course SIS ID
      • Note:  This requires that all courses MUST have an SIS ID value set.)
    • Secure Gateway: None
  1.  Click the Save button at the bottom of the Authorization section.
  2. Click Save & Continue at the bottom of the page.

Single Sign-On Interlinks

  1. Click on the Edit link under the Single Sign-On Interlinks section.
  2. Drag the Canvas connector from the right column (Available Connectors) to the left column (Currently Used Connectors).
Canvas SSO Connector - Click to enlarge

Canvas SSO Connector – Click to enlarge

  1. Enter the following values in the Canvas Connector:
    • Title: Title for this connector (ex: Canvas BLTI)
    • Canvas FQDN: Same as Authorization connector
    • Access Token:  Same as Authorization connector
    • Interlink Type: Tegrity
    • User Id Origin: Same as Authorization connector
    • Course Id Origin: Same as Authorization connector
    • Secure Gateway: None
  1. Click on the Advanced Filters button
    • Include everything, exclude nothing – Enable Tegrity link in every course
    • Exclude everything, include nothing – Do not add Tegrity link to any course
    • CSV Lists – Enable Tegrity link to courses specified in the text box or uploaded via CSV
Advanced Filters - Click to enlarge

Advanced Filters – Click to enlarge

  1. Click the Save button at the bottom of the Single Sign-On Interlinks section.
  2. Click Save & Continue at the bottom of the page.

 

Add the Tegrity External Tool to a Canvas Course Module

  1. As an Admin or as an Instructor, log into Canvas.
  2. Under Courses, click the desired course name link.
  3. Click the ‘Modules’ link in the left navigation area.
  4. Optionally, add a new module.
  5. Click ‘Add item to a module’ link.
  6. On the Add Item dialog,
    • Select ‘External Tool’ from the add drop down list.
    • Click ‘Tegrity Recordings’ tool.
    • Do NOT click ‘Load this tool in a new tab’ checkbox.
    • Click ‘Add Item’ button.

 

 

Popular Articles

Let Tegrity Know!

We welcome your feedback on how we can improve the Tegrity lecture capture service. Please provide any comments and suggestions to your account management team.