Configuring LTI Pro
The LTI Pro app integrates Zoom Video Conferencing into learning management systems (LMS) that support the LTI 1.1.1 standard. LTI Pro has been successfully integrated into Blackboard, Canvas, Desire2Learn, Moodle, Sakai and other LMS platforms.
This article covers:
- Configuring the LTI Pro instance
- Configuring for Learning Management Systems (LMS)
- Configuration options for LTI Pro
- Allow Students to schedule and host meetings
- Enabling meeting links for auto-login users
- Enabling auto login for Zoom via LMS IDP
- Auto provision Zoom users
- Auto-populate Alternative Host
- Attendance report
- Cloud Recording links for students
- Auto Upgrade Zoom users
- Identify an LTI user as an instructor
- Email or Employee Unique ID attribute name
- Allow authentication exception
- Tracking fields
- Customize Launch Error message and URL
- Customizing the Get Training link and text
- Configure Approved Domains
- Import Meetings via CSV
Prerequisites for configuring LTI Pro
- LTI Pro has been installed.
- Account owner or admin privileges, or a user with a role that includes the Marketplace role privilege.
Configuring the LTI Pro instance
- Sign in to the Zoom Marketplace.
- Click Manage, then click Apps on Account.
- Find the LTI Pro App.
- Click the in the Action column and click Configure.
- Find your LTI credentials and click Edit.
Note: If you do not have credentials listed, click Create a new credential.
The web page will display the LTI Credentials.
Configuring for Learning Management Systems (LMS)
Below you will find links for installing and configuring LTI Pro for your LMS:
- LTI Pro for Blackboard
- LTI Pro 1.1 for Canvas
- LTI Pro 1.3 for Canvas
- LTI Pro 1.1 for Brightspace by D2L
- LTI Pro 1.3 for Brightspace by D2L
- LTI Pro 1.1 for Moodle
- LTI Pro 1.3 for Moodle
- LTI Pro for Sakai
- LTI Pro for Schoology 1.1
- LTI Pro for Schoology 1.3
Note: Before installing Zoom on your LMS, you should review the LTI Pro configuration options and configure them as needed.
Configuration options for LTI Pro
LTI Pro provides the following configuration options to optimize using the LTI.
LTI Pro provides a slightly different user interface and functionality for Instructors of a course and Students of a course. Instructors of a course are LTI Pro users that are teachers, administrators, course staff, etc. The LTI attribue “roles” is used to identify an LTI Pro user as an Instructor for that course. Please see the Identify an LTI User as an Instructor section below on how to make an LTI Pro user an Instructor. Users that are not identified as an Instructor are considered to be a Student.
How to configure allow students to schedule and host meetings
LTI Pro administrators can enable students to schedule and host meetings. Students can host meetings for study groups, course work, and other purposes. Student hosted meetings have the following characteristics:
- Meeting participation reports are not provided to students for student hosted meetings
- Instructors can view and delete cloud recordings for any student-hosted meeting.
- Student access to cloud recordings for student-hosted meetings follows the configuration settings described in the Cloud Recording Link for Students section below.
- Only course Instructors are automatically made alternative hosts for student-hosted meetings when Auto Populate Alternative Host is enabled.
Enabling meeting links for auto-login users
Automatically log users into their Zoom client when they click the Join meeting link in LTI Pro.
Note: This does not apply to meeting links provided in Canvas Calendar, D2L Calendar, or Moodle Calendar.
Enabling auto login for Zoom via LMS IDP
Users logged into the LMS via SSO are automatically logged into their Zoom accounts when they join a Zoom meeting. This requires:
- The IDP of the LMS and the Zoom account must be identical.
- The user must be an SSO user.
How to configure auto provisioning of Zoom users
Automatically create Zoom accounts for LTI Pro users that do not have Zoom accounts. LTI Pro administrators can choose to auto-provision user accounts for Instructors only or for both Instructors and Students.
If the Zoom account associated with LTI Pro has Associated Domain enabled and the email address of the user has a domain that is an Associated Domain, the user account is provisioned without sending the user an account activation email. If Associated Domain is disabled or the email address of the user does not have a domain that is an Associated Domain, the user will need to activate their Zoom user account by responding to the account activation email.
LTI Pro administrators can control which users get auto-provisioned with the allowed email domains setting. If one or more allowed email domains are added, then only LTI Pro users with email addresses that have a domain matching allowed domains will have a Zoom user account auto-provisioned for them.
LTI Pro users can be auto-provisioned with either a Basic, Licensed, or On-Prem user type.
How to configure auto-populate Alternative Hosts
If Auto Populate Alternative Host is enabled, then any Instructor of a course will automatically be made an alternative host for Zoom meetings hosted by Instructors only or Zoom meetings hosted by Instructors and Students if they have a Role that identifies them as a user which should be made an Alternative Host.
How to configure the Attendance report
Attendance reports can be disabled so that they do not appear in previous meetings, or they can be enabled so they are seen in previous meetings.
How to configure Cloud Recording links for students
If the Cloud Recording Link is enabled, LTI users that are students will see links to the cloud recordings of their previous meetings and in the cloud recording tab. If All is selected, then the link to the recording will be available when the meeting is complete. If Published is selected, then the link to the recording will only be available when an instructor or staff publishes the recording.
How to configure auto upgrade Zoom users
LTI Pro administrators can now automatically change the user type of Instructors only or Instructors and Students from Basic to Pro when they use LTI Pro.
How to configure a LTI user as an instructor
LTI Pro uses roles to determine if a user is an instructor. Instructors can access the mto schedule and start and manage Zoom meetings associated with courses.
The default roles that identify a user as an instructor are:
- Instructor (for LTI 1.1)
- membership#instructor (for LTI 1.3)
- Teaching Assistant
- Course Builder
Administrators can add additional roles that identify a user as an instructor. This example shows Staff added as a role that identifies the LTI Pro user as an instructor.
To add a role, enter the role name in the Identify an LTI User as an Instructor field and press enter.
How to configure the Email or Employee Unique ID attribute name
LTI Pro links LMS user accounts to their Zoom user accounts. Enter the LTI attribute containing a custom ID or email address string to enable the integration to match the LMS users to their corresponding Zoom accounts.
- Custom ID
The LMS attribute custom ID can be either a valid email address or an employee unique ID. For help setting up the employee unique id with Zoom accounts, see Setting Up Basic SAML Mapping.
Note: Auto provision is not supported for employee unique id.
- Email address formats:
Example: email_name LTI attribute + @ + school.edu
Note: In this example, we check if school.edu is an LTI attribute. If school.edu is not an LTI attribute then we use the string school.edu as the email address domain.
How to set the timezone
If LTI Pro is selected, then LTI Pro will set the timezone of the LTI user to the timezone that was set in LTI Pro.
If LMS is selected and the LTI attribute custom_person_address_timezone exists, then LTI Pro will set the timezone of the LTI Pro user from the value of that attribute.
If LMS is selected and the LTI attribute custom_person_address_timezone does not exist, then the default timezone will be used to set the time zone for the LTI Pro user.
How to allow authentication exception
When scheduling Zoom meetings, meeting organizers can enable the Only authenticated users can join meeting option to require that Zoom authenticate that users have a Zoom account and belong to a specific domain to join the meeting. The authentication exception feature enables meeting organizers to allow specific users who are outside of their domain or do not have a Zoom user account to join. The account administrator must enable the feature under account security.
- Sign in to the Zoom web portal.
In the navigation menu, click Account Management, then click Account Settings.
- Click Security.
- Select Allow authentication exception and save.
How to configure tracking fields
You can use tracking fields to associate Zoom meetings to Calendar course events. You can filter by the tracking field value in the Zoom Dashboard to see current and past meetings associated with specific educational institutions.
Note: To configure custom fields, see
How to configure Groups
LTI Pro supports assigning Instructors to a Group based on an LTI attribute and value match.
Note: The attribute name and attribute name with custom appended will match. For instance, in the example configuration above, either an attribute name of group or custom_group will match.
How to configure customize Launch Error messages and URLs
A common problem is that LTI users try to use LTI Pro, but they have a Zoom user account that is not within the Zoom account associated with LTI Pro installation.
When this error happens a user can get a customized error message and be provided a link to sign in to the Zoom account associated with the LTI Pro installation.
The Sign-in URL can be set to any URL. It is commonly set to the Vanity URL of the main account or sub-account.
Customizing the Get Training link and text
The Get Training link and text can now be customized so that customers can direct their users to train or support documentation provided by them.
Configure Approved Domains
As a Zoom admin sign in to the LTI Pro app on Zoom’s Marketplace and go to the LTI Pro configuration page.
Set the Approved Domains section of the LTI Pro configuration page.
Make sure that all domains that can be used to access the LMS and LTI Pro are entered in this field. Also, make sure that the domains entered do not include a trailing /.
How to import meetings via CSV
LTI Pro supports bulk importing of meetings via CSV file. Course meetings can be created programmatically via Zoom’s REST API and then imported into LTI Pro courses via CSV files by doing the following:
- Create your meetings via Zoom’s REST API. For more information on creating meetings via the REST API, please see this link.
- Either disable the “Auto Populate Alternative Host” setting. (This is because the admin who imports the meetings on the LTI Pro configuration will be an alternative host of the meeting.) or Create a new Credential only used to import meetings and do not change any settings in the configuration page of LTI Pro.
- Create CSV file(s) to Import meeting:
- To see an example of columns required for the CSV file, on the LTI Pro configuration page go to the Import Meeting section and click Download a CSV Template.
- Create a CSV meeting import file via a script or manually with the following columns:
- Meeting ID: the meeting ID of the meeting being imported to a course.
- Context ID: the Context ID associated with the course that the meeting will be associated with.
- Domain: the Domain that is used to access the LMS.
- custom_canvas_course_id: only required in order to support Canvas Calendar and Conversations.
- Import meetings by clicking the “Import CSV” button in the Import Meetings section of the LTI Pro configuration page.
Note: There is a limit of 1000 meetings that can be imported per CSV file. There is no way to bulk remove meetings from LTI Pro, so before you bulk import meetings to LTI Pro, test Importing a few meetings and verify it works and verify a large CSV meeting import meeting file is accurate.
- Import the completed CSV.
Once it is complete, you will receive an email confirming the import from Zoom.
For additional troubleshooting, submit a request to Zoom Support.
Join the 100K+ other members in the Zoom Community! Login with your Zoom account credentials and start collaborating.