Setting Up Intelligent Agents

Adding an Intelligent Agent

Log in to Brightspace with your MyCarletonOne credentials. On the Brightspace homepage, locate your course in one of the following ways: Click on the course tile under the My Courses widget. Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar. In the navbar, click Tools.              In the drop-down menu, select Intelligent Agents.  Under Agent List, click New Agent.                                                                          Give the new agent an Agent Name (e.g., “Login Activity”, as in the image below). You can also choose to add a Description of the Agent and to assign it to a Category for organizing your Agent List page. NOTE: This description is for your own use and will not be revealed to the students. Under Status, select Agent is enabled if you want to put the Agent into effect right away. On the New Agent page you can set the conditions that need to be met by students before an email is sent by the intelligent agent, as well as when and how often the system will check that there are students who meet these conditions. You have the following settings options: Scheduling: If you want to set up your agent to run automatically, select an option from the Frequency drop-down menu. Depending on the Frequency type, new options will appear below the menu to program a date range (Start/End Dates), time of day (Scheduled Time), and rate of recurrence (Repeats Every) for the intelligent agent, among other frequency-specific options. NOTE: : If the No Schedule option is selected, you will need to manually run the intelligent agent. TIP: Create a schedule for your agent within the start and end dates of your course so that students are not receiving notifications during holiday periods or after the course has finished. Criteria: Customize the settings below as they apply to your agent. Role in Classlist. Select one of the following options: All users visible in the Classlist: Choose this option if you want to email anyone enrolled in the course, regardless of role type. Users with specific roles: Choose this option if you want to isolate which role types will receive an email. For example, if you select the Learner role, the intelligent agent will be restricted to students enrolled in your course, and TAs or Instructors will not receive automated emails.                              Take Action on Activity. Optional conditions the student must meet to receive a notification. NOTE: If you are simply creating an Agent as a placeholder, this area of the settings can be left blank for the moment. However, in order for the Agent to work you must identify conditions for it to evaluate. Otherwise, when the Agent runs for the first time it will produce an error and be automatically disabled. Login Activity: This option refers to whether the student has logged into Brightspace LMS, not your course specifically. Enter the number of days since the student last logged into Brightspace before they receive an agent email. Course Activity: This option refers to whether the student has accessed your course page in Brightspace. Enter the number of days a student can be inactive/active before they receive an agent email. Release Conditions: Select this option if you want the intelligent agent to run only when the student meets certain requirements (e.g., student belongs to Group A, student receives 80% or greater on Quiz 3, etc). Click the Browse button to search for a Release Condition you have already created. Click the Create button to program a new one. For more information about using Release Conditions in Brightspace, refer to our support site on Creating Release Conditions. Actions. Customize the following settings as they apply to your agent. Repetition: This setting determines how many emails an agent might send to users who satisfy its criteria. Choose one of the following options: Take action only the first time the agent’s criteria are satisfied for a user: When you select this setting, all users that satisfy the agent’s criteria receive only one email no matter how many times the agent is evaluated. This is the recommended setting if you are sending automated emails to students to avoid sending repeated emails. Take action every time the agent is evaluated and the agent’s criteria are satisfied for a user: When you select this setting, the agent sends an email to all users that satisfy its criteria every time the agent is evaluated. Send an email: Select this option only if you want you or your students to receive an email when the criteria are satisfied. Use the email fields below to enter your message and add any attachments. Enter the recipient names in the To, Cc, and Bcc You can also enter a replace string. (For instructions, refer to our support site on Creating Replace Strings within the Intelligent Agent Tool.) Fill in the email fields as follows: To: Enter your own email address if you wish to receive email updates from the agent. Use the replace string {InitiatingUser} to have Brightspace autofill the applicable student’s email address. NOTE: Click on What special email addresses can I use? to see more replace strings for the To, Cc and Bcc fields. Use the Subject and Message email fields to enter your message. Optional: Use replace strings to personalize the message, such as to autofill the student’s name or the course address. See Creating Replace Strings within the Intelligent Agent Tool for more information. NOTE: The replace strings used in an intelligent agent are different from those used elsewhere in Brightspace. Click What replace strings can I use in the subject and message? to see the entire list of replace strings. Copy and paste the replace strings directly from that list to be sure they will work properly. Click Upload to attach a file from your computer, Choose Existing to select an item from your course files, or Record to create and attach a video or audio message Click Save and Close when finished.   Your Intelligent Agents will now appear on the Agent List. You can also see the date and time when they last sent reminders, and to how many users. See the video tutorial below for an overview of creating an intelligent agent: TIP: Perform a Practice Run to view the results of an agent without sending automatic emails to your students.

Performing a Practice Run

You can perform a practice run to view the results of an intelligent agent without notifying your students.  Log in to Brightspace with your MyCarletonOne credentials. On the Brightspace homepage, locate your course in one of the following ways: Click on the course tile under the My Courses widget. Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar. In the navbar, click Tools.              In the drop-down menu, select Intelligent Agents.  Locate the agent name in the Agent table and click the downward arrow to expand the actions menu. In the menu, select Practice Run. You will be prompted in a pop-up window to confirm that you want to complete a practice run. Click Run. NOTE: Processing time varies based on server load and the priority of other scheduled agents. You will see a Practice Run Agent Confirmation page confirming that your request has been submitted. An email will be sent to your @cunet.carleton.ca email when the request is completed and you will then be able to view the practice run results. Click Done to return to the Agent List page. On the Agent List page, locate the agent name and click …users identified in the Results of Last Run column to view your results report.   See the video tutorial below for an overview of performing a practice run:

Running an Intelligent Agent Manually

Agents are typically set up to run automatically as long as you have enabled a schedule in your agent settings. You also have the option to manually run the agent if no schedule has been set. Log in to Brightspace with your MyCarletonOne credentials. On the Brightspace homepage, locate your course in one of the following ways: Click on the course tile under the My Courses widget. Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar. In the navbar, click Tools.              In the drop-down menu, select Intelligent Agents.  Locate the agent name in the Agent table and click the downward arrow to expand the actions menu. In the menu, select Run Now. A pop-up window will appear prompting you to confirm that you want to manually run the intelligent agent. Click Run. You will see a Manual Run Agent Confirmation page confirming that your request has been submitted. An email will be sent to your @cunet.carleton.ca email when the request is completed. Click Done to return to the Agent List page and view your results. On the Agent List page, locate the agent name and click …users identified in the Results of Last Run column to view your results report. See the video tutorial below for an overview of how to manually run an intelligent agent:

Adding an Intelligent Agent Category

Categories are useful for organizing and sorting your Intelligent Agents.

To add an Intelligent agent:

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:
   • • Click on the course tile under the My Courses widget.
     • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.
3. In the navbar, click Tools.                                   
4. In the drop-down menu, select Intelligent Agents.
5. Click Edit Categories.                                                 
6. Click Add Category.
7. In the Create Category pop-up window, enter a Name for the category.
8. Click Create.

Categorizing Intelligent Agents

Once you have created an Intelligent Agents category, you are able to categorize your existing Intelligent Agents.

TIP: You can use the Bulk Edit feature to categorize multiple intelligent agents simultaneously.

To categorize an Intelligent Agent:

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:
   • • Click on the course tile under the My Courses widget.
     • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.
3. In the navbar, Click Tools.                                   
4. In the drop-down menu, select Intelligent Agents.
5. Click the arrow next to an Intelligent Agent and select Edit from the drop-down.
6. Under Category, select a category from the drop-down menu.
7. Click Save and Close.

Editing Intelligent Agent Categories

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:

• • Click on the course tile under the My Courses widget.
  • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.

1. In the navbar, Click Tools.                                   
2. In the drop-down menu, select Intelligent Agents.
3. Click Edit Categories.                                                 
4. You will be taken to the Edit Categories page.
   • To edit a category name – Click a category name and then type the new name. Click outside the text box or select the Enter key on your keyboard to save your changes.
   • To edit the Sort Order – Click a number under the Sort Order column to adjust the order of the category list. (Type 1 for the category that will appear first in the list, 2 for the category that will be listed second, etc.)

Deleting Intelligent Agent Categories

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:
   • Click on the course tile under the My Courses widget.
   • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.
3. In the navbar, Click Tools.                                   
4. In the drop-down menu, select Intelligent Agents.
5. Click Edit Categories.                                                 
6. You will be taken to the Edit Categories page. Click the checkbox to select the category you wish to delete.
7. Click the Delete Categories icon (trash can).
8. You will be prompted to confirm that you want to delete the selected categories. Click Yes.

Using Replace Strings for Intelligent Agents

See Creating Replace Strings within the Intelligent Agents Tool for more information.

Enabling or Disabling an Intelligent Agent

Intelligent Agents can be enabled or disabled. If an agent is disabled, it will not run automatically, even if a schedule has been set.

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:
   • • Click on the course tile under the My Courses widget.
     • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.
3. In the navbar, click Tools.                 
4. In the drop-down menu, select Intelligent Agents.
5. Click the checkbox next to the Intelligent Agent(s) you wish to enable/disable.
6. Click Enable or Disable.
7. A disabled agent will be marked with the disabled icon . An enabled agent will have no icon.

Deleting an Intelligent Agent

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:
   • • Click on the course tile under the My Courses widget.
     • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.
3. In the navbar, click Tools.               
4. In the drop-down menu, select Intelligent Agents.
5. Click the checkbox next to the Intelligent Agent(s) you wish to delete.
6. Click Delete.           
7. Click Ok in the confirmation pop-up.
8. The agent is now deleted.

Duplicating an Intelligent Agent

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:
   • • Click on the course tile under the My Courses widget.
     • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.
3. In the navbar, click Tools.                       
4. In the drop-down menu, select Intelligent Agents.
5. Click the downward arrow next to the Intelligent Agent you wish to duplicate.
6. Click Copy.
7. A copy of the agent has now been created, and will appear at the bottom of the list. The copied agent will be disabled by default.

Editing an Intelligent Agent

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:
   • • Click on the course tile under the My Courses widget.
     • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.
3. In the navbar, click Tools.                       
4. In the drop-down menu, select Intelligent Agents.
5. Click the agent’s name to open the Edit Agent page.
6. Make any necessary changes.
7. Click Save and Close.
8. Click Ok in the confirmation pop-up. The changes are saved.

NOTE: Changes to an agent will only apply to future runs of the intelligent agent. It will not alter the results of any previous runs.

Bulk Editing Intelligent Agents

You can edit multiple Intelligent Agents simultaneously with the Bulk Editing feature. Using Bulk Edit, you can edit agent names, categories, and enable/disable agents.

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:
   • • Click on the course tile under the My Courses widget.
     • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.
3. In the Navbar, click Tools.             
4. In the drop-down menu, select Intelligent Agents.
5. Select the agents you wish to edit by clicking the checkbox next to the agent’s name. If you want to edit the dates for all agents, select the top checkbox next to Agent.
6. Click Bulk Edit. 
7. You can now edit the following on the Agent Bulk Edit page:
   • Edit an Agent Name – Click the agent name and then type your new title.
   • Edit an Agent Category – Select a category from the drop-down menu in the Category column.
   • Enable or Disable an Agent – Click the toggle in the Enabled column to enable/disable an agent. The toggle will appear blue when enabled and grey when disabled.
8. When you are finished editing, click Save and Close.

Exporting the Results of an Intelligent Agent Run

The list of users identified by an intelligent agent’s run can be downloaded in a .csv file. This can be helpful when managing large classes to generate a list of students that meet set criteria (determined by release conditions, if needed).

1. Log in to Brightspace with your MyCarletonOne credentials.
2. On the Brightspace homepage, locate your course in one of the following ways:
   • • Click on the course tile under the My Courses widget.
     • Click the Course Selector Grid  and select the course from the drop-down menu. If you are enrolled in more than 20 courses, you can search for the course name using the search bar.
3. In the navbar, click Tools.             
4. In the drop-down menu, select Intelligent Agents.
5. Click the action menu (arrow) next to the Intelligent Agent you wish to duplicate.
6. Click Export History.
7. Click the Include Practice Runs checkbox to include the results from practice runs.
8. Click the From This Date and To This Date selection boxes to set the date range to export.
9. Click Export. Depending on the server load and size of the file, the page may load for a few minutes.                                               
10. Click the name of the file to download the .csv file.
11. Click Intelligent Agents in the breadcrumb trail to return to the intelligent agent tool page.

NOTE: The .csv file is only available in one format and may include additional information not relevant to your needs. Perform a practice run and export the agent history early on in your course to ensure the file suits your needs.

Was this page helpful?

Still need help? Contact us

Posted in Communication and Collaboration Share: Twitter, Facebook
Short URL: https://carleton.ca/brightspace/instructors/?p=86