Email reporter¶
Use the Email reporter plugin to create and send reports.
The data for such reports comes from portals.
The actual sending of the email reports is carried out by the scheduler.
An email report is divided into basic, report and email configuration:
Basic¶
| Parameter | Meaning | Note |
|---|---|---|
| name | descriptive name | you can filter by this in the selection dialog |
| active from | from when should this report be sent | must be a valid date in the format DD.MM.YYYY |
| active until | to what date should this report be sent? | must be a valid date in the format DD.MM.YYYY |
Reports¶
The Reports section defines the portals from which the data to be sent originates.
The button Add is used to configure new reports and the button Edit
is used to configure existing reports.
In both cases, the report dialog opens:
With the button Accept, the report is marked for dispatch. The button Delete report can be used to remove existing reports from dispatch.
| Parameter | Meaning | Note |
|---|---|---|
| name | meaningful name | increases the clarity of many reports |
| portal | portal with the desired data | |
| group | group in the portal | |
| row | row in the portal group | |
| Tables | ||
| send | Should the list or pivot be included in the report? | |
| heading | optionally different heading | |
| attachment | Should the list or pivot be sent as an attachment? | if not checked, the table must be included in the email text |
Email¶
The email section configures the email to be sent itself. In addition, report data can be embedded directly in the email text using the placeholders.
| Parameter | Meaning | Note |
|---|---|---|
| recipient | main recipient of the email report | addresses visible to all recipients! addresses can be added with  (*1) |
| CC | other recipients of the email report | addresses visible to all recipients! addresses can be added with (*1) |
| BCC | hidden recipients of the email report | addresses not visible to recipients. addresses can be added with (*1) |
| subject | subject of the email | |
| placeholder | the selected placeholder is inserted at the current cursor position in the text | will be replaced with the data of the referenced table when sent |
*1: Add email addresses
Email addresses can be transferred from lists with an email column. Columns with the name ""E-Mail", "E-mail", "EMail", "Email", "email" and "eMail" are taken into account.
Delivery¶
The email can be sent manually on request or scheduled automatically.
Manually¶
The email can be sent manually at any time.
Automatically¶
Here you configure when sending is possible or desired (this is taken into account by the scheduler when sending).
Ready for delivery
If the data to be sent is only available at or after certain times, the sending can be adjusted here.
With the button Accept the readiness for dispatch is set, with the button Do not send automatically it is removed.
| Parameter | Meaning | Note |
|---|---|---|
| hour | at what hour is the delivery possible? | multiple entries possible, must be separated by commas. not available if cron_interval = day |
| day of the month | On which days of the month is the delivery possible? | multiple entries possible, must be separated by commas. |
| day of the week | On which weekdays is the delivery possible? | note: has an or relationship to Day of the month (either it is Day of the month X or Day of the week Y). |
| month | In which months is the delivery possible? |
Expert view
Ready for dispatch in CronFormat. This is interpreted by the scheduler as "Dispatch can take place on match" (not "must take place").
Any CronJob configured at system level for the scheduler is independent of this, so the actual dispatch time may differ.
Scheduler¶
Send specific report¶
A single report can be sent:
-
by specifying the configuration ID
-
by specifying the configuration name
Send all reports¶
All currently active reports can be sent.
Tip: Regular delivery via CronJob
Use emlrep-scheduler for regular delivery via CronJob
Readiness for delivery is taken into account
A report is only sent if this is possible or desired according to readiness for delivery.