Skip to content
English
Visit edly.io
  • There are no suggestions because the search field is empty.

How to Add OneNote LTI in Edly as Instructor?

Overview

Integrating Microsoft OneNote into your course run allows instructors to deploy shared class notebooks, collaborative workspaces, and personal student journals directly inside a course unit. This integration relies on standard LTI (Learning Tools Interoperability) communication protocols to securely link your platform instance with Microsoft’s educational tools.

 

Note: The steps below describe the LTI 1.1 integration method, which uses per-course LTI Passports configured in Advanced Settings. This method remains fully supported in Open edX Ulmo. However, Ulmo also introduces a centralized Reusable LTI Store that supports the newer LTI 1.3 (LTI Advantage) standard. If your organization has configured the Reusable LTI Store, you may be able to set up OneNote as an LTI 1.3 tool at the platform level, eliminating the need for per-course passport configuration. Contact your site administrator to determine which method is recommended for your deployment.

Tip: Ensure you are logged into Open edX Studio with appropriate Admin or Staff permissions before proceeding.

Step 1: Generate OneNote LTI Credentials

Before configuring settings in Studio, you must register your course instance with Microsoft to obtain secure access keys.

  1. Navigate to the official Microsoft LTI Registration Portal (e.g., ononote.com/lti).
  2. Log in with your institution's Microsoft 365 Teacher or Admin account credentials.
  3. Select Register a new LMS/Platform and follow the onboarding prompts.
  4. Name your registration profile clearly (e.g., Edly_LMS_OneNote).
  5. Copy the generated Consumer Key, Shared Secret, and Launch URL displayed on the final success screen. Keep this window open for reference.

Step 2: Configure the LTI Passport in Studio

To establish a verified trust relationship between your platform database and Microsoft's content servers, you must save your credentials inside your course policy settings.

  1. Open your course run in Studio.
  2. From the Settings menu in the top navigation bar, select Advanced Settings.
  3. Locate or search for the LTI Passports field.
  4. Add your credential details inside the array brackets using this strict syntax format: ["onenote:CONSUMER_KEY:SHARED_SECRET"]
    • Note: Replace CONSUMER_KEY and SHARED_SECRET with the exact alphanumeric strings generated in Step 1. Retain the onenote: prefix identifier exactly as shown.
  5. Click Save Changes at the bottom of the screen.

Step 3: Enable the LTI Consumer Module

Next, you must verify that the LTI building tool is active within your current course run template.

  1. While still inside Advanced Settings, look for the Advanced Module List field.
  2. Inside the square brackets [ ], verify or add the key string exactly as: "lti_consumer"
    • Note: Ensure you use standard straight double quotation marks ("). Using smart curly quotes or missing commas between multiple blocks will result in a validation error.
  3. Click Save Changes.

Step 4: Embed the OneNote Component into a Unit

With your background keys saved, you can drop the live workbook portal onto any target learning page.

  1. Navigate to your Course Outline and open the specific Unit where you want the workbook to reside.
  2. Scroll to the Add New Component selection bar at the bottom of the unit workspace.
  3. Click the Advanced tile.


  4. Click LTI Consumer. The interface container block will immediately load onto your unit layout page canvas.

Step 5: Configure the LTI Consumer Tool Settings

You must configure the individual block instance to call your explicit Microsoft notebook module.

  1. Find the newly deployed LTI Consumer block on your unit canvas and click Edit.
  2. Enter the following parameters in the configuration window:
    • Display Name: Enter a customer-facing title (e.g., Collaborative Workspace: Class OneNote Notebook).
    • LTI ID: Type exactly: onenote (This matches the shorthand prefix identifier you declared inside your LTI Passport in Step 2).
    • LTI URL: Paste the specific launch URL copied from your Microsoft tool registration dashboard.
    • Scored Options: If this notebook is purely for collaboration, ensure the scoring parameters are turned off. If notebook participation counts towards grades, toggle grading to true and define an assignment category.
  3. Click Save.
  4. Click the Publish button in your right-hand status panel to push the unit updates live.

Student Experience in the LMS

Once published, the integration operates smoothly within the course layout player. When an enrolled learner opens the unit page, the LTI consumer initializes a secure iframe communication layer:

  • Automatic Creation: The system seamlessly provisions a personal workbook tab for the learner or logs them into the central shared class journal space based on their platform username parameters.
  • Inline Editing: Learners can type, draw, view lecture slides, or complete group activities directly inside the embedded viewport frame without ever leaving the LMS player.