Brightspace Data Sets for LTI

Brightspace Data Sets for LTI include:

This data set has a dependency on External Learning Tools. If you turn this tool on and off during the data set query period, there may be unexpected or missing content in your data sets.

Entity Relationship Diagram

To show the relationships between entities used to create Brightspace Data Sets for LTI, click the following thumbnail image:

Entity Relationship Diagram for LTI

Brightspace Data Set: LTI Links

About

Retrieves the list of LTI links that exist in the organization. Does not include deleted links.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a daily basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

3.6 / 4.1

LtiLinkId

Unique identifier for the LTI link.

bigint

8

PK

4.7 / 5.1 - Updated description

OrgUnitId

Identifier for the Org Unit where the link was created.

int

4

FK

5.7 / 6.0 - Changed Column Size

Title

The title of the link.

nvarchar

200

 

3.6 / 4.1

LinkType

The type of link, either being a basic LTI launch or a CIM/Deep Linking launch to retrieve content from a tool. (0 = Basic LTI Launch, 1 = Content Item Message or Deeplinking).

int

4

 

5.7 / 6.0 - Changed Column Size

LTIVersion

Indicates whether the link is Legacy or LTI Advantage.

varchar

12

 

5.7 / 6.0 - Changed Column Size

Url

The URL used during the launch.

Field can be null.

nvarchar

1000

 

3.6 / 4.1 Description

Description of the LTI link.

Field can be null.

nvarchar 1000  
3.6 / 4.1 IsVisible Determines if the link is displayed when adding to course content in the course. For Legacy LTI, this is called IsVisible in the UI. bit 1  
3.6 / 4.1 SendTCInfo If true, determines if the tool_consumer variables are allowed to be included in the LTI launch. Legacy LTI only. bit 1  
3.6 / 4.1 SendContextInfo If true, determines if context_id, context_title, context_label, and context_type variables are included in the LTI launch. Legacy LTI only. bit 1  
3.6 / 4.1 SendCourseInfo If true, determines if LISSourcedId is included in the launch. Legacy LTI only. bit 1  
3.6 / 4.1 SendOrgUnitInfo

If true, determines if Org Unit Id, Course Name, Course Code, Org Unit Type, LIS Course Offering Sourcedid, and LIS Course Section Sourcedid are included in the LTI launch. LTIAdvantage only.

Field can be null.

bit 1  
3.6 / 4.1 SendUserId If true, determines a unique identifier for the user, generated on the user's first launch. Legacy LTI only. This is always sent to LTIAdvantage and cannot be turned off unless Anonymous launch is used. bit 1  
3.6 / 4.1 SendUserName If true, determines if users first, last, and given name (first last) are sent during launch. bit 1  
3.6 / 4.1 SendUserEmail If true, determines if the user's primary email is sent during launch. bit 1  
3.6 / 4.1 SendLinkTitle If true, determines if the LTI Link Title is sent during launch. Legacy LTI only. bit 1  
3.6 / 4.1 SendLinkDescription If true, determines if the LTI Link Description is sent during launch. Legacy LTI only. bit 1  
3.6 / 4.1 SendD2LUserName If true, determines if the Brightspace username is sent during launch. bit 1  
3.6 / 4.1 SendD2LOrgDefinedId If true, determines if the Brightspace OrgDefinedId is sent during launch. bit 1  
3.6 / 4.1 SendD2LOrgRoleId If true, determines if the custom Brightspace D2L role is sent during launch. Legacy LTI only. bit 1  
3.6 / 4.1 SendBrightspaceUserId

If true, determines if the D2L User Id is sent during the launch. LTIAdvantage only.

Field can be null.

bit 1  
3.6 / 4.1 Anonymous

If true, no user information is sent during the launch. LTIAdvantage only.

Field can be null.

bit 1  
3.6 / 4.1 Shared

Indicates whether the link is shared with additional org units or not.

Field can be null.

bit 1  
3.6 / 4.1 UseToolProviderSecuritySettings If true, uses the Tool Provider security settings versus link security settings based on domain matching. Legacy LTI only. bit 1  
3.6 / 4.1 LastModifiedDate

The last time a link was updated.

Field can be null.

datetime2 8  
4.7 / 5.1 OuAvailabilitySetId

Unique sharing identifier. Can be used to join on LTI Links Shared.

Field can be null.

bigint 8  

Brightspace Data Set: LTI Links Shared

About

Lists the parent Org Unit(s) that a link is shared with and can be used within the organization. LTI Links can be shared explicitly with an org unit or be shared with an org unit’s descendants, which is called inherited sharing. When an LTI 1.1 link is shared, users have the option to share with descendants of a specific type such as course offering.

Note: You can be assured of unique rows within the data set by using the following four fields: OuAvailabilitySetId, OrgUnitId, SharingType, and DescendantTypeId. These may be considered a composite unique identifier for the data set.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a daily basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Returned Fields

Version History

Field

Description

Type

Column Size

Key

5.7 / 6.0 - Changed Key

OuAvailabilitySetId

Unique sharing identifier. Can be used to join on LTI Links.

bigint

8

PK, FK

4.7 / 5.1

OrgUnitId

Identifier for the Org Unit where the sharing occurred.

int

4

PK, FK

4.7 / 5.1

SharingType

Explicit or inherited sharing.

varchar

9

PK

4.7 / 5.1 DescendantTypeId

Identifier of the descendant org unit type.

Field can be null.

int 4 PK, FK
4.7 / 5.1 LastModified

The last time a link was updated.

Field can be null.

datetime2 8  

Brightspace Data Set: LTI Launches

About

The LTI Launches data set logs details of each time a user launches an LTI link in the organization since the last differential was generated.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a daily basis, containing all of the data.
  • Differential CSV, produced on a daily basis or hourly basis as a paid add-on, containing the differences (diffs) of the data that was updated or inserted since the last successful differential which is typically the previous day or hour, respectively.

Required Permission

External Learning Tools > Download LTI Launch Data Set (Organization level)

Returned Fields

Version History

Field

Description

Type

Column Size

Key

5.5

LTILaunchId

Unique identifier for each individual launch.

uniqueidentifier

16

PK

5.5

UserId 

The user who performed this launch.

int

4  
5.5 IMSRoleNames A list of user's IMS roles. nvarchar 10000  
5.5 ImpersonatingUserId 

The impersonating user who performed this launch.

Field can be null.

bigint 8  
5.5 ImpersonatingUserIMSRoleName

A list of impersonating user's IMS roles.

Field can be null.

nvarchar 10000  
5.5 LaunchDate  The UTC time when this launch occurred. datetime2 8  
5.5 OrgUnitId Id of the org unit where this launch happened. bigint 8  
5.7 / 6.0 - Changed Key LTILinkId The id of the link that was used for the LTI launch. bigint 8 FK
5.5 DeploymentId

The unique identifier of the link's deployment that was used for the LTI launch. This is only available for 1.3 links.

Field can be null.

uniqueidentifier 16  
5.5 ClientId

The unique identifier of the link's registration that was used for the LTI launch. This is only available for 1.3 links.

Field can be null.

uniqueidentifier 16  
5.5 ToolProviderId

The id of the link's tool provider that was used for the LTI launch. This is only available for 1.1 links.

Field can be null.

nvarchar 300  
5.5 ContentTopicId 

Id of the content topic where this launch happened.

Field can be null.

bigint 8  
5.5 ParentModuleId 

Id of the parent module where this launch happened.

Field can be null.

bigint 8  
5.5 Placement

Placement type of this launch.

Field can be null.

nvarchar 10  
5.5 MessageVersion 

LTI message version of this launch.

Field can be null.

nvarchar 10  
5.5 RequestType

LTI request type of this launch.

Field can be null.

nvarchar 30