Configuring an LTI App for LMS Integration

Widget App Configurations 

Before you configure the LTI App, you need to complete the following steps if the Widget App isn't configured for LTI Integration.

1. Go into the Widget App's settings.

LTI App Configurations

Automatic Configuration

1. Go into the settings of the LTI App you’ve added.

2. Enter the URL of the LMS to the ‘Whitelisted Domain’ field. Make sure that there is no trailing ‘/’ at the end, and no protocol (e.g. http:// or https://) at the start of the URL that you copy. You can only provide one domain URL in this field, as a single LTI App can only support integration with one LMS, learn more here: Relationship between LTI App and LMS

3. Paste the ‘Application ID’ that you copied from the Widget App in the ‘Widget ID’ field. 

4. Select the ‘Default CAL’ that an LMS user will be assigned if they are not mapped according to the mapping rules you’ve created.  

5. You can also use the “+Add New Rule” button to create rules for role mapping of external LMS users. See Creating Rules for Role Mapping below for more. 

6. Turn the “Scale Score” toggle on to enable the synchronization of grading for graded activities in your LMS that utilize graded VIDIZMO content. See Grading to see how it works 

7. Provide a value for the Scale that will be used for scaling.  

8. Enable “Automatic Configuration” via the toggle. 

9. Copy the “Registration Link” from the LTI App. 

10. Use the “Save Changes” button to save all configurations. 

11. Enable the “LTI App” on the Integration Apps page. 

12. Next, login to your LMS with administrator-level access. We will be using Moodle as our LMS for a demonstration of the LTI Integration. 

13. After logging in, select ‘Site Administration.’  

14. Click ‘Plugins.’  

15. In the ‘Activity modules’ section, select ‘Manage tools’ present under ‘External tool.’ 

16. In the ‘Tool URL’ field, Paste the ‘Registration Link’ that you’ve copied from the LTI App.

17. Click the ‘Add LTI Advantage’ button to add the tool to the LMS.

18. You will be given a message if the tool has been added successfully without any exceptions. Click the ‘Proceed’ button to continue.

19. The tool you’ve registered will be shown under Tools. It will also have your Portal’s name so that you can easily identify it.

20. Click the ‘Activate’ button on the tool to complete the registration.

21. You can verify that the registration is complete by going back to the LTI App on your Portal, turning off ‘Automatic Configuration’ and checking the details under the ‘Registered Platform’ section. 

Note: The LTI App on your VIDIZMO Portal is linked to the LTI Tool on the LMS in a one-to-one relationship. If you want to replace the current LTI Tool and link a new one with your Portal, then you will need to delete the current LTI App and create a new one to link with the new tool. Read more here: LTI App and LMS Tool Connectivity 

Manual Configuration

You also have the option to register the LTI tool manually, where you copy and paste the information yourself and do not utilize a registration link. The following steps show how you can perform manual configurations in the Moodle LMS.  

1. With administrator-level access to your LMS, navigate to the ‘Manage Tools’ page. 

2. Click “Configure a tool manually” to open the configurations for an LTI Tool.

3. Under the ‘Tool settings’ section shows the input fields where you need to provide the configuration details of the LTI App on your VIDIZMO Portal. You also need to make the following adjustments to display all required fields to complete the configuration.

1. Set the ‘LTI version’ to ‘LTI 1.3’ 
2. Set the ‘Public key type’ to ‘Keyset URL’ 
3. Select the ‘Supports Deep Linking’ checkbox

4. To get the information, login to your VIDIZMO Portal, add an LTI App and go into its settings. 

5. When configuring the LTI App, turn the Automatic Configuration off to display the registration details you need.  

6. Use the information provided in the ‘Tool Configuration’ section to configure the ‘Tool settings’ of the LTI tool you have manually added on the Moodle LMS. See Step 3 for a view of the input fields. 

7. Once you’re done with adding the information in the tool settings, use the “Save Changes” button to add the LTI tool. The tools added this way will be activated by default. 

8. Once the tool is added, click the details icon to display the ‘Tool configuration details.

9. This will display the information you need to add to the LTI App in your VIDIZMO Portal. 

10. Navigate back to the LTI App’s settings on your Portal and enter the tool configuration details in their respective fields under ‘Registered Platform’ section. In Moodle, The ‘Platform ID’ goes in ‘Issuer’ and the ‘Authentication request URL’ goes in ‘Authorization URL’

11. Click ‘Save Changes’ to complete the registration.

Create Rules for Role Mapping 

In the LTI App, you can create rules for role mapping of LMS users. These rules determine which CAL will be assigned to them after they are registered to your VIDIZMO Portal. 

1. Use the '+ Add New Rule' button to create a rule. You can also add multiple rules that utilize different conditions. 

2. The ‘Attribute Path’ field gives you two options for creating the rules. Select 'Role' to create a rule that assigns a CAL to IMS roles directly. 

3. Choose the condition that determines how the rule will perform the operation. Select 'In' to assign the selected CAL to all selected IMS Roles.  

4. Add the IMS Roles from the dropdown that will be assigned the selected CAL.  

5. Choose the CAL that you want to assign using this rule.  

6. Use the ‘x’ button at the right if you want to remove a rule.  

7. Another way to assign CAL(s) is by creating a rule that analyzes the emails of the LMS users registered into the Portal. To create a rule for this, set the ‘Attribute Path’ to ‘Email.’ 

8. Next, select the condition that checks the input provided in the 'Email' field to determine if the CAL will be assigned or not. These fields are case sensitive, so ensure you take capitalization into account.  

1. Start With: Checks if the information in the 'Email' field is present at the beginning of the email. For instance, if you enter ABC in the 'Email' field, then the rule will apply to [email protected] but not [email protected] 
2. Equals: Checks if the information in the 'Email' field matches exactly with any of the emails being analyzed. For instance, if [email protected] is present in the 'Email' field, then the rule will only apply to [email protected] and nothing else.   
3. Ends With: Checks if the information in the 'Email' field is present at the end of the email. You must also provide the email server name (hotmail or gmail) and the domain (.com or .org) here. For instance, if 'gmail.com' is present in the 'Email' field, then the rule will apply to [email protected] but not [email protected]  
4. Contains: Checks if the information in the 'Email' field is present in any position of the email. For instance, if 'contact' is present in the 'Email' field, then the rule will apply to both [email protected] and [email protected].   

9. Provide the text present in an email address that will be analyzed by the rule. 

10. Select the CAL that will be assigned to users after their email has been analyzed and the condition specified in the rule is met.

11. To save the rules you’ve created, click the ‘Save Changes’ button. 

Note: If multiple conflicting roles are added, then the rule created first will be applied instead of the rest.