Applicable products: CertMaster Learn, CertMaster Labs
CompTIA uses Canvas' JSON configuration option to configure its LTI 1.3 LMS integration tools in order to minimize customer configuration time as well as opportunity for human error. 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 can have serious effects on the integration process. Your Canvas instance 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 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 on the top left. Neither affect functionality, but for the Key Name, we recommend copying the title value in the first line of the JSON configuration.
-
Click Save.
-
Change 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 in two steps in Part 2 below.
Part 2: Add App
-
Click the Admin icon in the left navigation bar, and navigate to the 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. A CompTIA tool will not function properly if it is configured at multiple parts of the Canvas hierarchy.
-
Click Settings at the bottom of the left navigation bar
-
Click the View App Configurations button in upper right.
-
Click colored +App button in 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.
-
Hit Submit and affirm your way through the dialogue boxes.
-
Find the App you just created in the list that appears, and click the Gear button to the right, select Deployment ID, and copy the value that appears into that email to your CompTIA Technical Specialist.
-
Repeat Parts 1 and 2 for each configuration JSON you were sent.
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-3 business days.
-
Once the specialist responds that this has been completed, your tools will be fully functional and 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
