Overview
This article provides a step-by-step guide to setting up the Advanced D2L Integration. It covers creating a specialized "Integration Role" with necessary permissions, establishing an "Integration User" with this role, and registering an OAuth 2.0 application in D2L to obtain the Client ID and Secret needed for P&SS integration.
Before setting up the integration, it is essential to complete all of the required data mappings. The data sync process begins immediately after the integration is activated. If the data mappings are not configured beforehand, no data will be pulled into the app during the initial sync.
Please refer to the Required Data Mapping in Advanced D2L- Required Data Mapping article.
*The Advanced D2L Integration needs to be enabled by Watermark before proceeding with the steps below.*
Create a Role in Desire2Learn (D2L)
- The Administrator logs in to D2L.
-
The Administrator navigates to: Admin Tools > Security > Roles and Permissions.
- Click Create/Copy.
- Select Start Fresh.
- The Administrator enters a Role Name (e.g., Integration Role).
- The Administrator enables the Cascading Role by checking the box.
- Under Course Access Options, the following are selected:
- Access inactive courses
- Access past courses
- Access future courses
- Click Save and Close.
Assign Role Permissions
- The Administrator locates the newly created role in the role list.
-
Click the Down Arrow > Edit Permissions.
-
The Administrator ensures the role is selected in the Filter by Role dropdown and the relevant tool is selected in the Filter by Tool dropdown, then clicks Apply Filter.
-
The following permissions are enabled:
- Assignments: See and Manage Assignment Submission Folders (All); View Submitted Files (All).
- Classlist: Has Access to the Classlist (All); View Group Enrollments (All); View Section Enrollments (All).
-
Discussions: View Discussions (All); Access Hidden Forums and Topics (All).
-
Grades: See the Grades tool (All); See user grade values (API Only); Retrieve Grade Values for Course Offering Descendants (API Only).
-
Quizzes: View Quizzes (All); View hidden quizzes and details; View Out-of-Date Quizzes.
-
User Information Privacy: See First Names, See Last Names, See Usernames, See Org Defined IDs, and See Email Addresses (All).
- Click Save and Close.
Create an Integration User in D2L
- Navigate to: Admin Tools > Users.
- Click Create New User.
-
The Administrator provides a unique Org Defined ID, First Name, and Last Name.
- The Administrator selects the Integration Role from the Role dropdown.
- Check the box to Make User Active.
- Click Save.
Register an App in D2L
- Navigate to: Admin Tools > Manage Extensibility > OAuth 2.0 Tab.
- Click Register an App.
- The Administrator fills in the Application Name, Redirect URI (copied from Planning & Self-Study (P&SS)), and Scope (copied from P&SS).
-
The Access Token Lifetime is set to 3600 seconds (default).
-
The Administrator enables the following: Prompt for user consent, Enable refresh tokens, and Accept the Non-Commercial Developer Agreement.
- Click Register.
-
Save the generated Client ID and Client Secret for use within P&SS.
Click Activating D2L within P&SS to proceed with activating the integration.