Brightspace Data Sets for Intelligent Agents

Brightspace Data Sets for Intelligent Agents include:

This data set has 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

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

Entity Relationship Diagram for Intelligent Agents_

 

Brightspace Data Set: Intelligent Agent Runs

About

Returns all the intelligent agents and how they have been used across the 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.6 / 4.1

OrgUnitId

Unique org unit identifier where the agent was run.

Integer

4

PK

3.6 / 4.1 UserId Unique user identifier. Integer 4 PK, FK
3.6 / 4.1

AgentId

Unique agent identifier.

BigInteger

8

PK

3.6 / 4.1

AgentName

Name of intelligent agent.

nvarchar

300

 

3.6 / 4.1

Changed Type to DateTime

EndDate

Date the intelligent agent run ended.

DateTime

 

 

3.6 / 4.1

IsPracticeRun

Indicates whether this run was triggered for practice.

Boolean

1

 

3.6 / 4.1

IsRunNow

Indicates whether this run was triggered on demand.

Boolean

1

 

3.6 / 4.1

Changed Key to FK

ActionType Type of action. Field can be null. varchar   FK
3.6 / 4.1 ActionHasError Indicates where the run had an error. Field can be null. Boolean 1  
3.6 / 4.1 EnrollmentType Type of enrollment if the run creates enrollment(s). Field can be null. nvarchar    
3.6 / 4.1 NewRoleId Unique role ID. Field can be null. Integer 4 FK
3.6 / 4.1 EnrollmentOrgUnitId Unique enrollment Org Unit ID. Field can be null. Integer 4 FK
3.6 / 4.1 AgentRunId Unique Agent run identifier. BigInteger 8 PK

 

Brightspace Data Set: Intelligent Agent Objects

About

Describes all the intelligent agents created 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

4.10 / 5.4

AgentId

Unique agent identifier.

BigInteger

8

PK

4.10 / 5.4

OrgUnitId

Unique org unit identifier where the agent was created.

Integer

4

FK

4.10 / 5.4

AgentName

Name of intelligent agent.

nvarchar

300

 

4.10 / 5.4 Description The description of the intelligent agent. Can be null. nvarchar Truncated to 1000 characters.  
4.10 / 5.4 Enabled Indicates if the agent is enabled. Boolean 1  
4.10 / 5.4

SpecificRoles

Array of the roles the agent allies to. If null, it applies to all users visible in the Classlist.

nvarchar

1000

 

4.10 / 5.4

LoginConditionEnabled

Indicates if the agent looks at login activity.

Boolean

1

 

4.10 / 5.4

LoginConditionThreshold

Number of days the login threshold is set to. Can be null.

Integer

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. Can be null.

nvarchar

14

 

4.10 / 5.4

AccessConditionEnabled

Indicates if the agent looks at course access activity.

Boolean

1

 

4.10 / 5.4

AccessConditionThreshold Number of days the course activity threshold is set to. Can be null. Integer 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. Can be null. nvarchar 20  
4.10 / 5.4 ResultId Unique release condition result identifier. Integer 4 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. Boolean 1  
4.10 / 5.4 EnableSchedule Indicates if a schedule is used. Boolean 1  
4.10 / 5.4 ScheduleType Defines the frequency the schedule runs on: daily, weekly, monthly, annually. Can be null. nvarchar 8  
4.10 / 5.4 ScheduleRepeatsEvery The number of days, weeks, etc between runs. Can be null. Integer 4  
4.10 / 5.4 StartDate When the schedule begins (UTC). Can be null. DateTime 8  
4.10 / 5.4

EndDate

When the schedule ends (UTC). Can be null.

DateTime

8  
4.10 / 5.4 LastModified The date when the agent was last modified (UTC). DateTime 8  
4.10 / 5.4 LastModifiedBy The unique user identifier of the user who last changed the agent. Integer 4 FK
4.10 / 5.4 IsDeleted Indicates if the agent is deleted. Boolean 1  

 

Brightspace Data Set: Intelligent Agent Run Log

About

Lists all the times, including practice runs, each intelligent agent has run 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

4.10 / 5.4

AgentId

Unique intelligent agent identifier.

BigInteger

8

FK

4.10 / 5.4

AgentRunId

Unique run identifier.

BigInteger

8

PK

4.10 / 5.4

IsPracticeRun

Indicates if the run is a practice run and no real actions will be taken.

Boolean

1

 

4.10 / 5.4 IsRunNow Indicates if the run (real not practice) was kicked off by a user opposed to a schedule. Boolean 1  
4.10 / 5.4 NumUsers The number of users assessed by the agent. Integer 4  
4.10 / 5.4

NumUsersWithErrors

The number of users with errors.

Integer

4

 

4.10 / 5.4

NumUsersWithInfos

The number of users with information.

Integer

4

 

4.10 / 5.4

NumUsersWithWarnings

The number of users with warnings.

Integer

4

 

4.10 / 5.4

RunUserId

Unique identifier of the user who ran the agent. 0 for system.

Integer

4

 

4.10 / 5.4

RunDate

The date the run occurred (UTC).

DateTime

8

 

 

Brightspace Data Set: Intelligent Agent Run Users

About

Lists the users that each intelligent agent run affected and the resulting action. Does not include users that don't meet agent criteria or are part of a practice run.

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

4.10 / 5.4

AgentId

Unique intelligent agent identifier.

BigInteger

8

PK, FK

4.10 / 5.4

AgentRunId

Unique run identifier.

BigInteger

8

PK, FK

4.10 / 5.4

UserId

Unique user identifier.

Integer

4

PK, FK

4.10 / 5.4 OrgUnitId

Unique org unit identifier where the agent was run.

Integer 4 FK
4.10 / 5.4 ActionTypeName The type of action that was taken. Can be null nvarchar 50  
4.10 / 5.4

ActionHasError

Indicates if there was an error taking the action.

Boolean

1

 

4.10 / 5.4

ActionHasInfo

Indications if there is information about the action.

Boolean

1

 

4.10 / 5.4

ActionHasWarning

Indicates if the action has a warning.

Boolean

1

 

4.10 / 5.4

ShouldRetry

Indicates if the run should be retried.

Boolean

1