Brightspace Data Sets for Role Details do not depend on specific tools being turned on.
Entity Relationship Diagram
The following diagram shows the relationships between entities used to create Brightspace Data Sets for Role Details. To enlarge the diagram, right-click on the image and select Open image in a new tab.
Important: This diagram is in alignment with BDS Major Version 9, which includes disruptive changes to existing data sets. For details, refer to Motivations behind the changes in Data Hub Brightspace Data Set (BDS) Major Version 9 on Brightspace Community.
Role Details
The Role Details Brightspace Data Set returns a full set of attributes for each role in your organization.
Version History |
Field |
Description |
Type |
Size |
Key |
---|---|---|---|---|---|
3.1 | RoleId |
Unique role identifier. |
int |
4 |
PK |
9.0 - REMOVED COLUMN | OrgId |
Unique org unit identifier. Field can be null. |
int |
4 |
FK |
9.0 - Updated size | RoleName | Name of the role. | nvarchar | 120 | |
9.0 - Updated size | Description |
Description of the role. Field can be null. |
nvarchar | 400 | |
3.1 | IsCascading | Attribute indicating that the role cascades from other roles. |
bit |
1 |
|
3.1 | InClassList | Attribute indicating that users with this role appear in class lists. |
bit |
1 |
|
9.0 - Updated size | ClassListRoleName |
Attribute indicating the role name for users that appear in class lists. Field can be null. |
nvarchar | 120 | |
3.1 | ClassListShowGroups | Attribute indicating that members of this role can see groups consisting of learners in the class list. |
bit |
1 |
|
3.1 | ClassListShowSections | Attribute indicating that members of this role can see sections consisting of learners in the class list. |
bit |
1 |
|
3.1 | ClassListDisplayRole | Attribute indicating that members of this role appear in the class list with the role displayed. |
bit |
1 |
|
3.1 | AccessInactiveCO | Attribute indicating that the role can access inactive course offerings. |
bit |
1 |
|
3.1 | HasSpecialAccess | Attribute indicating that the role has special access to courses. |
bit |
1 |
|
5.7 / 6.0 - Field | AddToCourseOfferingGroups |
Attribute indicating that the role appears in the course offering group. |
bit |
1 |
|
3.1 | CanBeAutoEnrolledIntoGroups | Attribute indicating that the role can be automatically enrolled into groups in a class. |
bit |
1 |
|
3.1 | AddToCourseOfferingSections | Attribute indicating that users with this role can be added to course offering sections. |
bit |
1 |
|
3.1 | CanBeAutoEnrolledIntoSections | Attribute indicating that users with this role can be automatically enrolled into course sections. |
bit |
1 |
|
9.0 - REMOVED COLUMN | ClassListDisplayRoleCategory | Attributing that this role category appears in class lists. |
bit |
1 |
|
9.0 - REMOVED COLUMN | ClassListRoleCategory | Attribute indicating this is a role that can be used to sort members of a class list. | nvarchar | 50 | |
9.0 - REMOVED COLUMN | ClassListRoleCategoryOrder |
Attribute indicating the order in which the role categories should appear in the class list. |
int |
4 |
|
3.1 | AccessPastCourses | Attribute indicating that this role can access past courses. |
bit |
1 |
|
3.1 | AccessFutureCourses | Attribute indicating that this role can access courses that have not yet started. |
bit |
1 |
|
3.1 | SortOrder | Indicates the sort order for users with this role. |
int |
4 |
|
3.1 | ShowInContent | Indicates that this role should appear in Content. |
bit |
1 |
|
3.1 | ShowInDiscussionAssess | Indicates that this role should appear in Discussions assessments. |
bit |
1 |
|
3.1 | ShowInDiscussionStats | Indicates that this role should appear in Discussions statistics. |
bit |
1 |
|
3.1 | ShowInGrades | Indicates that this role should appear in Grades. |
bit |
1 |
|
3.1 | ShowInAttendance | Indicates that this role should appear in Attendance. |
bit |
1 |
|
3.1 | AllowSelfEnrollInGroups | Indicates that this role should have permission to self-enroll in groups. |
bit |
1 |
|
3.1 | ShowInRegistration | Indicates that this role should appear in registration information for a course. |
bit |
1 |
|
3.1 | ShowInUserProgress | Indicates that this role should appear in User Progress. |
bit |
1 |
|
9.0 - Updated size | RoleAlias |
Indicates the alias for this role. Field can be null. |
nvarchar | 120 | |
9.0 - REMOVED COLUMN |
Version | Indicates the version for this row entry. | bigint | 8 | |
9.0 - Updated size | RoleCode |
Code assigned to each role for mapping to other systems or organizations. Field can be null. |
nvarchar | 100 | |
9.0 | LastModifiedDate |
Date and time when the role was last modified (UTC). Field can be null. |
datetime2 | 8 | |
9.0 | DeletedBy |
User identifier of the user that deleted the role. Field can be null. |
int | 4 | FK |