Skip to end of metadata
Go to start of metadata

Badgr for Canvas may be added as an LTI app to Canvas courses, Accounts, or Sub-Accounts.

See also: How do I add Badgr to a single Canvas Course?

A Canvas administrator can easily make badges available to teachers (account-wide) in all courses at once. Instead of navigating to a single course's settings, start from the Account Settings available in the Admin menu. Badgr may be added to either Accounts or Sub-Accounts.

Access the Account Settings Apps tab from the Admin Menu. If you have the EduAppCenter activated, you can add Badgr to all your courses with just a few clicks!

Enable Badgr in all courses on a Canvas Account at once

These quick instructions will allow a Canvas administrator to add the Badgr app to all courses on an account in one step. Only this administrator will need to create a Badgr account to make the power of badges available to all teachers on the account.

  1. Create an account on Badgr.io using the same email address used as your primary Canvas ID (or add this as a secondary address to an existing Badgr account)
  2. Click APP Integrations in the upper-right settings menu in Badgr, (confirm your canvas server URL if necessary), and you will see your LTI credentials
  3. In another window or tab, log into Canvas with your administrator credentials. Go to the desired Canvas account or sub-account, choose Settings in the left-hand menu, and select the Apps tab
  4. Select Badgr from the list (if connected with the EduAppCenter) or add a new custom integration
  5. If you are not using the EduAppCenter, choose the By URL method and copy the Config URL into the dialog
  6. Copy the values for your LTI shared secret and consumer key from Badgr into the dialog
  7. Submit the form and refresh the page
  8. Observe that a new Badges tab will appear on your left-side course navigation in all courses on the account

Variation: Make Badgr optionally available across a Canvas Account or Sub-Account

Here's a method that will allow a Canvas administrator to enable Badgr within an account but disabled by default, so that teachers who want to turn it on may do so from their course's settings page.

  1. Create an account on Badgr.io using the same email address used as your primary Canvas ID on your administrator account (or add this as a secondary address to an existing Badgr account)
  2. Click LTI Info in the upper-right settings menu in Badgr, (confirm your canvas server URL if necessary), and you will see your LTI credentials
  3. In another window or tab, log into Canvas with your administrator credentials. Go to the desired Canvas account or sub-account, choose Settings in the left-hand menu, and select the Apps tab
  4. Select View App Configurations to escape the EduAppCenter then Add App to add a custom App configuration
  5. Select the Paste XML method
  6. Copy the values for your LTI shared secret from Badgr and consumer key into the dialog
  7. Paste the below XML code into the XML box
  8. Submit the form and refresh the page
  9. Observe that Badges now appears as a disabled option in the Settings > Navigation screen for each course on the account
  10. To enable Badgr for Canvas in a course:
    1. Navigate to the course, then select Settings from the left-side course navigation menu
    2. Choose the Navigation tab, and find the entry for Badges at the bottom of the list among the disabled options
    3. Enable it and save
    4. The Badges tab will now appear in the course navigation on the next page load

 

Custom XML
<cartridge_basiclti_link xmlns="http://www.imsglobal.org/xsd/imslticc_v1p0"
                         xmlns:blti="http://www.imsglobal.org/xsd/imsbasiclti_v1p0"
                         xmlns:lticm="http://www.imsglobal.org/xsd/imslticm_v1p0"
                         xmlns:lticp="http://www.imsglobal.org/xsd/imslticp_v1p0"
                         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                         xsi:schemaLocation="http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0.xsd http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd">
    <blti:title>badgebook</blti:title>
    <blti:description>
        Integrate with Badgr Server to award badges to students for Module completion.
    </blti:description>
    <blti:launch_url>https://api.badgr.io/badgebook/</blti:launch_url>
    <blti:extensions platform="canvas.instructure.com">
        <lticm:property name="privacy_level">public</lticm:property>
        <lticm:property name="tool_id">badgebook</lticm:property>
        <lticm:options name="custom_fields">
            <lticm:property name="person_address_timezone">$Person.address.timezone</lticm:property>
        </lticm:options>
        <lticm:options name="user_navigation">
            <lticm:property name="url">https://api.badgr.io/badgebook/user</lticm:property>
            <lticm:property name="text">My Badges</lticm:property>
            <lticm:property name="enabled">true</lticm:property>
        </lticm:options>
        <lticm:options name="course_navigation">
            <lticm:property name="url">https://api.badgr.io/badgebook/</lticm:property>
            <lticm:property name="text">Badges</lticm:property>
            <lticm:property name="enabled">true</lticm:property>
			<lticm:property name="default">disabled</lticm:property>
        </lticm:options>
        <lticm:options name="account_navigation">
            <lticm:property name="url">https://api.badgr.io/badgebook/</lticm:property>
            <lticm:property name="text">Badgr Analytics</lticm:property>
            <lticm:property name="enabled">true</lticm:property>
        </lticm:options>
    </blti:extensions>
</cartridge_basiclti_link>

With this custom XML, Badgr will be available in all courses, but with the navigation entry disabled by default. The below is the property that varies from the default configuration:

<lticm:property name="default">disabled</lticm:property>

User navigation (a view of all badges earned by a student on the canvas server from their profile navigation menu) will be available if this XML is installed at the root account level.

LTI Configurations

For more information about controlling the configuration of LTI apps in Canvas, see Instructure's Importing Extended Tool Configurations

 

Need more help? Contact us at help@badgr.io