Quick BI：報表嵌入資料許可權控制和傳參的安全增強方案

背景資訊

Quick BI全新推出了安全增強嵌入分析方案，簡稱Ticket報表嵌入方案，當使用Quick BI專業版時，可實現連結、訪問、看數等多情境一站式安全管控，協助您低成本與企業業務系統整合，高效構建自有品牌特色的資料產品。

注意事項

使用Ticket報表嵌入方案，需要關注以下幾點：

• 目前僅支援將儀表板、試算表、資料大屏、自助取數、即席分析和資料填報的報表嵌入到其他系統。

• 若您需要試用全域參數能力，請聯絡Quick BI營運負責人。

• Quick BI專業版支援增強方案，進階版僅支援基礎方案。

  基礎方案和增強方案的能力項有所不同，具體請參見下表：

  能力項	基礎方案	增強方案
  綁定使用者	報表owner，且不可修改	支援自訂，千人千面
  訪問次數	每個Ticket最多10萬次	不限量，支援自訂設定
  浮水印	不支援	支援 （大屏本身不支援浮水印除外）
  有效時間長度	最大 240 分鐘	支援自訂
  全域參數	不支援	支援
  區塊嵌入	不支援	支援
  跳轉次數 說明 被跳轉的報表也需要開通嵌入。	僅可跳轉一次 例如：A報表跳轉到B報表後，B報表無法再跳轉到C報表。	支援跳轉任意次數 例如：A報表跳轉到B報表後，B報表還能跳轉到C報表，C也能再繼續往後跳轉，以此類推。

步驟1：開通需要嵌入的報表

僅當報表是發布狀態時，才支援設定報表嵌入功能。

步驟2：通過API介面產生AccessTicket票據

1. 調用CreateTicket介面產生報表嵌入需要使用的Ticket。

   產生accessTicket的各項參數說明如下：

   參數名稱	類型	描述
   WorksId	String	開通嵌入的報表ID。 目前支援儀表板、試算表、資料大屏、自助取數、即席分析和資料填報。
   CmptId	String	組件ID。為以上報表中某個組件的ID。 擷取組件ID調用的介面請參見QueryWorksBloodRelationship。
   TicketNum	Integer	Ticket的票據數量。 預設值為1。 建議值為1。 最大值為99999。 每次使用票據訪問後，Ticket的票據數量減1。
   UserId	String	Quick BI的UserId，非您的阿里雲帳號ID。 您可以調用QueryUserInfoByAccount介面，擷取UserId。UserId範例為fe67f61a35a94b7da1a34ba174a7****。 說明 UserId和AccountName只填一個即可，不填時預設綁定報表的Owner。若您需要配置資料行級許可權，請參見附1：配置資料行級許可權。
   AccountName	String	使用者的帳號名稱。 如果使用者是阿里雲主帳號wangwu，格式為[主帳號]，例如wangwu。 如果使用者是RAM帳號zhangsan**@aliyun.cn，格式為[主帳號：子帳號]，例如wangwu:zhangsan**。 說明 UserId和AccountName只填一個即可，不填時預設綁定報表的Owner。若您需要配置資料行級許可權，請參見附1：配置資料行級許可權。
   AccountType	Integer	使用者的帳號類型。 1：阿里雲帳號 3：Quick BI自建帳號 5：RAM子帳號 說明 若AccountName不為空白時，則AccountType也不可為空。
   ExpireTime	Integer	到期時間。 單位：分鐘 預設值：240（該值為頁面調試的上限數值，可通過介面自訂，最大上限是integer欄位類型的最大取值）
   WatermarkParam	String	報表的浮水印參數。 不得超過50個字元。
   GlobalParam	String	報表過濾條件的全域參數。 格式為JSON格式的字串。 說明 若您需要使用全域參數能力，請聯絡Quick BI營運負責人。

   說明

   • 連結防分享控制：TicketNum的取值建議為1，表示產生的第三方嵌入連結僅被訪問一次。

   • 報表嵌入時，支援綁定浮水印參數WatermarkParam。

2. 產生AccessTicket。

   範例程式碼請參見SDK樣本。

   返回結果樣本如下：

   {
     "requestId" : "7D784AB0-5B77-077E-B628-E782B58D3898",
     "result" : "fd138bcb-****-4fde-b413-81bcee59bdb6",
     "success" : true
   }

   說明

   result即為此次API調用產生的AccessTicket，AccessTicket為fd138bcb-****-4fde-b413-81bcee59bdb6。

步驟3：拼接免登URL

https://bi-cn-hongkong.data.aliyun.com/token3rd/report/view.htm?id=<42****18ef6>&accessTicket=fd138bcb-****-4fde-b413-81bcee59bdb6&cmptId=XXX

1. 擷取Quick BI網域名稱。

   例如，Quick BI 中國香港網站網域名稱為bi-cn-hongkong.data.aliyun.com，以具體環境網域名稱為準。

2. 擷取預覽報表URL。

   報表對應的預覽頁面URL如下，您可以根據需要選擇。

   • 儀表板：token3rd/dashboard/view/pc.htm

   • 試算表：token3rd/report/view.htm

   • 資料大屏：token3rd/screen/view/pc.htm

   • 自助取數：token3rd/offline/view/pc.htm

   • 即席分析：token3rd/analysis/view/pc.htm

   • 資料填報：token3rd/dataform/view.htm

3. 在報表編輯頁面，擷取報表ID。

   • 儀表板ID，本例為d01****c5f

     在儀表板編輯頁面，擷取地址欄中儀表板pageId的值。

     

   • 試算表ID，本例為d0****3ba88

     在試算表編輯頁面，擷取地址欄中試算表ID的值。

   • 資料大屏ID，本例為3c****26b

     在資料大屏編輯頁面，擷取地址欄中資料大屏pageId的值。

     

   • 自助取數ID，本例為b2****47

     在自助取數編輯頁面，擷取地址欄中自助取數pageId的值。

     

   • 即席分析ID，本例為7f****da

     在即席分析編輯頁面，擷取地址欄中即席分析pageId的值。

     

   • 資料填報ID，本例為29****53

     在資料填報編輯頁面，擷取地址欄中資料填報pageId的值。

     

4. 將上述步驟擷取的Quick BI網域名稱、預覽報表URL、報表ID和步驟2 擷取AccessTicket參數拼接到如下請求地址中。

   • 儀表板的拼接格式https://<Quick BI網域名稱>/<預覽報表URL>?pageId=<報表ID>&accessTicket=<AccessTicket>

   • 試算表的拼接格式https://<Quick BI網域名稱>/<預覽報表URL>?id=<報表ID>&accessTicket=<AccessTicket>

   • 資料大屏的拼接格式https://<Quick BI網域名稱>/<預覽報表URL>?pageId=<報表ID>&accessTicket=<AccessTicket>

   • 自助取數的拼接格式https://<Quick BI網域名稱>/<預覽報表URL>?pageId=<報表ID>&accessTicket=<AccessTicket>

   • 即席分析的拼接格式https://<Quick BI網域名稱>/<預覽報表URL>?id=<報表ID>&accessTicket=<AccessTicket

   • 資料填報的拼接格式https://<Quick BI網域名稱>/<預覽報表URL>?id=<報表ID>&accessTicket=<AccessTicket>

附1：配置資料行級許可權

若UserId和accountName不填時，嵌入報表的查看許可權預設跟隨報表Owner。您可以按照下圖指引，配置資料行級許可權，並設定UserId或AccountName參數，繫結目標使用者的許可權。詳情操作請參見行列許可權。

附2：產生全域參數說明

在目標儀表板或試算表中設定對應的全域參數，全域參數用於綁定報表並產生AccessTicket。

[
  {
    "paramKey": "price", // 全域參數 Key
    "joinType": "and",   // 串連方式，使用 and 即可
    "conditionList": [
      {
        "operate": "=", // 操作符，參考以下說明
        "value": "1"    // 操作值，在多個值的情況下使用數組 ["1", "2"]
      },
      {
        "operate": "=", // 操作符，參考以下說明
        "value": "2"    // 操作值，在多個值的情況下使用數組 ["1", "2"]
      }
    ]
  },
  {
    "paramKey": "area", // 全域參數 Key
    "joinType": "and",   // 串連方式，使用 and 即可
    "conditionList": [
      {
        "operate": "in",          // 操作符
        "value": ["華北","華南"]    // 操作值，在多個值的情況下使用數組
      }
    ]
  }
]

附3：可嵌入報表數量說明