Connection setup

This article provides a detailed, step-by-step process for integrating your Canvas account with Insendi, ensuring a seamless and efficient setup. Whether you are configuring the integration for the first time or reviewing the process, this documentation will equip you with the necessary instructions and best practices to streamline the connection.

To complete this process, Admin access to your Canvas platform is required. Admin access to Insendi is optional, since our team can provide you the dynamic registration link.

The process involves two required steps: first, creating the LTI connection (also called in canvas Developer keys or just Apps) between canvas and Insendi using admin access, which can be automated through Dynamic Registration and only needs to be done once; and second, adding the app at the desired level, per course, or just once at account or subaccount level, depending on where you want it to appear.

For step 1, we recommend LTI Registration (Dynamic Registration) which is the most flexible and automated integration method, as it does not require manual configuration of URLs, settings, and keys. Alternatively, the LTI Key method allows for the manual configuration of URLs, keys, and secrets using forms. Within this method, there are two options: the Enter URL option, which requires only filling out the form in Insendi since it is automatically filled out in Canvas, and the Manual Entry option, which requires manually completing the forms on both platforms.

Both LTI Registration and the Enter URL option automatically configure the necessary settings in Canvas, ensuring a smoother and more streamlined user experience.

1. Create the developer key

Option A: LTI Registration (Dynamic Registration)

1. Obtain the dynamic registration URL:

   1. Our team can provide you with the Dynamic Registration URL directly to copy the URL.

   2. If you have access to, log into Insendi, navigate to the 'Tenant Settings' section, click on the 'LTI provider' tab, and access the ' + Dynamic Registration' button to copy the URL.

Open

2. Log into Canvas and navigate to the 'Admin' section in the left sidebar. In the Admin panel, select the account where you want to add the Insendi connection. Then, navigate to the 'Developer Keys' section from the left-side menu, click the '+ Developer Key' button in the top-right corner, and choose the third option: LTI Registration.

Open

3. Paste the URL and click on 'Continue'. Then, as seen at the end of the video, a modal pops up with the 'Permissions' and 'Placements' displaying the default parameters enabled based on our recommendations.
   
   Permissions specify what data and actions Insendi can access, with five enabled by default. The relate to assignment and grades management plus access to user information. Placements define where the Insendi integration appears within Canvas. We configure four to get all the flexibility if possible: Modules Index Menu (Modal), Link selection, Course settings sub navigation and Account Navigation. The first provides access to the app from the modules menu in Canvas, opening a pop-up window, the second enables inserting links to the app within course content, such as pages or assignments, the third enables a menu in the course settings to easily manage paired courses and the four one enables a menu at admin level to administrate Insendi. For more details, please consult Placements Overview.

Open

4. Finally, click 'Enable & Close' to complete the process.
   Alternatively, if you'd rather activate the key manually later, click 'Save' instead. You’ll then be able to enable it anytime by toggling the switch next to the key.

Open

5. Now that you have the developer key, to complete the connection setup, you need to add the app: Connection setup | 2. Enable the insendi App at account levelPreview

Option B: LTI Key (Manual entry or Enter URL)

Use this method only if you want an expert and flexible control of the developer key, since the result form after creating the developer key is more detailed than the one with dynamic registration, but in general you should not need it.

Enter URL

1. Log in to Canvas, navigate to the 'Admin' section in the left sidebar. In the Admin panel, select the account where you want to add the Insendi connection. Then, navigate to the 'Developer Keys' section from the left-side menu, click the '+ Developer Key' button in the top-right corner, and choose the second option: LTI Key. To complete this step, in the drop-down menu, select the method Enter URL.

Open

2. In the 'JSON URL' field, enter the following endpoint: https://[hostname]/api/v2/[tenant_ref]/lti/json

Open

*Note: Replace [hostname] and [tenant_ref] with your actual hostname and Insendi tenant reference, respectively.

3. Click 'Save'. Then, toggle the switch under the 'State' column. The number that appears in the 'Details' column is your Client ID. You will need this in the next step.

Open

4. Log into Insendi, navigate to the 'Tenant Settings' section, click on the 'LTI provider' tab, and access the ' + New connection' button to access the Insendi form.

Open

Complete the Insendi form:

*Note: Replace [CANVAS DOMAIN]with your actual Cavas domain.

5. Finally, click on 'Create' to finish setting up the connection on the Insendi side.

6. Now that you have the developer key, to complete the connection setup, you need to add the app: Connection setup | 2. Enable the insendi App at account levelPreview
   
   

Manual entry

1. Log into Insendi, navigate to the 'Tenant Settings' section, click on the 'LTI provider tab', and access the ' + New connection' button to access the Insendi form. Leave this form open and open another browser window for the next step.
   
   

Open

2. Log into Canvas, and navigate to the 'Admin' section in the left sidebar. In the Admin panel, select the account where you want to add the Insendi connection. Then, navigate to the 'Developer Keys' section from the left-side menu, click the '+ Developer Key' button in the top-right corner, and choose the second option: LTI Key. To complete this step, in the drop-down menu, select the method Manual entry.

Open

3. Fill out the form by copying and pasting the following fields from Insendi to Canvas:

4. Enable the first five toggles on the 'LTI Advantage Services' drop-down menu:

Open

These permissions parameters establish what data and actions Insendi can access. These five are related to assignment and grade management and access to user information.

5. To enable course copying for your instance, go to the 'Additional Settings' section. In the 'Custom fields' box, add the following parameter exactly as shown: context_history=$Context.id.history

Next, under Privacy Level, select Public.

Open

6. Add Modules Index Menu (Modal), Link selection, Course settings sub navigation and Account Navigation to the 'Placements' section. The first provides access to the app from the modules menu in Canvas, opening a pop-up window, the second enables inserting links to the app within course content, such as pages or assignments, the third enables a menu in the course settings to easily manage paired courses and the four one enables a menu at admin level to administrate Insendi. For more details, please consult Placements Overview.

Open

7. Once you’ve filled everything out, click 'Save'. Then, toggle the switch under the 'State' column to enable it. The number that appears in the 'Details' column is your Client ID. You will need this in the next step.

Open

8. Go back to Insendi to complete the Insendi form you left off on the first point of this section:

*Note: Replace [CANVAS DOMAIN] with your actual Canvas Domain.

9. Click on 'Create' to finish setting up the connection on the Insendi side.

10. Now that you have the developer key, to complete the connection setup, you need to add the app: Connection setup | 2. Enable the insendi App at account levelPreview

2. Enable the insendi App at account level

Enabling the insendi app in Canvas at the account level (or subaccount) will allow you to have all the options visible that insendi provides to manage insendi and link content in all courses:

1. Go to 'Admin' -> 'Settings' and then to the ‘Apps' tab (at account level or previously going into a subaccount). 

2. Press the 'View App Configurations' button and '+ App.' 

3. In the 'Add App' window that pops up, select 'By Client ID' from the Configuration Type dropdown menu, paste the Client ID you can copy from the LTI Developer key already added and hit 'Submit'.

4. Next, click on 'Install' to have insendi available in all your courses.