โ๏ธ Smart Communication & Reminders
Automation Feature Guide
Automations help your app send reminder messages automatically when specific conditions are met โ for example rent reminders, MOT reminders, payment reminders, appointment follow-ups, and other scheduled notices.
๐ฉ
Channels Supported
Email and SMS
๐ง
Rule Driven
Messages are only generated when your rule conditions match.
๐
Preview First
Eligible messages are shown to you before they are sent.
๐
Fully Logged
Sent automation messages are saved into Automation Logs.
โ๏ธ Automation System Settings
Before automation rules can work well, you should configure the automation engine settings first.
| Setting | What It Means | Why It Matters |
|---|---|---|
| hours_between_runs | How many hours the app waits before running automation again in the background. | Helps prevent the same background check from happening too often. |
| max_messages_per_run | The maximum number of eligible messages prepared in one batch. | Useful when many records match at once. |
๐ก Tip: If you want reminders to appear more frequently, reduce the number of hours between runs. If you want larger batches, increase the maximum messages per run.
โ
Before You Start
- Make sure your Email or SMS integration has been set up.
- Make sure your message template exists.
- Make sure the target records contain the needed values such as email, mobile, due date, or related customer.
- Turn on Enabled when the rule is ready to use.
๐ Understanding the Rule Scopes
Each automation rule can include three types of conditions:
1) when
This is usually the date-based trigger. It decides when a message becomes due.
2) if
This is an extra condition that must also be true.
3) once
This helps prevent duplicate messages for the same record and date/event.
๐ง How the System Thinks
- Find all enabled automation rules.
- Check that the selected channel is available.
- Look through records in the chosen entity.
- Apply the when conditions.
- Apply the if conditions.
- Use the once rule to avoid sending duplicates.
- Resolve the recipient.
- Generate the message and show it for preview.
๐ What when, if and once Mean in Practice
| Scope | Purpose | Example | Meaning |
|---|---|---|---|
| when | Date/time check | property.rent_info.overdue_date <= today | Send the reminder when the due date is today or earlier. |
| if | Extra filter | property.rent_info.owed >= 0 | Only continue if there is an amount recorded. |
| once | Duplicate prevention | property.id + rent_info.overdue_date | Send only once per property per due date. |
Important: If a record does not meet your rule conditions, no message will be generated for it.
๐ค Recipient Settings Explained
The system needs to know who should receive the message.
| Entity Recipient | The path to the related person or record to contact. Example: lease.tenant. |
| Entity Recipient Type | The type of record that recipient is. Example: customer. |
| Recipient Field | The field to send to. For Email use email. For SMS use mobile. |
| Enabled | Only enabled rules are considered during automation runs. |
๐ Example
Entity Recipient: lease.tenant
Entity Recipient Type: customer
Recipient Field: email
Result: The system follows the lease record, finds the linked tenant, treats that tenant as a customer record, and sends the email to the customer email field.
๐งช Testing with Simulate Automation
If you want to test your automation before waiting for the next background run, you can simulate it manually.
- Go to Settings.
- Click Simulate Automation.
- Choose the date you want to simulate.
- Click Simulate.
- The system will generate eligible messages and show them for preview.
Note: A simulation may return no messages if the selected date does not satisfy your when condition or if the record data does not meet your if rules.
๐ Automation Logs
Every message that is actually sent through automation is stored in the logs.
Where to find it:
Go to Settings and search for Automation Logs.
Logs are useful for checking what was sent, to whom it was sent, and when it was sent.
๐ก๏ธ Duplicate Prevention
The once rule helps stop the same automation from being sent repeatedly for the same event.
Example: if your once rule uses the record ID together with the due date, the system will only send one reminder for that record for that date.
๐ก Best Practice Tips
Use clear template names so they are easy to recognise later.
Test new rules with Simulate Automation before relying on them.
Always define a sensible once rule to avoid duplicate reminders.
Check that customers actually have an email or mobile number saved.
For SMS, keep messages shorter and simpler.
Review Automation Logs regularly to confirm what has already been sent.
๐จ Troubleshooting
| Problem | Possible Cause | What To Check |
|---|---|---|
| No messages are generated | Rules did not match | Check the date condition, if condition, and whether the rule is enabled. |
| Recipient not found | Recipient path is incorrect | Check Entity Recipient and Entity Recipient Type. |
| Email/SMS not available | Integration not configured | Review your Email or SMS integration settings. |
| Preview is empty during simulation | Selected simulation date does not satisfy the rule | Try another date or check your rule values. |
โ
Summary
The automation feature helps you send messages at the right time, to the right person, using rules you define. Set your engine options, choose a channel, create a template, define your when, if, and once rules, configure the recipient, and enable the rule. Then use Simulate Automation to test it and Automation Logs to review what has been sent.
