Intelligent Agents

Intelligent agents monitor your course to find activity that matches criteria that you set. The criteria that the agents search for are:

  • Student login activity

  • Release conditions in the Learning Environment

You can use existing release conditions, or create new ones for your agents. The agent will send you an email when it finds users matching its criteria.

You can run agents manually or set them to run on a schedule; daily, weekly, monthly, or annually.

When you run an agent manually, it will send you a confirmation email that lists the following information:

  • org unit code and name

  • which agent ran

  • whether the agent took action

  • any error text

Example uses for intelligent agents include:

  • Email for users with grades below a certain level

  • Check for users that have not logged in within a specific number of days

  • Check for users that view a specific content topic

Creating, Running, Editing, and Deleting Intelligent Agents

You can create, edit, and delete intelligent agents from the Agent List page.

Create an Intelligent Agent

  1. Select Course Admin from the course navbar.

  2. Select Intelligent Agents.

  3. Click the New button.

  4. Enter a name for the agent and include a description (optional).

  5. Under Status, check the Agent is enabled box if you want the agent enabled once you save it.

  6. Under Criteria, determine the criteria the agent will look for:

    • If you want the agent to search for login activity, select the Take action when the following login criteria are satisfied check box and choose which of the two login activities you want to monitor,

    • If you want the agent to search for course activity, select the Take action when the following course activity criteria are satisfied check box and choose which of the two course activities you want to monitor.

  7. Click the Attach Existing, or Create and Attach button to add or create release conditions for the agent to monitor (see Release Conditions for more information).

  8. Under Action you can determine the action the agent takes when its conditions are met:

    • Select one of the Action Repetition radio buttons to set whether the agent takes action once or anytime the conditions are met.

    • If you would like students who meet the criteria to receive an email, select Send an email when the criteria are satisfied.

      • See Replace Strings for detailed information about what to enter in the To/Cc/Bcc field., Subject field, and Message field.

  9. If you want the agent to run on a schedule, under Scheduling, select the Use Schedule check box, then click the Update Schedule button.

    • Select when and how often and for how long you would like the agent to run and click Update.

  10. Click Save and Close or Save.

Replace Strings

Replace strings allow you to customize course content and communications in LEARN by incorporating student’s personalized information, such as their name, automatically.

Email Address Replace Strings

You can use the following replace strings in the address fields for the agent emails.

Replace String

Description

Replace String

Description

{InitiatingUser}

The user who performed the action that met the agent's criteria.

Email Body and Subject Replace Strings

You can use the following replace strings in the HTML editor for the agent email body.

Replace String

Description

Replace String

Description

{OrgName}

The name of the organization.

{OrgUnitCode}

The code for the Org Unit.

{OrgUnitName}

The name of the Org Unit.

{OrgUnitStartDate}

The start date specified for the Org Unit.

{OrgUnitEndDate}

The end date specified for the Org Unit.

{InitiatingUserFirstName}

The first name of the initiating user.

{InitiatingUserLastName}

The last name of the initiating user.

{InitiatingUserUserName}

The username of the initiating user.

{InitiatingUserOrgDefinedId}

The Org Defined ID of the initiating user.

Practice Run of an Agent

You can run a Practice Run of an agent to verify your selection criteria without sending the selected users an email.

  1. Select Course Admin from the course navbar.

  2. Select Intelligent Agents.

    Course Admin page with Intelligent Agents highlighted
  3. Click the down arrow next to an agent's name on the Agent List page.

  4. Select Practice Run.

  5. Click Run on the Confirmation Screen, and then click Done.

  6. On the Agent List Screen, you will see the results of the Practice Run in the “Results of Last Run” column. Click on the # users identified link to see the list of identified users.

Screenshot highlighting the number of users identified link

Running an Agent Manually

Typically, intelligent agents are set up to run automatically. If you do not have a regular schedule set up for an agent, you must run it manually.

  1. Select Course Admin from the course navbar.

  2. Select Intelligent Agents.

  3. Click the down arrow next to an agent's name on the Agent List page.

  4. Select Run Now to run it manually.

Enabling and Disabling an Agent

  1. Select Course Admin from the course navbar.

  2. Select Intelligent Agents.

  3. Select the agents that you want to enable or disable by checking the box to the left of the Agent Name.

  4. Click the Enable or Disable button.

Editing an Agent

  1. Select Course Admin from the course navbar.

  2. Select Intelligent Agents.

  3. Click the name of the agent you want to edit on the Agent list page.

  4. Make your revisions.

  5. Click Save or Save and Close.

Deleting an Agent

  1. Select Course Admin from the course navbar.

  2. Select Intelligent Agents.

  3. Select the agents that you want to enable or disable by checking the box to the left of the Agent Name.

  4. Select Delete.

  5. Click Delete again to confirm the deletion.

Need help?

Contact LEARNhelp at learnhelp@uwaterloo.ca or 519-888-4567 ext. 41744 for assistance.

Article Feedback

If you’d like to share any feedback about this article, contact LEARNhelp at learnhelp@uwaterloo.ca.