Manual Registration Method – ProctorExam

Steps to register the LTI 1.3 tool within Canvas Cloud.

1. In Canvas LMS, Configure LTI Key for an account as documented here How do I configure an LTI key for an account?

Choose Manual entry as the configure method. Manual entry form looks like this:

Note: The only Placements that need to be added is “Link Selection”, adding other types of placements will create confusion and should be avoided.

Go to your ProctorExam institute settings, navigate to LMS registrations and create a new Registration. Select Canvas from LMS dropdown. Copy the fields below over to your configuration in Canvas:

Canvas fields	Value from ProctorExam Tool settings
Redirect URIs	redirect uris
Target Link URI	target uri
Public JWK URL Note: Select Public JWK URL as JWK Method	jwks uri
OpenID Connect Initiation URL	login uri

NOTE: The registration form has additional optional fields which must be set as below:

Additional Settings / Custom Parameters	canvas_membership_roles=$Canvas.membership.roles com_instructure_membership_roles=$com.Instructure.membership.roles com_instructure_assignment_lti_id=$com.instructure.Assignment.lti.id canvas_api_baseurl=$Canvas.api.baseUrl canvas_course_id=$Canvas.course.id
Privacy Level	Public
Placements	Link Selection

After populating all the fields, click Save. After successful submission, ensure that the state is On in the list of keys.

Copy the Client ID of the tool, which will be used in next step.

2. Adding the ProctorExam tool to a course using the Client ID

In Canvas LMS, Navigate to Courses → Course → Settings → Apps
Click +App button
Select By Client ID, submit the Client ID from Step 1

Install the tool by clicking Install button

Grab the Deployment ID by opening the settings menu of the External App list item.

3. In ProctorExam settings, Return to your LMS Registration

Select Canvas from the LMS dropdown, enter the values below from your Canvas configuration. Then click "Update Registration"

Field	Value
Issuer	https://canvas.instructure.com [pre populated]
Client ID	Client ID from Step 1
Deployment ID	Deployment ID from Step 2
jwks uri	https://sso.canvaslms.com/api/lti/security/jwks [pre populated]
token endpoint	https://sso.canvaslms.com/login/oauth2/token [pre populated]
authorization endpoint	https://sso.canvaslms.com/api/lti/authorize_redirect [pre populated]

Note: Issuer, JWKS Uri and Authorization Endpoint values are documented at # Manually Configuring LTI Advantage Tools - Canvas LMS REST API Documentation and may be set differently depending on stage of the Canvas LMS instance, eg: beta, development, etc. Above values using the default, production values.

Note: Token Endpoint is documented on different page, here Minor LTI 1.3 Changes: New OIDC Auth Endpoint, Support for Platform Storage

4. Configure Tool in Canvas LMS

Finally, teachers can configure ProctorExam tool per Quiz under Modules section.

Add a new item to the desired module, by selecting “External Tool” from the dropdown, then click the “ProctorExam” tool to populate the URL and Page Name fields. Edit Page Name field to reflect the Quiz which will be proctored. Exam settings can be launched by opening the newly added module item, where teachers can configure exam details, and students can start proctoring. Since the tool is not linked directly to the quiz, it is required to enter the quiz url and password fields manually in order to show them to students in ProctorExam screen.

Alternatively, API key can be provided in LMS registration page to automate quiz url and password linking. In CANVAS;

Click the “profile” link in the top right menu bar, or navigate to /profile
Under the “Approved Integrations” section, click the button to generate a new access token.
Once the token is generated, you cannot view it again, and you'll have to generate a new token if you forget it. Remember that access tokens are password equivalent, so keep it secret.

In ProctorExam LMS registration page

Add to Token in API key field and click Update button

Related articles