Content Service

Description

The Content Service houses Brightspace content, and currently provides and standardizes functions such as import/export, storage, preview, permissions, and basic search of SCORM objects in the Brightspace platform. It makes use of a new SCORM Engine to play back SCORM objects in a new window.

Connections from the Content Service to Brightspace Learning Environment are made through Brightspace APIs.

Location

One instance per region in AWS automatically deployed to a specific region based on an organization’s geographic location:

  • U.S. East (N. Virginia) (default location)
  • EU (Ireland)

  • Asia Pacific (Sydney)

  • Canada Central (Montreal)

Administrators first set the d2l.Tools.ContentService.Endpoint configuration variable to on, and then a call from the Brightspace platform is routed to the appropriate region based on its location. The endpoint URL is automatically set based on location.

Note: If administrators had already enabled the configuration variable and set the endpoint URL in a release prior to Brightspace Learning Environment 10.7.4, the region does not change automatically based on location. Administrators must manually change the URL if they want a different region than the one they initially set.

Important: Once the AWS region is specified and your users start to add SCORM content to their courses, you cannot change the region without loss of data. However, if you change the endpoint and then revert to the one you had data stored in previously, it is possible to reclaim that data.

  • If you are located in The United States, Central America, or South America, the US region is set (https://api.us-east-1.content-service.brightspace.com).

  • If you are located in Canada, the Canada region is set (https://api.ca-central-1.content-service.brightspace.com/).

  • If you are located in Europe, Africa, or the Middle East, the Ireland region is set (https://api.eu-west-1.content-service.brightspace.com).

  • If you are located in Australia, New Zealand, Oceania, China, India, or the rest of Asia (excluding Singapore), the Australia region is set (https://api.ap-southeast-2.content-service.brightspace.com)

Dependencies

  • Depends on the Authentication Service, Landlord Service, Brightspace Event Flow Service, and LTI Outcomes.
  • Depended on by the new Brightspace SCORM solution.

Data Transmitted/Stored

The following data is transmitted through/stored in the Content Service, the SCORM Engine, or S3:

  • Data related to upload sessions.
  • Data related to the conversion process of content objects.
  • Data related to user sessions, which can include:
    • User ID.
    • First and last name.
    • Where in Brightspace Learning Environment the user launched from.
    • LTI roles.
    • User roles in the LMS.
  • Data related to the content object, which can include:
    • Where it is stored on S3.
    • Revisions of the content object.
    • Who owns the content.
    • Metadata such as title or type.
    • Where the content object is put in the LMS.
  • Report information on SCORM progress, attempts, score, user ID, and first and last name.
  • SCORM Engine stores reporting data, progress in the SCORM package, and user ID.
  • S3 stores data on the SCORM packages uploaded.

How the Service Works

Embedding a SCORM package into the Content tool:

  1. When a user clicks the option to add a SCORM package, an LTI (ContentItemSelectionRequest) launch is made to the Content Service.
  2. The user selects a SCORM package (zip file) from their system. API calls are made to the Content Service to register the new object and sign requests to upload the package to S3.
  3. After the SCORM package is uploaded to S3, processing occurs to unzip the package, re-upload the unzipped package to S3, and import it into the SCORM Engine.
  4. When the processing of the package is complete, the user is notified that they can insert the content topic.
  5. When the user inserts the content topic, a request is made from the Content Service to Brightspace Learning Environment that assigns a URL to the uploaded object, which is then embedded into the content topic.

Playing or interacting with a SCORM package in the Content tool:

  1. When a user clicks on a content topic that includes a SCORM package, a button is displayed indicating that they can open the object in a new window. The user clicks the button and a new window is opened, which performs an LTI (basic-lti-launch-request) launch to the Content Service.
  2. The Content Service checks the user’s IMS role from the LTI launch to determine whether the user is an instructor or learner.
  3. The Content Service makes API calls to the SCORM Engine to register the launch and request a signed preview or launch URL. The preview URL is requested if the user is an instructor and the launch URL is requested if the user is a learner.
  4. The Content Service redirects to the SCORM Engine preview or launch URL and the SCORM package displays to the user.
  5. As the user interacts with the SCORM package, progress updates are sent to the SCORM Engine, which are then forwarded to the Content Service for its own reporting.