Create an agent
- On a course navbar, click
Course Admin.
- Click Intelligent Agents.
- On the Agent List page, click New.
- On the New Agent page, enter a name.
- If you want to assign a category to the agent, select an option from the Category drop-down menu.
- You can create a new category by clicking the Add Category link to the right of the Category drop-down menu. Enter a name into the Name field, and then click Save.
-
Enter a description into the Description field, if required.
- If you want the agent to be active, select the Agent is enabled check box.
Figure: The New Agent page, showing the agent details box. This contains Agent Name, Description, Category, and Status.
- To schedule how frequently agent criteria is evaluated, choose a frequency option from the dropdown menu and complete the schedule dates and repetition options as needed.
Note: Intelligent Agents can be scheduled to run before the course start date. Scheduled intelligent agents stop running and are automatically disabled if the course is inactive, past its end date, or deleted. You can still set up a practice run or a manual run of an intelligent agent at any time in a course with a passed end date.
Figure: The Scheduling box with the Frequency drop-down menu expanded.
- Expand Criteria, and under Role in Classlist do one of the following:
- If you want the intelligent agent to be applicable to all roles in the Classlist, select the All users visible in the Classlist check box.
- If you want the intelligent agent to be applicable to select roles, select the Users with specific roles check box and select the respective roles.
- If you want your agent to target users' login habits, under Criteria > Login Activity, enter your criteria.
- Note: Login activity refers to logins at the platform level.
- If you want your agent to target users' course habits, under Criteria > Course Activity, enter your criteria.
-
To set an intelligent agent based on specific release conditions, do one of the following:
- If you want your agent to run when a specific existing condition has been met, under Criteria > Release Conditions, click Attach Existing. Select the condition you want and click Attach.
- If you want your agent to run when a specific new condition has been met, under Criteria > Release Conditions, click Create and Attach. Select a Condition Type from the drop-down list. Complete any additional Condition Details that appear and click Create.
For example, you can create an agent that acts against users who have been enrolled in a course for a certain number of days, either based on the first or last time they were enrolled into the course.
-
Note: All criteria selections under Take Action on Activity, which include the criteria Login Activity, Course Activity, and Release Conditions, are optional selections.
Figure: Criteria requirements for Role in Classlist and Take Action on Activity.
- Under Actions > Repetition, select how often you want the agent to take action.
- If your role has the Use Agent Enrollment Actions and Perform Unenroll permissions, you can set your agent to perform an enrollment or unenrollment action:
- If you want the agent to send an email when the set criteria are satisfied, expand Actions, and under Send an Email, select the Send an email when the criteria are satisfied check box and enter your email details and relevant attachments.
- Click Save and Close.
Add a link to the Intelligent Agents tool to the navbar
You can add a link to the Intelligent Agents tool to your course’s navbar.
- From the Admin Tools menu, select Navigation and Themes.
- Click the link for the navbar, in which you want to add a link to the Intelligent Agents tool.
- On the Edit Navbar page, in the Links area, click Add Links.
- In the Add Links dialog box, select the Intelligent Agents check box.
- Click Add, and then Save and Close.
Edit an agent
- On the navbar, click Course Admin.
- Click Intelligent Agents.
- You can filter what agents are viewed by selecting an option from the View drop-down menu. The options are All Agents; By Category (which sorts the Agents by their assigned category); Enabled (only those Agents that have been enabled); and Disabled (only those Agents who are not currently enabled).
- From the context menu of the agent you want to edit, click Edit Agent.
- To edit multiple agents at once, click Bulk Edit.
- Note: You can only change certain attributes (title, category, active/inactive state) using Bulk Edit.
- Make your changes.
- Click Save and Close.
Copy an agent
You can copy an agent to reuse or make minor editing changes to. All copied agents will be disabled by default.
- On the navbar, click Course Admin.
- Click Intelligent Agents.
- From the context menu of the agent you want to copy, click Copy. A new agent is created and Copy of is added to the beginning of its name.
Note: When copying an agent with a scheduling frequency of One-Time Run, the agent's schedule is only copied if you have not yet run the agent.
Delete an agent
To delete an agent
You can delete an agent individually or in bulk. Deleted agents do not run if they have a recurring schedule.
- On the navbar, click Course Admin.
- Click Intelligent Agents.
- In the Agent List, select the check boxes of the agents you want to delete and click Delete.
- To confirm the deletion, click Delete.
Watch how to delete and restore an agent
Restore an agent
You can restore deleted agents. All restored agents maintain existing properties and history.
- On the navbar, click Course Admin.
- Click Intelligent Agents.
- In the Restore Agents page, click Restore to restore any of the deleted agents.
Change the status of an agent
You can enable and disable agents individually or in bulk easily on the Agent List page. Disabled agents display an 
Agent is not enabled icon by their name.
- On the navbar, click Course Admin.
- Click Intelligent Agents.
- On the Agent List page, do one of the following:
- To enable an agent, select the check box for any agent you want to enable and click the Enable link.
- To disable an agent, select the check box for any agent you want to disable and click the Disable link.
Update Intelligent Agents settings
You can adjust the settings in the Intelligent Agent tool to set custom values for the name that emails come from and the reply-to address that responses are delivered to.
- On the navbar, click Course Admin.
- Click Intelligent Agents.
- Click Settings.
- On the Intelligent Agents Settings page, select one of the following:
- Select Use the system defaults.
- Select set custom values for this course and fill in the available fields.
- Click Save.
Replace strings for agents
|
Replace String
|
Description
|
For Use In
|
|---|
|
{InitiatingUser}
|
The user who performs the action that meets the agent’s criteria
|
Email address field
|
|
{InitiatingUserAuditors}
|
The auditors for the user who performs the action that meets the agent’s criteria
|
Email address field
|
|
{OrgName}
|
The name of the organization
|
Email body
|
|
{OrgUnitCode}
|
The code for the Org Unit
|
Email body
|
|
{OrgUnitName}
|
The name of the Org Unit
|
Email body
|
|
{OrgUnitStartDate}
|
The start date specified for the Org Unit
|
Email body
|
|
{OrgUnitEndDate}
|
The end date specified for the Org Unit
|
Email body
|
|
{OrgUnitId}
|
The org unit ID required to make quicklinks works
|
Email subject line and email body
|
|
{InitiatingUserFirstName}
|
The first name of the initiating user
|
Email body
|
|
{InitiatingUserLastName}
|
The last name of the initiating user
|
Email body
|
|
{InitiatingUserUserName}
|
The username of the initiating user
|
Email body
|
|
{InitiatingUserOrgDefinedId}
|
The Org Defined ID of the initiating user
|
Email body
|
|
{LastCourseAccessDate}
|
The date the initiating user last accessed the course
|
Email subject line and email body
|
|
{LastLoginDate}
|
The date the initiating user last logged in
|
Email subject line and email body
|
|
{LoginPath}
|
The address of the login path for the site
|
Email body
|