Applicable products: CertMaster Learn, CertMaster Learn+Labs, CertMaster Labs
CompTIA uses Canvas' JSON configuration option to configure its LTI 1.3 LMS integration tools in order to minimize customer configuration time. Below is a step-by-step process. For further assistance, see the screenshots at the bottom of this document, and feel free to reach out to your CompTIA representative or technical specialist with any questions.
If your Canvas instance is hosted by anyone other than Canvas/Instructure (either locally by your institution, or by a third-party hosting company), please make this known to your CompTIA Technical Specialist. This is an uncommon situation, but it can have significant effects on the integration process. If your instance is not Instructure-hosted, it will need to be updated to at least the April 16, 2022 release before proceeding.
Part 1: Make Developer Key
-
In Canvas, navigate to: Admin --> Developer Keys toward the bottom of the navigation list on the left
-
Click the colored +Developer Key button in upper right and select +LTI Key
-
Change Method dropdown in top center to Paste JSON
-
Copy and paste the contents of one of the JSON files emailed to you by your CompTIA Technical Specialist (including brackets).
-
Fill out Key Name and Owner Email at the top left. Neither affects functionality, but for the Key Name, you may copy the title value in the first line of the JSON configuration.
-
Click Save.
-
Change the red State button to On.
-
Copy the number shown in the Details column. This number is called the Client ID, and it will be used below.
Part 2: Add App
-
Click the Admin icon in the left navigation bar, and navigate to the Canvas Account, Sub-account, or Course where you’d like to make the integration tools available for instructors/course designers.
Please take care where you choose to configure the Canvas App, as all tool usage must fall within that part of the Canvas account/course hierarchy.
-
Click Settings at the bottom of the left navigation bar
-
Click the View App Configurations button in the upper right.
-
Click the colored +App button in the upper right.
-
Change the Configuration Type dropdown at the top to By Client ID.
-
Paste the Client ID you copied in Part 1, Step 8 into the field.
-
Click Submit and affirm your way through the dialogue boxes.
-
Find the App you just created in the list that appears. Click the Gear button to its right, select Deployment ID, and copy the value that appears into the email to your CompTIA Technical Specialist.
Part 3: Send parameters to CompTIA
-
Send the email with the Client ID and Deployment ID over to your CompTIA technical specialist, and they’ll finish the tool configuration within 1-2 business days.
-
After your CompTIA Technical Implementation specialist has received your return parameters and finished configuration on their end, they will notify you, and your system will be ready for testing!
For more assistance, see the configuration screenshots below.
1.5 Example Configuration
1.8 Copy the highlighted value (Client ID). Paste into email to CompTIA and also use in Step 2.5
2.6 Select ‘By Client ID’ under Configuration type, and paste Client ID
2.8 Click gear icon, then Deployment ID; copy and paste into email to CompTIA