Brightspace Data Sets for Intelligent Agents have a dependency on Intelligent Agents. 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
The following diagram shows the relationships between entities used to create Brightspace Data Sets for Intelligent Agents. To enlarge the diagram, right-click on the image and select Open image in a new tab.
Intelligent Agent Objects
The Intelligent Agent Objects Brightspace Data Set describes all the intelligent agents created in your organization.
Returned Fields
Version History
|
Field
|
Description
|
Type
|
Column Size
|
Key
|
|---|
| 4.10 / 5.4 |
AgentId
|
Unique agent identifier.
|
bigint
|
8
|
PK
|
| 4.10 / 5.4 |
OrgUnitId
|
Unique org unit identifier where the agent was created.
|
int
|
4
|
FK
|
| 5.7 / 6.0 - Changed Column Size |
AgentName
|
Name of intelligent agent.
|
nvarchar
|
128
|
|
| 4.10 / 5.4 |
Description |
The description of the intelligent agent.
Field can be null.
|
nvarchar |
1000 |
|
| 4.10 / 5.4 |
Enabled |
Indicates if the agent is enabled. |
bit |
1 |
|
| 5.7 / 6.0 - Updated Description |
SpecificRoles
|
Array of the roles the agent allies to. If null, it applies to all users visible in the Classlist.
Field can be null.
|
nvarchar
|
1000
|
|
| 4.10 / 5.4 |
LoginConditionEnabled
|
Indicates if the agent looks at login activity.
|
bit
|
1
|
|
|
4.10 / 5.4
|
LoginConditionThreshold
|
Number of days the login threshold is set to.
Field can be null.
|
int
|
4
|
|
| 4.10 / 5.4 |
LoginConditionType
|
The type of login activity: User has not logged in for at least X days or user has logged in during the past X days.
Field can be null.
|
nvarchar
|
14
|
|
| 4.10 / 5.4 |
AccessConditionEnabled
|
Indicates if the agent looks at course access activity.
|
bit
|
1
|
|
|
4.10 / 5.4
|
AccessConditionThreshold |
Number of days the course activity threshold is set to.
Field can be null.
|
int |
4 |
|
| 4.10 / 5.4 |
AccessConditionType |
The type of course activity: User has not accessed course in for at least X days or user has accessed course in during the past X days.
Field can be null.
|
nvarchar |
20 |
|
| 5.7 / 6.0 - Changed Type and Column Size |
ResultId |
Unique release condition result identifier.
Field can be null.
|
bigint |
8 |
FK |
| 4.10 / 5.4 |
RepeatType |
Indicates whether the action is taken once or every time the criteria is met for a user. |
nvarchar |
10 |
|
| 4.10 / 5.4 |
EmailWhenSatisfied |
Indicates if an email is sent when the criteria are satisfied. |
bit |
1 |
|
| 4.10 / 5.4 |
EnableSchedule |
Indicates if a schedule is used. |
bit |
1 |
|
| 4.10 / 5.4 |
ScheduleType |
Defines the frequency the schedule runs on: daily, weekly, monthly, annually.
Field can be null.
|
nvarchar |
8 |
|
| 4.10 / 5.4 |
ScheduleRepeatsEvery |
The number of days, weeks, etc between runs.
Field can be null.
|
int |
4 |
|
| 4.10 / 5.4 |
StartDate |
When the schedule begins (UTC).
Field can be null.
|
datetime2 |
8 |
|
| 4.10 / 5.4 |
EndDate
|
When the schedule ends (UTC).
Field can be null.
|
datetime2
|
8 |
|
| 4.10 / 5.4 |
LastModified |
The date when the agent was last modified (UTC).
Field can be null.
|
datetime2 |
8 |
|
| 6.16 / 7.4 - Updated description |
LastModifiedBy |
The unique user identifier of the user who last changed the agent.
Field can be null.
|
int |
4 |
FK |
| 4.10 / 5.4 |
IsDeleted |
Indicates if the agent is deleted. |
bit |
1 |
|
Intelligent Agent Run Log
The Intelligent Agent Run Log Brightspace Data Set lists all the times, including practice runs, each intelligent agent has run in your organization.
This data set captures data from November 2020 onwards.
Returned Fields
Version History
|
Field
|
Description
|
Type
|
Column Size
|
Key
|
|---|
| 4.10 / 5.4 |
AgentId
|
Unique intelligent agent identifier.
|
bigint
|
8
|
FK
|
| 4.10 / 5.4 |
AgentRunId
|
Unique intelligent agent run identifier.
|
bigint
|
8
|
PK
|
| 4.10 / 5.4 |
IsPracticeRun
|
Indicates if it is a practice run.
|
bit
|
1
|
|
| 4.10 / 5.4 |
IsRunNow |
Indicates if it was an unscheduled run. |
bit |
1 |
|
| 4.10 / 5.4 |
NumUsers |
Count of the number of users affected by this run. |
int |
4 |
|
| 4.10 / 5.4 |
NumUsersWithErrors
|
The number of users where the action produced errors.
|
int
|
4
|
|
| 4.10 / 5.4 |
NumUsersWithInfos
|
The number of users where the action produced informational messages.
|
int
|
4
|
|
|
4.10 / 5.4
|
NumUsersWithWarnings
|
The number of users where the action produced warning messages.
|
int
|
4
|
|
| 5.7 / 6.0 - Changed Key |
RunUserId
|
Unique identifier of the user who ran the agent. 0 for system.
|
int
|
4
|
FK
|
| 4.10 / 5.4 |
RunDate
|
The date the run occurred (UTC).
|
datetime2
|
8
|
|
Intelligent Agent Run Users
The Intelligent Agent Run Users Brightspace Data Set lists the users that each intelligent agent run affected and the resulting action. It does not include users that don't meet agent criteria or are part of a practice run.
Returned Fields
Version History
|
Field
|
Description
|
Type
|
Column Size
|
Key
|
|---|
| 4.10 / 5.4 |
AgentId
|
Unique intelligent agent identifier.
|
bigint
|
8
|
PK, FK
|
| 4.10 / 5.4 |
AgentRunId
|
Unique intelligent agent run identifier.
|
bigint
|
8
|
PK, FK
|
| 4.10 / 5.4 |
UserId
|
Unique user identifier.
|
int
|
4
|
PK, FK
|
| 4.10 / 5.4 |
OrgUnitId |
Unique org unit identifier where the agent was run.
|
int |
4 |
FK |
| 4.10 / 5.4 |
ActionTypeName |
The type of action that was taken.
Field can be null.
|
nvarchar |
50 |
|
| 4.10 / 5.4 |
ActionHasError
|
Indicates if the intelligent agent run has errors.
|
bit
|
1
|
|
| 4.10 / 5.4 |
ActionHasInfo
|
Indicates if the intelligent agent run has info messages.
|
bit
|
1
|
|
|
4.10 / 5.4
|
ActionHasWarning
|
Indicates if the intelligent agent run has warnings.
|
bit
|
1
|
|
| 4.10 / 5.4 |
ShouldRetry
|
Indicates if the run should be retried.
|
bit
|
1
|
|