Canvas Custom LTI 1.1 XML

Introduction

This article will provide you the steps to create a custom XML for your LTI 1.1 connection between Canvas and AEFIS. A custom configuration will allow you to do things like change the name of the LTI 1.1 tool from AEFIS Tools, disable the LTI 1.1 tool by default, when enabled hide the tools from particular users, and other items.

Creating the Custom LTI 1.1 XML

Complete the following to create the custom LTI 1.1 XML

1. Copy the Custom LTI 1.1 XML Template located at the bottom of this page to you favorite text editor
2. Fill out/update the following fields as desired
   1. LTI_Tool_Name: This will be the name of the LTI 1.1 tool that is displayed in Canvas
   2. LTI_Tool_Description: Basic description of the LTI 1.1 Tool
   3. AEFIS_URL: Enter your institution’s AEFIS URL, enter the name only i.e. institution.aefis.net
   4. User_Access: Configure who will see the LTI 1.1 tool in the Course Navigation Menu.
      1. The options are:
         1. admins = Is only visible to anyone who is in the course with role of Teacher, TA, Course Designer (or any role built from these base roles) or has any account role that grants access to the course.
         2. members = Is only visible to anyone who is in the course with role of students
         3. public = Tool is visible to all users
   5. Hide_From_Menu: Configure if the LTI 1.1 tool is displayed by default in the Course Navigation Menu
      or hide it by default.
      1. The options are:
         1. enabled = Enable in Course Navigation Menu
         2. disabled = Hide from Course Navigation Menu
   6. Show_AEFIS_Menu_Items: This optional item, can be modified so that the AEFIS menu in the LTI 1.1 frame shows only the desired AEFIS menu items. If you want to use this feature you MUST work with AEFIS in order to obtain the menu IDs of the menu items you want to display. To enabled this feature <lticm:property name=”SHOW_MENU_ITEMS”> must be un-commented.
   7. Landing_Page: This optional item, can be used to change the “homepage” the LTI 1.1 tool lands on when launched. By default the LTI 1.1 tool will land on the syllabus page, if this property is configured it will redirect to the one the other possible alternate “homepages”. To enabled this feature <lticm:property name=”ACCESSURL”> must be un-commented.
      1. Below is a list of all possible alternate “homepages” based on the AEFIS LTI 1.1 tool menu:
         1. AefisCourseSection.CourseLearningObjectives = Course Outcomes
         2. AefisCourseSection.AssociatedPrograms = Program Outcomes
         3. AefisCourseSection.StudentPerformance = Student Performance
         4. AefisCourseSection.QuestionDesigner = Course Section Questions
         5. AefisCourseSection.SurveyResults = Evaluation Results for Instructors & Completion of Evaluation by Students
         6. AefisCourseSection.Assignments = Assignments
         7. AefisCourseSection.AssignmentMapping = Assignment Linking
         8. AefisCourseSection.Assessments = Assessment Data
         9. AefisCourseSection.AssignmentSamples = Assignment Samples

Configure the LTI 1.1 Tool in Canvas

Next you will add the LTI 1.1 to Canvas by doing the following.

1. Login to your account and go to the admin view
2. Go to Settings
3. Go to the Apps tab
4. Click on the Add App button
5. Choose Paste XML under Configuration Type
6. Type the desired name in the Name field
   1. This name is only a description of the LTI 1.1 tool on the External Apps page, it will not be displayed to users.
7. Enter the LTI 1.1 Key in the Consumer Key field
   1. LTI Key: To be provided by AEFIS
8. Enter the LTI 1.1 Secret in the Shared Secret field
   1. LTI Secret: To be provided by AEFIS
9. Paste your custom XML in the XML Configuration field
10. Click Submit

Custom LTI 1.1 XML Template

<!DOCTYPE LTI-config-xml [
<!-- Enter the name to display on the Course Navigation menu -->
<!ENTITY LTI_Tool_Name "AEFIS Tools"> <!-- default is AEFIS Tools -->

<!-- Change the description of the LTI Tool --> 
<!ENTITY LTI_Tool_Description "AEFIS is the web-based assessment management solution that facilitates the collection and application of real-time assessment data."> 

<!-- Enter your institution's AEFIS URL   -->
<!ENTITY AEFIS_URL ""> <!-- URL name only i.e. institution.aefis.net, aefis.institution.edu, etc. -->

<!-- Configure who will see the LTI tool in the Course Navigation Menu.
     The options are:
        admins = Is only visible to anyone who is in the course with role of Teacher, TA, Course Designer (or any role built from these base roles) or has any account role that grants access to the course. 
        members =  Is only visible to anyone who is in the course with role of students
        public = Tool is visible to all users -->
<!ENTITY User_Access "public">  <!-- default is public -->

<!-- Configure if the LTI tool is displayed by default in the Course Navigation Menu 
     or hide it by default. 
     The options are:
        enabled = Enable in Course Navigation Menu
        disabled = Hide from Course Navigation Menu -->
<!ENTITY Hide_From_Menu "enabled"> <!-- default is enabled -->

<!-- This optional item, can be modified so that the AEFIS menu in the LTI frame shows only the desired AEFIS menu items. 
     If you want to use this feature you MUST work with AEFIS in order to obtain the menu IDs the you want to display. 
     To enabled this feature <lticm:property name="SHOW_MENU_ITEMS"> must be un-commented below. -->
<!ENTITY Show_AEFIS_Menu_Items ''>

<!-- This optional item, can be used to change the "homepage" the LTI tool lands on when launched.
     By default the LTI tool will land on the syllabus page, if this property is configured it will redirect to the one the other possible alternate "homepages". To enabled this feature <lticm:property name="ACCESSURL"> must be un-commented.
     Below is a list of all possible alternate "homepages" based on the AEFIS LTI tool menu:
        AefisCourseSection.CourseLearningObjectives = Course Outcomes
        AefisCourseSection.AssociatedPrograms = Program Outcomes
        AefisCourseSection.StudentPerformance = Student Performance
        AefisCourseSection.QuestionDesigner = Course Section Questions
        AefisCourseSection.SurveyResults = Evaluation Results
        AefisCourseSection.Assignments = Assignments 
        AefisCourseSection.AssignmentMapping = Assignment Linking
        AefisCourseSection.Assessments = Assessment Data
        AefisCourseSection.AssignmentSamples = Assignment Samples-->
<!ENTITY Landing_Page "">
<I_Tool_Name; <I_Tool_Description; https://&AEFIS_URL;/assets/images/logos/AefisLogoCanvasLms.png https://&AEFIS_URL;/index.cfm?page=AefisFramework.login LTI syllabus courseSectionId|custom_canvas_course_id aefis public https://&AEFIS_URL; <I_Tool_Name; &User_Access; &Hide_From_Menu; true