Module Auto Reminder: Difference between revisions

no edit summary
Tag: 2017 source edit
No edit summary
Tag: 2017 source edit
 
Line 35: Line 35:


For each document, only the highest reminder level reached is considered. Lower levels that were missed are never sent afterwards: a document already overdue when the module is enabled receives a single reminder, the one matching its actual delay, with the right template. Never a burst of reminders over several days.
For each document, only the highest reminder level reached is considered. Lower levels that were missed are never sent afterwards: a document already overdue when the module is enabled receives a single reminder, the one matching its actual delay, with the right template. Never a burst of reminders over several days.
== Semi-automatic mode (since 1.3.7) ==
Instead of sending a reminder, the module can prepare it and let you send it yourself. Each reminder due becomes an alert:
* a bell in the top bar shows how many invoices and proposals are to be reminded, and leads to them;
* the invoice and proposal lists get a ''Reminder'' column and a ''To remind'' filter;
* the card of the document shows the alert with a ''Remind'' button, which opens the native Dolibarr send form, prefilled with the template of the level in the language of the customer, and with the recipients of the module.
The alert closes when an email is sent from the card or scheduled with Doli Mail Later, when a higher level replaces it, or when you cancel it: only this level is then skipped. The mode is set per document type in the settings (''Semi-automatic mode by default''), and can be changed per third party and per document with the "Reminders" field.
== Reminders per third party and per document (since 1.3.7) ==
The "Reminders" field is available on the third party card, the invoice card, the template invoice and the proposal card:
* '''Automatic''': the reminder goes out on its own;
* '''Semi-automatic''': the module prepares the reminder and flags it to you;
* '''None''': the reminder is neither sent nor prepared as an alert, and an alert already open disappears.
Left empty, the next level decides: the setting chosen on the invoice or the proposal takes precedence over that of the third party, which takes precedence over the module settings. Example: a third party in dispute is set to "None", one of its invoices to "Automatic": only that invoice is reminded. An invoice generated from a template invoice receives the setting of the template, which can then be changed on the invoice.
The initial sending of documents is not affected by this field. It replaces the "Exclude from automatic reminders" checkbox of previous versions (see Installation for the upgrade).


== Recipient of the emails ==
== Recipient of the emails ==
Line 51: Line 71:
== Language of the emails (since 1.3.2) ==
== Language of the emails (since 1.3.2) ==


The template selected in the settings defines the LABEL of reference, not the language. When the Dolibarr multi-language option is enabled and the third party has its own language, the module uses the email template carrying the same label in that language, and falls back to the template selected in the settings when there is none. The language fallback (es_MX to es_ES, then a template with no language) is the native Dolibarr one. When a translation is used, amounts and dates in the email follow that language too. The attached PDF is not regenerated: it is the document as it stands.
An email goes out in the language of the third party, else in the default language of emails chosen in the module settings (since 1.3.7), else in the language of your Dolibarr. The module takes the first of these languages in which the email template exists, and sends the template of the settings as it is when none has it. The language fallback (es_MX to es_ES, then a template with no language) is the native Dolibarr one. Dates and amounts follow the language of the email sent. The attached PDF is not regenerated: it is the document as it stands.


Translating a template is done in Dolibarr itself, not in the module settings: create the template again with the SAME label, choose the language, then translate the subject and the content. Note that the Language column of email templates only appears when the multi-language option is enabled.
Example: in a French Dolibarr with English as default language of emails, a third party without language receives English, a French third party French, and a German third party English when there is no German template.
 
Translating a template is done in Dolibarr itself, not in the module settings: create the template again with the SAME label, choose the language, then translate the subject and the content. Note that the language of third parties and templates only appears when the Dolibarr multi-language option is enabled.


== Safety against mass sending ==
== Safety against mass sending ==


Only documents validated after the sending option was enabled are sent: enabling the module on an existing database never sends the historical documents. The reference date is stored when you enable the option, displayed in the settings, and editable: you can move it back knowingly to include part of the history. An explicit warning is shown next to the field: any document validated on or after that date and never sent will be sent on the next job run.
Only documents validated after the sending option was enabled are sent: enabling the module on an existing database never sends the historical documents. The reference date is stored when you enable the option, displayed in the settings, and editable: you can move it back knowingly to include part of the history. An explicit warning is shown next to the field: any document validated on or after that date and never sent will be sent on the next job run.
== Exclusions ==
A checkbox "Exclude from automatic reminders" is available:
* on the third party card: never remind this customer (invoices and proposals),
* on the invoice card: never remind this invoice (dispute, negotiated payment schedule...),
* on the proposal card: never remind this proposal.
The initial sending of documents is not affected by these checkboxes.


== When a document cannot be processed ==
== When a document cannot be processed ==
Line 87: Line 100:


The module creates its database table, its extrafields and a daily scheduled job automatically. When upgrading from a 1.x version, existing reminder levels are kept as invoice levels.
The module creates its database table, its extrafields and a daily scheduled job automatically. When upgrading from a 1.x version, existing reminder levels are kept as invoice levels.
After upgrading from 1.3.6 or an earlier version, disable then enable the module: the ticked "Exclude from automatic reminders" checkboxes become "None" in the "Reminders" field. Your settings and levels are kept.


= Setup =
= Setup =
Line 92: Line 107:
Before configuring the module, create your email templates in ''Home - Setup - Emails - Email templates'': type ''Send invoice'' for invoices, type ''Send commercial proposal'' for proposals. One template for the initial sending, one per reminder level.
Before configuring the module, create your email templates in ''Home - Setup - Emails - Email templates'': type ''Send invoice'' for invoices, type ''Send commercial proposal'' for proposals. One template for the initial sending, one per reminder level.


Then open the module settings. There is one tab per document type (Invoices, Proposals), each with:
Then open the module settings. At the top of the page, shared by both document types, the ''Default language of emails'' sets the language of the emails sent to third parties whose card has no language. Left empty, it is the language of your Dolibarr.
 
Then there is one tab per document type (Invoices, Proposals), each with:


* the automatic sending switch and its email template. When enabled, today's date is stored: only documents validated from that date on will be sent. The date is editable (with a warning),
* the automatic sending switch and its email template. When enabled, today's date is stored: only documents validated from that date on will be sent. The date is editable (with a warning),
* the automatic reminders switch (and, for invoices only, the partially paid option),
* the reminders switch, the ''Semi-automatic mode by default'' option (and, for invoices only, the partially paid option),
* the reminder levels table: delay in days + email template, unlimited number of levels.
* the reminder levels table: delay in days + email template, unlimited number of levels.


48

edits