Admin Guide for Canvas

  • Last updated on December 19, 2024 at 10:54 AM

The admin will need to set up external LTI tool and create an LTI app on Canvas and launch the MagicBox portal. Follow the below steps to complete the configuration.

Prerequisites:

  1. Access to Canvas: Ensure you have administrative access to your Canvas instance.

  2. LTI 1.3 Credentials: Obtain the LTI 1.3 credentials (client ID, client secret, and authorization URL) from the external tool you're integrating.

  A. Set up external LTI tool in Canvas. 

  1. As the LMS Administrator, log in to Canvas and select Admin from the left navigation.

Open Account
2. Click Developer Keys from the inner left navigation.
Open Developer Keys
  1. Select the blue Developer Keys button. Choose the LTI Key from the dropdown menu.

Add LTI Key
  1. On the Key Settings screen, enter the required information. 

  • Key Name: The name of the external tool.

  • Owner Email: The email of the person who owns the external tool.

  • Redirect URLs: Redirect URL data should be provided by the tool provider (“Launch URL” from magic box platform)

  • Notes: Any notes about the LTI key, such as the reason it was created.

 


5. For Method, choose Manual Entry.

6. Title is the name of the LTI 1.3 tool that you will send to instructors so they can use the tool in their course.

7. For the Target Link URL- Enter the Redirect URL again.

8. For OpenID Connection Initiation URL- Enter the value of Login Initiation URL from the MB portal as the OpenID Connection Initiation URL (refer to the screenshot below).

9. For the JWK Method, choose Public JWK.

10. For Public JWKS - You will find this on the magic box platform - click on “View” > select Keyset URL > paste this keyset under new browser and click enter and then paste the values from the curly bracket as highlighted below in Public JWKS.


11. Check the below LTI 1.3 services to enable gradepass passback services. 

12.Go to Additional Settings and select public.

 

13. Now scroll down to Placements.

14. Delete Account Navigation, which is populated by default. 



15. Begin entering Assignment and then select Assignment Edit, Assignment Selection, Assignment View, Assignment Menu to add it beside Link Selection. 


16. Select > next to Link Selection to expand the page.


17. In the Target Link URI field, copy and paste the Target Link URI that you entered earlier on this page.

18. For Select Message Type, choose LtiResourceLinkRequest.

19. Select > next to Assignment Edit, Assignment Selection, Assignment View, Assignment Menu to expand the page and enter the same values as you did for Link Selection.


20. Click Save below the completed Link Selection and Assignment sections.


21. After you have set MagicBox up as an LTI 1.3 Tool, you can place LTI links into courses.

MagicBox supports LTI 1.3 which allows you to place links via Course Navigation, or via the tool modules via Link Selection, or both.

  • Course Navigation - link placement is enabled by default within the course navigation menu. Using course navigation is Ideal if you are using the same link in every course. This is not recommended if you would like to launch to a specific digital content as that requires the link is edited when added to a course.

  • Link Selection - enables link placement within course modules. This is ideal for launching specific digital content. 

22. View your LTI key [1]. LTI keys are indicated by the External Tool icon [2].
View LTI Key

23. Complete the platform setup on Magicbox once the external tool is created on Canvas, copy the ID from the details column from the canvas and paste it to the client ID input box on Magicbox portal.

24. And update the below URLs to the Magicbox portal.

27. Click "Update" to successfully add a platform on the MagicBox portal.

B.  Create a Course on Canvas

  1. Login with the admin credentials on the Canvas site. 
  2.  After redirecting to the admin portal, the canvas admin has to click on the Course and "+ Courses' button to add the new course.


3. Fill the below details to create a new course.

4. Once the course is created, Canvas admin will have to publish the course by clicking on the "Publish" button. 

B. Once the course creation is done, the canvas admin has to add the App by clicking on the Settings tab.

1. Open the Account

Open Account

2. Click the Admin link [1], then click the name of the account [2].

3. In Account Navigation, click the Settings link.
Open Settings


4. Click the Apps tab.
Open Apps


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


6. Select the configuration type as - By Client ID. The client ID is a numeric ID, can be copied from the developer keys.

7. When the Add App prompt appears, click the Install button. 


C. After successfully adding the app, the canvas admin has to add one assignment to call that app.


1. Click on the course in which you want to add the assignment. 

2. In Course Navigation, click the Assignments link.

Open Assignments


3. Click the Add Assignment button.

Add Assignment


4. In the Submission Type drop-down menu, select the External Tool option.
Select Submission Type
5. Click the Find button [1] or enter the External Tool URL in the URL field [2].
Find External Tool




6. If you want the assignment to load in a new tab, click the Load in a new tab checkbox.
Desktop
7. If you are ready to publish your assignment, click the Save & Publish button [1]. If you want to create a draft of your assignment and publish it later, click the Save button [2].
Save and Publish
8. Return to the Course and click on the assignment to launch the assignment. 

9. Click on the Assignment app will launch the MagicBox portal on canvas. Please refer to the screenshot. 

Once this setup is complete, canvas admin have to add the users in canvas account and also in the course.


Note: Traditionally, canvas is responsible for managing user access through its filtering options when adding new users. As it stands, all user credentials created in Canvas are directly used for MagicBox without additional restrictions.


Was this article helpful?