Report Subscription Plugin

  • Last update:June 19, 2025
  • Overview

    Version

    FineBI Version
    JAR PackagePlugin Version
    6.06

                 2022-12-28

                    5.0.6

    Application Scenario

    • For report users: They want to select which report to be pushed by themselves. When they find the content they are interested in or have work-related needs during report preview, they want to quickly subscribe to the report and receive automatic report push, without having to feed back this report to administrators for push configuration. When they do not need this report to be pushed, they can quickly unsubscribe from this report, without asking report administrators for canceling report push.

    • For report developers: They want to offload some routine report push tasks onto users.

    Function Description

    This plugin supports the following main functions:

    • You can add subscription configurations on the dashboard preview page.

    • Subscription messages can be pushed to terminals, including email boxes, native apps, WeCom, and DingTalk.

        To push subscription messages to email boxes, you can select platform users, departments, roles, and custom email addresses for notification.

        报表订阅插件 图1.png

    • Subscription message push types include report snapshot links and attachments (PDF/Excel 07). Subscription attachment files can be uploaded to an SFTP server.

    iconNote:
    If this plugin is upgraded from 5.2.0 or 5.2.2 to 5.2.5 or later versions, closed subscription tasks will turn to be open ones. In this case, close these subscription tasks before saving. For other upgrade situations, you do not need to pay attention to this issue.

    Plugin Introduction

    Plugin Installation

    You can contact our technical support to obtain the plugin.

    For details about how to install the plugin on the server, see Plugin Management.

    Function Page

    For dashboards configured with the subscription function, users can add subscriptions or manage subscriptions, as shown in the following figure.

    报表订阅插件 图2.png

    Template Subscription

    Prerequisite

    1. To push subscription messages to WeCom:

    First, you have completed WeCom integration. You also have configured the WeCom push app under System Management > Report Subscription > Setting, as shown in the following figure.

    You are advised to use the WeChat management plugin of V10.4.977 or later versions.

    报表订阅插件 图3.png

    2. To push subscription messages to DingTalk:

    First, you have completed DingTalk integration. You also have configured the DingTalk push app under System Management > Report Subscription > Setting, as shown in the following figure.

    You are advised to use the DingTalk management plugin of V10.4.977 or later versions.

    报表订阅插件 图4.png

    3. Currently, subscribed snapshots pushed to mobile terminals cannot be previewed via H5.

    4. Currently, only the nginx ip_hash configuration is supported in cluster environments.

    5. To allow subscribed attachment files to be uploaded to an SFTP server, you have completed the FTP configuration.

    Subscription by Users

    iconNote:

    The subscription function requires the user information in FineBI. Therefore, you must log in to FineBI before subscription.

    Without logging in to FineBI, you are automatically redirected to the login page of FineBI after clicking the subscription button.

    The subscription button appears in the upper right corner of the dashboard. Click Subscribe to open the subscription setting page.

    报表订阅插件 图5.png

    The following table lists subscription settings.

    Setting ItemDescription
    Subscription Switch

    Running status of the subscription task

    Subscription Name

    Title of the subscription push

    Parameter Setting

    Parameter used when the subscription task is executed

    Filter widget types support time filter components, text filter components, and value filter components.

    1. This setting supports filter scenarios where the same dataset or model-associated dataset is used in filter components and table/chart components.

    2. This setting does not support filter scenarios where unassociated dataset parameters are used for filtering. (For example, the parameter is added in the template, and bound to filter components where unassociated datasets or custom value lists are used.)

    3. This parameter cannot be a parameter from direct-connected SQL datasets.

    Start Time

    Subscription start time

    Execution Time

    Execution time of the subscription task

    Notification Frequency

    Subscription push date/cron expression

    Notification Method

    1. Email Notification

    To use Email Notification, the mailbox service must be configured first.

    To use Email Notification, ensure that the user's information includes a bound email address. Otherwise, the user cannot receive emails.

    2. App Notification

    3. DingTalk Notification

    To use DingTalk Notification, ensure that DingTalk integration has been completed in FineBI.

    To use DingTalk Notification, ensure that the current user's FineBI account has been bound to the DingTalk account.

    4. WeChat Notification

    To use WeChat Notification, ensure that WeCom integration has been completed in FineBI.

    To use WeChat Notification, ensure that the current user's FineBI account has been bound to the WeCom account.

    Notification Attachment

    Whether to generate attachments during subscription push

    Subscription Push Effect Preview

    Email Notification

    报表订阅插件 图6.png

    Unsubscription

    Users can unsubscribe from a single dashboard.

    Access a subscribed dashboard, click Subscription in the upper right corner, and select Unsubscribe from the drop-down list, as shown in the following figure.

    报表订阅插件 图7.png

    Subscription Management by Users

    Users can manage (quickly modify subscription and unsubscribe from) the templates subscribed by themselves.

    报表订阅插件 图8.png

    Assignment of Use Permissions

    To enable users to manage subscriptions, administrators must first assign use permissions on the report subscription node to the users.

    Log in to FineBI as the admin, choose System Management > Permission Management > Global Setting, enable Hierarchical Authorization, and click Save, as shown in the following figure.

    报表订阅插件 图9.png

    Log in to FineBI as the admin, choose System Management > Permission Management > Common Permission Configuration, and select the department, role, or user as the permission carrier. In this example, select user eoco.

    Click the System Management tab and configure the Authorization permission on Report Subscription for eoco, as shown in the following figure.

    报表订阅插件 图10.png

    Subscription Management

    After users log in to FineBI, they can view Management and Surveillance under System Management > Report Subscription, as shown in the following figure.

    iconNote:
    The Setting function is only available to super administrators, and is unavailable to sub administrators.

    报表订阅插件 图11.png

    附件列表


    主题: Creating a Dashboard
    Previous
    Next
    • 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