Skip to main content

Integrating ArborXR with Canvas using LTI 1.3 Registration

This guide provides a structured walkthrough to integrate ArborXR with Canvas using LTI 1.3 Dynamic Registration. Follow these steps to configure.

Written by Matthew Kuykendall

💡 This is a step-by-step for Canvas, but should be sufficient information as a generalized help for most LMSs.

It is required that your application be integrated with Insights. If you are unsure if your application has Insights capabilities, please contact us and let us know what vendor the content is from.


Step 1: Registering ArborXR to Canvas with a Dynamic Link

First, we'll set up Canvas to communicate with ArborXR by linking the two platforms with a dynamic link.

  1. Log in to your ArborXR web application.

    1. Navigate to your Organization's Settings page, and click 'LMS Connections'.

    2. Begin creating an LMS connection by adding the name of your LMS and selecting an Insights-integrated application (and module, if applicable).

    3. Select LTI as your Connection Method.

      1. Copy the LTI Launch Link from the LMS Connection page.

      2. Optionally, you can add web-based alternatives to the connection.

  2. Log in to Canvas as an admin and access your Canvas Admin Panel.

    1. From the Accounts page, select the account you want to install the tool under (in this example, ours is called ArborXR Dev but yours will be different).

    2. In the left-hand navigation, click Developer Keys.

    3. Click the + Developer Key button and select + LTI Registration from the dropdown.

    4. Paste the LTI Launch Link (copied from ArborXR) into the dynamic registration URL field and press Continue.

    5. You should see a "Registration Successful" screen. Press Close Window.

  3. The Register App modal will appear. Everything is pre-configured for you.

    1. Press Enable & Close.

    2. ⚠️ Keep all default settings untouched unless absolutely necessary. Changing permissions, user data sharing, or placements may break ArborXR's functionality.

  4. You should now see the new developer key listed as an entry on the Developer Keys page.


Step 2: Enabling the App for Your Account

After registration, the app is installed but not yet available to courses. We'll need to update its availability.

  1. In the left-hand navigation, click Apps.

  2. Click the Manage tab.

  3. Select the entry you just created (e.g., your Insights-integrated application name).

  4. On the Availability and Exceptions section, click the pencil icon next to the account you're currently in.

  5. Change the availability from Not Available to Available and press Save.

  6. You should see a confirmation that the exception availability has been updated successfully.


Step 3: Adding an Assignment to Your Course

To launch ArborXR and capture a graded attempt, you need to launch it from an assignment.

  1. Navigate to Courses on the far left sidebar and select the course where you want to integrate ArborXR.

  2. In the course's left-hand navigation, click Assignments.

  3. Click + Assignment in the top-right corner.


Step 4: Configuring Assignment Details and Submission Type

  1. In the General section, enter a meaningful Assignment Name (e.g., "Handwashing Sim").

  2. (Optional) Add a description for the assignment.

  3. Set the grading system as you require.

  4. Under Submission Type, select External Tool from the dropdown.

  5. Click Find next to the External Tool URL field.

  6. From the list, select the ArborXR tool you registered (e.g., "Handwashing Simulator") and click Select.

  7. Configure Submission Attempts, Assign Access, and Due Date as needed for your course. Unlimited Attempts is recommended.


Step 5: Save and Publish

  1. Click Save & Publish. You will get launched into the Assignment which you can test immediately, but you can also exit that screen by selecting "Assignments".

  2. Your assignment is now live. Students can launch the ArborXR training from this assignment.

Congratulations! 🎉 You have successfully integrated ArborXR with Canvas.


Step 6: Testing as a Student (Recommended)

We highly recommend testing the integration before assigning it to your students.

  1. Click View as Student in the top-right corner and then open the assignment you just created.

  2. You will see the assignment screen with a 6-digit PIN and a QR code.

  3. Put on your headset, launch the application, and either enter the PIN or scan the QR code when prompted.

    1. ⚠️It is required that you do this testing in an ArborXR provisioned headset. The MDM service maps your organization's information and settings which are required for Insights authentication. If you do not have a provisioned headset, please contact us as explained at the bottom of the page.

  4. Complete the training session in the headset.

  5. Once the session ends, you will see the Session Overview screen with your overall result (Pass/Fail), score, duration, activities completed, and a training timeline.


Step 7: Viewing Results in the Gradebook

  1. Navigate to the Grades tab in the course to see the submitted score.

  2. To revisit the Session Overview at any time, click the assignment name from the Grades tab. Canvas will present a link to the external session review page.

  3. Depending on your assignment settings, the student can take the assignment as many times as you allow.


💡 If you have any questions, contact ArborXR Support via the Messenger in the lower-right corner of the Web Portal!

Did this answer your question?