D2L Brightspace Integration

Introduction

Below you will find an example of our D2L integration guide that you can review.
AEFIS will supply you with a customized guide for your institution that you will be able to complete the integration with.

AEFIS-D2L Brightspace Setup Guide

(v6 – 12/17/2020)

This document covers requirements for AEFIS – D2L Brightspace (D2L) integration. A D2L Brightspace Administrator working with an AEFIS integration technician can complete requirements for the AEFIS Tool. There may be additional personnel required for unforeseen circumstances such as client network or server restrictions.

AEFIS Tool

The AEFIS Tool allows students and instructors the ability to view an AEFIS course syllabus within a related course and complete assessment forms.

Requirements:

  • The domain name of the AEFIS installation that will be used
  • LTI Consumer Key supplied by AEFIS for security
  • LTI Shared Secret supplied by AEFIS for security

Data Feed Requirements:

  • In the Course Section file of data feed set to AEFIS the following ID needs to be included in the ExternalLmsId field:
    • Course Offering Code – This is the data is populated in the Course Offering Code field that your institution sends in the data feed to D2L.
      • For example, it could be a concatenation of something like term code, subject code, course number, and section number i.e. 202010.ENG.101.1
    • Course Context ID – This is the internal ID assigned to a Course by D2L once it is created.
      • If your institution plans on sending this code the institution will need to pull those IDs from D2L and then insert them into the Course Section sent to AEFIS.
      • Also, if your institution plans on using this code be sure to notify your AEFIS integration contact.

LTI Configuration

The following will create the External Learning Tool (LTI) connection between D2L and AEFIS:

  1. Login to your D2L account as an administrator
  2. Click the Admin Tools gear icon
  3. Click External Learning Tools under Organization Related
  4. Click New Link
  5. Fill out the form with the following values:
    1. Title: AEFIS Tools
    2. URL: https://<Your Institution AEFIS_URL>/index.cfm/page/AefisFramework.login
    3. Description: AEFIS is a web-based assessment management solution that facilitates the collection and application of real-time assessment data.
    4. Visibility: Check Allow users to view this link
    5. Key/Secret:
      1. Check Sign messages with key/secret with
      2. Click Link key/secret
      3. Key: Paste the following: To be provided by AEFIS
      4. Secret: Paste the following: To be provided by AEFIS
    6. Custom Parameters:
      1. Click Add custom parameters
      2. Name: Paste the following AUTHENTICATORCODE
      3. Value: Paste the following LTI
    7. Security Settings:
      1. Click Use link security settings
      2. Check at minimum the required fields below under Use link security settings
        1. Required:
          1. Send tool consumer information to tool provider
          2. Send context information to tool provider
          3. Send user email to tool provider
        2. Optional:
          1. Send course information to tool provider
          2. Send LTI user ID and LTI role list to tool provider
          3. Send user name to tool provider
          4. Send system username to tool provider
          5. Send system Org Defined ID to tool provider
          6. Send system role to tool provider
          7. Send link title to tool provider
          8. Send link description to tool provider
    8. Make the link available to: At this point share LTI connection to the org units you wish to make AEFIS available to.
  6. Click Save and Close

Add the LTI link to NavBar 

The following will add the AEFIS Tools link directly to the NavBar and will be available to all users, if you wish to not share with all child org units or limit to certain user roles you may do that based on your institution’s policies. Also if you wish to add the link to an existing drop-down link please consult the D2L documentation.

  1. Hover over the NavBar and click the button to the right with the 3 dots
  2. Click Manage All Course NavBars
  3. Find then click on the NavBar you with to add the button to
  4. Under Links Click Add Links
  5. Click Create Custom Link
  6. Fill out the form with the following values:
    1. Name: AEFIS Tools
    2. URL:
      1. Click Insert Quick Link
      2. Scroll down and Click External Learning Tools
      3. Click AEFIS Tools
    3. Behavior: Choose Same Window
    4. Description: Launch the AEFIS Tools.
    5. Icon: If you use Icons in the NavBar please download the icon from the following link then upload it https://goo.gl/p312yp  
    6. Availability: Check Share with child org units
  7. Click Add
  8. Move the new link the where you would like it located under Links
  9. Click Save and Close

AEFIS Oauth2 Configuration 

A D2L Oath2 Key/Secret is a required part of the Oauth2 process where instructors can grant permission to import related data from D2L into AEFIS for assessment.

Create Oauth2 Configuration

  1. Login to your D2L account as an administrator
  2. Click the Admin Tools gear icon
  3. Click Manage Extensibility under Organization Related
  4. Click OAuth 2.0
  5. Click Register an app
  6. Enter the following information:
    1. Application Name: AEFIS D2L Integration
    2. Redirect URI field: https://<AEFIS_URL>/index.cfm/page/AefisLmsIntegration.authCallback
    3. Scope: Paste the following: core:*:* enrollments:enrollment:read grades:gradeobjects:read
    4. Access Token Lifetime: Paste the following: 72000
    5. Prompt for user consent: Check this box
    6. Enable refresh tokens: Check this box
    7. Select the I accept the Non-Commercial Developer Agreement check box
    8. Click Register
    9. Make a note of the values in the Client ID and Client secret fields 

Before you proceed with the Service Acount step please be sure to supply your AEFIS Onboarding contact the following information. They will contact you and let you know when to proceed.

  1. The URL for your D2L instance i.e. https://d2l.institution.edu
  2. The Oauth2 Client ID and Client Key you created in the steps above.
  3. If you are going to use the optional D2L Course Context ID

Service Account

This section will walk you through creating a service account for the REST API calls AEFIS will use to gather information from your institution’s D2L environment to AEFIS for assessment purposes. A D2L Administrator and AEFIS Institutional Admin at your institution will need to complete the following. 

Create the service account role in D2L:

The following should be completed by a D2L Administrator

First you will need to create a role in D2L for the service account.

  1. Login to your D2L account as an administrator
  2. Click the Admin Tools gear icon
  3. Click Roles and Permissions under Security
  4. Click Create/Copy
  5. Click Start Fresh
  6. Name: AEFIS Service Role or a name that follows your institution’s role naming convention
  7. Enable Cascading Role: Check this box
  8. Role Alias: AEFIS Service Role or a name that follows your institution’s role naming convention
  9. Tool Behavior Options: Leave all options unchecked
  10. Classlist Display Options: Leave all options unchecked
  11. Course Access Options
    1. Access:
      1. Access inactive courses: Leave unchecked
      2. Access past courses: Optionally check this box, if you desire for AEFIS to be able access past courses for assessment purposes.
      3. Access future courses: Leave unchecked
    2. Sections:
      1. Choose None of the above
    3. Groups:
      1. Choose None of the above
  12. Click Save
  13. Edit Role Interactions:
Role InteractionPermission(s)
Search for ‘AEFIS Service Role’Allow at a minimum your Super Administrator and members of the role itself to be able to search for users of the service role in all org unit types.
Impersonate ‘AEFIS Service Role’Allow at a minimum your Super Administrator and members of the role itself to be able to impersonate users of the service role in all org unit types.
Enroll ‘AEFIS Service Role’Allow at a minimum your Super Administrator and members of the role itself to be able to enroll users of the service role in all org unit types.
Role Switch ‘AEFIS Service Role’Allow at a minimum your Super Administrator and members of the role itself to be able to role switch the service role in all org unit types.
See External Email Addresses for ‘AEFIS Service Role’Allow at a minimum your Super Administrator and members of the role itself to be able to view external email addresses for users of the service role in all org unit types.
See Internal Email Addresses for ‘AEFIS Service Role’Allow at a minimum your Super Administrator and members of the role itself to be able to view internal email addresses for users of the service role in all org unit types.
Make ePortfolio Content Available to ‘AEFIS Service Role’Allow at a minimum your Super Administrator and members of the role itself to be able to provide ePortfolio content to users of the service role in all org unit types.
See Parent Child Relationships for ‘AEFIS Service Role’Allow at a minimum your Super Administrator and members of the role itself to be able to view parent child relationships for users of the service role in all org unit types.

13. Click Save
14. Find the AEFIS Service Role on the Role List page
15. Click the chevron next to AEFIS Service Role
16. Click Edit permissions

a. You will need to grant certain permissions within a few tools to allow AEFIS to make the required REST API calls with this role.

b. Below are listed the tools and which permission(s) should be granted within each tool. Please complete the following by choosing the tool under Filter by Tool, clicking Apply Filter, selecting the proper permission(s), click Save, and repeat for all tools. Once completed click Save and Close.

ToolPermission(s)OrgUnit
AssignmentsSee and Manage Assignment Submission Folders
View Submitted Files
View Feedback
Enable at Organization & Course Offering levels
ClasslistHas Access to the Classlist
See Classlist Report
View Group Enrollments
Enable at Organization & Course Offering levels
ContentView Course Content
Search Content
View Content that is Not Released
Enable at Organization & Course Offering levels
GradesSee the Grades tool
Export Grades
See user grade values (API Only)
Enable at Course Offering levels
Org Unit EditorCan Create and Edit Org UnitsEnable at Organization level
User Information PrivacySee First Names
See Last Names
See Usernames
See Org Defined IDs
See Email Addresses
Enable at Organization & Course Offering levels
UsersView User Enrollments
Search for: At a minimum add the role the students are included in, this is typically the Learner role
Enable at Organization & Course Offering levels

Create service account user in D2L

  1. Login to your D2L account as an administrator
  2. Click the Admin Tools gear icon
  3. Click Users under User Related
  4. Click New User
  5. Legal First Name: AEFIS
  6. Legal Last Name: Service Account
  7. Email: [email protected]  
    1. This does not need to be a real email address, as long as you use the same email address when you create the account in AEFIS 
  8. Username: Input desired username or allow the system to auto create it. 
  9. Role: Choose the AEFIS Service Role or the name that follows your institution’s role naming convention
  10. Password: Choose Manually set password and create a password meeting your password requirements. This password will not be provided to AEFIS.   
  11. Active: Check this box
  12. Notification Number: Choose No notification number

Create the service account in AEFIS:

The following should be completed by a AEFIS Institutional Admin

First, you will need to create the service account that was created in D2L on your AEFIS application.
Once you have logged on to AEFIS complete the following to add the service account:

  1. Click the hamburger menu on the top left of AEFIS
  2. Scroll down to the Admin Tools section of the menu
  3. Click User Accounts
  4. Click ADD USER towards the top right
  5. Choose University User
  6. Click Next
  7. Fill in the User Details with the service account information from D2L above
    1. Email Address
    2. First Name
    3. Last Name
    4. University ID
      1. If the Service account you created does not have SIS ID in D2L you can place the email address here.
    5. Username
    6. Password – If you chose a Local User please enter a password for the account
  8. Click Next
  9. From the drop down menu choose Institutional Admin
  10. Click Add Role
  1. Click Edit Parent Objects
  1. Click the your Institution under Available Institutions on the left
  2. Click the arrow pointing right to move it to Selected Institutions
  3. Click OK
  1. Click Save User
  2. Stay on the user’s page for the final step

Authorize the service account from AEFIS on D2L:

The following can be completed by a D2L Administrator or AEFIS Institution Administrator if the AEFIS Institution Administrator can impersonate the service account in AEFIS

The last step is to do the REST API authorization with D2L using the service accounts you created in D2L and AEFIS.

  1. Login to your D2L account as an administrator
  2. Click Users under User Related
  3. Search for the service account you created
  4. Click the chevron next to the user’s name
  5. Choose Impersonate user
  6. Choose Yes on the confirmation window
  7. Open a Course that also exists in AEFIS
  8. Click AEFIS Tools in the Course Menu to lunch the LTI tool
  9. Once the AEFIS opens in the i-frame click the launch icon pictured below to open AEFIS in a new tab
  1. You should see the image below, if not click the hazard icon towards the top right of the page
  2. Click GO TO AUTHORIZATION
  1. Click Accept to authorize the service account.
It's Your Academy. Help us improve it!
Your feedback is vital to help build the best Academy
— and our community deserves it!

Recent Favorites

View your most recent favorited blogs, resources, events and content hubs.

It's Your Academy. Help us improve it!

Your feedback is vital to help build the best Academy
— and our community deserves it!

  • Hidden
  • Hidden
  • Hidden
  • This field is for validation purposes and should be left unchanged.

It's Been A Year...

Welcome to AEFIS Academy!

Here is what’s driving us to do it and why…