IMS LTI integration

Cirrus Assessment Support Team -

 

IMS LTI integration for your LMS

Cirrus offers an out of the box IMS LTI integration with the Canvas LMS: you can add Cirrus to the list of tools in LMS Canvas. Cirrus offers 2 methods:

1. Dashboard (LTI version 1.0): Example: when candidates click this link in Canvas they will go directly to their Cirrus candidate dashboard without having to log in.

2. Schedule (LTI version 1.3): Example: when candidates click this link in Canvas they will go directly to their specific schedule without having to log in.

Setup of a link to the candidate Dashboard

  • First you set up the IMS configuration in Cirrus
    • Add IMS LTI item
    • IMS LTI Settings: data Mapping / Default Parameters LTI
  • Secondly you set up the LTI integration in Canvas

First you set up the IMS configuration in Cirrus:

  • Go to Admin > IMS LTI > Integrations tab.
  • Click on Add Item in order to create an integration:

2017-12-14_1644-Add-LTI.png

  • Title - fill out a descriptive title showing the type of integration you are setting up.
  • Create users checkbox - this offers the option to allow Canvas app to create the user in Cirrus if it is not found. By default this is not the case. If you choose to check this you will need to 
  • select a hierarchy, select "Candidate" for Role and select the default hierarchy users will be added to. lick on Save button. 
  • Save - click on 'Save': the integration is saved and three new fields appear populated (to be used later in Canvas app): it this will generate a xml snippet under Config together with the relevant keys:

2017-09-14_1524-Admin-IMS-LTI-example.png

  • Next: click on Cancel and go to IMS LTI > Settings tab. Here you can see the mappings used between Cirrus and Canvas:

2017-12-14_1651-IMS-LTI-Settings-tab.png

IMS LTI Settings: default data Mapping / Default Parameters LTI

On Admin > IMS LTI > Settings-tab you can see or change the mapping of fields in both applications. You can change the mapping here also.

The LTI integration only creates a new user if the checkbox is checked in the previous step or amends / synchronises an existing users. (R = Required):

Canvas Field

Type

R

Max length

Description

Cirrus Field

user_id

String

+

500

Contains unique user name. Alphanumeric string (e.g. 655, a1b2c3d4 etc)

User Name

user_id

String

+

500

Contains unique user id. Alphanumeric string (e.g. 655, a1b2c3d4 etc)

User Id

lis_person_name_given

String

+

500

First name

First name

lis_person_name_family

String

+

500

Last name

Last name

lis_person_contact_email_primary

String

+

500

Email address. Also serves as a username

Email / Username (see description)

       

Used from LTI settings

Regional settings

       

Used from LTI settings

Groups

       

Used from LTI settings

Profile


Next you set up the LTI integration in Canvas:

  • Go to Canvas app (https://[your].instructure.com/) and login as an administrator
  • Go to Courses -> Settings -> Apps tab -> View App configuration -> Click on '+App'- button

Canvas-_App-button.png

  • In the new opened window select "Paste XML" for Configuration Type
  • Fill in a name for the Name field.
  • Copy the values from your Cirrus IMS LTI Item in the next fields:

Canvas-add-Cirrus-info.png

  • Click Submit button and refresh the page. The App should appear in External Apps list as well as the integration from Cirrus in the list of menus on the left (refresh page to actually see the added app in the menu).

Result: a link has been added to your course in Canvas

A link has been added to your course in Canvas. When you click on this link, a new browser will open and the user will go directly to the Cirrus dashboard without having to log in:

  • The Integration is visible if the user clicks on IMS LTI link to Cirrus from Dashboard or from Courses - see the example screenshot below:

2017-09-14_1433.png

 

  • After clicking the link in Canvas the user goes to the Cirrus Candidate Dashboard without having to log in:

Screen_Shot_2017-09-14_at_14.26.56.png

Setup of a link to the schedule

 

If you don't want to go to the dashboard it's also possible to go directly to the assessment schedule.

  • First you set up the IMS configuration in Cirrus (you don't have to create a Integrations in the admin of Cirrus)
    • IMS LTI Settings: data Mapping / Default Parameters LTI
  • Secondly you set up the LTI integration in Canvas 
  • Go to Canvas app (https://[your].instructure.com/) and login as an administrator
  • Go to Courses -> Settings -> Apps tab -> View App configuration -> Click on '+App'- button

Canvas-_App-button.png

  • In the new opened window select "By URL" for Configuration Type
  • Fill in a name for the Name field.
  • Copy the values from your Cirrus IMS LTI Item in the next fields:

Screenshot_2020-03-05_at_13.48.23.png

TheLTI XML config details can be found per schedule via Delivering->specific schedule-> ... (right top corner) when IMS LTI configuration is done as an Admin.

Screenshot_2020-01-21_at_12.57.03.png

When the app is created in Canvas, it will not create a menu such as the dashboard LTI. The only option to click on this link, is by creating an Assignment.

Go to Courses->Assignments-> click on the button '+ Assignment'

  • Fill in a assignment name
  • Choose as a Submission Type "External Tool"
  • Click on "Find" and choose the tool which you've added before (NOTE: The name in this list will not have the same name as the tool earlier created in Canvas, but will have the name of the schedule in Cirrus)Screenshot_2020-03-05_at_13.52.41.png
  • Optionally choose to 'load this tool in a new tab'
  • Click on "save & publish"

Now a candidate will login automatically in their assessment by clicking the link in the Assignment.

Please make sure the following:

  1. The user who will click on the LTI link in Canvas must been added as a candidate in the schedule of Cirrus
  2. The userid and username of the Cirrus user must contain the "lti_user_id" value of Canvas. When this is not setup correctly, you'll receive an error "User_unknown". 

 

 

Comments 0

Cirrus uses Zendesk to provide our Help Center services. Check out Zendesk's Terms of Service and Privacy Policy, as they govern your use of these services.

Powered by Zendesk