Canvas Guides (en)Canvas Admin Guide External Apps (LTI)How do I configure an external app for an account using XML?

How do I configure an external app for an account using XML?

Some external apps require an XML configuration. This lesson shows how to add an external tool using the XML provided by the external app provider. To learn more about configuring external apps, visit the Edu App Center.

Notes:

  • External apps can also be configured using XML in sub-accounts.
  • Manually configuring an external app is an account permission. If you cannot configure an external app, this permission has not been enabled for your user role.

Open Settings

Open Settings

In Account 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

In the XML Configuration field, paste the XML code.

Submit App

Submit App

Click the Submit button.

View App

View the external app.

To edit, see the place(s) the app will appear, or delete the app, click the Settings icon [1]. To edit the app, click the Edit link [2]. To see the places the app will appear, click the Placements link [2]. To delete the app, click the Delete link [4].