Canvas · For administrators

Install Voshi in Canvas

Voshi is installed once per Canvas instance, not once per tool. After that, instructors add the tools they want themselves.

Instructors add Voshi tools themselves, through the Voshi deep linking dialog; you never add tools one at a time. Canvas lists Voshi under the MyEducator name. Most schools already have it, so check before you install.

Check whether it's installed

In Admin, choose your root account and open Developer Keys. If a key named MyEducator Resources 1.3 (or whatever name your school gave it) is listed and its State is On, look in Settings → Apps → View App Configurations for an app of the same name. If both are there, Voshi is installed: send instructors to Add Voshi to Canvas.

Screenshot to come
Developer Keys on the root account, with the MyEducator Resources 1.3 key switched On.

Before you start

  • You need to be an administrator of the root account: developer keys can only be created there.
  • It takes about ten minutes, plus the time it takes MyEducator to turn on your school (step 4).

When you create the key, Canvas shows what it grants. In plain terms:

Canvas showsWhat it lets Voshi do
Privacy level PublicReceive the name and email address of each person who opens a tool, so their work and grades follow them.
Line items, scores, resultsCreate gradebook columns for graded activities, post scores to them, and read them back.
Course membershipRead a course's roster.
Progress, account lookup, public JWKCanvas-specific: check that a posted score was recorded, read the account's name, and keep Voshi's signing key current.

1. Create the developer key

  1. Open Developer Keys

    In Admin, choose your root account, then Developer Keys. Click + Developer Key and choose + LTI Key.

    Screenshot to come
    The + Developer Key menu open, with + LTI Key.

  2. Fill in the key

    FieldValue
    Key NameAnything you will recognize, such as MyEducator
    Owner EmailYours
    Redirect URIshttps://api.link.voshi.com/lti13/v1/launch
    MethodEnter URL
    JSON URLhttps://api.link.voshi.com/lti13/v1/config?product_family_code=canvas

    Click Save.

    Screenshot to come
    The Key Settings form, filled in, with Method set to Enter URL.

  3. Turn it on

    The new key is listed with its State set to Off. Switch it On.

  4. Copy the Client ID

    The key's Details column shows a long number, its Client ID. Copy it.

    Screenshot to come
    The new key in the list: State On, and the Client ID in the Details column.

2. Install the app

  1. Open the app configurations

    In the account where Voshi should be available, open Settings → Apps → View App Configurations, and click + App.

    Install it in the root account to make it available in every course. To limit it to part of your school, install it in that sub-account instead.

  2. Add it by Client ID

    Set Configuration Type to By Client ID, paste the Client ID, and click Submit. Canvas shows the app's name, MyEducator Resources 1.3; click Install.

    Screenshot to come
    The Add App dialog, set to By Client ID, with the Client ID pasted.

3. Try it

In a test course, add a tool as an instructor would, following Add Voshi to Canvas. You should see Voshi in three places:

WhereCanvas lists Voshi as
An assignment's External Tool submission typeMyEducator Assignment Selector
A module's Add Item → External ToolMyEducator Deep Linking
The rich content editor's Apps menuMyEducator Reading Links

4. Wait for your school to be turned on

The first launch from a new installation shows LTI Login Not Enabled. This is expected: each new school is turned on by the MyEducator team, which is notified automatically when it happens. To speed it up, email integrations@myeducator.com with your school's name, your Canvas address, and the Deployment number shown in the message.

Screenshot to come
The LTI Login Not Enabled message, with its Deployment number.

Once your school is on, there is nothing more to do. New Voshi tools appear in the dialog as builders publish them, with no change on your side.

Removing Voshi

To stop new launches everywhere, switch the developer key Off. To remove it from one account, delete the app in that account's Settings → Apps → View App Configurations. Either way, links already placed in courses stop working.