Successfully!

Error!

You are viewing 10.0 help doc. More details are displayed in the latest help doc

Task Schedule Email Notification

I. Overview

1. Version

Report server version
JAR packageFunction change
10.0--
10.02019-05-20Added support for custom mailboxes for recipients, CCs, and Bccs


2. Application scenarios

  • Send email reminders and notifications to users in batches during the front-end data entry process.

  • After the corresponding conditions are met, it needs to be triggered regularly to send emails to different people.


3. Function introduction

Set the sender and recipient, send an email reminder after the scheduled task is completed, and send an email to notify the recipient of the result.

Chapter II of this document uses a simple example to demonstrate how to use the scheduled email notification function.

Chapter III of this document explains in detail the function of scheduled email notification.

II. Example

Example in this document: by task schedule regularly, push the latest sales details to the salesLeader mailbox of the sales department at 18:00 every night .

1. Set sender

To send an email, a sender is required, otherwise the sending action cannot be completed. The sender of each data decision system is unique and only needs to be set once.

The administrator logs in to the data decision system, clicks Management >System>Mailbox, configures the sender's account, and clicks Save, as shown in the figure below:

Note 1: The type of sender's mailbox is different, and the configuration steps may not be exactly the same. For details, please refer to: Mailbox .

Note 2: After the configuration is complete, please click Send Test Email to ensure that the mailbox is available.

1.png


2. Set recipient

The scheduled task needs to send an email to the salesLeader  mailbox of the sales department, so first bind the mailbox for Lisa, the sales director.

The administrator logs in to the data decision system, clicks Management >User >All Users, edits the user information of Lisa, the head of the sales department, fills in the email information, and clicks OKAs shown below:

Note: This example only demonstrates how to configure mailboxes for users in the system. The administrator can also configure mailboxes when synchronizing/manually adding users. For details, see:  Importing Users , and Synchronizing Users .

2.png

3.png


3. Add task

The administrator logs in to the data decision system, clicks Management > Task Schedule> Task Management, and clicks Add Task to add a scheduled task. As shown below:

4.png


4. Basic settings

1) Task Name is set to TodaySales.

2) Click the Editbutton of the Default User GroupSelect the saleLeaderof the sales department for the department, and click OK. As shown below:

Note: There is no need to set the default user group in this step. When setting the email recipient, it can be sent to the specified email account, but the email cannot be associated with the user of the data decision system.

5.png

Confirm that the department has selected All Departments: Sales Department: salesLeader;, click OK, the default user group setting is complete. Click Next, as shown in the figure below:

6.png


5. Dispatcher objects

1) Select Report Template for the object type, and select the template GettingStartedEN.cpt.

2) The file name is set to ${now()}Sales.

3) Select pdffor attachment archive.

Click Next, as shown in the figure below:

Note: What type of Attachment Archive  is checked in this step, and what type of mail attachment can be selected when sending mail.

7.png


6. Frequency

Select Detailed Frequency Setting for execution frequency, and click Add.

Set the execution time to 18:00, the execution day to Daily, and the execution month to Select all. Click OKto successfully add detailed frequency.

Check the detailed frequency just added and clickNextAs shown below:

8.png


7. File handling

1) Check Email Notification for the processing method.

2) In the Email Notification setting:

  • Recipient: Default User Group

  • The topic is:${today()}Sales

  • The content of the email is:Please check the sales today.

  • Checked: Preview the report content in the main text

  • Checked: Text plus result link

  • Check: Use attachment

Click Save, as shown in the figure below:

9.png


8. Effect preview

Since the execution frequency of this task is executed once every night at 18:00, the effect of the task cannot be seen immediately.

In order to see the effect of the task immediately, you can find the task in the Management> Task Schedule > Task Management interface and select Run Once.

10.png

After the task is executed once, the mailbox of the user Lisa corresponding to the position saleLeaderreceives an email from the data decision system.

The content of the email is shown in the figure below:

11.png

III. Function details

In the step of Task Schedule>File Process, the user can choose the processing method of Email Notification As shown below:

This chapter will introduce in detail the functions and precautions of the mail notification processing method.

12.png

1. Prerequisites

To send an email, a sender is required, otherwise the sending action cannot be completed. The sender of each data decision system is unique and only needs to be set once.

The administrator logs in to the data decision system, clicks Management >System >Mailbox, configures the sender's account, and clicks Save, as shown in the figure below:

Note 1: The type of sender's mailbox is different, and the configuration steps may not be exactly the same. For details, please refer to: Mailbox .

Note 2: After the configuration is complete, please click Send Test Email to ensure that the mailbox is available.

13.png


2. Recipient

The recipient can be Default User Group and Custom mailbox.

1) Default User Group

The default user group is the default user group set in Task Schedule>Basic Settings, and the task schedule task will send emails to the mailbox of the user of the data decision system.

14.png

It should be noted that if the user information of the default user group is not bound to the mailbox, the mail cannot be sent successfully.

15.png

2) Custom mailbox

Custom mailboxes support multiple mailboxes manually, no need to bind with the users of the data decision system, and the mailboxes are separated by ,For example111@qq.com,222@qq.com,333@qq.com

Note: The report project on and after 2019-05-20 adds support for custom mailboxes.

16.png


3. CC/Bcc

The recipients of CC and Bcc can be Platform usersand Custom mailboxes.

1) Platform users

The targets of CC and BCC can be selected from users in the data decision system, and the scheduled tasks will be CC/bcc emails to the users of the data decision system.

  • The platform user information allowed to be selected must be bound to the mailbox.

  • If the platform user has no information and is not bound to the mailbox, it will not appear in the drop-down list.

  • The recipient mailboxes for CC and Bcc will be displayed in the email in the order selected by the user.

17.png

2) Custom mailbox

Custom mailboxes support multiple mailboxes manually, no need to bind with the users of the data decision system, and the mailboxes are separated by ,For example111@qq.com,222@qq.com,333@qq.com

Note: The report project on and after 2019-05-20 adds support for custom mailboxes.

18.png


4. Subject

The subject is the title of the email. It is required and cannot be empty.

1) The subject of the email supports normal text, which can be entered manually.

2) The email subject supports formulas. For the formulas that can be used, see: Task Schedule supported formulas .


5. Email content

The email content is the body content of the email and is not required.

1) Support text

The email content supports normal text, which can be entered manually.

2) Support formula

The email content supports formulas. For the formulas that can be used, please refer to: Task Schedule supported formulas

3) Support HTML tags

HTML tags can be used in the email content. As shown below:

19.png

20.png

HTML tags that can be used in emails include: a, abbr, b, br, button, dd, dl, dt, form, hr, i, img, input, li, ol, p, span, sub, sup, table, td , tr, ul

Please refer to the following suggestions when using HTML:

  • Most mail clients do not support the body tag. If you encounter other tags that are not parsed because the body tag is not used, you can try to add the body tag.

  • Try to use table tags instead of div tags in web page layout.

  • The img tag is the only external resource referenced by customers, but many clients do not display pictures by default (such as Gmail), so make sure that the main content can be read even if there is no picture. At the same time, some clients will add a border to the picture link, and the border should be removed:

<img border="0" style="display:block;">

  It is also recommended that all pictures have clearly defined height and width.

  • All CSS rules should not be abbreviated, and inline styles should be used.

  • When the email content is displayed in HTML format, some fonts do not support the display.

     The specific features of unsupported fonts are: the font name contains special symbols such as spaces          and -, such as Windding 3.

     Fonts that do not support display will be displayed as SimSun fonts.


6. Body preview report content

If you check the Body preview report content option, the report content will be displayed directly in the email body.

The table is displayed in HTML, and the chart is displayed in image format.


7. Body with result link

If you check the option of Body with result link, then a preview hyperlink of the task schedule result report will be added to the body of the email.

The user needs to enter the user name and password of the data decision system before viewing the result report.


8. Use accessories

If attachments other than Result Report are not checked in the Dispatcher Objects> Attachment Archive setting of the scheduled task, then the Use Attachmentfunction will be grayed out in the Mail Notification and there is no attachment file in the mail.

If other attachments other than Result Report are checked in the Dispatcher Object> Attachment Archive setting of the scheduled task, then you can select Use Attachment in the Email NotificationWhat type of Attachment Archive is checked, and what type of email attachments will be sent when sending emails.

Note: The result report file in .cpr/.frr format will not be sent as an attachment to the email.

21.png

22.png


9. Mail received

The correspondence between the received mail and the setting items is shown in the figure below:

23.png

244.png

IV. Matters needing attention

For the content of the main body preview report and the use of attachments, the following points need to be noted:

  • Display according to the generated result report, that is, according to the template parameters corresponding to different users.

  • If a recipient has a corresponding result report, it will be sent to this recipient separately.

  • If some recipients do not have a corresponding result report, the general result report will be sent together.

  • If some recipients have neither a corresponding result report nor a general result report, the sending fails.

  • If the scheduled task is executed multiple times, every time it is executed, the user will receive a result report and attachment.

  • If a user has multiple result reports in one task, multiple texts and attachments will also be sent, and the template parameters will be added when the attachment name is renamed.

  • If the scheduled task needs to send multiple emails, and some of the emails cannot be sent successfully, the task will send the sendable emails first.

The administrator can view the list of unsuccessful users in Task Schedule>Run Monitoring> DetailsAs shown below:

For more precautions, error reports and solutions for e-mail notification of task schedule, please refer to: Common Issues of Task Schedule  .

24.png

Attachment List


Theme: Decision-making Platform
Already the First
Already the Last
  • Helpful
  • Not helpful
  • Only read

Doc Feedback