All Products
Search

This Product

    Dataphin:Create and manage workbooks

    Document Center

    Dataphin:Create and manage workbooks

    Last Updated:Jun 17, 2026

    You can create and manage Quick BI workbooks in the workbook consumption channel to view your published analytical work.

    Prerequisites

    • You have purchased the value-added service for asset consumption and enabled the asset consumption module for the current tenant.

    • Before you use the workbook feature, you must initialize the consumption channel. For more information, see Create and manage consumption channels.

    Limits

    • To consume a table in the BI channel, the data source's cluster must be connected to the Dataphin cluster network.

    • You cannot create Quick BI analysis tasks if the data source is Hive on CDH 5.x (Hive 1.1.0) or MySQL 5.1.43.

    • If full table scan is disabled in Dataphin, you must enable it for analysis tasks when you create a Dataphin data source in Quick BI. This prevents SQL runtime errors. Use the following statement: set oneservice.allow.full.scan=true.

    • Only on-premises deployments of Quick BI V5.5.1_feature_2509 support data tables from AnalyticDB for PostgreSQL.

    Create a workbook

    1. On the Dataphin home page, choose Asset > Asset Consumption from the top menu bar.

    2. In the navigation pane on the left, choose Consumption > My BI Analysis. On the My BI Analysis page, click the Quick BI Workbook tab, and then click Create Workbook. The Create Quick BI Analysis dialog box appears.

    3. In the Create Quick BI Analysis dialog box, configure the parameters.

      Parameter

      Description

      Analysis Task Type

      Click Expand Details for more information.

      Associated Asset

      Select the table assets for which to create analysis tasks. You can search for an asset by name or filter by source. You can select multiple assets.

      Workspace

      If the selected consumption channel has a default workspace and you have management permission for it, the system automatically populates this field. Otherwise, select a workspace for which you have management permission. To create a workspace, see Create and Manage Workspaces.

      Dataset

      If a dataset exists for the selected asset in the workspace, its name is displayed. Otherwise, a dataset is automatically created before the analysis task is created. You can specify a name for the new dataset.

    4. Click OK to validate the configuration.

    5. After the configuration is validated, the system creates the required data source, dataset, and Quick BI workbook. You are then automatically redirected to the workbook creation page on the Quick BI platform for further configuration. For more information, see Create a Workbook.

    View workbooks

    1. The Quick BI Workbook tab lists the analytical work that you own and have published. This tab provides a unified view and quick access to your work, and displays the workbook name, publishing status, and BI workspace information.

    2. You can search for analytical work by name or filter the list by publishing status or workspace.

    3. The Actions column provides the following operations:

      Feature

      Description

      View

      Click to go to the Quick BI platform to view the workbook task. For more information, see Workbooks.

      Edit

      Click to go to the Quick BI platform, where you can modify the workbook's fields, page configuration, and more. For more information, see Manage Workbooks.