User Activities

• Users can view alerts for new discussions, unattempted quizzes, and new feedback on assignments from their home screen on the live tile.
• Users are redirected to either the D2L Brightspace domain (if on the web) or to the Pulse mobile app (if on a mobile device) when the tile is clicked.

Authentication

The D2L Brightspace product integration uses an OAuth Integration Profile (configured at App Settings > Integration Profile > Add Integration Profile). This must be configured before the product integration will work. See OAuth Integration Profile Configuration. For additional details on how to configure an OAuth Integration Profile, see OAuth2.

The following is the authentication workflow:

1. The end-user opens the D2L Brightspace tile.
2. campusM requests a token from the D2L Brightspace token API.
3. The user logs into D2L Brightspac (if they have not already done so).
4. If valid, D2L Brightspace sends a response with the user's access token.
5. campusM sends the access token with every D2L Brightspace API request made.
6. The token is automatically refreshed on expiration unless the user has logged out of the campusM app or their D2L Brightspace session.

Offline Support

• None provided - the user must be online to fetch the D2L Brightspace data.
• D2L Brightspace data is not cached on the user's device. A live tile is intended to present fresh data. To configure the time between updates, see Product Integration Configuration.

Screenshots

The following is an overview of the D2L Brightspace product integration user interface for reference when configuring it.

Example of 2 x 1 dimensions

Live Tile Configuration Rules

The D2L live tile is designed to work with the following sizes. The tile will attempt to display as many elements as possible regardless of the dimensions set, but we cannot guarantee the intended experience if you do not adhere to the following dimensions. The tile dimensions are set in the App Builder, while the widgets per row (and other details) are set in the Configuration page for this product integration.

• 1 wide x 1 high
  • This is a special case. The tile only displays one widget (the highest prioritized, enabled widget).
• 2 wide x 1 high
  • We recommend using 1 - 2 widget rows and using 1 - 3 widgets per row.
• 2 wide x 2 high
  • We recommend using 2 - 3 widget rows and using 1 - 3 widgets per row.
• 3 wide x 1 high
  • We recommend using 1 - 2 widget rows and using 2 - 4 widgets per row.
• 3 wide x 2 high
  • We recommend using 2 - 3 widget rows and using 2 - 4 widgets per row.

We also recommend keeping the header text and widget labels for the live tile short.

Supported Versions

The relevant API version for the Learning Platform and the Learning Environment must be specified in the product integration configuration page and in the OAuth integration profile. These versions are used during the API calls. See the Brightspace Developer Platform for the versions that D2L Brightspace supports.

Prerequisites

The following prerequisites are required to configure the D2L Brightspace product integration:

For the prerequisites that must be completed in D2L Brightspace, see Setting up OAuth 2.0 authentication.

• Format the redirect URI as follows: {{your_campusM_app_hostname}}/cmauth/oauth/callback, for example:
  https://my-app.name.com/cmauth/oauth/callback.
  • This URL is not meant to be accessible. It is used by our cloud platform to complete the OAuth authentication flow.
  • The required scope is: core:*:*
  • It is advised that you register all of your campusM apps (typically Dev and Prod)
• An integration profile for D2L Brightspace must be configured for the product integration. See OAuth Integration Profile Configuration. For additional details on how to configure an OAuth Integration Profile, see OAuth2.
• Verify with Ex Libris that D2L is included as an app added to the allow list (apps.brightspace). This is necessary for deep linking on mobile devices.

OAuth Integration Profile Configuration

You add and edit integration profiles from App Settings > Integration Profile > Add Integration Profile. 

The following table describes the configuration options available on this page. All values are exactly as-is unless listed otherwise.

Product Integration Configuration

Once the Integration Profile is set up, you can configure the D2L Brightspace product integration, by selecting Product Integrations > Add Product Integration > LMS/VLE > D2L Brightspace. The following table describes the configuration options available on this page.