Module 17: Notifications Rules in AccuCampus
Topic: Rules (Notifications)
- Notification Topics
- Parts of Rules
- Creating New Rules
Within AccuCampus, you are able to create rules that tell the system to complete tasks automatically based on user actions within the system. In this module, we’ll discuss Notification rules, which allow you to automatically send a notification in response to a user action. This could include missed appointments, missed classes, or even encouragement when a user accesses a specific resource.
Before you can create a notification rule, you first need to create notification topics. These are primarily used when creating rules for automatic notifications; however, they will also appear on the user profile and users will be able to decide if they want notifications from that topic delivered via e-mail, push notification or text, or if they want them delivered at all. For more information about notification topics see Module 8.
From the Main Sidebar, hover over Advanced Options.
Click Create Topic.
Enter a Name for the topic. We recommend being specific so that other users will know what the topic addresses.
Enter a Description for the topic. We recommend being specific so that other users will know what the topic addresses.
Choose the type of Delivery that will be enabled. We recommend selecting all three to ensure that notifications can be sent to all users. Make sure to set the default action to send.
On-Screen Delivery: the notification will be sent via a push notification through the app, or appear onscreen through the browser.
Email Delivery: the notification will be sent via e-mail.
Text Message Delivery: the notification will be sent via text message.
Parts of Rules
Before creating new rules, you must first be familiar with the different parts of a rule. Each rule has a trigger and an action and may have a condition, which modifies the trigger. These are explained in more detail below.
Triggers are the first step to tell the system when to apply the rule. Triggers are typically based in a user’s actions within the system. The following triggers have been built into the system.
Signing In/Out of a Sign-in Station
- When a card is swiped
- When a person is automatically signed out
- When a user signs in using a multistep kiosk station
- When a user signs out using a multistep kiosk station
- When a user has moved forward in a waiting line
- When a user is added to a waiting line
- When a user is signed in from a waiting line
- When an appointment is cancelled
- When an appointment is created
- When an appointment is edited
- When an appointment is restored
- When an appointment is voided
- When an appointment reminder is processed
- When a seminar reminder is processed
- When someone does not show for an appointment
- When an attendance log is deleted
- When an attendance log is saved
- When an attendance log is tagged
- When an attendance log tag is removed
- When an action assignment has expired
- When an action assignment is due
- When an action assignment is updated
- When an action assignment is assigned to a user
- When a user is manually created or edited
- When a user is manually deleted
- When a user is tagged
- When a user tag is removed
- When a media checkout has passed its due date
- When a media checkout is about to end
- When a media item is checked in
- When a media item is checked out
- When an import job finishes
Conditions are the second step to tell the system when to apply the rule. Conditions provide more context for the trigger. An example would be a trigger of “when a card is swiped” and the condition specifying the location where the card is swiped. The conditions available depend on the trigger; however, they general involve locations, users, services, etc. You are able to add more than one condition to a trigger.
When creating a condition that pertains to a location, service or course/event, we recommend that you use the Internal ID for that item versus the written name of it. This ensures that if the written name changes, the rule will still stand. To get the Internal ID, follow these instructions.
Navigate to the location, service or course/event you wish to use.
At the end of the web address for that page, you will see id= followed by a string of numbers and letters. Everything after the equals sign is your Internal ID.
Set your condition to an Internal ID and paste the string of numbers and letters into the condition.
The rule will now remain active, even if the name of the location, service or course/event changes over time.
When creating your notifications, it’s possible to use tokens. This allows you to create a generic notification that will be personalized based on the tokens contained within it. Much like with Internal IDs in the conditions, this allows the rule to remain active even if the name of a user, location, service or course/event changes.
Depending on the action you choose, a list of tokens will appear on the right hand side of the screen. These include user ID tokens, location tokens, service tokens, etc. Click on the desired token to add it to your message, or to identify followers for the action.
Using the token [[Assignment.Assignee.Id]] ensures that the rule applies to any user that meets the conditions. In this case, any user that is assigned the specific action item in the trigger receives the notification.
Using the token [[Assignment.Assignee.FirstName]] causes the message to be addressed to the specific user who was assigned the action item.
Creating New Rules
Within this page, you are able to create rules for actions within AccuCampus. You can select one trigger per rule with multiple conditions for that trigger. You are also able to select multiple actions per rule.
From the Main Sidebar, hover over Advanced Options.
Click Create New.
Enter a Name for the rule. We recommend that you use a unique and specific name so that the rule can be identified by other users.
Enter a Description for the rule. We recommend that you use a unique and specific description so that the purpose of the rule can be identified by other users.
Set the rule as Active.
Set a Trigger for the rule.
Set Condition(s) for the rule.
Click Add Action.
Click Send a Notification.
Choose a Notification Topic.
Enter Fixed Users. Fixed Users are specific people who will always be notified when the notification is sent out.
Enter Other Users who will receive the notification. Other Users are typically identified by a token so that the notification goes to anyone who meets the trigger and conditions.
Enter a Notification Title. You can use tokens in order to personalize the message.
Choose Delivery Methods. You can choose to deliver via On-screen Notification, E-mail or Text Message. We recommend sending the notification via all channels so that users are more likely to receive it.
Enter the Content for the delivery methods chosen. You can use tokens in order to personalize the message.
On-screen Notification: enter the body of the notification, choose a class of message and duration for the message (for push notifications). You can also add a link to more information, including a custom URL.
E-mail Notification: enter the sender name and e-mail address, the subject and the body of the e-mail.
Text Message: enter the message to be sent.
If the rule should cause more than one action, click Add Action. If not, click Save.