Legacy D2L Brightspace Integration

Introduction

Below you will find an example of our D2L integration guide that you can review.

HelioCampus-D2L Brightspace Setup Guide

(v8 – 02/26/2024)

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

Data Feed Requirements

• In the Course Section file of the data feed set to HelioCampus the following ID needs to be included in the “ExternalLmsId” field in course section file:

  • 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 HelioCampus.

    • Also, if your institution plans on using this code be sure to notify your HelioCampus integration contact.

HelioCampus LTI Tool

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

Please choose if you are going to use an LTI 1.1 or LTI 1.3 integration with HelioCampus, follow the chosen LTI method’s guide from the links below then return to this guide to complete the REST integration.

• Legacy D2L LTI 1.1 Integration

• Legacy D2L LTI 1.3 Integration

HelioCampus 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 HelioCampus 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: HelioCampus D2L Integration

   2. Redirect URI field: https://<HelioCampus_URL>/index.cfm/page/AefisLmsIntegration.authCallback

   3. Scope: Paste the following: core:*:* enrollments:enrollment:read grades:gradeobjects:read quizzing:access:read quizzing:attempts:read quizzing:quizzes:read datasets:bds: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 Account step please be sure to supply your HelioCampus Onboarding contact the following information. They will contact you and let you know when to proceed.

7. The URL for your D2L instance i.e. https://d2l.institution.edu

8. The Oauth2 Client ID and Client Key you created in the steps above.

9. 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 HelioCampus will use to gather information from your institution’s D2L environment to HelioCampus for assessment purposes. A D2L Administrator and HelioCampus Institutional Admin at your institution will need to complete the following. 

• Legacy D2L Brightspace REST API Calls

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: HelioCampus Service Role or a name that follows your institution’s role naming convention

7. Enable Cascading Role: Check this box

8. Role Alias: HelioCampus 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 HelioCampus 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:

13. Click Save

14. Find the HelioCampus Service Role on the Role List page

15. Click the chevron next to HelioCampus Service Role

16. Click Edit permissions

a. You will need to grant certain permissions within a few tools to allow HelioCampus 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.

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: HelioCampus

6. Legal Last Name: Service Account

7. Email: heliocampusservice@XXXXX  

   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 HelioCampus

8. Username: Input the desired username or allow the system to auto-create it. 

9. Role: Choose the HelioCampus 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 HelioCampus.   

11. Active: Check this box

12. Notification Number: Choose No notification number

Create the service account in HelioCampus

*The following should be completed by a HelioCampus Institutional Admin

First, you will need to create the service account that was created in D2L on your HelioCampus application.

Once you have logged on to HelioCampus complete the following to add the service account:

1. Click the hamburger menu on the top left of HelioCampus

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 Local 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 (You need to add a password for the service account on HelioCampus)

1. Click Next

2. From the drop-down menu choose Institutional Admin

3. Click Add Role

1. Click Edit Parent Objects

1. Click 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 and click Save again to create the service account

2. The service account is ready for the authorization step

Authorize the service account from HelioCampus on D2L

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

1. Login to your D2L account as an administrator

2. Act as the service account

3. Open a Course in D2L that also exists in HelioCampus

4. Now open a new tab from your internet browser and go to your HelioCampus platform and put “/?login” at the end of the URL (i.e university.heliocampus.net/?login )

1. Click “SIGN IN WITH BASIC AUTHENTICATION”

2. Enter the credentials of the service account that you have created in the HelioCampus platform and click sign-in

1. Once you login into the platform 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. Make sure that the highlighted area in the image below displays information about the D2L service account.

1. Click Accept

2. You will be redirected back to HelioCampus

LMS Integration Troubleshooting

This troubleshooting guide aims to assist users in resolving common issues encountered while using LMS-HelioCampus. If you encounter a problem not addressed here, please contact support@heliocampus.com for further assistance.

D2L ExternalLmsID → Course Offering Code

Why is my HelioCampus section not accessible via the LMS/not pulling assignments?

We receive information about your course sections via your data files. As a part of that, for each section, we receive what’s called the Course Offering Code field from LMS. We map this to our field called “ExternalLMSID.” It is the LMS’s unique key for each section. We need that field to be able to match up information in our platform with information coming to us from your LMS. So when you try to refresh assignments, our platform asks the LMS, “What assignment information do you have with this Course Offering Code?”

Should you be having issues with seeing refreshed/updated LMS Assignments, it is recommended to examine the Course Offering Code (again, that we map to ExternalLMSID) appearing for these course sections. If these values do not match, the Integration cannot connect the LMS and HelioCampus A&C Platform.

As a next step - we’d like you to log into LMS and go to the course sections in question, view the Course Offering Code, and confirm whether or not they appear like the IDs below. The Course Offering Code is on the Course/Co-Curricular Activity Settings page of the HelioCampus A&C Platform. Should you have trouble finding it, someone at your institution who handles LMS should be able to help you if you can’t find it. If these IDs are not the actual Course Offering Codes for these sections in LMS, we need to figure out why they are coming to us via your data file. That may require us to have a discussion with whomever at your institution was responsible for setting up the data files.

Examples:
EDU 261 400- ExternalLMSID: 2023SP-INST-EDU261-400
EDU 261 401- ExternalLMSID: 2023SP-INST-EDU261-401
BIO 3061 4120- ExternalLMSID: 2023FA-INST-BIO3061-4120

Why is the HelioCampus section showing an "Invalid Access Token" error when I try to refresh assignments?

Should you receive an "Invalid Access Token" error message when attempting to refresh LMS Assignments into the HelioCampus A&C Platform, reauthorization of the expired access token must be completed. Authorization Tokens are required to ensure appropriate security and permissions through the API Integration.

To address this issue, please notify the HelioCampus A&C team. Our team will delete the current expired token, and then your LMS service account will need to be re-authorized.

Here is our documentation, which includes the steps for the re-authorization: Legacy D2L Brightspace Integration . This action should be completed by the LMS Administrator or an Institutional Administrator who has login access to the LMS System Account.

It is possible for our team to bypass the LTI step to recreate the token, however, it must be noted that adding the service account to the Keycloak realm is essential. This is because a manual user login to the HelioCampus system is a necessary step in completing the reauthorization process. For more information on this bypass method, please reach out to the HelioCampus A&C team.