Skip to main content

Configuring LTI 1.3 for Feedback Studio in a Canvas-hosted test environment

In this guide:

  1. Initial setup in Turnitin
  2. Initial setup in Canvas
  3. Continue setup in Turnitin
  4. Add the Turnitin app in Canvas
  5. Create a dummy assignment

Initial setup in Turnitin

  1. If you are part of a global institution, log in to your Turnitin account as an administrator
  2. Select the name of the account and then Integrations from the side navigation.

If you are migrating from LTI 1.1 to LTI 1.3 and already have an LTI 1.1 integration set up in your Canvas test environment, please create a new Turnitin sub-account for testing how the LTI 1.3 integration works. Do not use the same account that is being used in your production environment for testing here.

If you are unsure which account is linked to your test and/or production environment, as a Canvas admin, please go to Settings, then select the Apps tab. Select View App Configurations. Select the gear icon next to your Turnitin LTI 1.1 integration and choose Edit. The Consumer key listed there is the Turnitin account ID.

  1. Select the LTI 1.3 button to open the configuration page.
  2. If this is your first LTI 1.3 registration, review the introduction page to get an idea of what you are about to do. When you're ready, select the Get Started button.
    INT_TFS_LTI13Setup.png
  3. For Canvas test environments, select Other.
  4. Based on your selection, the page will autofill with the information that you need to enter into Canvas to complete the integration.
    INT_TFS_ToolURLs.png
  5. Keep this page open and open a new tab to your Canvas test environment.

Initial setup in Canvas

  1. Navigate to the Admin page of your Canvas environment, and then open the Developer Keys section.
    Canvas_DeveloperKeys.png
  2. On the Account tab, select the + Developer Key button.
    Canvas_DeveloperKeysLTI.png
  3. From the sub-menu, select the + LTI Key option.
  4. A configuration screen will show. Please use the following information to fill out the fields:
Field Change to
Method Use the drop-down to select Manual entry
Key Name Create an identifiable name that will be used in the list of developer keys for your account, e.g. Turnitin
Redirect URLs

https://lti.int.turnitin.com/launch

https://api.turnitin.com/api/lti/1p3

Title Assign a name for the integration that Instructors will use to create a new assignment, e.g. Turnitin
Description Add any information or notes you'd like to log about the integration.
Target Link URL https://lti.int.turnitin.com/launch/tfs
JWK Method Use the drop-down to select Public JWK URL
  1. Switch to your Turnitin tab and copy the following fields. Paste them into the appropriate Canvas fields.
Canvas language Turnitin language
OpenID Connect Initiation URL Login Initiation URL
Public JWK URL Tool Public Key set URL

Keep the Turnitin page open once you've set these fields. You'll need it during the next step to add information into Turnitin to complete the connection.

  1. Back in Canvas, expand the LTI Advantage Services section. Certain defaults must be set here for the connection to Turnitin to successfully pass the right data. Select the first seven options, and use the table below to ensure you have selected the correct ones.
    Canvas_LTIAdvantageServices.png
Toggle option Correct toggle state
Can create and view assignment data in the gradebook associated with the tool Active
Can view assignment data in the gradebook associated with the tool Active
Can view submission data for assignments associated with the tool Active
Can create and update submission results for assignments associated with the tool Active
Can retrieve user data associated with the context the tool is installed in Active
Can update public jwk for LTI services Active
Can lookup Account information Active
Can create subscription to data service data Deactivated
Can show subscription to data service data Deactivated
Can update subscription to data service data Deactivated
Can list subscriptions to data service data Deactivated
Can destroy subscription to data service data Deactivated
Can list categorized event types Deactivated
Can view feature flags Deactivated
Can view Progress records associated with the context the tool is installed in Deactivated

You are now finished with the LTI Advantage Services section and it can be collapsed.

  1. Open the Additional Settings section. In the Domain field, enter turnitin.com. Then change the Privacy Level from Private to Public.
    Canvas_AdminAdditionalSettings.png
  2. Moving to the Placements section, remove of the default options by selecting the X icon in each of the pills.
  3. Select the now empty Placement field, and select the Course Assignments Menu option.
    Canvas_Placements.png
  4. On successfully setting the Placement correctly, a new Course Assignments Menu section will appear. Expand this section.
  5. From the Course Assignments Menu section, select the LTIDeepLinkingRequest option. All other fields can be left blank.
    Canvas_CourseAssignmentsMenu.png
  6. Select Save and return to the Developer Keys page.
  7. Switch to the Account tab, if it is not already open.
  8. Navigate to the LTI Key that you just created. This should be identifiable by the Key Name you gave it.
    Canvas_LTIKeyOn.png
  9. Move the switch for your LTI Key from OFF to ON.
  10. You'll be asked to confirm changing the state of the developer key. Select OK to continue.
  11. From the Details column, copy the fifteen-digit developer key you just activated.
    Canvas_LTIKeyValue.png

You do not need to use the Show Key button to do this. Simply copy the fifteen-digit key.

  1. Keep your Canvas test tab open.

Continue setup in Turnitin

You can only complete this section if you have kept the same Turnitin page open that you used in the Initial Canvas setup section above. If you have not kept this page open, you will have to start the process again.

  1. Return to the Turnitin configuration page you should still have open.
  2. Navigate to the LMS Details section of the Turnitin configuration page and add the following data. Please note that the Canvas test environment use slightly different URLs, as outlined below.
Turnitin field Change to
Client ID Paste the fifteen digit LTI Key that you previously copied.
Platform public key set URL https://sso.test.canvaslms.com/api/lti/security/jwks
Issuer https://canvas.test.instructure.com
Access token URL https://sso.test.canvaslms.com/login/oauth2/token
OpenID connect login endpoint https://sso.test.canvaslms.com/api/lti/authorize_redirect
Platform authorisation provider Leave blank
  1. Use the Save button to complete the configuration process. Next, you'll add the Turnitin app to make it available to instructors in your environment.

Add the Turnitin app in Canvas

  1. Go back to your Canvas test tab and switch to the Settings section of the Admin page. Then select the Apps tab.
  2. Select the View App Configurations button.

    Canvas_ViewAppConfigurations.png

  3. Select the + Add button.
  4. Change the Configuration Type to By Client ID.
  5. Paste the developer key you copied into the Client ID field.
    Canvas_AddApp.png
  6. Select the Submit button.
  7. You'll be asked to confirm the app installation. Select the Install button to continue.

Create a dummy assignment

When configuring a new Turnitin integration within your LMS, you must run our deployment workflow before your institution can start using the integration.

The deployment workflow requires the Turnitin account administrator at your institution to link the integration to a specific Turnitin sub-account. This workflow will launch automatically when attempting to use the integration for the first time, which is why we recommend creating a “dummy” assignment to complete your configuration.

This process will only have to be done once for your account, and this will not appear for any instructors and students.

  1. Navigate to the course where you would like to add Turnitin.
  2. Select the vertical ellipsis menu icon ⋮ and select Turnitin.
    Canvas_CreateAssignment.png
  3. You will be prompted to log in to your Turnitin administrator account.
  4. Once you have logged in to Turnitin’s deployment workflow, you will either be provided with a list of existing configurations or the option to create a new one.

    If you are migrating from LTI 1.1 to LTI 1.3, we recommend that you link to the same configuration that you used for the LTI 1.1 integration.

    1. To link to an existing configuration, locate the name of the configuration in the list provided and select the link button. If there is a lock icon in place of the link button, that configuration cannot be used for this deployment.
    2. To create a new deployment - Select the Create New or Create Deployment button, depending on which you have available.
      1. Select the Turnitin account the configuration should be registered to and select Next.
      2. Enter a descriptive name for the deployment, as it may be listed for future configurations in your LMS. Select Next.
  5. Confirm the deployment to complete your configuration. If successful, you will be prompted to log out of the deployment workflow and return to your LMS.
Was this article helpful?
0 out of 3 found this helpful

Articles in this section

Powered by Zendesk