1-888-257-2278 Go to YuJa
  1. YuJa Help Center
  2. YuJa Engage
  3. D2L Brightspace
  4. Administrator

Integrating the YuJa Engage Platform for D2L Brightspace LTI 1.3

Avatar
YuJa Product Support
  • Updated

Admins can integrate the YuJa Engage Platform into their D2L Brightspace Learning Management System (LMS). The integration will allow polls to be created, published, and graded directly to desired courses and viewed by admins, instructors, and students. If you have any questions regarding the steps in this process, please contact your dedicated Customer Success Manager.

Registering the YuJa Engage Tool

To deploy YuJa Engage as an external learning tool, it must first be registered to your D2L learning environment. Please follow the steps below to learn how to register YuJa Engage as an LTI 1.3 tool.

  1.  Log in to D2L Brightspace as an admin.
  2. Click the Gear icon, and select Manage Extensibility.
    The Admin Tool gear icon is selected showcasing a menu with the option to select Manage Extensibility.
  3. Click on the LTI Advantage tab and then click Register Tool.
    The LTI Advantage tab is selected and the Register tool button is shown highlighted.
  4. To register the YuJa Engage tool, select Standard, fill out the information as shown below, and then click Register.
     The register a tool settings are shown filled out.
      • Name: Any name of your choice to identify the YuJa Engage Tool.
      • Domain: Provided by your Customer Success Manager 
      • Redirect URLs: Provided by your Customer Success Manager
      • OpenID Connect Login URL: Provided by your Customer Success Manager
      • Target Link URL: Provided by your Customer Success Manager
      • Keyset URL: Provided by your Customer Success Manager 
      • Extensions: Ensure that the following Extensions are checked:
        • Assignment and Grade Services
        • Deep Linking 
        • Names and Role Provisioning Services 
      • Roles: Ensure that Send Institution Role is checked.
      • Custom Parameters
        • Name: person_sourcedid Value: $Person.email.primary
        • Name: lis_person_sourcedid Value: lti_login_id=$User.username
  5. Once the tool is registered, select the YuJa Engage tool from the list of LTI Advantage tools.
    The New YuJa Engage LTI tool is shown highlighted.
  6. Scroll down to the Brightspace Registration Details and note down the details. They will be required when configuring the YuJa Engage API.
  7. Click View Deployments and move to the next section of this guide. 
    The registration details for the tool are shown and the option to view deployments is highlighted.

 

Deploying the YuJa Engage Tool 

Once you have registered the YuJa Engage tool to your institution's D2L Brightspace environment, it will need to be deployed to allow courses to access it.

 

  1. On the External Learning Tools page, ensure that the LTI Advantage tab is selected and click New Deployment.
    In the External Learning Tools page, the LTI Advantage tool is selected with the New Deployment button highlighted.
  2. To deploy the tool, fill out the information as shown below, and click Create Deployment.
    The deploy tool settings are filled out.
      • Tool: Select the YuJa Engage tool registered in the previous section of this guide.
      • Name: Any name of your choice to identify the YuJa Engage deployment tool.
      • Extensions: Check the following Extensions:
        • Assignment and Grade Services 
        • Deep Linking 
        • Names and Role Provisioning Services 
      • Security Settings: Check the following settings:
        • Org Unit Information
        • User Information 
          • Name
            • First Name
            • Middle Name 
            • Last Name 
          • Email
          • User ID
          • Username
          • Org Defined Id
        • Link Information 
          • Title
          • Description 
      • Custom Parameters
        • Name: person_sourcedid Value: $Person.email.primary
        • Name: lis_person_sourcedid Value: lti_login_id=$User.username
      • Add Org Units: Add courses you wish to enable YuJa Engage for. You can edit the deployment tool at any time to add additional courses. 
  3. Once you've created the deployment tool, select the tool from the list of External Learning Tools.
    The engage tool is shown highlighted in the list of external learning tools.
  4. Under the Brightspace Deployment Details, note down the deployment Id; it will be needed when configuring the YuJa Engage API.
  5. Click View Links. 
    The view links options is shown highlighted in the Deployment Details.
  6. You'll be required to create two links: Basic Launch and Deep Linking Quicklink.
  7. Click New Link.
    In the Links page, the new links button is shown highlighted.
  8. Fill out the information as shown below and click Save and Close.

    The information for creating a new link is filled out.
    • Name: Any name of your choice to identify the Basic Launch link.
    • URL: Provided by your Customer Success Manager.
    • Type: Basic Launch 
  9. Click New Link one more time to add the Deep Linking Quicklink by filling out the information as shown below.
  10. Click Save and Close to complete the YuJa Engage deployment. Move to the next section of the guide to configure the YuJa Engage API tool. 
    The information for creating a new link is filled out.
      • Name: Any name of your choice to identify the Basic Launch link.
      • URL: Provided by your Customer Success Manager.
      • Type: Deep Linking Quicklink

Configuring the API for YuJa Engage

Once you've deployed YuJa Engage to D2L Brightspace, you will be required to configure the YuJa Engage API to allow for data transfer between D2L Brightspace and YuJa Engage.

  1. Log in to YuJa Engage as an admin using your zone URL.
      • Example: https://www.evergreen.engage.yuja.com
  2. From the left-side navigation menu, select Integration.
  3. From the Choose Integration Type drop-down menu, select LMS LTI 1.3.
  4. Select D2L from the Select LMS drop-down menu.
    The D2L integration page within Engage.
  5. Scroll down to API Configuration, and based on the Brightspace Registration and Deployment details noted in the previous sections, enter the following information:
      • ISS: Issuer
      • Client Id: Client Id
      • OIDC Endpoint: OpenID Connect Authentication Endpoint
      • JWKS Endpoint: Brightspace Keyset URL
      • OAuth2 Token Endpoint: Brightspace OAuth2 Access Token URL
      • Deployment Id: Deployment Id
  6. Select all checkboxes under User Configuration and Course Configuration.
  7. Click Save Changes to complete the integration between D2L and YuJa Engage.
    Information for the integration is filled out.

Integrating Course Roster Sync

Once the integration is complete, you can enable course roster sync to automatically update the Engage roster with a list of students within a specified course. Before proceeding with the steps below, please ensure you have received a trusted URL from your Customer Success Manager. 

  1. Log in to D2L Brightspace as an admin.
  2. Click the Gear (Admin Tools) icon.
  3. Select Manage Extensibility.
    the ADmin Tool drop-down menu is shown with Manage Extensibility shown highlighted.
  4. Ensure the ID Key Authorization tab is selected, and then click Register an App.
    The ID Key Authorization tab is selected with register an app highlighted.
  5. Fill out the information as shown below:
    • Application Name: Any identifiable name of your choosing.
    • Trusted URL: The trusted URL received from your Customer Success Manager.
    • Enable this application: Ensure this option is checked.
    • I accept the Non-Commercial Developer Agreement: Ensure this option is checked.
  6. Click Register Application.
    The Reigster an Application settings are filled out
  7. On the next page, make a note of the Application ID and Application Key. They will be needed to complete the course roster integration.
    The API Application ID and Key are shown.
  8. Next, click the Gear (Admin Tools) icon.
  9. Select Config Variable Browser.
    The admin tool drop-down menu is shown with Config variable browser highlighted.
  10. From the left-side menu, select Tools.
  11. Select Classlist.
  12. From the table, select DisplayEmail.
    The classist is shown with Display Email highlighted.
  13. Click Add Value.
    The add value button is shown highlighted.
  14. Click Select Org Unit to select the Org from which you'd like to retrieve emails.
  15. Set the Value to On.
  16. Click Save.
    The Add Variable value window shows an org unit has been selected and the value is on. the Save button is shown highlighted.
  17. Under Tools, select Classlist again.
  18. From the table, select DisplayUsername.
    Within the classist, display username is shown highlighted.
  19. Click Add Value.
    The add value button is highlighted.
  20. Click Select Org Unit to select the Org from which you'd like to retrieve usernames.
  21. Set the Value to on.
  22. Click Save.
  23. Next, log in to YuJa Engage.
  24. From the left-side navigation menu, select Integrations.
  25. Under Choose Integration Type, select LMS - API, and then select D2L.
    The Engage integration page is shown. LMS API integration type is selected for D2L.
  26. Enter the following API Access information:
    • Domain: Your D2L domain URL
      • Example: evergreen.canvas.com
    • LMS API Link: https://<YOUR_D2L_DOMAIN>/api/v1
      • Example: https://evergreen.canvas.com/api/v1
    • App ID: The Application ID that was copied in step 7 of this section.
    • App Key: the Application key that was copied in step 7 of this section.
    The API key access information is filled out.
  27. Adjust any additional Linkage Settings.
    • D2L Course: The primary linkage attribute will be based on the D2L Course ID.
    • D2LUsers: The primary linkage attribute can be the user's D2L User ID or their Primary Email.
    • It is recommended that you check: Use user email and user's name as backup fields if no D2L User ID is found.
    The linkage settings information is filled out.
  28. Click Save Changes.
    The save button for the integration page is shown highlighted.
  29. After saving your changes, click Allow API Access.
    the allow API access button is shown highlighted in the integration page for D2L.
  30. Click Continue to complete the process
    the continue button is shown highlighted.

Adding YuJa Engage to a Course

Once the integration process is complete, YuJa Engage can be inserted into the Navbar for any course added to the YuJa Engage deployment tool. For more information, please refer to step 4 in Deploying the YuJa Engage Tool section of this guide.

  1. Log in to D2L and navigate to a course you'd like to add YuJa Engage to. 
  2. Click the More drop-down menu and click Edit This Navbar.
  3. Next, click Add Links. 
    The Edit navbar page is shown with the Add Links button highlighted.
  4. Click Create Custom Link.
    the create custom link button is shown highlighted.
  5. Enter a Name for the custom link and then click Insert Quicklink.
    The name for the custom link is entered and the insert quicklink button is highlighted.
  6. Click External Learning Tools.
    External learning tools is selected.
  7. Locate and select the YuJa Engage LTI link.
    the YuJa Engage LTI link i shown highlighted.
  8. From the Behavior drop-down menu, select Same window. 
  9. Click Create.
    The create button is shown highlighted for the Create Custom Link settings.
  10. To access the YuJa Engage platform, click the More drop-down menu and select YuJa Engage.
    YuJa Engage is shown within the Navbar.
  11. Selecting the LTI link will allow you to access the YuJa Engage platform inside D2L to create, publish, and automatically grade Polls once administered.
    YuJa Engage is shown within D2L.

 

Related articles