Note: Most users should set up in Canvas using our other method: Canvas LTI 1.3 with Advantage -- Installing via JSON Configuration. This article only exists for legacy purposes, and is only visible to CompTIA Agents/Admins.
Step 1: Go to: Admin > Developer Keys > + Developer Key > + LTI Key
Step 2: Complete the following (see image below for details):
Step 3: Key Settings
-
- Key Name: CertMaster LTI Adv
- Owner Email: <your email here>
- Redirect URIs: https://partner.platform.comptia.org/openid/idtoken
- Notes: <your notes here>
Step 4: Configure
-
-
- Method: Manual Entry
- Title: CertMaster Perform
- Description: LTI tool for CompTIA's CertMaster Learn, Labs, and Perform products
- Target Link URI: https://cdn.platform.comptia.org/lms-gate/index.html
- OpenID Connect Initiation Url: https://partner.platform.comptia.org/openid/authorize
- JWK Method: Public JWK URL
- Public JWK URL: https://partner.platform.comptia.org/openid/keyset
- LTI Advantage Services:
- Check all boxes except for "Can update public jwk for LTI services"
- Additional Settings:
- Domain: partner.platform.comptia.org
- Skip: Tool ID, Icon Url , Text, Section Height, Section Width
- Custom Fields:
- course_end_date=$Canvas.term.endAt
- course_start_date=$Canvas.term.startAt
- submission_end_date=$ResourceLink.submission.endDateTime
- submission_start_date=$ResourceLink.submission.startDateTime
- resource_available_end_date=$ResourceLink.available.endDateTime
- resource_available_start_date=$ResourceLink.available.startDateTime
- Privacy Level: Public
- Placements: Module Menu Modal
- Module Menu Modal
- Target Link URI: https://cdn.platform.comptia.org/lms-gate/index.html
- Select Message type: LtiDeepLinkingRequest
- Icon URI: https://cdn.platform.comptia.org/labsimsaas/images_v2/comptia-c-logo.png
-
If the red icon disappears into your LMS' background, you can also select from the two icon URLs below:
- White: https://cdn.platform.comptia.org/labsimsaas/images_v2/c-logo-white.png
- Dark Gray: https://cdn.platform.comptia.org/labsimsaas/images_v2/c-logo-gray-darkest.png
-
If the red icon disappears into your LMS' background, you can also select from the two icon URLs below:
- Text: <leave blank>
- Section Height: 800
- Section Width: 1000
- Module Menu Modal
-
Step 5: Select Save
Step 6: Toggle the Developer Key to On
Step 7: Copy the Developer ID under Details
Step 8: Paste the Developer ID into the Registration Form provided by your CompTIA Representative. Also add your name and email. Don't hit Send yet.
Step 9: Return to Canvas.
WARNING - PLEASE READ
Please take care in the next step to choose the correct Canvas sub-account, particularly if your school or institution shares a Canvas instance with other organizations.
- We strongly recommend that integrations be configured at the Canvas Sub-Account level for the school, or even better, the department that will be using the LTI integration.
- If no such Sub-Account exists and one cannot be added, the integration can also be configured at the root Canvas Account level, but be aware that everyone with the right course-building permissions in Canvas will have access to the tool.
Please note that even though Canvas allows it and you may get a successful launch initially, our system CANNOT accommodate separate installations at each Canvas Course your organization runs.
Proceeding incorrectly can cause issues with student access, grade syncing, billing, user-to-institution association, and more. If you're unsure of how to proceed, please reach out to your CompTIA Technical Implementation rep for guidance.
Step 10: Navigate to the Canvas sub-account where you'd like to make the App available by navigating to Admin tab -> Select Account, then Sub-accounts -> Select your org's sub-account.
Step 11: Go to Settings > Apps > View App Configurations > + App button
Step 12: Configuration Type: By Client ID
Step 13: Client ID: Paste the same Developer ID copied in step 7
Step 14: Select Submit
Step 15: Select Install
Step 16: After installing, click on the gear cog for the plugin just installed and select Deployment ID.
Step 17: Copy the whole deployment ID
Step 18: Return to the Registration Form from Step 8 and provide the following:
-
- Paste the Canvas Developer ID into the Canvas Developer ID field.
- Paste the Deployment ID into the Canvas Deployment ID Field
- Access Token Endpoint: https://sso.canvaslms.com/login/oauth2/token
- Authorization Endpoint: https://sso.canvaslms.com/api/lti/authorize_redirect
- JWKS Endpoint: https://sso.canvaslms.com/api/lti/security/jwks
Note: Nearly all production Canvas instances use the above endpoints (even for testing), but if you have a completely separate instance of Canvas that uses Instructure's Beta or Test servers, you may need to use the following endpoints instead. To confirm this is the case, look at your instance's URL: if it follows the format of 'beta.<yourinstitution>.instructure.com' or 'test.<yourinstitution>.instructure.com', use the corresponding set of endpoints below in our Registration form.
-
-
-
-
Beta
- Access Token Endpoint: https://sso.beta.canvaslms.com/login/oauth2/token
- Authorization Endpoint: https://sso.beta.canvaslms.com/api/lti/authorize_redirect
- JWKS Endpoint: https://sso.beta.canvaslms.com/api/lti/security/jwks
-
Test
- Access Token Endpoint: https://sso.test.canvaslms.com/login/oauth2/token
- Authorization Endpoint: https://sso.test.canvaslms.com/api/lti/authorize_redirect
- JWKS Endpoint: https://sso.test.canvaslms.com/api/lti/security/jwks
-
Beta
-
- Click Send to complete the install
-
Step 19: To test, go into a course with the subaccount you installed the App in to. Go to modules you intend to make the link and in the upper right hand corner, you should see three dots. Click on the three dots and the plug should be labeled "CertMaster Perform"
-
- Note: You may need to publish your module(s) before you can access CertMaster Perform from the modal (three vertical dots) menu.
Step 20: See our other guides to add content to your Canvas Assignments.