LTI Authentication (for WeBWorK 2.18 or newer)

From WeBWorK_wiki
Jump to navigation Jump to search

Learning Management Systems (LMS) like Blackboard, Moodle, Canvas, and BrightSpace Desire2Learn all support a protocol called Learning Tools Interoperability (LTI) which can be used to connect learning tools like WeBWorK to the LMS in a standardized fashion.

This page documents how to setup LTI authentication for WeBWorK 2.18 and beyond. For prior versions of WeBWorK see LTI Authentication (for WeBWorK 2.17 or older).

First Time WeBWorK Setup

Before you can use WeBWorK's LTI features you need to do some initial setup. This will need to be done by a system administrator and in particular often requires administrator access to both WeBWorK and your Learning Management System.

These instructions include how to configure the content selection feature. That feature is available for WeBWorK 2.19 or newer, and is not available for WeBWorK 2.18. So ignore those portions of the instructions if you are using WeBWorK 2.18.

  • Start by making a copy of the distribution configuration file needed with the following command.
    cp /opt/webwork/webwork2/conf/authen_LTI.conf.dist /opt/webwork/webwork2/conf/authen_LTI.conf
    In localOverrides.conf uncomment the line that reads #include("conf/authen_LTI.conf"); by removing the # from the beginning of the line.
  • Now determine if you will be using LTI version 1.1 or 1.3. Note that both versions can be used by one WeBWorK server for different courses if needed.
    • If you will be using LTI 1.1, then uncomment the line in authen_LTI.conf that reads #include('conf/authen_LTI_1_1.conf'); by removing the # from the beginning of the line and copy the LTI 1.1 distribution configuration file with
      cp /opt/webwork/webwork2/conf/authen_LTI_1_1.conf.dist /opt/webwork/webwork2/conf/authen_LTI_1_1.conf
    • If you will be using LTI 1.3, then uncomment the line in authen_LTI.conf that reads #include('conf/authen_LTI_1_3.conf'); by removing the # from the beginning of the line and copy the LTI 1.3 distribution configuration file with
      cp /opt/webwork/webwork2/conf/authen_LTI_1_3.conf.dist /opt/webwork/webwork2/conf/authen_LTI_1_3.conf

Note that all WeBWorK LTI configuration variables that do not have a $LTI{v1p?} prefix are in the authen_LTI.conf file, and are used by both versions of LTI. All variables that have the $LTI{v1p1} prefix are in the authen_LTI_1_1.conf file, and are only used by LTI 1.1. All variables that have the $LTI{v1p3} prefix are in the authen_LTI_1_3.conf file, and are only used by LTI 1.3.

The followed are the variables defined in authen_LTI.conf. Some of these are described in more detail later in this document.

  • $debug_lti_parameters: Set this to 1 to enable debugging. Getting LTI authentication set up can be tricky, and this can with troubleshooting the issues. Note that for LTI 1.1 most of these messages are displayed in the browser, but for LTI 1.3 you will need to inspect the logs/webwork2.log file to see the error messages. Make sure to set this back to 0 for production use.
  • $debug_lti_grade_passback: Set this to 1 to get debugging information when using grade pass back. As with the previous option, the messages for LTI 1.1 are displayed in the browser, but most LTI 1.3 messages will be in the logs/webwork2.log file. Make sure that this is also set to 0 for production use.
  • $authen{user_module}: This is a list of authentication modules in the order that they will be considered when a request is received by WeBWorK. Usually you will not need to modify this from the default values.
  • $authen{admin_module}: This is a list of authentication modules tha are allowed for signing in to the admin course. By default only "WeBWorK::Authen::Basic_TheLastOption" is allowed, which means that only username and password sign in is allowed. If you want to allow signing in to the admin course via LTI, then you can uncomment "WeBWorK::Authen::LTIAdvantage" (for LTI 1.3) or "WeBWorK::Authen::LTIAdvanced" (for LTI 1.1). This is not recommended.
  • $LTIVersion: Set this to the LTI version that the courses on your server will be using. This is either "v1p1" for LTI version 1.1, or "v1p3" for LTI version 1.3. This can also be set in a course's course.conf file to make a course use a different LTI version than the site wide default.
  • $LTIAccountCreationCutoff: WeBWorK will automatically create users when logging in via the LMS for the first time for users with a permission level below what this is set to. This is set to "ta" by default.
  • $LMSManageUserData: If set to 1 (the default setting), then WeBWorK's user demographic data will be kept up to date with the data from the LMS.
  • $external_auth: If set to 1, then the username and password fields will not be displayed on the WeBWorK login page. Instead a message will be shown informing users to sign in via the LMS. This is set to 0 by default.
  • $LTIGradeMode, $LTIGradeOnSubmit, $LTICheckPrior, and $LTIMassUpdateInterval: These are for grade passback. Details on these will be given later in this document.
  • @LTIConfigVariables: If any of the listed variables are uncommented, then an "LTI" tab will be available on the "Course Configuration" page in courses. The settings for the uncommented variables can be changed for an individual course by the instructor in that tab.

Next follow the instructions for the LTI versions that will be used by your server below.

LTI 1.3 Setup

LTI 1.3 LMS Configuration

First the LMS needs to be configured to use LTI 1.3 authentication. Follow the instructions for your LMS below.

Moodle LTI 1.3 Configuration

Go to "Site Administration" -> "Plugins" -> "Activity Modules" -> "External Tool" -> "Manage Tools" and click on the link to "configure a tool manually."

Enter a "Tool name" and add a "Tool description" that are appropriate for you. These will be visible to instructors that use the tool, and so should appropriately describe what the tool is for.

Select "LTI 1.3" for the LTI Version", and enter the following for the fields shown. Change https://webwork.yourschool.edu to the URL for your webwork2 server.

  • Tool URL: https://webwork.yourschool.edu/webwork2
  • Public Keyset: https://webwork.yourschool.edu/webwork2/ltiadvantage/keys
  • Initiate login URL: https://webwork.yourschool.edu/webwork2/ltiadvantage/login
  • Redirection URI(s): https://webwork.yourschool.edu/webwork2/ltiadvantage/launch
  • Tool configuration usage: Show as a preconfigured tool when adding an external tool

It is recommended that you set the Default launch container to "New Window".

Note that the "Content Selection URL" is needed for version 4.02 or newer of Moodle in order for instructors to add WeBWorK assignment links to their courses. Make sure to follow the instructions for setting this up later in this document. Older versions of Moodle allow manual link creation. So you will also need to check Supports Deep Linking (Content-Item Message) and enter https://webwork.yourschool.edu/webwork2/ltiadvantage/content_selection for the Content Selection URL.

MoodleToolSettings.png

Under "Services" make the following selections.

  • IMS LTI Assignment and Grade Services: "Use this service for grade sync and column management" (only needed for grade pass back)
  • IMS LTI Names and Role Provisioning: "Use this service to retreive members' information as per privacy settings"
  • Tool Settings: "Use this service"

MoodleServices.png

Under "Privacy" make the following selections.

  • Share launcher's name with tool: "Always"
  • Share launcher's email with tool: "Always"
  • Accept grades from the tool: "Always" (only needed for grade pass back)

If both your Moodle instance and your WeBWorK server have SSL (https), then check the "Force SSL" check box for added security.

MoodlePrivacy.png

View the configuration details for the external tool that is created after saving the changes by clicking on the list icon in the top right corner of the created tool. It will look something like the following screenshot. Save these details for the WeBWorK configuration later.

MoodleConfigurationDetails.png

The following is the mapping of these values to the WeBWorK configuration variables that will need to be set in authen_LTI_1_3.conf.

  • Platform ID: $LTI{v1p3}{PlatformID}
  • Client ID: $LTI{v1p3}{ClientID}
  • Deployment ID: $LTI{v1p3}{DeploymentID}
  • Public keyset URL: $LTI{v1p3}{PublicKeysetURL}
  • Access token URL: $LTI{v1p3}{AccessTokenURL} and $LTI{v1p3}{AccessTokenAUD} (only needed for grade pass back)
  • Authentication Request URL: $LTI{v1p3}{AuthReqURL}

Canvas LTI 1.3 Configuration

First, a user that has admin privileges in Canvas must create a developer key. Go to "Developer Keys", click "+ Develop Key", and select "LTI Key".

Choose a "Key Name", "Title", and "Description" that are appropriate for you. The title and description will be visible to instructors that use the tool, and so should appropriately describe what the tool is for.

Now select "Public JWK URL" for the "JWK Method", and enter the following for the fields shown. Change https://webwork.yourschool.edu to the URL of your server.

  • Target Link URI: https://webwork.yourschool.edu/webwork2
  • OpenID Connect Initiation Url: https://webwork.yourschool.edu/webwork2/ltiadvantage/login
  • Redirect URIs: https://webwork.yourschool.edu/webwork2/ltiadvantage/launch
  • Public JWK URL: https://webwork.yourschool.edu/webwork2/ltiadvantage/keys

CanvasKeySettings.png

If you are going to use grade passback, then under "LTI Advantage Services" select everything. Note that some of the services may not be needed, but I am not sure which ones are not so just check them all!

CanvasServices.png

Under "Additional Settings" set the "Domain" to https://webwork.yourschool.edu and set the "Privacy Level" to "PUBLIC".

CanvasAdditionalSettings.png

In "Placements" add the "Assignment Selection" placement if you want to be able to utilize content selection. Note that this only allows importing a single WeBWorK assignment at a time, and will be available when creating an external tool assignment.

If the "Course Assignments Menu" placement is available, then you may want to add that as well. This will allow importing multiple assignments from WeBWorK at once, and will add a menu item in the "Assignments Settings" drop down menu on the "Assignments" page. Note that this is an experimental feature in Canvas at this time, and must be turned on for your institution through your Canvas customer success manager.

For both placements set the "Target Link URI" to https://webwork.yourschool.edu/webwork2/ltiadvantage/content_selection. Choose a "Text". This is what will be shown to users when the placement is presented to users for selection. Set the "Selection Height" and "Selection Width". Those are the height and width of the dialog that opens and displays the available WeBWorK assignments for the course when content selection is used by the instructor. Reasonable values are 500 and 600, respectively.

You can remove any other placements. WeBWorK does not support any of the others at this time.

CanvasPlacements.png

After saving the developer key you will see the following. Make note of the long number above the "Show Key" button in the details column. That is the client id which will be needed in the next step and will be the value for the $LTI{v1p3}{ClientID} in the WeBWorK authen_LTI_1_3.conf file.

CanvasDeveloperKeyDetails.png

Now go to "Settings" and select the "Apps" tab. Click on "+ App" and select "By Client ID" for the "Configuration Type". Enter the client id from above in the "Client ID" field. Then click "Submit".

CanvasAddApp.png

After submitting Canvas will return to the "Apps" tab in "Settings". Find the app you just created and click on the gear icon drop down menu to the right. Select "Deployment ID" and save the deployment ID that is shown. This will be the value for the $LTI{v1p3}{DeploymentID} in the WeBWorK authen_LTI_1_3.conf file.

The other variables that will need to be set in the authen_LTI_1_3.conf file are as follows:

  • $LTI{v1p3}{PlatformID}: Either 'https://canvas.instructure.com' or 'https://yourschool.instructure.com' (It is not known at the time of this writing which this will need to be in production.)
  • $LTI{v1p3}{PublicKeysetURL}: 'https://yourschool.instructure.com/api/lti/security/jwks'
  • $LTI{v1p3}{AccessTokenURL}: 'https://yourschool.instructure.com/login/oauth2/token'
  • $LTI{v1p3}{AccessTokenAUD}: 'https://yourschool.instructure.com/login/oauth2/token'
  • $LTI{v1p3}{AuthReqURL}: 'https://yourschool.instructure.com/api/lti/authorize_redirect'

Brightspace Desire2Learn LTI 1.3 Configuration

See Desire2Learn Brightspace LTI 1.3 Configuration

LTI 1.3 WeBWorK Configuration

Now configure WeBWorK for LTI 1.3 authentication.

In the authen_LTI_1_3.conf file set the LTI 1.3 basic authentication parameters $LTI{v1p3}{PlatformID}, $LTI{v1p3}{ClientID}, $LTI{v1p3}{DeploymentID}, $LTI{v1p3}{PublicKeysetURL}, $LTI{v1p3}{AccessTokenURL}, $LTI{v1p3}{AccessTokenAUD}, $LTI{v1p3}{AuthReqURL} to the values found in the LMS configuration above.

Set $LTIVersion = 'v1p3'; in authen_LTI.conf. You may instead set this in the course.conf files of the courses that you want to use LTI 1.3 for, leave $LTIVersion = 'v1p1'; in authen_LTI.conf if most of the courses on your server will be using LTI 1.1.

There are some other options that can be set as well. Some of these are discussed in more detail in other sections of this document.

  • $LTI{v1p3}{LMS_name}: This is a string that is used to name the LMS for end users. It is used in messages displayed for users by WeBWorK.
  • $LTI{v1p3}{LMS_url}: This is a URL that should take users to a place they can log in to their LMS. It is also used in messages displayed for users by WeBWorK together with the LMS_name above.
  • $LTI{v1p3}{preferred_source_of_username}: When a user logs into WeBWorK from the LMS WeBWorK needs to determine the username of the person logging in. This determines which parameter sent from the LMS to use for the WeBWorK username. This is "email" by default, but can be set to any parameter included in the JWT sent from the LMS that uniquely identifies users.
    • You can set $debug_lti_parameters = 1 in authen_LTI.conf to help find which parameter to use for this.
    • If this variable is set to "email", then by default the entire email address is used. If you don't want to use the entire email address you can also set $LTI{v1p3}{strip_domain_from_email} = 1 and WeBWorK will remove the domain name from the email address when creating the username.
  • $LTI{v1p3}{fallback_source_of_username}: If the parameter set for $LTI{v1p3}{preferred_source_of_username} is not present in the JWT sent from the LMS, then the parameter set for this variable will be used instead if it is present in the JWT. This is not set by default.
  • $LTI{v1p3}{lowercase_username}: If set to 1, then all usernames (as determined by the options above) will be converted to lowercase.
  • $LTI{v1p3}{preferred_source_of_student_id}: The parameter sent from the LMS to use for the WeBWorK student id. This is optional and is not set by default.
    • You can set $debug_lti_parameters = 1 in authen_LTI.conf to help find which parameter to use for this.
  • $LTI{v1p3}{StateKeyLifetime}: When the WeBWorK responds to an initial LMS request it includes state and nonce values in that request. These values are saved in the database until the response from the LMS to that request is received. This variable controls how long in seconds this data will be saved in the database before it is considered stale and deleted. It should be short enough to accomodate normal server and networking delays. Note that if authentication is successful this will be deleted before this lifetime expires in any case. This is only to ensure that keys from failed authentication attempts don't pile up in the database.
  • $LTI{v1p3}{LMSrolesToWeBWorKRoles}: This is a mapping of roles used by the LMS to WeBWorK roles. Add roles to this if your LMS uses a role that is not present in the mapping already.
  • $LTI{v1p3}{modify_user}: This can be set to a routine that can modify the student id and other user data when a user signs in from the LMS.
  • $LTI{v1p3}{modify_user_set}: When users are added to the system they are also assigned all visible sets. This can be set to a routine that can modify the sets before they are assigned.

LTI 1.1 Setup

LTI 1.1 WeBWorK Configuration

In authen_LTI_1_1.conf set $LTI{v1p1}{BasicConsumerSecret}. This acts like a global password and is used to authenticate all communication between WeBWorK and the LMS. So pick something secure.

If your WeBWorK server will be serving multiple LMS's all using LTI 1.1 and you want your instructors to be able to utilize content selection, then you will also need to ensure that each LMS uses a different consumer key, and set $LTI{v1p1}{ConsumerKey} in the course.conf file for each course to be the consumer key for its LMS.

Set $LTIVersion = 'v1p1'; in authen_LTI.conf (this is the default setting). You may instead set this in the course.conf files of the courses that you want to use LTI 1.1 for, and set $LTIVersion = 'v1p3'; in authen_LTI.conf if most of the courses on your server will be using LTI 1.3.

There are some other options that can be set as well. Some of these are discussed in more detail in other sections of this document.

  • $LTI{v1p1}{LMS_name}: This is a string that is used to name the LMS for end users. It is used in messages displayed for users by WeBWorK.
  • $LTI{v1p1}{LMS_url}: This is a URL that should take users to a place they can log in to their LMS. It is also used in messages displayed for users by WeBWorK together with the LMS_name above.
  • $LTI{v1p1}{preferred_source_of_username}: When a user logs into WeBWorK from the LMS WeBWorK needs to determine the username of the person logging in. This determines which parameter sent from the LMS to use for the WeBWorK username. This can be lis_person_sourcedid, lis_person_contact_email_primary (the default), or another parameter sent from the LMS that uniquely identifies users. This setting is required.
    • If this variable is set to "lis_person_sourcedid" then the sourced_id will be used as the WeBWorK username. Note: The LMS may not provide this parameter, and if it is provided it is usually an obscure identifier that is likely not a good choice for a username.
    • If this variable is set to "lis_person_contact_email_primary" then the email address provided by the LMS will be used for the WeBWorK username.
      • By default the entire email address is used. If you don't want to use the entire email address you can also set $LTI{v1p1}{strip_domain_from_email} = 1 and WeBWorK will strip off the server portion of the email address when creating the username.
    • You can set $debug_lti_parameters = 1 in authen_LTI.conf to help find which parameter to use for this.
  • $LTI{v1p1}{fallback_source_of_username}: If the parameter set for $LTI{v1p1}{preferred_source_of_username} can not be found, then the parameter set for this variable will be used instead if it can be found in the parameters. This is not set by default.
  • $LTI{v1p1}{lowercase_username}: If set to 1, then all usernames (as determined by the options above) will be converted to lowercase.
  • $LTI{v1p1}{preferred_source_of_student_id}: The parameter sent from the LMS to use for the WeBWorK student id. This is optional and is not set by default.
    • You can set $debug_lti_parameters = 1 in authen_LTI.conf to help find which parameter to use for this.
  • $LTI{v1p1}{NonceLifeTime}: When the LMS sends a user to WeBWorK it makes a request identified by a "Nonce". This variable controls how long the Nonce is valid, in seconds, from the time it is created by the LMS. It should be short enough to prevent "casual" man-in-the-middle attacks. However, you may need to set it to something longer if your servers/network are slow or if the clocks on your servers are not synced.
  • $LTI{v1p1}{OverrideSiteURL}: When the authentication request is being validated WeBWorK will check to see if the address that the user clicked in in the LMS is the same as the address of the WeBWorK server. If you have a load balancing system where the WeBWorK server address may not be the same as the address the student clicked on in the LMS then you may need to set this variable to the address in the LMS.
  • $LTI{v1p1}{OverrideSiteProtocolDomain}: This is similar to the $LTI{v1p1}{OverrideSiteURL} except that only the protocol (http or https) and host name portion of the URL given here are substituted for the protocol and host name of the request, leaving the URL path in the request the same.
  • $LTI{v1p1}{modify_user}: This can be set to a routine that can modify the student id and other user data when a user signs in from the LMS.
  • $LTI{v1p1}{modify_user_set}: When users are added to the system they are also assigned all visible sets. This can be set to a routine that can modify the sets before they are assigned.

LTI 1.1 LMS Configuration

Now configure the LMS. In general you will need to provide the following things:

  • The address of your WeBWorK server. The address here needs to exactly match the address of your webwork server as defined in site.conf, i.e., it should be the combination of $server_root_url and $webwork_url
  • The "Tool Provider Key" or "Consumer Key". This is just some made up word, like "webwork". However, if the WeBWorK server will be serving multiple LMS's with different LTI 1.1 configurations, then this must be different for each LMS in order for instructors in the courses to be able to utilize content selection.
  • The "Tool Provider Secret" or "Shared Secret". This is the password used to identify the LMS to your WeBWorK site (and vice versa) and should be the same as $LTI{v1p1}{BasicConsumerSecret}.
  • What user information is submitted to WeBWorK.

The specifics in setting up the LMS vary depending on which LMS you use. Instructions for Moodle, Canvas, BrightSpace Desire2Learn, and Blackboard are below. An instructor can perform these instructions at the course level, and this will apply to only that course, or an LMS administrator can do this at the system level so that it applies to all courses on the system.

You can also try to have the LMS provide section or recitation information by setting a custom parameter. In all of the configurations there is a "Custom Fields" section. You would specify "section = #" or "recitation = #" to set the section or recitation.

Moodle LTI 1.1 Configuration

Go to "Site administration" > "Plugins" > "Activity modules" > "External Tools" > "Manage Tools" and click the link to "configure a tool manually."

Enter a "Tool name" and "Tool description" that are appropriate for you. These will be visible to instructors that use the tool, and so should appropriately describe what the tool is for.

Then select "LTI 1.0/1.1" for the "LTI Version", and set the following. Change https://webwork.yourschool.edu to the URL of your WeBWorK server.

  • Tool URL: https://webwork.yourschool.edu/webwork2
  • Consumer key: This can be any word, e.g., "webwork". However, if the WeBWorK server will be serving multiple LMS's with different LTI 1.1 configurations, then this must be different for each LMS in order for instructors in the courses to be able to utilize content selection.
  • Shared secret: This must be the value of $LTI{v1p1}{BasicConsumerSecret}.
  • Tool configuration usage: Show in activity chooser and as a preconfigured tool

It is recommended that you set the Default launch container to "New window".

Note that the "Content Selection URL" is needed for version 4.02 or newer of Moodle in order for instructors to add WeBWorK assignment links to their courses. Make sure to follow the instructions for setting this up later in this document. Older versions of Moodle allow manual link creation. So for version 4.02 or newer of Moodle you will also need to check Supports Deep Linking (Content-Item Message) and enter https://webwork.yourschool.edu/webwork2/ltiadvanced/content_selection for the Content Selection URL.

Moodle-lti1.1-tool-settings.png

Under "Services" make the following selections.

  • IMS LTI Assignment and Grade Services: "Use this service for grade sync and column management" (only needed for grade pass back)
  • IMS LTI Names and Role Provisioning: "Use this service to retreive members' information as per privacy settings"
  • Tool Settings: "Use this service"

MoodleServices.png

Under "Privacy" make the following selections.

  • Share launcher's name with tool: "Always"
  • Share launcher's email with tool: "Always"
  • Accept grades from the tool: "Always" (only needed for grade pass back)

If both your Moodle instance and your WeBWorK server have SSL (https), then check the "Force SSL" check box for added security.

MoodlePrivacy.png

Canvas LTI 1.1 Configuration

Go to "Settings" and select the "Apps" tab. Then click on "+ App".

Choose "Manual Entry" for the "Configuration Type", and choose a "Name" and "Description" that are appropriate for you. These will be visible to instructors that use the tool, and so should appropriately describe what the tool is for.

Then set the following. Change https://webwork.yourschool.edu to the URL of your WeBWorK server.

  • Consumer Key: This can be any word, e.g., "webwork". However, if the WeBWorK server will be serving multiple LMS's with different LTI 1.1 configurations, then this must be different for each LMS in order for instructors in the courses to be able to utilize content selection.
  • Shared Secret: This must be the value of $LTI{v1p1}{BasicConsumerSecret}.
  • Launch URL: https://webwork.yourschool.edu/webwork2
  • Domain: webwork.yourschool.edu (Note that in some cases you may need to prefix the domain with https://.)
  • Privacy Level: Public

Canvas-lti-setup.png

If you would like to allow content selection, then instead select "Paste XML" for the "Configuration Type". Enter the "Consumer Key" and "Shared Secret" as above. Then past the following XML into the "XML Configuration". Make sure to change https://webwork.yourschool.edu to the URL for your WeBWorK server. You can also change the title, description, selection_width, and selection_height if desired. Unfortunately, Canvas only allows selection of a single assignment at once for LTI 1.1. 

<?xml version="1.0" encoding="UTF-8"?>
<cartridge_basiclti_link
  xmlns="http://www.imsglobal.org/xsd/imslticc_v1p0"
  xmlns:blti="http://www.imsglobal.org/xsd/imsbasiclti_v1p0"
  xmlns:lticm="http://www.imsglobal.org/xsd/imslticm_v1p0"
  xmlns:lticp="http://www.imsglobal.org/xsd/imslticp_v1p0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.imsglobal.org/xsd/imslticc_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticc_v1p0.xsd http://www.imsglobal.org/xsd/imsbasiclti_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imsbasiclti_v1p0p1.xsd http://www.imsglobal.org/xsd/imslticm_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticm_v1p0.xsd http://www.imsglobal.org/xsd/imslticp_v1p0 http://www.imsglobal.org/xsd/lti/ltiv1p0/imslticp_v1p0.xsd">
  <blti:title>Available WeBWorK Assignments</blti:title>
  <blti:description>Select from available assigments.</blti:description>
  <blti:launch_url>https://webwork.yourschool.edu/webwork2</blti:launch_url>
  <blti:extensions platform="canvas.instructure.com">
    <lticm:property name="privacy_level">public</lticm:property>
    <lticm:property name="domain">https://webwork.yourschool.edu</lticm:property>
    <lticm:options name="assignment_selection">
      <lticm:property name="message_type">ContentItemSelectionRequest</lticm:property>
      <lticm:property name="url">https://webwork.yourschool.edu/webwork2/ltiadvanced/content_selection</lticm:property>
    </lticm:options>
    <lticm:property name="windowTarget">_blank</lticm:property>
    <lticm:property name="selection_width">500</lticm:property>
    <lticm:property name="selection_height">600</lticm:property>
  </blti:extensions>
</cartridge_basiclti_link>

Warning: Canvas does not copy the consumer key and consumer secret when course content is copied to a new course. Those values need to be set again manually for the new course.

BrightSpace Desire2Learn LTI 1.1 Configuration

Note: This is not up to date. Someone using D2L should update it.

This assumes that you will be using the email address stored in D2L (or just the first part of the email address) as the username in WeBWorK. Currently this is the only supported format when linking with D2L. So you will need to set $LTI{v1p1}{preferred_source_of_username} = "lis_person_contact_email_primary"; in authen_LTI_1_1.conf in order for these instructions to work. If you prefer to use only the first part of the email address as the username in WeBWorK, then you should also set $LTI{v1p1}{strip_domain_from_email} = 1;.

  1. Navigate to the "Manage External Tools" page (as an instructor, this can be found as follows. Go to the Content Browser. Within a content area, click on the "Add Existing Activities" drop-down, and choose "External Learning Tools", then click on "Manage External Tools" at the bottom.
  2. Click on "Manage Tool Providers" at the top.
  3. Click on "New Tool Provider".
    Enter a Name and Description that are appropriate for you. These will be visible to instructors that use the tool, and so should appropriately describe what the tool is for.
    Then set the following. Change https://webwork.yourschool.edu to the URL for your webwork2 server.
    • Launch Point: https://webwork.yourschool.edu/webwork2
    • Secret: This must be the value of $LTI{v1p1}{BasicConsumerSecret}.
    • Tool consumer information: Check the box "Use custom tool consumer information instead of default"
    • Key: This can be any word, e.g., "webwork". However, if the WeBWorK server will be serving multiple LMS's with different LTI 1.1 configurations, then this must be different for each LMS in order for instructors in the courses to be able to utilize content selection.
    • Visibility: Select "Allow users to use this tool provider"
    • Security settings: Check the following: "Send user ID to tool provider", "Send user email to tool provider", "Send system role to tool provider"
    • Make tool provider available to: You can choose which courses or organizational units can use this tool. Note that courses not selected here would still be able to create WeBWorK links, but they would have to be set up manually.

Blackboard LTI 1.1 Configuration

Note: This is not up to date. Someone using Blackboard should update it.

  1. In the Administrator Panel (under Building Blocks) click LTI Tool Providers and then Register Provider Domain
  2. Input the address of the WeBWorK server in Provider Domain
  3. Use Set Globally for Default configuration and input the Tool Provider Key (any word, e.g. webwork) and the Tool Provider Secret ($LTI{v1p1}{BasicConsumerSecret})
  4. Enable Send User Data. (Restricting to ssl is safer if you have https enabled.) Then enable all three user fields.
  5. If you want to use grade pass back, then enable the setting to allow any Tool Provider to post grades to the Grade Center in Building Blocks > LTI Tool Providers > Global Properties.

Blackboard-lti-setup.png

Setup Courses To Use Content Selection

Content selection requests do not identify the WeBWorK course. So WeBWorK needs to know which course to select content from for a given LMS course. If content selection was configured in the LMS above and an instructor attempts to use content selection from the LMS (see Adding Links To WeBWorK below), then the instructor will be shown the LMS context id as in the screen shot below.

LTILMSContextID.png

This can be done by the instructor under the following conditions:

  • The instructor is able to sign in to WeBWorK directly ($external_auth is set to 0 and another authentication method is available (e.g. password))
  • lms_context_id is uncommented in the @LTIConfigVariables in authen_LTI.conf, and
  • $permissionLevels{change_config_lms_context_id} = 'professor'; is set in localOverrides.conf.

In this case the "LTI" tab will be available in the course configuration, and the instructor can enter the shown context id there.

Otherwise, a WeBWorK administrator will need to enter the context id for the course on the "Manage LTI Course Map" page in WeBWorK Course Administration.

Adding Links To WeBWorK

Once you have set up your WeBWorK configuration files and added WeBWorK as an LTI Tool to your LMS you will need to make a link/assignment in the LMS that students can use to get to WeBWorK. This needs to be done in every LMS course which uses WeBWorK. The process for this varies depending on what LMS you are using. Instructions for Moodle, Canvas, and BrightSpace Desire2Learn, and Blackboard are below.

If you are using WeBWorK 2.19 or newer it is recommended that you set up Content Selection, which allows instructors to choose the link they want from a list rather than manually creating it. If Content Selection is available then instructors do not need to manually create links using these instructions.

Note that it is usually best to have WeBWorK open in a new window. There are usually settings you can set when creating a link/assignment in the LMS which will control this.

Moodle Link Creation

  1. Go to a Course, turn on "Edit mode", and click "Add an activity or resource".
  2. To manually create a link, choose "External Tool" and click "Add". Then pick an activity name and add the URL for a WeBWorK course or assignment. The URL structure is either https://webwork.yourschool.edu/webwork2/coursename or https://webwork.yourschool.edu/webwork2/coursename/assignmentname. Note that this will only work for versions of Moodle prior to 4.2.
  3. To have a link (or multiple links) created automatically, instead choose the external tool created above named "WeBWorK LTI 1.3" or "WeBWorK LTI 1.1" (or whatever the "Tool name" was set to when the tool was created above). Then click the "Select Content" button on the page that opens next. Select the assignment or assignments that you wish to import, and click "Submit Choices". Note that this is the only permitted method for creating external tool links in version 4.2 or newer of Moodle.

Moodle-lti-link-creation.png

Canvas Link Creation

  1. Go to the "Assignments" page in your course, click "+ Assignment" to create an assignment group (or use an existing assignment group), and then click the "+" button in the top right of the assignment group to add an assignment.
  2. Select "External Tool" for the "Type" and then click "More Options".
  3. To manually create a link, input the URL of the WeBWorK course or assignment that you are linking to. The URL structure is either https://webwork.yourschool.edu/webwork2/coursename or https://webwork.yourschool.edu/webwork2/coursename/assignmentname.
  4. It is recommended that you check "Load This Tool In A New Tab".

Canvas-lti-link.png

  1. To automatically create a link using content selection (if this was configured above) click on "Find" and select the external tool that was created above. Then select the assignment you wish to import and click "Submit Choices".
  2. If the "Course Assignments Menu" is enabled and configured above (this is only available for LTI 1.3), then multiple assignments can be imported at once. On the Assignments page, click on the vertical dots button that opens the "Assignment Settings" menu (to the right of the "+ Assignment" button at the top), and select "Available WeBWorK Assignments" (or whatever you set the "Text" for this to be). Then select the assignments you wish to import and click "Submit Choices".

Canvas-lti-configure-external-tool.png

Desire2Learn BrightSpace Link Creation

  1. Navigate to the content area in your D2L course where you would like the link to reside.
  2. From the "Add Existing Activities" menu, select "External Learning Tools".
  3. Click "Create New LTI link"
  4. Under "Title", fill in whatever text you would like to see for the link in D2L
  5. For LTI URL, enter the URL to the course or the assignment, typically either https://webwork.yourschool.edu/webwork2/coursename or https://webwork.yourschool.edu/webwork2/coursename/assignmentname
  6. When you move the cursor out of the "LTI URL" textbox the "Tool" drop-down menu should auto-populate. If you are using LTI 1.1 it will change to "Legacy LTI Tool". If you are using LTI 1.3 it will change to "WeBWorK" (or whatever you named the deployment in Desire2Learn_Brightspace_LTI_1.3_Configuration#Create_a_New_Tool_Deployment).
  7. If you want your newly created link to open in a new window, edit the properties of the link and select "Open as External Resource". Depending on how you initially configured the LTI Tool for WeBWorK this may be the default.

Blackboard Link Creation

Note: This is not up to date. Someone using Blackboard should update it.

  1. Go to Content > Build Content > (Create) Web Link
  2. Add a Name for your link and the URL of the WeBWorK course or assignment that you are linking to. The URL structure is either https://webwork.yourschool.edu/webwork2/coursename or https://webwork.yourschool.edu/webwork2/coursename/assignmentname.
  3. Check "This link is a Tool Provider"*
  • You may need to enable "LTI" in Customization => Tool Availability if the checkbox for "This link is a Tool Provider" is not shown

Blackboard-lti-link.png

Automatic Student Account Management

WeBWorK can be configured to automatically manage and create student accounts in WeBWorK. In particular if a student does not have an account in WeBWorK, then the first time they log in a WeBWorK account will be created for them. The username will be determined by $LTI{v1p?}{preferred_source_of_username} (see above for the details) and they will automatically be assigned all "visible" homework sets.

Now you should be all set up. You can test it out by creating a test student in your LMS and using the link to log into WeBWorK from the LMS. Logging into WeBWorK in this way should not require a password, the WeBWorK user for the student should be automatically created, and the user should also automatically be assigned all "visible" homework sets. In particular you should keep the following in mind about automatic account creation.

  • Students created when signing in via LTI authenticaiton will not have a password. In particular they will not be able to sign into WeBWorK directly. The variable $external_auth is set to 0 by default, and the username and password fields are displayed on the WeBWorK login page. This can be confusing to students, since they still will not be able to sign in. So you may want to change $external_auth to 1. In that case the username and password fields will not be displayed on the WeBWorK login page, and instead a message will be shown that directs users to login through the LMS (the $LTI{v1p?}{LMS_name} and $LTI{v1p?}{LMS_url} variables are used for this).
  • On the other hand setting $external_auth = 1; prevents ALL users from signing into WeBWorK directly including instructors and TAs. For this reason you may want to set $external_auth = 0; to allow direct sign in to WeBWorK. Students still will not be able to sign in to webwork directly unless a password is created for them. So it will be necessary to inform them that they can only log in to WeBWorK through the LMS, and that the username and password fields on the login page will not work for them.
  • Note that if $external_auth is set to 1, then you may also want to set $permissionLevels{change_password} = 'ta' to prevent students from changing passwords (since they usually can't be used anyway).
  • Accounts with a permission level of TA or higher are not automatically created by default for security reasons. So you will have to add your TA's and other professors manually. The parameters that control account creation are:
    • $LMSManageUserData: WeBWorK will try to keep your student's data up to date with the LMS if this flag is on. Student data doesn't change much so you could turn it off with relatively few side effects.
      • If you enable this feature then you should not let students change their email address, since their changes will constantly be overwritten. To do that set $permissionLevels{change_email} = "ta";.
      • If you use a $LTI{v1p?}{LTI_modify_user} subroutine then you should turn this feature off.
    • $LTIAccountCreationCutoff: Users with permission levels at or above this value are not automatically created. It is set to 'ta' by default. You will need to manually add users at or above this value to a course before they can log in via the LMS. If you want to allow professors to be created automatically set this variable to 'professor'. If you want to turn off the account creation feature set this variable to 'guest' or 'student'.
    • $LTI{v1p?}{LMSrolesToWeBWorKroles}: If your LMS uses roles not listed in this hash you will need to add those roles so that users get the right WeBWorK permission level.
    • $LTI{v1p?}{LTI_modify_user}: This is a subroutine which you can use to modify a newly created user before they are actually added to WeBWorK. You would use this if you wanted to, for example, analyze the LTI context parameter for a section number and set the student's section, or create a random string which you set as the student ID and the students password. There are example subroutines in the authen_LTI_1_1.conf and authen_LTI_1_3.conf files.
    • $LTI{v1p?}{LTI_modify_set}: This is a subroutine which you can use to modify newly created sets before they are assigned to users. You would use this if you wanted to, for example, modify the due date of the set before it is assigned, adding extra days based on the number of sets assigned. There are example subroutines in the authen_LTI_1_1.conf and authen_LTI_1_3.conf files.

Grade Pass Back

WeBWorK can be configured to automatically pass grades back to the LMS. There are several configuration variables in authen_LTI.conf that control grade pass back.

  • $LTIGradeMode: If this variable is not set then grade pass back is disabled. If it is set to "course" then the Course Grade Mode is used. If it is set to "homework" then the Homework Grade Mode is used. These grade modes are describe in more detail below.
  • $LTIGradeOnSubmit: If this is enabled then WeBWorK will attempt to update student grades every time they submit an answer to a problem. This keeps the student grades current, but can be a drain on your server. If either the WeBWorK server or the LMS server bogs down it might be a good idea to turn this off.
  • $LTICheckPrior: If this is set to 1, then the current LMS grade will be checked before passing back a grade. If the grade has not changed, then the grade will not be updated. This reduces the number of times that records in the LMS are changed, but requires an additional query to the LMS to determine if grades have changed before grades are updated.
  • $LTIMassUpdateInterval: Grades for all sets and students can be periodically updated. This interval controls how often that mass update happens (in seconds). It is set to 86400 (24 hours) be default and if it is set to -1 this feature will be disabled. Note that you can also manually trigger grade pass back for a selection of users and sets from the "LTI Grade Update" page in WeBWorK.

General notes on grade passback:

  • In some LMS's instructors do not have grades. In this case an instructor will see the message "Your score was not successfully sent to the LMS". This is usually not a problem.
  • You can set $debug_lti_grade_passback = 1; to turn on extensive debugging messages related to grade pass back. Many of these messages can only be seen in the logs/webwork2.log file particularly if you are using LTI 1.3. It also helps to set $LTIMassUpdateInterval = 60; with this. If you want even more debugging information you can trun on the general debug facility in the webwork2.mojolicious.yml file.
  • A different grade pass back configuration can be used for one course than the site wide default by setting the above configuration variables in that course's course.conf file.

Course Grade Mode

This mode is activated by setting $LTIGradeMode to "course". In this mode you create a single link/assignment in the LMS which points to WeBWorK. There will be a single column in the LMS gradebook, and WeBWorK will pass back the "cumulative" assignment grade as a percentage which will be shown in this column. Students sign in to WeBWorK via the single link in the LMS. Once in WeBWorK the students navigate WeBWorK and work assignments as they normally would. When students submit an answer, their course grade will be computed and sent to the LMS.

Things to note when using this grade mode:

  • You should only create one graded link to WeBWorK. If you create more than one, then the LMS gradebook will have multiple columns, and WeBWorK will get confused about which one to send the grade back to. The link URL should have the format https://webwork.yourschool.edu/webwork2/coursename (or select the "Assignments (Course Home)" link when using content selection).
  • Student's must log in to WeBWorK via the link created in the LMS at least once in order for this to work. The easiest way to guarantee this is to set up LTI authentication to create student users the first time that they sign in. However, once they have logged in via the LMS once you could allow them to log in directly via username and password. In that case you will need to create passwords for the students manually (or use an alternate remote authentication method).

Homework Grade Mode

This mode is activated by setting $LTIGradeMode to "homework". In this mode you create a link/assignment in the LMS for each problem set in WeBWorK. There will be multiple columns in the LMS gradebook, one for each link/assignment, and the score for each assignment will be passed back and represented in each column. Each link URL should have the format https://webwork.yourschool.edu/webwork2/coursename/assignmentname (or select the individual assignment links listed under "Visible Sets" when using content selection).

Things to note when using this grade mode:

  • Students must click on a link corresponding to an assignment at least once for grade pass back to work. Once in WeBWorK they can navigate like normal (depending on how you have your WeBWorK course configured). However, on the course home page in WeBWorK (the "Assignments" page or "Homework Sets" page depending on the version of WeBWorK) the links to assignments that have not yet been entered from the corresponding link in the LMS will be disabled and will have the message "You must log into this set via your Learning Management System".
  • If you set $permissionLevels{navigation_allowed} = 'login_proctor' (this can be set on the "Permissions" tab in the course configuration where it is titled "Allowed to view course home page") then student's will not be able to view the course home page (the "Assignments" page or "Homework Sets" page depending on the version of WeBWorK). This can reduce confusion for students. If you do this, then it is recommended that you also disable direct sign in to WeBWorK by setting $external_auth = 1;.
  • Homework due dates and problem totals are not synced between WeBWorK and the LMS. The easiest thing to do is to set all of the homework sets to be open forever in the LMS and let WeBWorK manage access to the homework sets. You can also set the number of points for each set to 100 in the LMS and the score will be a percentage. You can also keep the due dates and number of points synchronized, but you will have to do so by hand.
  • Depending on how you weight assignments in the LMS the contributions of an assignment to the total grade in the LMS may be different than the Homework Totals on the Grades page in WeBWorK. You can turn off displaying the Homework Total in WeBWorK using the course configuration "Show Total Homework Grade on Grades Page" setting to reduce confusion. Note also that if you set $permissionLevels{navigation_allowed} = 'login_proctor' then the students will not be able to view the "Grades" page in WeBWorK at all.

Use Different LTI Configurations for Courses

Configure WeBWorK to use LTI as directed above. Then add any of the configuration variables defined in authen_LTI.conf, authen_LTI_1_1.conf, or authen_LTI_1_3.conf to the end of a course's course.conf file to use different values for this course than the site wide settings.

Combining LTI With Other External Authentication Methods

If your LMS uses an LDAP system for authentication you can set WeBWorK to also use LDAP authentication (see LDAP Authentication). This will allow students to log into WeBWorK using their LDAP/LMS credentials (once their account is created in WeBWorK). To do this you should first comment out the following lines in authen_ldap.conf 

#$authen{user_module} = {
#    "*" => "WeBWorK::Authen::LDAP",
#};

In authen_LTI.conf you should change the definition of $authen{user_module} to 

$authen{user_module} = [
    { '*' => 'WeBWorK::Authen::LTIAdvantage' },          # first try LTI 1.3
    { '*' => 'WeBWorK::Authen::LTIAdvanced' },           # next try LTI 1.1
    { '*' => 'WeBWorK::Authen::LDAP' }                   # fallback authorization method
];

You should also make sure that $external_auth is set to 0.

Retrieved from "https://webwork.maa.org/mediawiki_new/index.php?title=LTI_Authentication_(for_WeBWorK_2.18_or_newer)&oldid=24895"