Skip to main content

Engageli Deeplink Selection Screens

Overview

In this article, we'll walk through the deeplink selection screens Engageli offers for LTI integrations. These screens give users more control when setting up LTI links in the LMS, but they also come with extra options that users need to be familiar with. If you'd like help deciding what's right for your setup, the Engageli team is available to discuss your use case.

General Selector Screen

The general selector screen is the most commonly-used deeplink option. To configure Engageli to display this screen, you'll need to use the following endpoint:

https://PARTNER.engageli.com/api/PARTNER/lti/selector

The "PARTNER" portions would need to be swapped out with your organization's name/identifier.

Below is an example screenshot of the general selector screen:

We'll now review all the options that appear on the page.

Step 1: Choose LTI Links(s)

In this section, you can select which resource links you'd like to create. The options here are presented as checkboxes, which means you can create multiple links simultaneously.

  • Engageli Browser-Based Classroom Access - Check this box to generate a link to the Engageli classroom. When users click this link, they'll be directed to the Engageli classroom's Lobby page. This is the most commonly-selected option.
  • Engageli Management Portal Access (Instructor only) - Check this box to generate a link to the Engageli classroom's Class Portal. If you choose to generate this link, you should consider hiding its visibility from students, as the Class Portal is only accessible by class Instructors and Super Admins.

Note: Although you can create multiple links at once from this deeplink page, not all LMS software support this. If you encounter errors attempting to create multiple links at once, try creating them one at a time, instead.

Step 2: Choose a link type

In this section, you will decide the specifics of the Engageli classroom associated with the link. For example, do you want a new Engageli classroom to be created or do you want this link to take users to an existing Engageli classroom, instead? The options here are presented as radio buttons, we'll cover them all below:

  • Create link that match LMS course names - This will create a link that, when clicked, will direct users to the Engageli classroom that was automatically generated for the course. If a classroom hasn't been created yet, Engageli will generate one on the spot. Engageli creates only one classroom through this method, so repeated clicks won't produce additional classrooms. Additionally, all links you create using this option (within the same LMS course) will point to the same Engageli classroom.
  • Link to an Engageli class - This option, along with its dropdown menu, lets you create a link that directs users to a specific Engageli classroom. The dropdown only lists classrooms where you are currently rostered as an Instructor. This is especially helpful when you want multiple courses to have links that take students to the same Engageli classroom. For example, if you teach several courses but hold office hours in a single Engageli classroom, you can add a link in each course that takes students directly to that shared office‑hours room.
  • Create a new Engageli class and link to this course - This option--and its accompanying text box--lets you create a link to an Engageli classroom where you choose the classroom name. It's also the right choice when a classroom has already been automatically created for the course but you need an additional one. Using this option, you can create as many Engageli classrooms to be linked to the current course as you desire.

  • Enable the creation of a shared Engageli class by consolidating multiple LMS classes taught by the same instructor - This option allows you to create a shared Engageli classroom by deferring the choice of which classroom the link should open. After the link is added to an LMS course, the instructor clicks it and is prompted to select the appropriate Engageli classroom. This workflow is especially useful in institutions where administrators set up LTI links in the LMS, while instructors are responsible for managing the Engageli classrooms those links connect to. It's a niche feature designed for specific organizational needs. When the instructor clicks the link, they'll see a prompt like the one shown below. The page includes two radio‑button options:

    • Enter a name to create a new class - Choose this option to create a brand‑new Engageli classroom, then enter the desired classroom name.
    • Link this LMS course to one of your existing Engageli classes - Choose this option to connect the LMS course to an existing classroom. The dropdown will list only the classrooms that were originally created from this selection screen.

    Note: This prompt appears only once per LMS course. After the instructor makes a selection, all other links of this type in the same course will automatically point to the classroom chosen during this initial setup.

Once you've made choices, click "Submit" to create the link.

Class Content Selector Screen

The class content selector screen lets you create links that take users directly to specific content within the Playback Room. Specifically, it will take users to the class Lobby and, once they hit the button to join the Playback Room, the corresponding content is automatically loaded into the main panel. It's designed to guide learners straight to a particular recording or module, rather than linking to the classroom itself and asking them to, for example, open the Learning Path, find the module titled "Extra Credit", and select it. To configure Engageli to display this screen, you'll need to use the following endpoint:

https://PARTNER.engageli.com/api/PARTNER/lti/selector?type=content

The "PARTNER" portions would need to be swapped out with your organization's name/identifier.

Below is an example of the class content selector screen:

We'll describe each element seen on the selector screen:

  • Class List - Select the classroom that contains the content to which you'd like to link. Only classrooms that are already linked to the current LMS course will appear in this dropdown list. If the classroom you need the content from isn't appearing, you'll need to create an LTI link to the classroom via the various options in the general selector screen, first.
  • Choose from Recordings - This list displays all recordings that exist under the selected classroom. Select the recording to which you'd like to link.
  • Choose from Modules - This list displays all modules that exist under the selected classroom. Select the module to which you'd like to link.

Note: You can use CTRL+Click to select multiple recordings or modules. This will create multiple LTI links at once. If you encounter errors when creating several links simultaneously, try selecting and linking one item at a time.

After making your selections, click "Submit" to generate the links.

Related articles