Admin – one time process


This is a one-time step, in which you create a new “External App” in Canvas.

The “External App” holds the details of your Leganto account.

Three parameters were generated after you created the LTI Integration Profile in Alma.

You will be asked to supply these parameters when creating the “External App”.

Create a new “External App”

Navigate to your account => Settings => App.

Select “Add App”.

Paste XML

Select the “Paste XML” option.

Enter the following four values.

1) Name – To expose to whomever creates the future link in the course.

2) Consumer Key – The LTI key from the integration profile.

3) Shared Secret – The LTI secret from the integration profile.

4) XML Configuration – Copy the below XML, and place the Launch URL from the integration profile
instead of:
      in the example below

  xmlns:xsi="" xsi:schemalocation="">
  <blti:extensions platform="">
    <lticm:property name="tool_id">exlibris_leganto</lticm:property>
    <lticm:property name="domain"></lticm:property>
    <lticm:property name="privacy_level">anonymous</lticm:property>
    <lticm:options name="post_only">true</lticm:options>
    <lticm:options name="course_navigation">
        <lticm:property name="default">enabled</lticm:property>
        <lticm:property name="visibility">public</lticm:property>

Course Navigation

The example above is configured to display the link in the course navigation panel.
You can decide instead to display this link in Account navigation or User Navigation, or not at all.
The relevant configuration for this in the above XML is:

enabled public

Possible values for visibility are: ‘public’, ‘members’, and ‘admins’.
This specifies what types of users can see the link in the course navigation.
“public” means anyone accessing the course.
“members” means only users enrolled in the course.
“admins” means only teachers, TAs, designers, and account admins.

For more on this see:

NOTE: If you decide to keep the course navigation in place, the link appears automatically for all courses. In this case, there is no need to create an additional link for each course, as described in “Create a Leganto Link in a Course “.

The course navigation looks like this (The tool name in this case is “Reading List”):

5) Select “Submit”.

Add Custom Field

Edit the newly created “App”.

Add the following custom fields:


lms_user_roles=$Canvas.membership.roles (used for automatically adding the Instructor role to users when arriving to Leganto)

canvas_masq=$ (optional, used to detect “Student View”. If “Student View” is used when clicking the LTI link, an error message will be displayed. You can configure the text of the message under this leganto label: lti.user.error.studentView)

lms_course_start_date=$Canvas.course.startAt (used for creating courses on the fly)
lms_course_end_date=$Canvas.course.endAt (used for creating courses on the fly)

select “Submit”.

You might want to add an additional line to the “Custom Fields” which controls the course code
to be sent to Leganto.
Usually Canvas customers use the context_label as the course code (see below).
If you decide to use a custom value, add a line such as:

               (the value on the right hand should be changed to the value you want)

The list of possible values to pass can be seen here:

Make sure to add the “$” symbol before the name of the filed you choose
(i.e $com.instructure.contextLabels).
If you have chosen to use this method, do not configure the integration profile with the value context_label
as seen below.

Course Code Field Name (context_label)

The course code is passed using the context_label parameter. You will need to add this as a field in Alma’s “Integration Profile”.

Place the value context_label in the ‘Course Code Field Name’ field.

For Banner users

For users which are using the Banner ERP, there might be some exceptions to the above.

If the integration is not workingfor you, try the following changes

  • In the “Add Custom Field“, use the following fields instead of what is documented:
    • lis_user_username=$Person.sourcedId
    • lis_course_id=$Canvas.course.sisSourceId>
  • In the “Course Code Field Name“, leave the field blank, and do not use the value context_label


You Are Done

You are now ready to create a Leganto Link in a Course.