The Moodle LTI integration connects your Moodle site to your organisation's Uptale environment with LTI 1.3 (Learning Tools Interoperability, the standard that lets an LMS open external tools). Teachers add Uptale experiences (immersive training content) to their courses like any other activity, learners open them from Moodle without a separate Uptale password, and their score goes back to the Moodle gradebook. The integration is self-service: your Environment Administrator sets it up in Uptale, with your Moodle administrator, and Uptale support can help.
Site administration›Plugins›External tool›Manage tools (Moodle)
About this integration
What it does
- Teachers pick Uptale content from Moodle. When they add the Uptale activity to a course, a selection window lists the published experiences of the Uptale workspaces (groups of experiences) opened to Moodle. The activity's name, description and maximum grade are filled in automatically.
- Learners sign in once. They open the activity from Moodle and arrive on the experience's launch page, already identified. Their Uptale account is created at their first launch, with the Learner role on the workspaces chosen during the setup.
- Always up to date. Moodle links to the experience in Uptale: when a creator publishes a new version, learners get it with nothing to upload again.
What goes back to Moodle
When a learner's session ends (they finish or close the experience), Uptale sends Moodle a score for the activity, with the activity marked as completed. The score is the number of stars the learner won, out of the stars available in the experience: its creator sets them with the experience's objectives (see Objectives, stars & success score).
With the Send only success score option, a session that doesn't meet the experience's success criteria sends nothing to Moodle.
Moodle only receives this summary. The detailed results (path, answers, session reports) stay in Uptale's reports: see Data tracked & LMS data.
What you need
- A Moodle site where you are a site administrator, with the External tool plugin (mod_lti) enabled.
- Someone with the Environment Administrator role in your Uptale environment: they see the Moodle LTI card on the environment's Integration tab.
- At least one Uptale workspace with published experiences to offer in Moodle.
If the Moodle LTI card isn't on your Integration tab, or if you'd rather Uptale finished the setup for you, contact support@uptale.io.
Set it up
The setup goes back and forth once between the two platforms: Uptale gives the addresses to enter in Moodle, then Moodle gives the identifiers to enter in Uptale.
Before you start: the External tool plugin
- In Moodle, go to Site administration › Plugins › Plugins overview and search for External tool (mod_lti).
- If it's disabled, open Manage activities from the Plugins page and enable External tool.
Step 1: create the configuration in Uptale
- In Uptale, open your environment, click the Integration tab, then Open details on the Moodle LTI card.
- Click Configure this integration. The Configuration area appears, with Uptale tool URLs to copy into Moodle: OIDC initiation URL, Redirect / callback URL, Public JWKS URL and Deep-linking URL.
Note: The Redirect / callback URL is specific to your configuration. Always copy it from the card. If you delete the configuration and create a new one, update it in Moodle.
Step 2: register Uptale in Moodle
- In Moodle, go to Site administration › Plugins and, under External tool, open Manage tools.
- Click Configure a tool manually.
- Fill in the fields as below, then click Save changes.
| Moodle field | Value |
|---|---|
| Tool name | Uptale, or any name you like |
| Tool URL | https://my.uptale.io |
| LTI version | LTI 1.3 |
| Public key type | Keyset URL |
| Public keyset | The Public JWKS URL from the card (https://my.uptale.io/.well-known/lti-jwks.json) |
| Initiate login URL | The OIDC initiation URL from the card (https://my.uptale.io/lti/authenticate) |
| Redirection URI(s) | The Redirect / callback URL from the card |
| Tool configuration usage | Recommended: Show in activity chooser and as a preconfigured tool |
| Default launch container | New window, or according to your preference |
| Supports Deep Linking | Yes |
| Content Selection URL | The Deep-linking URL from the card (https://my.uptale.io/lti/deeplinkselect) |
| IMS LTI Assignment and Grade Services | Use this service for grade sync and column management |
| IMS LTI Names and Role Provisioning | Do not use this service |
| Tool Settings | Do not use this service |
| Share launcher's name with tool | Recommended: Always (needed to show learners' names in Uptale) |
| Share launcher's email with tool | Recommended: Always (needed to show learners' emails in Uptale) |
| Accept grades from the tool | Recommended: Always. At a minimum: As specified in Deep Linking definition, or Delegate to teacher |
The addresses above are those of Uptale's EU instance. If your environment is on the US instance, they start with https://my.us.uptale.io: the card always shows the right ones. See Hosting: EU and US instances.
Step 3: finish the configuration in Uptale
- In Moodle, on the Manage tools page, open the tool's configuration details. Moodle shows the identifiers it generated for Uptale.
- In Uptale, on the Moodle LTI card, click Edit and copy each value from Moodle:
Uptale field Moodle value Display name A name of your choice, for example your Moodle site's name Platform ID Platform ID Application ID Client ID Keyset URL Public keyset URL Token endpoint Access token URL Authorization endpoint Authentication request URL - Under Role assignment, add the workspaces whose experiences Moodle can offer. People coming from Moodle get the Learner role on them.
- If needed, turn on Send only success score.
- Click Save and activate. The state shows Activated.
Prefer Uptale to finish the setup? After step 2, send the tool's configuration details from Moodle (platform ID, client ID and the URLs) to support@uptale.io, with the workspaces to open to Moodle. Uptale confirms when the configuration is active.
Use it
Add an experience to a course
- In the Moodle course, turn editing on and click Add an activity or resource.
- Select the preconfigured external tool Uptale (or the name you gave it).
- In the activity settings, click Select content. The Uptale selection window opens.
- Choose a workspace under Available workspaces, pick the experience, then click Select.
- Back in Moodle, the activity's name and description are filled in, and its maximum grade is the number of stars available in the experience. Set the Grade to pass and the Completion conditions as you need, then save.
Note: Only published experiences are listed. Set the experience's objectives and stars before adding it: an experience with no stars to win gives Moodle no maximum grade.
How learners launch an experience
Learners click the activity in their Moodle course. The experience's launch page opens in a new window (or as set in the tool's launch container), with the learner already signed in to Uptale. From there, they play in their web browser, or on a VR headset with the experience launch code shown on the page: see All the ways to play.
Limits
- Only published experiences of the workspaces listed under Role assignment can be added and played. See Publish an experience.
- Role assignment only applies to new connections. People who already came from Moodle before you added a workspace don't get it automatically: give them access from the workspace's Access management tab.
- One Moodle site per environment on this card.
- Sessions launched from Moodle don't count towards Uptale programs: a program only counts the sessions launched from the program itself.
Troubleshooting
The Moodle LTI card isn't on the Integration tab, or says to contact support
Only Environment Administrators see the Integration tab. If the card is missing, or shows To set up this integration, please contact support@uptale.io., contact support@uptale.io.
Uptale won't save the configuration
You see Required configuration fields are missing. Fill in every field of LTI sign on data, and check that each address is a full address starting with https://, copied from Moodle's tool configuration details.
The selection window lists no workspace or no experience
Add the workspace under Role assignment on the Moodle LTI card, and check that its experiences are published. Teachers who already opened Uptale from Moodle before the change may need access from the workspace's Access management tab.
"Session has expired or was not launched correctly"
You see Session has expired or was not launched correctly. Please try again. The selection window stays valid for one hour after it's opened from Moodle. Close it and click Select content again.
"Your platform does not support Uptale's LTI launch"
You see Your platform does not support Uptale's LTI launch (ltiResourceLink, window). Please contact your administrator. Uptale adds each experience as a link that opens in a window. Check the tool's settings in Moodle against step 2, especially Supports Deep Linking and Content Selection URL.
A learner sees "Oops, unauthorized access"
The experience isn't published, or the learner has no access to its workspace. Publish the experience, add its workspace under Role assignment, or give the learner access from the workspace's Access management tab if they had already come from Moodle before.
No grade appears in Moodle
The grade is sent when the session ends. Check that IMS LTI Assignment and Grade Services and Accept grades from the tool are set as in step 2, that the experience has stars to win, and that Send only success score isn't holding back a failed session.
Learners show up without their name in Uptale
Set Share launcher's name with tool and Share launcher's email with tool to Always in the tool's settings in Moodle. The change applies from the learners' next launch.