Configuring Gradescope LTI 1.3 in Sakai
Before you can begin configuring your LTI 1.3 integration, please email us at email@example.com so that we can enable the integration permissions to your account. Once you have received our confirmation that your Gradescope account has the necessary permissions, you can continue onto the first step.
If you don’t have an account yet, go to the Gradescope website and select Sign Up. Select the Instructor role, fill out the provided form and ensure you use the same email address you use on Sakai. You will be emailed with a link to set a password so that you are able to access your new account.
The configuration process consists of steps in both Sakai and Gradescope. Having both apps open in separate tabs could make the process easier. We recommend that you either complete the configuration process all at once, or on your test Sakai environment if you think it may need to be completed in stages. Let’s get started!
Step One - Configuring in Sakai
- Log into your Gradescope account that has the integration permissions enabled. It contains details that need to be copied into your Sakai integration configuration page.
- Once logged in, select LTI 1.3 Integrations from the left side navigation and then select Configure Integration in the bottom right corner. If the “LTI 1.3 Integrations” option is not listed, please check you are logged into the correct account and then contact your account manager to have the integration permissions enabled.
- Select Create new registration and then choose Other from the drop-down menu. Change the Registration Name to Sakai or a preferred name for your Sakai integration.
- Two headings will appear, Gradescope and LMS Details. The details under the Gradescope heading need to be copied into Sakai. Once that has been done, Sakai will provide you with the information needed for the LMS Details section.
- Now that you have the information you need, open a new tab in your browser and log into your Sakai administrator account.
- Access the Administration Workspace and then select External Tools from the side navigation.
- Select Install LTI 1.x Tool and begin your configuration.
- We recommend using “Gradescope” or something your instructors will recognise as your Gradescope integration for the Tool Title and Button Text fields.
- Ensure that Tool Status is set to “Enabled” and Tool Visibility is set to “Visible”.
- Enter the Target Link URL, which is one of the details provided by Gradescope, and ensure Allow launch URL to be changed is set to Do not allow.
- Ensure all boxes are selected from the Privacy Settings, Services, and launching sections.
- If applicable to your version of Sakai, ensure Allow external tool to configure itself is selected for the “Indicate the following types of Content Item/Deep Link Selection launches this tool can handle” setting.
- For Indicate where these tools are placed in Sakai select Allow the tool to selected from lessons.
- Ensure Launch in Popup and Debug Launch are both set to Never.
- If your institution will be using the gradescope.ca, gradescope.eu, or gradescope.com.au instance, in the Custom Parameters box add one of the following:
- Gradescope.eu users enter - preferred_geography=eu
- Gradescope.ca users enter - preferred_geography=ca
- Gradescope.com.au users enter - preferred_geography=ap
- If you are using gradescope.com, you can leave this box blank.
- If applicable to your version of Sakai, check/enable: Allow additional custom parameters.
- Select Tool supports LTI 1.3.
- Now you can copy the remaining details listed in the Gradescope configuration page. Ensure you copy the details for the following fields:
- LTI 1.3 Tool Keyset URL
- LTI 1.3 Tool OpenID Connect/Initialization Endpoint
- Launch URL / Tool Redirect URL
- Select Save. Gradescope will now appear as an option for your instructors, but they will receive error messages until the deployment stage in Step 3 is complete if they attempt to create Gradescope courses or assignments via the LTI links in Sakai.
Step Two - Configuring in Gradescope
- Now that you have configured the necessary details in Sakai, you need to enter details into Gradescope. To access the required information, return to the External Tools page in Sakai.
- Gradescope will now be listed as one of your external tools with the title you assigned. Select the title.
- Scroll to the bottom of the View Installed Tool page. All details with a Copy button need to be entered into the Gradescope LTI 1.3 configuration page. The fields are named slightly differently and are in a different order, so please ensure you copy:
- LTI 1.3 Client ID to Client ID
- LTI 1.3 Platform OAuth2 Well-Known/KeySet URL to Platform public key set URL
- LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL to Access token URL
- LTI 1.3 Platform OIDC Authentication URL to OpenID connect login endpoint
- LTI 1.3 Issuer for this Platform to Issuer
- You can leave Platform authorisation provider blank.
- Select Save on the Gradescope configuration page.
Step Three - Deployment
Gradescope is now installed and will be listed within your External Tools. To complete the configuration, we need to link it to your account so that it can be used by instructors and students.
- Access a Sakai course and select Site Info and then Manage Tools.
- Select External Tools at the bottom of the page. Gradescope will be listed as whatever you have named it in the LTI 1.x Tool configuration page. Ensure Gradescope is checked, then select Continue and then Finish.
- Gradescope will now appear as an option in the left sidebar of your course navigation. Select Gradescope from the side navigation.
- You may be prompted to log into Gradescope if you are not already. Please ensure you are logging into the account that has had the integration permissions enabled.
- Enter your Branded Platform Name and select your school. This will be the name that instructors will see in Gradescope when referring to your Sakai integration. We recommend using a name that instructors will easily associate with your Sakai LMS.