Notification

  • Last update: August 29, 2024
  • Overview 

    Version 

    FineDataLink Version

    Functional Change

    3.6.1

    Added a Notification node, which allowed notifying specified users of the task scheduling result via the WeCom chatbot.

    4.0.1

    Allowed notifying specified users of the task scheduling results via emails.

    4.0.3

    Added notification channels including SMSWeCom App NotificationDingTalk App Notification, and DingTalk Chatbot to the Notification node.

    4.0.28
    • Supported Lark notification.

    • Allowed configuring notification objects based on the platform system for SMS and Email notification, with optional objects including platform users, departments, and roles. Ultimate objects would be the union of the selected.

    • Masked SMS templates unrelated to FineDataLink.

    • Allowed using multiple notification channels for a task.

    4.1.5.5

    Disabled the notification frequency limit by default

    Application Scenario 

    The Notification node can be used in the following scenarios:

    • You want to notify specified users by email/SMS/WeCom App notification/WeCom group robot message/DingTalk App notification/DingTalk group robot message/Lark App notification/Lark group robot message.

    • You want the notification content to include calculated values and parameter values generated during the task execution besides the task execution status and want to customize notification content as needed.

    • You want notifications to be triggered not only at the end of a task but also upon the successful completion of specific steps in a step flow or when data anomalies are detected. 

    Function Description 

    Notification can be used to notify specified users of the task scheduling results via Email/SMS/WeCom App Notification/WeCom Chatbot/DingTalk App Notification/DingTalk Chatbot/Lark App Notification/Lark Chatbot. It also supports the push of specified data during task execution.

    Usage Instruction 

    1. You can add multiple notification channels in a Notification node, but the maximum number of characters that can be sent is subject to the channel character limit.

    In versions before 4.1.5.5, the notification issued by the same node can only be triggered once every 10 s and longer. Otherwise, an error occurs.

    For instance, if a notification node A was triggered at 10:00:00, any subsequent triggers between 10:00:00 and 10:00:09.999 would result in an error.

    To ensure this node functions normally in such cases, you can add an SQL Script node before it and use a SLEEP function, as shown in the following figure.

    iconNote:
    The database syntax varies. In MySQL, sleep(10) delays the execution for 10 s. In 4.1.5.5 and later versions, the notification frequency limit is disabled by default.


    Function Description 

    Email 

    The setting page is shown in the following figure.

    The following table describes specific settings.

    Setting ItemIntroduction

    Platform User Group

    You can select platform users, departments, and roles as the notification objects. The ultimate objects are a union of the selected.

    Sender

    You can choose from the list of senders configured on the platform. The value defaults to the default sender.

    If no senders are configured on the platform, the dropdown list will be empty. For details about configuring the sender, see Email.

    Notification Object

    1. Platform User Group:

    • This option can only be selected when User/Dept./Role has been set in Platform User Group. Otherwise, it is grayed out and unselectable.

    • If User/Dept./Role has been set in Platform User Group, select this option. 

    • Users bound to no email address cannot receive notification emails.

    2. Custom Recipient:

    You can customize recipients by entering email addresses. Separate multiple addresses by commas (,). Referencing parameters is supported. 

    Carbon Copy/Blind Carbon Copy

    You can select platform users with the email address configured or enter custom email addresses. 

    • Separate multiple addresses by commas (,), for example, a@fanruan.com,b@fanruan.com.

    • Referencing parameter values using ${Parameter} is supported. 

    Subject 

    Enter the email subject.

    Referencing parameter values using ${Parameter} is supported.

    Body

    Enter the email body.

    Referencing parameter values using ${Parameter} is supported.

    SMS 

    The setting page is shown in the following figure.

    Using SMS requires the configuration of the FanRuan passport and the SMS platform on the platform.

    • Without the FanRuan passport being verified, if you use the SMS channel, a prompt will appear asking you to sign in to get the SMS template and signature.

    • Without the SMS platform being activated, if you use the SMS channel, a prompt will appear, indicating that the SMS has not been activated and asking you to apply for activation. Note: For details about SMS service activation, see SMS

    iconNote:
    If the SMS platform has been configured but not enabled on the platform, you can configure the node, but an error will occur upon notification.


    The following table describes specific settings.

    Setting ItemIntroduction
    Platform User Group

    You can select platform users, departments, and roles as the notification objects. The ultimate objects are a union of the selected.

    Recipient

    1. Platform User Group:

    • This option can only be selected when User/Dept./Role has been set in Platform User Group. Otherwise, it is grayed out and unselectable.

    • If User/Dept./Role has been set in Platform User Group, select this option. 

    • Users bound to no mobile number cannot receive short messages for notification.

    2. Custom Recipient:

    You can customize recipients by entering mobile numbers. Separate multiple mobile numbers by commas (,). Referencing parameters is supported. 

    SMS Signature

    You can select the SMS signature.

    • Available options include the SMS signature of the account bound with the FanRuan passport (with activated SMS) on the platform.

    • It must be set

    SMS Template

    You can select the SMS template, which cannot be edited here.

    In FineDataLink 4.0.28, SMS templates unrelated to FineDataLink are masked.

    SMS Parameter

    You can set the parameter value to be passed to the SMS template. All parameters in the selected SMS template are displayed in the Parameter Name column with their values being empty.

    • Parameter Name: It displays the parameter in the selected SMS template. The parameter name cannot be edited here.

    • Value: You can fill in the parameter value. Referencing parameters is supported. (The content is processed as strings.)

    WeCom App Notification 

    Function Description

    The setting page is shown in the following figure.

    The following table describes specific settings.

    Setting ItemIntroduction
    Platform User Group

    Ignore this item, which is valid for SMS/Email notification only.

    Enterprise ID

    See the WeCom document to obtain the enterprise ID.

    App Secret

    Enter the app secret, which can be viewed on the application management page. See the WeCom document to obtain the app secret.

    AgentID

    Enter the AgentID of the message-issuing account, which can be viewed on the App Management page.

    Receiving Member
    • Specify the message-receiving members by entering the member ID. Separate multiple member IDs with vertical bars (|). You can enter up to 1000 member IDs. You can notify all members by entering @all

    • Referencing parameters is supported.

    Receiving Department
    • Specify the message-receiving department by entering the department ID. Separate multiple department IDs with vertical bars (|). You can enter up to 1000 department IDs.

    • Ignore this item if you set Receiving Member to @all.

    • Referencing parameters is supported.

    Receiving Label

    • Specify the message-receiving labels by entering the label ID. Separate multiple label IDs with vertical bars (|). You can enter up to 1000 label IDs.

    • Ignore this item if you set Receiving Member to @all

    • Referencing parameters is supported.

    Message Type

    Specify the message type, including Text Message and Markdown Message.

    For details about the currently supported Markdown syntax, see the official document.


    Message Content

    Fill in the message content, where referencing parameters is supported.  

    • It cannot be empty.

    • The content of a text message cannot exceed 2048 bytes. The exceeding content will be truncated.

    • The content of a Markdown message cannot exceed 2048 bytes and must be UTF-8 encoded. The exceeding content will be truncated.

    Confidential Message

    Non-confidential messages can be shared.

    Confidential messages are not shareable and the content is watermarked.

    Duplicate Message DetectionIf Duplicate Message Detection is enabled, messages with the same content that are pushed within the detection interval will be automatically ignored.
    Detection Interval (s)

    Specify the interval of detecting duplicate messages in seconds. The default value is 1800. You can enter a value between 1800 and 14400.

    Notes

    1. Each app can send a maximum of 200 notification messages to each member per day.

    iconNote:
    Calling an API to send a message to 1000 members at once counts as 1000 messages. If the maximum number of members of an enterprise account is 500, each app can send up to 100000 messages per day.


    2. Each app can send up to 30 messages per minute to the same member. Any excess will be discarded.

    3. If you select WeCom App Notification but the recipients lack app permission: 

    • No members have permission: The notification node reports an error.

    • Some members have permission: Members with permission are notified, while those without permission are skipped, and their names are printed in the WARN log.

    WeCom Chatbot 

    The setting page is shown in the following figure.

    The following table describes specific settings.

    iconNote:
    Each WeCom chatbot can send up to 20 messages per minute. 


    Setting ItemIntroduction
    Platform User GroupIgnore this item, which is valid for SMS/Email notification only.
    Chatbot

    The Webhook URL of the WeCom chatbot cannot be empty.

    Add a chatbot as shown in the following figure. The Webhook URL is displayed on the prompt page after the chatbot is successfully added.

    Message Type

    Specify the message type, including Text Message and Markdown Message.

    1. The setting page after you select Text Message is shown in the following figure.

    Reminding Method: Select the way of setting the message-receiving group members. Options include User ID and Mobile Number.

    iconNote:
    The user ID is the account ID of the enterprise member. Log in to the WeCom console as the admin and view the account ID under Contacts > Member Details, or log in to the WeCom App as the admin and view the account ID under Workspace > Manage Company > Member and Dept. Management > Edit Member.

    Group Member List: Enter the member ID or the mobile number for targeted notification.

    You can notify multiple group members at the same time by entering member IDs or mobile numbers separated by commas (,), and notify all members by entering @all. Referencing parameters is supported.

    2. The setting page after you select Markdown Message is shown in the following figure.

    Message Content

    Fill in the message content, where referencing parameters is supported. The requirements are as follows:   

    • It cannot be empty.

    • The content of a text message cannot exceed 2048 bytes and must be UTF-8 encoded. The exceeding content will be truncated.

    • The content of a Markdown message cannot exceed 4096 bytes and must be UTF-8 encoded. The exceeding content will be truncated.

    DingTalk App Notification 

    Function Description

    The setting page is shown in the following figure.

    The following table describes specific settings. 

    Setting ItemIntroduction
    Platform User Group

    Ignore this item, which is valid for SMS/Email notification only.

    AppKeyIt is the unique identifier of an app, which can be obtained on the application detail page of the DingTalk developer console.
    AppSecret

    It is the app key, which can be obtained on the application detail page of the DingTalk developer console.

    AgentID

    It is the ID of the microapplication used to send the message.

    • The AgentID of an enterprise application can be obtained on the application detail page of the DingTalk developer console.

    • The AgentID of a third-party application can be obtained by calling the /service/get_auth_info interface. For details, see the corresponding official document.

    Receiving Member  
    • Mobile numbers are not supported. Enter the member ID, and separate multiple member IDs with commas (,). You can enter up to 100 member IDs.

    • You can notify all members by entering @all.

    • Referencing parameters is supported.

    • You can obtain member IDs using mobile numbers through an API. For details, see the corresponding official document.

    • You can view the DingTalk IDs of current employees.



    Receiving Department  

    • You can enter up to 20 department IDs.

    • If you enter a department ID, all members of the department will be notified. Referencing parameters is supported.

    Message Type

    Specify the message type, including Text Message and Markdown Message.

    Message Title

    The Message Title input box is displayed only when Markdown Message is selected. 

    Enter the message title, where referencing parameters is supported. The message title cannot exceed 100 characters, otherwise, an error will occur.

    Message Content

    Fill in the message content, where referencing parameters is supported. It cannot be empty.

    • The content of a text message cannot exceed 500 characters. The exceeding content will be truncated.

    • The content of a Markdown message can not exceed 5000 characters and must be UTF-8 encoded. The exceeding content will be truncated.

    Notes

    1. No error message will be displayed upon notification if the receiving member is incorrectly specified. You need to check and debug the notification (which can be implemented via the notification query API provided by DingTalk).

    2. An enterprise app can send messages to up to 5000 members at a time, while a third-party enterprise app can send messages to up to 1000 members at a time.

    3. Each employee can receive at most one identical notification message per day. 

    4. An enterprise app can send up to 500 messages to each employee per day, while a third-party enterprise app can send up to 100 messages to each employee per day.

    5. A maximum of 5000 members can receive the messages sent by the enterprise app or a third-party enterprise app per minute.

    DingTalk Chatbot 

    Function Description

    The setting page is shown in the following figure.

    The following table describes specific settings.

    Setting ItemIntroduction
    Platform User GroupIgnore this item, which is valid for SMS/Email notification only.
    ChatbotEnter the Webhook URL of the DingTalk chatbot, where referencing parameters is supported. It cannot be empty.
    Message TypeSpecify the message type, including Text Message and Markdown Message.
    Reminding Method

    Select the way of setting the message-receiving group members.

    Group Member List
    • Enter the member ID or the mobile number for targeted notification.

    •  This configuration item is displayed only when Message Type is set to Text Message

    • You can notify multiple group members at the same time by entering member IDs or mobile numbers separated by commas (,). No spaces are needed behind commas.   

    • You can notify all members by entering @all.   

    • Referencing parameters is supported.

    Message Title

    The Message Title input box is displayed only when Markdown Message is selected.

    Enter the message title, where referencing parameters is supported. The message title cannot exceed 100 characters, otherwise, an error will occur.

    Message Content

    Fill in the message content, where referencing parameters is supported.  

    • It cannot be empty.

    • The content of a text message cannot exceed 500 characters. The exceeding content will be truncated.

    • The content of a Markdown message cannot exceed 5000 characters and must be UTF-8 encoded. The exceeding content will be truncated.

    Notes

    1. Each chatbot can send up to 20 messages per minute.

    2. If more than 20 messages are sent, rate limiting will be applied for 10 minutes.

    3. The DingTalk chatbot supports custom keywords and the setting of IP address whitelist for security control. Signature-based encryption is not supported.

    Lark App Notification 

    The setting page is shown in the following figure.

    The following table describes specific settings.

    Setting ItemIntroduction
    Platform User GroupIgnore this item, which is valid for SMS/Email notification only.
    App ID

    Obtain App ID and App Secret under Credentials & Basic Infor > Credentials on the Lark Developer Console page.

    App Secret 
    Receiving Member

    Enter the member ID and separate multiple member IDs with commas (,). Referencing parameters is supported. You can notify all members by entering @all. You can enter up to 200 member IDs. 

    iconNote:

    1. Member ID is Open ID. For details on how to obtain Open ID, see How to Obtain OpenID

    2. The notification will fail if you enter @all and not all members who can view the app have joined the enterprise.

    Receiving Department

    Enter the department ID and separate multiple department IDs with commas (,). Referencing parameters is supported. 

    You can enter up to 200 department IDs. 

    Message Type

    Specify the message type, including Text Message and Markdown Message.

    For the syntax of markdown messages, see Markdown. To send card messages using Lark, you are advised to set the Message Type to Markdown Message.

    Message Title 

    This configuration item is displayed only when Markdown Message is selected. The filled content will be emptied if you switch Markdown Message to Text MessageEnter the message title, where referencing parameters is supported. 

    The message title cannot exceed 100 characters, otherwise, an error will occur.

    Message Content

    Fill in the message content, where referencing parameters is supported.   

    • It cannot be empty.

    • The content of a text message cannot exceed 500 characters. The exceeding content will be truncated.

    • The content of a Markdown message cannot exceed 5000 characters and must be UTF-8 encoded. The exceeding content will be truncated.

    As mentioned in the official document of Lark, the maximum size of the request body of a text message cannot exceed 150 KB and that of a card message or rich text message cannot exceed 30 KB.

    Lark Chatbot 

    The setting page is shown in the following figure.

    The following table describes specific settings.

    Setting ItemIntroduction
    Platform User Group

    Ignore this item, which is valid for SMS/Email notification only.

    Chatbot

    Enter the Webhook URL of the chatbot, where referencing parameters is supported. It cannot be empty.

    For details about the custom chatbot, see Custom Bot Usage Guide.

    Message Type

    Specify the message type, including Text Message and Markdown Message.

    Message TitleThis configuration item is displayed only when Markdown Message is selected. Referencing parameters is supported. The message title cannot exceed 100 characters, otherwise, an error will occur.
    Reminding Method

    Message Type This configuration item is displayed when Text Message is selected. Enter the member ID or the mobile number for targeted notification.  

    iconNote:
    1. Member ID is Open ID. For details on how to obtain Open ID, see How to Obtain OpenID. 2. To use mobile numbers as the reminding method, you need to create an app first. 
    App ID/App Secret

    These configuration items are displayed when you set Reminding Method to Mobile Number.

    Group Member List

    This configuration item is displayed when Text Message is selected.

    • You can notify multiple group members at the same time by entering member IDs or mobile numbers separated by commas (,). No spaces are needed behind commas.

    • You can notify all members by entering @all. Ensure that tagging everyone using the At symbol (@) is enabled for the group.

    • Referencing parameters is supported.

    Message Content

    Enter the message content, which is empty by default.   

    • Referencing parameters is supported.

    • It cannot be empty.

    • The content of a text message cannot exceed 500 characters. The exceeding content will be truncated.

    • The content of a Markdown message cannot exceed 5000 characters and must be UTF-8 encoded. The exceeding content will be truncated.


    Description of Special Scenarios 

    Scenario

    Description

    You have set a platform user as the notification object and also entered the user's mobile number or email address.

    If the mobile number/email address of the selected recipient is the same as the content entered manually, no repeated notification will be given.

    You have set a platform user as the notification object, but the selected user has no mobile number or email address configured.

    You will be prompted.

    Best Practices 

    Illustration

    Description

    Notify the specified responsible person by email.

    Notify multiple people with one notification message.

    Notify one person per message.

    Tasks in the notification message to a certain person are displayed in different colors by urgency. The notification content contains links, and the recipient can click it to jump to the corresponding page.

    Tasks in the message are displayed on different lines.


    附件列表


    主题: Data Development - Scheduled Task
    • Helpful
    • Not helpful
    • Only read

    滑鼠選中內容,快速回饋問題

    滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

    不再提示

    10s後關閉

    Get
    Help
    Online Support
    Professional technical support is provided to quickly help you solve problems.
    Online support is available from 9:00-12:00 and 13:30-17:30 on weekdays.
    Page Feedback
    You can provide suggestions and feedback for the current web page.
    Pre-Sales Consultation
    Business Consultation
    Business: international@fanruan.com
    Support: support@fanruan.com
    Page Feedback
    *Problem Type
    Cannot be empty
    Problem Description
    0/1000
    Cannot be empty

    Submitted successfully

    Network busy