Home › Online Documentation (2.3) › Administration › Jobs ›

Account Reminder Sender

Submitted by tanderson on Tue, 24/08/2021 - 14:51

The Account Reminder Sender is a scheduled job that periodically sends SMS reminders for unpaid invoices or counter sales.
Reminders are sent for unpaid invoices and counter sales where:

  • the charge Send Reminder flag is selected; and
  • the customer is active; and
  • has a mobile telephone; and
  • the charge was finalised within one of the reminder intervals; and
  • the charge is newer than than interval specified by the Ignore charges older than field

 

The fields are as follows:

Name The job name
Description The job description
Active This schedules the job to run if checked, or prevents it from being run if unchecked
Minimum Balance

Exclude charges with a balance less than this amount.
Ignore charges older than

Any charges finalised before this period will be ignored.
Minutes See Cron Expression
Hours See Cron Expression
Day Of Month See Cron Expression
Month See Cron Expression
Day Of Week See Cron Expression
Run As

Specifies the user to run the job as. This user is required to have permissions to:

  • save charges
  • send notification messages
Notify Specifies the user or user group to notify when sending has completed. Notification only occurs when SMS message are sent, or errors are encountered. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Reminder Jobs Message Receiver' used only for these notifications.

Reminders

Multiple reminders can be sent based on the interval when the charge was finalised.
Each interval has an associated template which determines the content of the SMS.
E.g. given:

Ignore charges older than: 1 year

Interval SMS Template
2 days Template 1
1 month Template 2
6 weeks Template 3

Any invoice or counter sale that was finalised:

  • 2 days and up to 1 month ago will receive an SMS generated from Template 1
  • 1 month and up to 6 weeks ago will receive an SMS generated from Template 2
  • 6 weeks ago up to 1 year ago will receive an SMS generated from Template 3

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Field Allowed Values Allowed Special Characters
Minutes 0-59 , - * /
Hours 0-23 , - * /
Day Of Month 1-31 , - * ? /
Month 1-12 or JAN-DEC , - * /
Day Of Week 1-7 or SUN-SAT , - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Description Minutes Hours Day Of Month Month Day Of Week
Run at 8am every weekday 0 8 ? * mon-fri
Run every 30 minutes */30 * * * ?
Run every 2 hours 0 */2 * * ?
Run every 15 mins between 8am and 6pm on weekdays */15 8-18 ? * mon-fri
Syndicate content