How to Set up the Hawkes Synchronization Tool and Single Sign On Link in Brightspace by D2L
Reference Number: AA-00665 Last Updated: 2021-10-13 14:33

The Hawkes Synchronization Tool allows instructors to synchronize their students??? Hawkes grades with D2L.

The Hawkes Single Sign On link allows students to access the Hawkes web platform directly from D2L without having to enter login credentials.

Requirements

  • A supported D2L version (Learning Environment 10.3.0 SP 5 and higher)
  • A Shared Secret and Key from Hawkes Learning
  • User with administrative rights in D2L

Setup Steps

  1. Determine your D2L LMSID and send it to Hawkes Learning
    a. Log into D2L as an administrator
    b. Go to Settings > Config Variable Browser
    c. Search for 'LMSID'
    d. Copy the value for "ID for the central application provisioning service," listed under the Effective Value column
    e. Send this value to Hawkes  Learning to receive approval for using the tools in D2L along with the key pairs (below)

  2. Obtain application key pairs for the two new applications that you will be adding to your instance of D2L (Hawkes Synchronization Tool and Single Sign On link)
    Information on how to apply for these key pairs can be found on Brightspace's developer platform. The steps are also below.
    If prompted, select "ID Key Authorization".

    a. Select "Register New Application"
    b. Application Name: Hawkes Synchronization Tool or Hawkes Single Sign On
    c. Trusted URL (Sync Tool):
    https://lmssynctool.hawkeslearning.com/D2LLaunch/D2LAuthReturn
    or
    Trusted URL (SSO):
    https://lmssynctool.hawkeslearning.com/D2LLaunch/SSOAuthReturn
    d. Major Version: 1
    e. Minor Version: 0
    f. Description: Allow users to synchronize students, assignments, assignment grades and final grades from their Hawkes Grade Book to their D2L grade books or Student Single Sign On capabilities for the Hawkes Learning web platform
    g. Repeat for the second application if necessary
    h. Once they key and ID pairs for each application are generated, send them to Hawkes Learning along with the D2L LMSID (above)

  3. Check to see if you have access to the Hawkes Synchronize Web Service
    Navigate directly to https://lmssynctool.hawkeslearning.com. You should receive a custom error message. If you receive a 404 error, please contact Hawkes Learning.

  4. Add an External Learning Tool
    a. Log into D2L as a user with administrative rights
    b. Go to Settings > External Learning Tools (not External Link)
    c. Select "new link"
    d. Enter the following information:
      Properties
    • Title: Hawkes Sync Tool or Hawkes SSO
    • URL (Sync Tool):
      https://lmssynctool.hawkeslearning.com/LTILaunch
      or
      URL (SSO):
      https://lmssynctool.hawkeslearning.com/LTISSOLaunch
    • Description: "Tool used to sync the D2L Grade Book with the Hawkes Learning Grade Book" or "Link used by students to access the Hawkes Learning web platform"
    • Visibility: Check "Allow user to view this link"
      Key/Secret
    • Signature: Check "Sign message with the key/secret with" and select "Link key/secret"
    • Key: Provided by Hawkes Learning
    • Secret: Provided by Hawkes Learning

    • Security Settings
      Check all of the following:
    • Send tool consumer information to tool provider
    • Send context information to tool provider
    • Send user ID to tool provider
    • Send user name to tool provider
    • Send user email to tool provider
    • Send link description to tool provider
      Make the link available to:
    • Check all Org Units that apply. Add new Org Units as needed.
  5. Set Role Permissions for Instructors (Does not apply to SSO link setup)
    a. Go to Settings > Roles and Permissions
    b. Select "Instructor"
    c. Choose Edit Role Permissions
    1. Select Instructor from the "Filter by Role" drop-down menu
    2. Select Users from the "Filter by Tool" drop-down menu
    3. Select Apply Filter
    4. For "View User Enrollments", check Organization, Course Template and Course Offering
    5. For "Search for ???Student???", check Organization, Course Template and Course Offering
    6. Press Save and Close
    If your D2L instance has other user roles that need access to the Hawkes Sync Tool, the other user roles need to have the same permissions granted. These additional users must also be mapped to the LMS LTI role of Instructor or Admin.

  6. Add to the Course Content page
    This can be done by a user with instructor or administrator permissions.
    a. Select the D2L course that you would like to sync with a Hawkes Section
    b. Select "Content" at the top of the course home page
    c. Select "Add a module..." on the left-hand side of the page
    d. Name the module 'Hawkes Learning' or something similar
    e. Press Enter
    f. Select the module you just created
    g. Open the "Existing Activities" drop-down menu
    h. Select "External Learning Tools"
    i. Choose "Hawkes Sync Tool" or "Hawkes SSO" from the list (The names may be slightly different.)
Repeat Steps 4 and 6 for the second tool.


Notes:

  • Do not make the Hawkes sync tool visible to students.
  • If you are using the Single Sign On link, both the link and the Hawkes unit will need to be made visible to students.
  • Selecting the Single Sign On link before the course has been linked to a Hawkes section will result in a message indicating that the course has not been set up yet. This is expected.
  • When testing the Single Sign On link as an instructor or LMS administrator, do not impersonate a student. This will result in an error.