Things to know before you begin

This information instructs System administrators in how to configure their LMS to SimCapture Enterprise and SimCapture Exam System which is the first step in using the integration.

Let's look at how to configure LMS (Learning Management System) for Canvas. 

Configure Canvas

Once you have logged into a Canvas instance as an Administrator, follow these steps. 

1. On the left sidebar, click Admin, then click on an account which is NOT Site Admin, unless you are able and want to create courses under the Site Admin account. 
2. In the list of links that appear, click Developer Keys. 
3. Click + Developer Key, and in the dropdown that appears, select + LTI Key. This will open the Key Settings page. 

On the Key Settings page, you will see the following areas:

Key Settings

In this area, you will see:

• Key Name - Optional. But it is helpful to input the same value as the Title.
• Owner Email - Optional. Enter your email here.
• Redirect URLs* - Required. Enter https://api.simcapture.com/lti/redirect in this field. While this field allows for multiple URLs, you only need to enter a single URL here.
• Notes - Optional. This area is for any notes you'd like to add.

Configure

In this area, you will see:

• Method - Required. Be sure to select Manual Entry in this area.
• Title - Required. Can be anything descriptive such as SimCapture LTI Tool.
• Description - Required. Can be anything descriptive such as SimCapture LTI Tool.
• Target Link URL - Required. This should be your Client's SimCapture URL and must include https:// at the start of the URL.
• OpenID Connect Initiation Url* - Required. This field must be https://api.simcapture.com/lti/login.
• JWK Method - Required. Select Public JWK URL from the dropdown.
• Public JWK URL* - Required. Enter https://api.simcapture.com/lti/jwks in this field.

*The subdomains for these URLs will vary based on your region.

LTI Advantage Services

Once you have saved the information in the Key Settings and Configure area, expand the LTI Advantage Services section and toggle all settings to ON which is indicated when the toggle switches turn green. If you do not take this action, the integration will be unable to access the necessary information to sync users and link courses.

Additional Settings

After taking the necessary action in the LTI Advantage Services area, expand the Additional Settings area and, under the Privacy Level heading, select PUBLIC so that the integration will sync users. Failure to select PUBLIC will cause the integration to fail.

Next, in the Placements area, be sure to include the following information:

• Account Navigation
• Link Selection
• Assignment Selection

Once all of this information is filled in, click Save. Other expandable information can be ignored.

You should now see your new Developer Key in the list. The State toggle will be turned off. Switch this toggle this to ON which is indicated when the toggle switch turns green.

Copy or make note of the number you see in the Details column. This number is the LTI tool ID.

Configure SimCapture

Log into your SimCapture organization take these steps these steps to configure it for use with Canvas.

1. Click the gear icon to go to System Setup. 
2. Click Learning Management System. 
3. Determine your Canvas instance’s host URL. This is the URL you normally use to access Canvas.
4. Click Edit and enter the following settings: 
   • LMS URL: <CANVAS_HOST>
   • LMS Issuer: https://canvas.instructure.com
   • LMS LTI OIDC Auth URL: <CANVAS_HOST>/api/lti/authorize_redirect
   • LMS OAuth2 Token URL: <CANVAS_HOST>/login/oauth2/token
   • LMS Public JWKS URL: <CANVAS_HOST>/api/lti/security/jwks
   • LTI Tool Client ID: Enter the LTI Tool ID you noted from the above section.
   • LMS Memberships Request Limit: Leave as the default of (50)
   • LMS Course Memberships Request Limit: Leave as the default of (2500)
   • External SSO ID Type: If using SSO, choose Email unless you have a less common SSO setup. If not using SSO, choose No SSO, but note that new users will not be created in SimCapture if you select this option.
   • Check the Enable Integration checkbox 
5.  Click Save.

Configure LTI Tool in Canvas course

Log into Canvas and take these steps to configure the LTI tool.

1. In Canvas on the left sidebar, click Courses then click All Courses. You can find and choose an existing course or, you can create a new course by clicking + Course. Give the course a descriptive title. Leave other fields as-is.
2. Click Create course.
3. In the Course list, click Settings (1).
4. Click Apps (2). This is where you will add the LTI tool to the course.
5. Click +App (3).

In the Configuration dropdown: 

1. Select By Client ID.
2.  Past the LTI tool ID from the previous section here.
3. Click Submit. A confirmation message will appear.
4. Click Install.

1. Click Home. Find an existing module in the course or create a new module.
2. Click + Module to create a new module.
3. Give your module a descriptive name.
4. Click Add Module.
5. Click the + icon to add an item to the module.

1. Select External Tool from the dropdown in the modal that appears.
2. Click the tool name.
3. Check Load in new tab.
4. Click Add Item. You should see the tool as an item in the module.
5. Click this tool link. 
6. Canvas will navigate to a new view that shows a Load <Your Tool> in a new window button. Click this button to launch the tool.

You will be redirected to SimCapture where you can choose to link the course from your LMS to an existing course in SimCapture, or create a new course in SimCapture to link to the LMS course. Once the course is successfully linked, the user information will begin to update.

Notes

• Course titles can only be transferred, lessons and other smaller components from Canvas will not appear in SimCapture
• Users are transferred on initial course linking/setup. Any future updates are applied automatically on a nightly basis.
• A total of 500 users can be transferred from the LMS to SimCapture during this process for a single Course. Please reach out to Support if your Course contains more than 500 users.
• Courses set to the Status of ‘Completed’ or ‘Archived’ will not sync new user information