Brightspace Data Sets for Role Details

Brightspace Data Sets for Role Details includes:

This data set does not depend on specific tools being turned on.

Entity Relationship Diagram

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

Entity relationship diagram for Role Details Brightspace data set

 

Brightspace Data Set: Role Details

About

Returns a full set of attributes for each role in your organization.

Data Set Availability

This data set is available as:

  • Full CSV, produced on a weekly 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.1 RoleId Unique role identifier.

Integer

4

PK
3.1 OrgId Unique org unit identifier.

Integer

4

FK
3.1 RoleName Name of the role. nvarchar 60  
3.1 Description Description of the role. nvarchar 200  
3.1 IsCascading Attribute indicating that the role cascades from other roles.

Boolean

1

 
3.1 InClassList Attribute indicating that users with this role appear in class lists.

Boolean

1

 
3.1 ClassListRoleName Attribute indicating the role name for users that appear in class lists. nvarchar 60  
3.1 ClassListShowGroups Attribute indicating that members of this role can see groups consisting of learners in the class list.

Boolean

1

 
3.1 ClassListShowSections Attribute indicating that members of this role can see sections consisting of learners in the class list.

Boolean

1

 
3.1 ClassListDisplayRole Attribute indicating that members of this role appear in the class list with the role displayed.

Boolean

1

 
3.1 AccessInactiveCO Attribute indicating that the role can access inactive course offerings.

Boolean

1

 
3.1 HasSpecialAccess Attribute indicating that the role has special access to courses.

Boolean

1

 
3.1 AddToCourseOfferingGroup Attribute indicating that the role appears in the course offering group.

Boolean

1

 
3.1 CanBeAutoEnrolledIntoGroups Attribute indicating that the role can be automatically enrolled into groups in a class.

Boolean

1

 
3.1 AddToCourseOfferingSections Attribute indicating that users with this role can be added to course offering sections.

Boolean

1

 
3.1 CanBeAutoEnrolledIntoSections Attribute indicating that users with this role can be automatically enrolled into course sections.

Boolean

1

 
3.1 ClassListDisplayRoleCategory Attributing that this role category appears in class lists.

Boolean

1

 
3.1 ClassListRoleCategory Attribute indicating this is a role that can be used to sort members of a class list. nvarchar 50  
3.1 ClassListRoleCategoryOrder Attribute indicating the order in which the role categories should appear in the class list.

Integer

4

 
3.1 AccessPastCourses Attribute indicating that this role can access past courses.

Boolean

1

 
3.1 AccessFutureCourses Attribute indicating that this role can access courses that have not yet started.

Boolean

1

 
3.1 SortOrder Indicates the sort order for users with this role.

Integer

4

 
3.1 ShowInContent Indicates that this role should appear in Content.

Boolean

1

 
3.1 ShowInDiscussionAssess Indicates that this role should appear in Discussions assessments.

Boolean

1

 
3.1 ShowInDiscussionStats Indicates that this role should appear in Discussions statistics.

Boolean

1

 
3.1 ShowInGrades Indicates that this role should appear in Grades.

Boolean

1

 
3.1 ShowInAttendance Indicates that this role should appear in Attendance.

Boolean

1

 
3.1 AllowSelfEnrollInGroups Indicates that this role should have permission to self-enroll in groups.

Boolean

1

 
3.1 ShowInRegistration Indicates that this role should appear in registration information for a course.

Boolean

1

 
3.1 ShowInUserProgress Indicates that this role should appear in User Progress.

Boolean

1

 
3.1 RoleAlias Indicates the alias for this alias. nvarchar 60  

3.1

4.7 / 5.1 - Updated column name

Version Indicates the version for this row entry. Timestamp 8  
3.9/4.4 RoleCode Code assigned to each role for mapping to other systems or organizations. Field can be null. nvarchar 100