All Products
Search
Document Center

Quick BI:Create a Subscription Task

Last Updated:Dec 11, 2024

This topic describes how to create a subscription task and push the subscription task by email.

Background information

The subscription and push feature of Quick BI allows you to create a subscription task to periodically send snapshots of dashboards or workbooks or send dashboards or workbooks as attachments to specific recipients. When you create a subscription task, you can configure the sending frequency and notification method. This feature is available only in Quick BI Pro and Quick BI Enterprise Standard.

Procedure

  1. Log on to the Quick BI console.

  2. In the top navigation bar, click 应用Subscriptions.

    image

  3. On the Subscription Task tab of the Subscriptions page, click + Create Subscription Task.

    image

  4. On the Create Task page, configure the parameters. The following table describes the parameters.

    image

    Create a subscription task

    Name

    Description

    Name of Subscription Task

    The name of a subscription task. In this example, the name of the subscription task is Daily Financial Report.

    Subscription Task Title

    Set the title of the subscription task.

    Title Suffix

    Specify whether to display the time on the title of the subscription task.

    The display time can be accurate to the month, day, or hour. The time here is relative time.

    image

    Header

    The beginning of the body of data to which you subscribe.

    Supports setting the font size, bold, oblique, underscores, font color, background color, alignment, and line spacing of text, and supports inserting links.

    image

    Description

    You can select a workspace and a dashboard or a workbook. You can select Dashboards or Workbooks.

    When you select Dashboard, you can select All Items Content or Partial Content to subscribe to a dashboard.

    • All Items Content: If you select All, all the widgets in the dashboard are selected by default.

    • Partial Content: If you select Partial Content, you can select a widget as needed.

      image.png

    Note

    You can use global parameters to dynamically control the result of a subscription. For more information about how to configure global parameters, see Configure Global Variables.

    image

    Footer

    The footer of the body of data to which you subscribe.

    You can set the font size, bold, Italic, underline, font color, background color, horizontal align, and row spacing, and insert links.

    image

    Owner

    By default, the owner of the change tracking task is displayed as the owner of the change tracking task. If you want to change the owner of the change tracking task, you can change the owner of the change tracking task. For more information, see Change the owner of the change tracking task.

    Content, Screenshot Type, and Attachment Type

    • Content: supports Screenshot, Report Link, and Data Attachment.

      Note

      You can send data attachments only when you select Mail for Notification Method, the workbooks that you want to attach can be downloaded, and you have the Export permission on the workbooks. For more information about the export feature, see Configure the export feature. For more information about the Export permission, see Grant users the permissions on reports.

    • Screenshot Type: If you select Snapshot for Dashboard, you can set the snapshot format to JPEG or PNG and set the pixel ratio to 1x or 2x.

      image.png

    • Attachment Type: the type of the data attachment that you want to send. Valid values: Excel and PDF.

      Note

      This parameter is available only when the values of Content include Data Attachment.

      • If the content to be sent is a dashboard and the attachment type contains Excel, you can select a specific chart as the data attachment.

        image.png

      • If the attachment type contains PDF, you can set Screenshot Direction to Vertical or Horizontal.

        When there are a large number of rows in the workbook or dashboard chart data, we recommend that you use vertical screenshots. When there are a large number of columns, we recommend that you use horizontal screenshots.

        image.png

    Screenshot Width

    The resolution of screenshots.

    • When the embedded content is a dashboard, the default width of the PC side is 1920 pixels, and the default width of the mobile side is 375 pixels.

    • If the embedded content is a workbook, the default width on the PC is 1920 pixels. You can customize the image resolution on the mobile terminal based on the data columns of the workbook.

    Sent At

    The time when the subscription task is triggered to send data. For example, you can select Every Day from the Sent At drop-down list and specify 17:00 to allow data to be sent at 17:00 every day.

    Notification Method

    Mail and Custom Channels are supported.

    Recipients

    Set the method to Email.

    • You can select multiple recipients. The recipients that you select must use Alibaba Cloud accounts in the same organization.

      Note

      If an account name is dimmed, it means that the account does not have an email address. Make sure that every recipient has an email address.

    • You can specify the email that you want to use to receive the subscribed data of the subscription task in the Personal dialog box. Procedure:

      1. Move the pointer over your profile picture in the upper-right corner.

      2. Select Account Settings and Management from the drop-down list.

        On the Bind Account page of the Account Settings and Management page, bind the email address that is used to receive the change tracking task. image

    Select Custom Channel.

    • Receiving channel

      Select a custom channel. For more information, see Create a custom channel. image.png

    • Push to Personal

      • You can select multiple recipients at a time, and the recipients can only be Alibaba Cloud accounts under the same organization.

    • Push to Group

      • Enter the parameters in the custom channel. image

    Advanced Settings

    If you set the Receive By parameter to Email, you can configure the following parameters in the Advanced Settings section:

    • Start Date: the date when the subscription task takes effect.

    • Send Screenshot: the size of screenshots in emails may be excessively large. If you turn on this switch, the large-size screenshots are compressed into multiple small-size screenshots before the screenshots are sent, and are decompressed after the screenshots are received. This way, the recipients can receive clear screenshots.

    • Picture Width in Email: the width of screenshots. If the width of screenshots that are sent by using emails does not adapt to the client, you can set the width of the screenshots in emails.

    • Email: You can select System Default Settings or Custom.

      If you select Custom, you must configure the following parameters:

      • Email and Password: the account and password of the email that receives the subscribed data of the subscription task.

      • Sent From and Port: the Simple Mail Transfer Protocol (SMTP) address and port number of the email server that receives the subscribed data of the subscription task.

      • Email Protocol: You can select SMTP or SMTPS.

      • Encryption Method: You can select No Encryption, SSL, or STARTTLS.

      • If you set the Verification Method parameter to Logon Verification, you must enter the email address, Password, and Nickname. If you set the parameter to No Verification, you do not need to enter the password.

      自定义邮箱411

      Note

      The Send Screenshot and Email parameters are available only when you set Notification Method to Mail.

    If you set the Receive Method parameter to Custom Channel, you can configure the following parameters in the Advanced Settings section:

    • Start Date: the date when the subscription task takes effect.

    • Backend parameters: You can configure custom parameters such as parameter names and values. You can add up to five parameters. image

  5. Click OK.

What to do next

After the creation, you can manage subscription tasks and view the sending records of the subscription tasks. For more information, see Manage Subscription tasks.