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 Account
Click the Admin link [1], then click the name of the account [2].
Open Settings
In Account Navigation, click the Settings link.
Open Apps
Click the Apps tab.
View App Configurations
To configure an app, click the View App Configurations button.
Add New App
Click the Add App button.
Set Configuration Type
Select the Configuration Type drop-down menu and set the configuration type to Paste XML.
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
In the XML Configuration field, paste the XML code.
Submit App
Click the Submit button.
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.
Note: Verifications only take place in the same context for an existing external app (such as installing the same app multiple times in the root account).
View App
View the external app.
To manage the app, click the Settings icon [1]. To edit the app, click the Edit link [2]. To manage app placements, click the Placements link [3]. To delete the app, click the Delete link [4].
To add an external app to the Rich Content Editor toolbar, click the Add to RCE toolbar toggle [5]. This option is only available for external tools that support placement in the Rich Content Editor.
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.
