Install MyLA via LTI 1.3

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 Instructure’s guidelines for installing a developer key 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 Instructure's guide to creating an LTI Key in Canvas. 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 colostate.edu); Indiana University’s is iu (for iu.edu).

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)

Follow Instructure’s instructions for installing the MyLA app in a course using the LTI Key.

Generate public and private keys

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, Michigan provides a Python program that you can run to generate your own 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.