Content
- 1. Sakai LTI 1.3 Integration - Overview
- 2. External Tool Registration and Configuration
- 3. Frequently Asked Questions
1. Sakai LTI 1.3 Integration - Overview
Learning Tools Interoperability® (LTI®) allows Sakai to connect with external learning tools such as Inspera easily and securely. The connection supports Sakai by passing information in a standards-based way to Inspera. These include the role of that user (instructor or Candidate) and the course from which they launched the tool. It can also create user accounts in the tool upon launch, acting as both a registration and single sign-on in one easy workflow.
There is one step in configuring Sakai:
- Registering the Inspera tool
2. External Tool Registration and Configuration
The security model for LTI 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, this means the Tool and Platform must register with one another ahead of time before activities and courses can be accessed from the platform. Registration happens only once manually, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.
2.1 Administrator - Configuring LTI Integration With Sakai
📢 Important Information When Copying and Pasting URLs
When copying and pasting URLs, ensure there are no whitespaces before or after; extra whitespaces can cause broken links, access errors, and break the LTI setup
To configure the integration between Inspera and Sakai, the user must follow the following steps:
a. Click on the Worksite Setup option from the left-side drawer menu in Sakai.
b. Click on Administration Workspace from the site list.
NOTE:
There are three (3) URLs that the user will need for the first time from Inspera to set up the LTI connection in the user Sakai instance. They are:
- key-url: a key-url typically refers to a set of public keys used for authentication and security purposes.
- login-init: When a user initiates a login process from LMS to an external tool using LTI 1.3, the "login-init" URL is the endpoint where this process begins.
- redirect-url(s): The redirect URLs specify the URLs where LMS should redirect the user after completing the OAuth 2.0 authorization flow.
key-url | https://{domain}/ICSXapi/metadata/PublicCertificates |
login-init | https://{domain}/ltiprovider/init |
redirect-url(s) | https://{domain}/ltiprovider/launch |
Using the URL templates above, replace {domain} with your Inspera tenancy that you will be setting up the integration against.
For example, if your Inspera tenancy has the URL, demo.inspera.com, then the URLs would be:
key-url | https://demo.inspera.com/ICSXapi/metadata/PublicCertificates |
login-init | https://demo.inspera.com/ltiprovider/init |
redirect-url(s) | https://demo.inspera.com/ltiprovider/launch |
c. Scroll down on the left-side drawer menu and click on External Tools. You can choose one of the following options
-
- LTI Dynamic Registration: When you enter your URL, the tool will register your data automatically.
- Install LTI 1. x Tool: Enter your registration information manually
d. On the Installed Tools tab, click Install LTI 1. x Tool.
e. To register the external tool fill up the following required fields:
- Tool Title: The name of the external tool.
- Button Text: The name of the button for the external tool.
- Description: Brief description of the tool.
- Launch URL: It specifies where the LMS should redirect the user when they click the content selector https://{domain}/ltiprovider/launch.
-
Privacy Settings: Under the privacy settings, the user can select
- Send User Names to External Tool: Enable this option to share the user names with the external tool.
- Send Email Address to External Tool: Enable this to share user email addresses with the external tool.
- Services: Under the services, the user can select:
- Allow External Tool to return grades: Enable this option if the user wants external tools to have the capability to submit and update grade information
- Allow External Tool to create grade column: Enable this option if the user wants external tools to be able to dynamically create new grade columns
- Provide Roster to External Tool: Enable this option to grant external tools access to the roster
- Allow External Tool to store settings data: Enable this option if the user wants external tools to store specific configuration settings
- Tools can generally accept…: Under this field, the user can select:
- The tool URL can receive an LTI Resource Link launch: Enable this option to simply launch the tool
-
The tool can receive a Content-Item or Deep-Link launch: Enable this option to let the tool receive Content-Item or Deep-Link launches
Note: Deep linking is currently not relevant for Inspera integration. Performing a deep-link launch will not result in any errors. The response back to the LMS is 'valid,' but it lacks usable values since Inspera doesn't have features that align with a deep-link request flow.
- Indicate where these tools are placed in Sakai: Under this field, the user can select:
- Allow the tool to be selected from Lessons: Enable this option if the user wants the tool to be accessible directly from the Lessons
- Allow the tool to be one of the assignment types: Enable this option if the user wants to include the tool as one of the available assignments
- Allow the tool to be used from the rich text editor: Enable this option to integrate the tool directly into the rich text editor, enhancing content creation and editing capabilities
- Tool supports the privacy launch message (experimental): Enable this option to enable the tool to support the privacy launch message
- Allow the tool to provide a common cartridge (usually to be imported into a tool like Lessons): Enable this option to import the cartridge into tools like Lessons
- Allow the tool to provide a file (usually as part of a file picker): Enable this option if the tool can provide files, making it accessible through the file picker functionality
- Launch in Popup: Under the launch options, the user can select:
- Never launch in Popup: Select this option to ensure that the tool never opens in a popup window
- Always Launch in Popup: Select this option to launch the tool in a popup window
- Allow popup to be changed: Select this option if the user wants to have the flexibility to change the popup settings based on their preferences
- Custom Parameters: Add the required custom parameters
- If the user selects LTI 1.3 support while .….the tool information: Select Tool supports LTI 1.3.
-
URLs:
- LTI 1.3 Tool Keyset URL: https://{domain}/ICSXapi/metadata/PublicCertificates
- LTI 1.3 Tool OpenID Connect/Initialization Endpoint: https://{domain}/ltiprovider/init
- LTI 1.3 Tool Redirect Endpoint(s): https://{domain}/ltiprovider/launch
- Click Save.
f. After completing the registration process, the Tool Configuration Details will be displayed.
Click on the Done button.
g. The registered tool will appear in the list.
2.2 Administrator - Configuration of Inspera Assessment
Inspera will need the following information (i.e. Tool Configuration Details) back from Sakai. The user will need to contact Inspera Support to have them make these updates for the user-specific Inspera tenancy.
The specific Sakai values are to be configured in Inspera to complete external tool configuration on both Sakai & Inspera.
LTI 1.3 Platform Issuer | https://<sakai domain> | |
LTI 1.3 Client ID | Unique for the tool which is created and can be found as part of the initial tool registration is done in Sakai | |
LTI 1.3 Platform OAuth2 Well-Known/KeySet URL | https://<sakai domain>/imsblis/lti13/keyset | |
LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL | https://<sakai domain>/imsblis/lti13/token | |
LTI 1.3 Platform OIDC Authentication URL | https://<sakai domain>/imsoidc/lti13/oidc_auth | |
LTI 1.3 Deployment Id | 1 |
2.3 Teacher/Instructor - Adding an Assignment
Once the configuration is completed on Sakai and Inspera, the teacher will create an assignment.
To add an assignment follow the below steps:
a. Login to Sakai with a Teacher/Instructor role
b. Select Worksite Setup from the left-side drawer menu and click on the site name (for reference, see SMPL101 Spring 2023 in the below image).
c. Select the Assignments from the left-side drawer menu.
d. Click on the Add tab.
e. Enter the following details:
- Title: Enter the assignment title
- Assignment Instructions: The required set of guidelines for making the assignment easy to understand and complete successfully.
- Availability: Open Date, Due Date, and Accept Until will be pre-filled by default on the basis of current time and date. The user can also adjust them as per their preference. The instructor should assign a future open date to prevent the assignment from being displayed to students before the test is activated in Inspera. Please refer to the custom parameters document for more details. Instructors need to send the activity start time in inspera_test_start_time and the activity end time in inspera_test_end_time.
- Submission Type: Select the External Tool (LTI) option to use the integrated external launch tool.
- Click on Select External Tool (LTI)
- Select the registered external tool from the popup window
Enter the following details in the popup window:
I. Tool Description: Brief description of the tool (by default, it will be prefilled from the tool).
II. Custom Parameter: Add the required custom parameters. An assignment specific custom parameter needs to be added here.
III. Click Save.
- External Tool to Launch: The selected tool name appears in the box.
- Load this tool in a new tab: Select this checkbox to launch the tool in the new tab
- Grade Scale: Select Points to enable grades in the form of points
-
Max Points: Enter the number of marks, e.g. this assignment will be out of 10 marks
Note: For consistent scoring, the instructor must establish identical total points on both Inspera and Sakai. If a question set is created with 40 marks in Inspera, but in Sakai, the assignment is set for 10 marks, and a student scores 27 out of 40 in Inspera, the student will see the marks as 27 in Inspera. However, in Sakai, it will show as 6.75 marks with a maximum score of 10. We can consider the score converted in the same ratio. - Create new Gradebook item: The instructors can select this option if they want to create a new gradebook for a specific assignment.
- Click Post
f. The assignment will appear on the assignments list
2.4 Teacher/Instructor - Author Assessment
- Login to Sakai as a Teacher/Instructor role
- Select Worksite Setup from the left-side drawer menu and click on the site name (for ref. SMPL101 Spring 2023 in the below image).
- Select the Assignments from the left-side drawer menu.
- Click on the added assignment name from the list.
- Click on the Go to External Tool button.
- Click on the Launch External Tool in New Window button.
- The user is taken to the test setup page within Inspera Assessment.
- If the user needs help creating tests in Inspera Assessment, please visit our help tutorials at https://support.inspera.com/hc/en-us/articles/360022690051-Tutorials
2.5 Candidate – How to take an Inspera Assessment from Sakai
Candidates can launch into an Inspera Assessment from Sakai and undertake scheduled tests set up by an instructor.
- Log in to Sakai as a candidate.
- Select Worksite Setup from the left-side drawer menu and click on the site name (for ref.
SMPL101 Spring 2023 in the below image).
- Select the Assignments from the left-side drawer menu.
- Click on the added assignment name from the list.
- Click on the Go to External Tool button.
- Click on the Launch External Tool in the New Window button.
- Candidates will be redirected to the Inspera screen to attempt the scheduled test.
3. Frequently Asked Questions
Question 1 | What steps should I take if I encounter authentication issues during the LTI 1.3 setup? |
Answer |
Revalidate LTI Configurations for both Sakai and Inspera. In Sakai, validate the tool configuration by editing the tool from the “External tools” section. Recheck the accuracy of the following fields:
Ensure that these details are correctly configured to ensure seamless integration and functionality |
On Inspera the service desk will need to ensure the below details are configured properly |
Question 2 | Why is a Candidate not able to launch an Assignment? |
Answer |
The following could be probable reasons
To avoid the same, the instructor needs to configure and activate an assignment on Inspera. |