Overview
Account Events automate actions when a target is added to a group, a campaign ends, or a test ends. You can also create a recurring schedule that generates or sends reports. To open this page, navigate to Administration > Settings > Account Events.
The Account Events page contains tools for finding and managing existing events and a three-step wizard for creating new events. The selections in each wizard list determine which fields and options appear next.
Click from the following to jump to the desired section:
Account Events Table
The table lists every Account Event active in the account. Use the controls above the table to locate, review, create, or export events:
- Search: Enter part of an event name, trigger, action, or other displayed value in the search box at the top-left of the table to narrow the visible rows.
- Filter: Select Filter to the right of the search box to build one or more conditions. Filters can use Name, Event, Action, or Date Created. Choose an operator and value for each condition, select + Filter to add another condition, and choose whether to match all or any conditions. Select Apply to filter the table or Cancel to close the window without applying the changes.
- Create: Select Create at the top-right to open the three-step event wizard described below.
- Export: Select Export, immediately to the right of Create, to export the table data.
- Show entries: Use the list above the table to display 10, 25, 100, 200, 500, or 1,000 rows per page. Use the pagination controls below the table to move between pages.
The Account Events table and its controls.
Table columns and row actions
- Selection: Select a row's checkbox to include it in a bulk action. Select the checkbox in the header to select the displayed rows. When one or more rows are selected, use the bulk Delete action to remove them. The Portal asks for confirmation before deleting events.
- Name: Displays the name of the Event.
- Event: Displays the trigger for the event (e.g., a target being added to a group, a campaign ending, a test ending, or an automated reporting schedule).
- Action: Displays the action or actions that the Portal performs when the event fires.
- Created: Displays the event's creation date and time.
- Actions: Select the Edit button for a respective event to reopen the event wizard. Select the arrow next to Edit to open the row menu, which contains Edit, View Log, and Delete.
Select the Name, Action, or Created column heading to change that column's sort order.
- View Log: Opens the Event Details window. The log identifies the event name and trigger and lists each time the event fired. Its table includes Fired at and Target columns. Use the page-size list to display 10, 20, 50, or 100 log entries and the pagination controls to move between pages.
- Delete: Opens a confirmation prompt before the event is removed. Confirmation prompts also remain in place for bulk deletion.
Successful actions and errors are displayed as brief notifications. If a Send To address is invalid, the address is highlighted in red so it can be corrected before the event is saved.
Creating An Event
Select Create at the top-right of the Account Events page. The wizard contains the Create New Event, Choose Action Type, and Additional Configuration tabs.
1. Create New Event
- Enter a unique, descriptive value in Name.
- Open Event and choose one of the following triggers:
- When a Target is Added to a Group
- When a Campaign Ends
- When a Test Ends
- Generate an Automated Report
- Complete the dependent field that appears to the right of Event, as described below.
- Select Next.
Complete the Create New Event tab from left to right.
Dependent options for event triggers
- When a Target is Added to a Group: The next Select list contains All Groups and the account's individual groups. Choose All Groups to apply the trigger whenever a target is added to any group, or select one group to limit the trigger.
- When a Campaign Ends: The next Select list contains All Campaigns and the account's individual campaigns. Choose All Campaigns to apply the trigger whenever a campaign ends in the account, or select one campaign to limit the trigger.
- When a Test Ends: The next Select list contains All Tests and the account's individual tests. Choose All Tests to apply the trigger whenever a test ends in the account, or select one test to limit the trigger. Each individual test is identified by its test name and the associated group, in parentheses, which helps distinguish tests that have similar names.
- Generate an Automated Report: The group, campaign, or test selector is replaced by a Repeat Every list. The schedule selected here determines which date controls appear next. Please see Automated reporting schedules below for details concerning report schedules.
Automated reporting schedules
- Day: Displays weekday buttons labeled M, T, W, R, F, S, and U (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday). All days are selected by default. Click each day icon to enable/disable the report being ran on that day.
- Week: Displays the same weekday buttons. Monday is selected by default; choose the weekday or weekdays on which the weekly event should run. The event will fire every week on each day selected.
- Month: Displays a day-of-month list from 1 through 31. The event will fire every month on the day selected.
- Year: Displays a month list from January through December followed by a day-of-month list from 1 through 31. The event will fire every year on the selected date.
- First Day of the Month, Last Day of the Month, First Day of the Quarter, and Last Day of the Quarter: These fixed schedules require no additional date selection.
2. Choose Action Type
The Action list changes according to the trigger selected in the "Create New Event" tab; below the provided image there is a description of the action lists for each trigger.
Choose an action on the left first, then complete each field that appears to its right. Select Add Action to add the completed action to the event. You can configure multiple actions; select the trash icon beside an added action to remove it. At least one action must be added before selecting Next.
The fields to the right of Action depend on the selected action type.
Actions for When a Target is Added to a Group
The Action list contains:
- Enroll a Target in a Program: The next list contains the account's programs.
- Enroll a Target in a Course: The next list contains the account's courses.
- Enroll a Target in a Third Party Course: The next list contains the account's third party courses.
After selecting the program or course, use the condition list to select Enrollment Check when the Portal should check the target's current enrollment before applying the action.
Actions for When a Campaign Ends
The Action list contains:Run Report, Run CSV Report, Send Report to Group Manager, Send Report, and Send CSV Report.
The Action list contains the following:
- Run Report - This will generate the report in the Portal account.
- Run CSV Report - This will generate the CSV report in the Portal account.
- Send Report to Group Manager - This will email the respective group manager the report.
- Send Report - This will email the report to the provided email address(es). The locale of the report can also be selected.
- Send CSV Report - This will email the CSV report to the provided email address(es). The locale of the report can also be selected.
Once an action is selected, then:
- In the next Select list, select the desired report.
- Complete the dependent entity selector. Campaign report templates provide Target Campaign and the account's individual campaigns. Target Campaign means the campaign that caused the event to fire. Send Report to Group Manager is limited to Target Campaign.
- For Send Report or Send CSV Report, add one or more addresses in Send To and select the message language. English is selected by default.
The general Send Report and Send CSV Report actions can expose saved templates for other report types. If one of those templates is selected, the next list changes to the matching entity type, such as groups, tests, or courses.
Actions for When a Test Ends
The Action list contains Run Report, Run CSV Report, Send Report to Group Manager, Send CSV to Target Manager, Send Report, and Send CSV Report.
- Run Report: Select a saved test PDF report, then choose Target Test or an individual test.
- Run CSV Report: Select a saved test CSV export, then choose Target Test or an individual test.
- Send Report to Group Manager: Select a saved test PDF report. The event uses Target Test.
- Send CSV to Target Manager: Select a manager CSV definition, such as Default Manager Report. This action uses the test that fired the event and does not display a separate email-address field.
- Send Report and Send CSV Report: Select a saved template, complete the dependent entity selector, add the Send To addresses, and select the language.
Actions for Generate an Automated Report
The Action list contains Run Report, Send Report, Run CSV Report, and Send CSV Report.
- Choose the action.
- Select the saved PDF report template or CSV export definition.
- Select the specific entity required by that template. For example, a campaign template displays campaigns, a test template displays tests, and a group template displays groups. A scheduled event has no triggering target entity, so a specific matching entity must be selected.
- For a send action, add the Send To addresses and select the language.
Note: Run Report and Run CSV Report generate or queue the report in the Portal. If Report Generated Notification is enabled under Notifications, the event creator receives an email when the report is ready. Send Report sends a PDF, and Send CSV Report sends a CSV file to the configured recipients. The selected language applies to the outgoing message.
3. Additional Configuration
The final tab displays a read-only summary of the selected trigger and entity followed by every added action, template, and entity. Review the summary carefully:
- Select Back if any trigger, schedule, action, report template, entity, recipient, or language must be changed.
- Select Finish to create the event.
When an existing event is edited, this tab also warns that saving the edit deletes the previous event and creates a new event. The configuration summary otherwise follows the same layout used during creation.
The Additional Configuration summary shown while editing an event; event creation uses the same summary layout.