Unizin Product Documentation
ProductsSupport and TrainingPolicies
  • Unizin Product Documentation
  • Products
    • Content
      • Unizin Engage
        • eReader User Guide
          • Notes, Highlights, and Citations
          • Appearance Settings
          • Download for Offline
          • eReader Layout
          • Keyboard Shortcuts
          • Navigating Your eBook
          • Print
          • Text to Speech
          • Copy and Paste
          • Creating Flashcards
          • Collaboration and Note Sharing
          • Pearson Titles
        • Institution Support
          • Disabled Student Services / Alt-Format
            • Best Practices for Republishing Course Content
            • Disabled Student Services
            • Requesting eTextbook Files for Accessibility Purposes
            • WCAG 2.0 AA evaluation for Engage
            • WCAG 2.0 AA evaluation for EPUB for Engage
          • Institution's Support Responsibilities
        • Caliper 1.1 sensor
        • Release Notes
          • 2.28.22
          • 2019-09-17
          • 2019-05-29
          • 2.26.8
          • 2.26.0
          • 2.25.0
          • 2.22.0
          • 2.21.6
          • 2.21.5
          • 2.20.8
          • 2.20.5
          • 2.20.3
          • 2.19.1
          • 2.18.0
          • 2.17.0
          • 2.14.0
          • 2.12.0
          • 2.11.0
          • 2.9.0
          • 2.8.3
          • 2016-03-17
          • 2016-02-11
          • 2016-01-28
        • Using Analytics (New)
      • Unizin Order Tool
        • Overview of the User Interface
        • Key Concepts
          • Profiles
          • Ordering periods
          • Coordinator permissions
          • Program administrator permissions
        • Courses & Ordering
          • Course filtering
          • Place an order
          • Add sections to a placed order
          • Edit a placed order
          • Cancel an order
          • Reordering
        • Order History
          • Instructor Order History
          • Coordinator and Program Administrator Order History
          • Order Activity
        • Student Choice
          • Student Choice (Program Administrators)
          • Student Choice (Students)
        • Entitlements
          • Entitlements (Program Administrators)
          • Entitlements (Students)
        • Catalog Tool
        • Schedule of Classes
        • Content Request Tool
        • Order Tool Dashboard
        • Vendor Sandbox Tenant
        • Institution Support
        • Implementation
          • SIS Data Integration
            • 1.0 - SIS Integration
            • 2.0 - SIS Integration
          • SSO integration
          • UI customizations
          • Order Feed
            • 1.0 - Order Feed
            • 2.0 - Order Feed
            • 3.0 - Order Feed
          • Publisher report
          • Final declined offers feed
          • Institutional (SIS) Catalog Import
          • Student Price
          • Historical Entitlements Import
        • Release Notes
          • Order Tool Bug Fixes and Enhancements
          • Order Tool Bug Fixes
          • Order Tool Accessibility Improvements
          • Order Feed Improvements
          • Content Request Form Update and Minor Bug Fix
          • Flat Markup Fee Update
          • Ordering Email Receipt Update & Minor Bug Fix
          • Bug Fix for Public Catalog Feature
          • Catalog Search Enhancements
          • Reordering Reminder Email Notifications
          • UX Improvements & Minor Bug Fixes
          • Historical Entitlements Import
          • Student Prices
          • Reordering Feature
          • Email Enhancements
          • Ordering Enhancements
          • Bug Fix for the Institutional Catalog Import
          • Bug Fix for the Final Declined Offers Feed (FDOF)
          • Order Activity Feature and Other Enhancements
          • Bug Fixes for Order History and Report an Issue Features
          • Public catalog feature
          • Minor Bug Fixes for Ordering and Student Choice
          • Entitlements Production Release, Bug fixes, and Minor updates
          • Minor Updates and Bug Fixes for Ordering Workflows
          • Catalog Search Optimization
          • Student Choice
          • Archive Terms Feature and Integration Improvements
          • Introduces the Program Administrator role, Catalog Tool, and Schedule
          • User interface updates and improvements
          • Order feed improvements
          • Order history, UI enhancements
          • Email notification upgrades, UI improvements
          • Order feed changes
          • New features for Course coordinators and upgrades to the UI
          • Changes to the Term, Course, and Section models; introduces a Session
          • Bug fixes, import improvements, and validation improvements
          • Tracking Order History
          • Publisher Reporting
          • Fixes the order feed, automates SIS data importing, and automates the generation of order feed repor
    • Data & Analytics
      • Unizin Data Platform
        • Key concepts
          • Platform overview
          • Data categories
          • Data models
          • Loading schemas
          • Keymap
        • Unizin Common Data Model
          • Academic structures (ERD)
          • Learners (ERD)
          • Course structures (ERD)
          • Course resources (ERD)
          • Learner activities (ERD)
          • Quizzes (ERD)
          • Social (ERD)
          • Course outcomes (ERD)
        • System overview
          • Context data pipeline
            • Context data ingress
            • Batch-ingest application
            • Batch-ingest db server
            • Context store
          • Event data pipeline
            • UDP Caliper endpoint
            • Approval process for implementing Caliper compliant tools
            • UDP Event enricher
            • Event store
        • Data stores
          • Data lake
            • UDP Context store
            • UDP Event store
              • Accessing the Event store
              • Expanded table
                • Expanded table: Canvas edApp mapping
            • Synthetic Data [beta]
              • Viewing Synthetic Data datasets within the BigQuery UI
              • Query Synthetic Data via client libraries
          • Data marts
            • UDP Distributions
            • Interaction sessions
            • Learning Environment Organization
            • File Interaction
            • Last Activity
            • Long Inactivity
            • Course Status
            • Daily Course Grade Record
            • LTI Tool Use
            • LMS Tool Use
            • Tool Usage Metrics
            • Links
            • Taskforce
              • Level 1 Aggregated
              • Level 2 Aggregated
              • Level 2 Course Weekly Distribution Summary
              • Student Term Profile
              • Course Profile
            • Student Activity Score
              • Student Course Metrics
              • Student Course Section Metrics
              • Final
              • Course Final
              • Course Section Final
        • Data integrations
          • Context data integration
            • Loading schema
            • Keymap support
            • Manifest file
            • File requirements
            • Integration mechanics
          • Event data integration
          • SIS data integration
          • LMS data integration
            • Instructure Canvas
        • Release Notes
          • UDP Marts Release Notes
            • 1.0.83
            • 1.0.80
            • 1.0.79
            • 1.0.78
            • 1.0.77
            • 1.0.72
            • 1.0.67
            • 1.0.58
            • 1.0.51
            • 1.0.44
            • 1.0.42
            • 1.0.32
            • 1.0.31
            • 1.0.0
            • Level 2 Taskforce data marts now available
          • 2.0.167
          • 2.0.152
          • 2.0.138
          • 2.0.137
          • 2.0.113
          • 2.0.112
          • 2.0.111
          • 2.0.110
          • 2.0.99
          • 2.0.98
          • 2.0.83
          • 2.0.80
          • 2.0.71
          • 2.0.66
          • 2.0.59
          • 2.0.58
          • 2.0.53
          • 2.0.47
          • 2.0.25
        • Miscellaneous
          • Canvas Data additions, ~Fall 2021
          • Canvas Live Events: from SQS to HTTPS
          • Canvas New Analytics vs. UDP
          • Course Section Enrollment Role Status Mappings
          • Migrating from UDW to UDP
      • Unizin Data Warehouse
        • Implementation Guide
        • Scope of Services
        • Access Provisioning
        • Access Revocation
        • Connecting to the UDW
      • Raw Canvas Data 2
        • Flat Files
        • BigQuery Datasets
    • Hosted Services
      • My Learning Analytics
        • Install MyLA via LTI 1.3
        • Custom configure MyLA
  • Support and Training
    • Professional Development
      • Stepping Stones: A Faculty Development Curriculum for Learning Analytics Use
      • Structured Conversations initiative
    • UDP Self-paced Training
    • Resources Site Broken Links
    • Status Pages
  • Policies
    • General policies
      • Sponsor Teams
      • Browser Support Policy
      • Opt-Out & Invoicing Policy (Order Tool)
    • Support Policy
      • Unizin Engage - SP
      • Unizin Order Tool - SP
      • Unizin Data Platform - SP
      • Unizin Data Warehouse - SP
      • Unizin Data Analysis - SP
      • Pressbooks Hosting - SP
    • Privacy Policy
      • Unizin Engage - PP
      • Unizin Order Tool - PP
      • Unizin Data Platform - PP
      • RStudio service - PP
    • End User License Agreements
      • Unizin Engage - EULA
      • Unizin Order Tool - EULA
    • Terms of Use
      • Unizin Data Platform - ToU
    • Incident Reports
Powered by GitBook
LogoLogo

Unizin Homepage

  • unizin.org

Data & Analytics

  • Unizin Data Platform
  • Unizin Data Warehouse

Content

  • Unizin Engage
  • Unizin Order Tool

Hosted Services

  • My Learning Analytics

Copyright © 2023, Unizin, Ltd.

On this page
  • Create the LTI key
  • Activate the LTI key
  • Install the MyLA app in the desired course(s)
  • Generate public and private keys
  • Send information to Unizin
  1. Products
  2. Hosted Services
  3. My Learning Analytics

Install MyLA via LTI 1.3

PreviousMy Learning AnalyticsNextCustom configure MyLA

Last updated 1 year ago

MyLA integrates with the LMS using the LTI 1.3 standard.

To install and configure MyLA, Unizin needs an LTI key from your LMS instance. The purpose of the LTI key is to support the LTI authentication protocol in LTI 1.3. Generally speaking, you should follow for MyLA.

The following sections describe:

  1. How to configure an LTI key for MyLA

  2. What information to gather from Canvas

  3. What information to send, securely, to Unizin Services

Note that Unizin Services will take care of the MyLA integrations with your UDP and UDW instances. You do not need to gather any authentication or credential information for them.

Create the LTI key

Follow . You will need to input configuration variables – please refer to the table below for guidance about how to set the values for the configurable variables of an LTI Key.

Shortcode In the documentation below, the term <shortcode> must be replaced by the standard top-level domain name of your institution. For example, Colorado State’s shortcode is colostate (for ); Indiana University’s is iu (for ).

Use the following values for the LTI Key settings.

Key name

My Learning Analytics

Owner email

An admin at your institution

Redirect URIs

https://myla.<shortcode>.cloud.unizin.org/lti/launch/

Method

Manual entry

Title

My Learning Analytics

Description

My Learning Analytics

Target link URI

https://myla.<shortcode>.cloud.unizin.org/lti/launch/

OpenID Connect Initiation URL

https://myla.<shortcode>.cloud.unizin.org/lti/login/

JWK Method

Public JWK URL

Public JWK URL

https://myla.<shortcode>.cloud.unizin.org/lti/jwks/

LTI Advantage services

Enable all services

Domain

myla.<shortcode>.cloud.unizin.org

Custom fields

user_username=$User.username

canvas_user_id=$Canvas.user.id

canvas_course_id=$Canvas.course.id

Privacy level

Public

Placements

Course navigation

Target Link URI (under placements)

https://myla.<shortcode>.cloud.unizin.org/lti/launch/

When you have successfully inputted the settings for a new LTI Key, Save the LTI Key.

Under Method, select the “Paste JSON” option.

Locate the “placements” array in the JSON.

In the “placements” array, add the following to the first object

Default
"default": "disabled",

By setting the default to "disabled," MyLA will not be installed in courses by default. A fully configured placements array might look like this:

Placements
"settings": {
  "placements": [
    {
      "default": "disabled",
      "placement": "course_navigation",
      "message_type": "LtiResourceLinkRequest",
      "target_link_uri": "https://path.to.myla/lti/launch/"
    }
  ]
},

Activate the LTI key

Once the above is completed, change the State of the key from "OFF" to "ON".

Install the MyLA app in the desired course(s)

Generate public and private keys

Send information to Unizin

You will need to collect the following information from your Canvas instance and send it to Unizin. Only when Unizin receives this information can it configure your MyLA courses.

Client ID

For the LTI Key you created, you will need to send the Client ID value. On your Developer keys admin page where the LTI keys are listed, the Client ID value will be presented in the Details column (note: this is not the key value itself).

Public/Private key pair

Unizin will need to install the public & private keys you create on the MyLA instances. This will enable MyLA to authenticate and securely communicate with your Canvas instance.

Deployment ID

You will need to send all of the app Deployment IDs used to install MyLA in your courses. If you’ve installed MyLA on a course by course basis, you will have a deployment ID for each course.

The deployment ID is found in the External apps settings page. Click the gear button next to your installed MyLA app. Choose “Deployment ID” from the gear menu. Send the full value to Unizin.

Course Identifier

Unizin will need the corresponding Canvas Course identifier for each course where MyLA is installed. This identifier can be found in the URL for the course in Canvas.

Follow the MyLA app in a course using the LTI Key.

To enable LTI launch requests, MyLA needs a public/private RS256 key pair in PEM format. Institutions must generate their own public/private key pair in PEM format. If you need help generating public/private keys, .

Instructure’s guidelines for installing a developer key
Instructure's guide to creating an LTI Key in Canvas
colostate.edu
iu.edu
Instructure’s instructions for installing
Michigan provides a Python program that you can run to generate your own keys