How do I configure an external app for a course using XML?

Document created by Canvas Doc Team Employee on Oct 7, 2017Last modified by Canvas Doc Team Employee on Feb 17, 2018
Version 7Show Document
  • View in full screen mode

One way to configure an app for a course is by using XML.

To learn more about configuring external apps, visit the Edu App Center.

Note: Configuring an external app is a course permission. If you cannot configure an external app, your institution has restricted this feature.

Open Settings

Open Settings

In Course Navigation, click the Settings link.

Open Apps

Open Apps

Click the Apps tab.

View App Configurations

View App Configurations

To configure an app, click the View App Configurations button.

Add New App

Add New App

Click the Add App button.

Set Configuration Type

Set Configuration Type

Select the Configuration Type drop-down menu and set the configuration type to Paste XML.

Add App Details

Add App Details

Enter the name of the app in the Name field [1]. Enter the consumer key in the Consumer Key field [2] and the shared secret in the Shared Secret field [3]. This key and shared secret will be provided by the vendor or (if using the Edu App Center) provided by the website.

Note: There are some apps that do not require a consumer key or shared secret, so pay attention to the configuration directions.

Enter Configuration XML

Enter Configuration XML

Copy the XML code in the paste XML here field [1]. Click the Submit button to link the app [2].

Verify App

Verify App

If the app has already been added in the account, Canvas verifies that you still want to install the app. To continue, click the Yes, Install Tool button.

View App

View App

View the linked app.

To edit, see the placements, or delete the app, click the Settings icon [1]. To edit the app, click the Edit link [2]. To see the placements where an app can be enabled, click the Placements link [3]. To delete the app, click the Delete link [4].

Note: When you click the Placements link, you may see a No Placements Enabled message. This message indicates that the app does not have any specified placements within Canvas. However, the app will still work as intended.

You are here
Table of Contents > External Apps (LTI) > How do I configure an external app for a course using XML?

Attachments

    Outcomes