背景信息

Quick BI 全新推出了安全增強的嵌入分析方案，簡稱Ticket智能問數(shù)嵌入方案，當(dāng)使用 Quick BI 專業(yè)版時，可實現(xiàn)鏈接、訪問、問數(shù)等多場景一站式安全管控，幫助您低成本與企業(yè)業(yè)務(wù)系統(tǒng)集成，高效構(gòu)建自有品牌特色的數(shù)據(jù)產(chǎn)品。

使用限制

僅專業(yè)版支持智能問數(shù)嵌入。

注意事項

需要購買智能問數(shù)、Ticket嵌入模塊。

步驟1：新增智能問數(shù)嵌入

您可以使用以下方式新增智能問數(shù)嵌入：

1. 在 Quick BI 產(chǎn)品首頁，按照下圖指引，進(jìn)入組織管理-智能問數(shù)-嵌入管理頁面。

2. 單擊新增嵌入模塊，并進(jìn)行以下配置。

   

   說明

   當(dāng)前僅支持1個嵌入模塊。

   類別	配置項	說明
   基礎(chǔ)配置	嵌入模塊名稱	該名稱作為該模塊的標(biāo)識符，創(chuàng)建后無法更改。
   	嵌入模塊類型	默認(rèn)為智能問數(shù)，不支持修改。
   	數(shù)據(jù)范圍	支持按問數(shù)資源或按分析主題選擇數(shù)據(jù)范圍。 按問數(shù)資源 按分析主題
   自定義配置	模塊名稱	支持自定義模塊名稱，限制20字以內(nèi)。 例如模塊名稱填寫“銷售運營機器人”，配置效果如下：
   	機器人昵稱	支持自定義機器人昵稱，限制10字以內(nèi)。 問數(shù)對話的時候，會顯示機器人昵稱，例如填寫“小Q”，配置效果如下：
   	機器人Logo	支持使用素材或上傳自定義圖片。 說明 機器人Logo展示在智能問數(shù)區(qū)域，自定義圖片尺寸為：48*48以內(nèi)，支持PNG、JPG格式，大小200K以內(nèi)。 例如使用素材，配置效果如下：

3. 單擊確定并調(diào)試嵌入代碼，在調(diào)試嵌入代碼對話框，進(jìn)行以下配置。

   

   配置項	說明
   Ticket鏈接	您可以手動輸入Ticket鏈接或者單擊快捷生成，生成Ticket。 在生成Ticket的界面，您可以設(shè)置綁定用戶、有效時長和訪問次數(shù)。 綁定用戶：嵌入的報表權(quán)限支持選擇綁定某一個用戶的權(quán)限。 有效時長：默認(rèn)過期時間為240分鐘，支持自定義傳失效時間，最大不超過240分鐘。 訪問次數(shù)：若輸入1，表示生成的鏈接僅支持被訪問1次。默認(rèn)為1，最大支持輸入9999次。
   獲取嵌入代碼	支持生成URL鏈接和Iframe代碼。

4. 單擊復(fù)制。

步驟2：通過API接口生成AccessTicket票據(jù)

1. 調(diào)用create4Copilot接口生成報表嵌入需要使用的Ticket。

   生成accessTicket的各項參數(shù)說明如下：

   參數(shù)名稱	類型	描述
   CopilotId	String	開通嵌入的智能問數(shù)模塊 ID。
   TicketNum	Integer	Ticket的票據(jù)數(shù)量。 默認(rèn)值為1。 建議值為1。 最大值為99999。 每次使用票據(jù)訪問后，Ticket的票據(jù)數(shù)量減1。
   UserId	String	Quick BI 的UserId，非您的阿里云賬號ID。 您可以調(diào)用 QueryUserInfoByAccount 接口，獲取 UserId。UserId 樣例為fe67f61a35a94b7da1a34ba174a7****。 說明 UserId和AccountName只填一個即可，不填時默認(rèn)開啟問數(shù)嵌入的Owner。
   AccountName	String	用戶的賬號名稱。 如果用戶是阿里云主賬號wangwu，格式為[主賬號]，例如wangwu。 如果用戶是RAM賬號zhangsan**@aliyun.cn，格式為[主賬號：子賬號]，例如wangwu:zhangsan**。 說明 UserId和AccountName只填一個即可，不填時默認(rèn)開啟問數(shù)嵌入的Owner。
   AccountType	Integer	用戶的賬號類型。 1：阿里云賬號 3：Quick BI 自建賬號 4：釘釘 5：RAM子賬號 9：企業(yè)微信 10：飛書 說明 若AccountName不為空時，則AccountType也不能為空。
   ExpireTime	Integer	過期時間。 單位：分鐘 默認(rèn)值：240

   說明

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

2. 生成AccessTicket。

   示例代碼請參見生成智能小Q嵌入Ticket。

   返回結(jié)果示例如下：

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

   說明

   result 即為此次 API 調(diào)用生成的 AccessTicket，AccessTicket 為fd138bcb-****-4fde-b413-81bcee59bdb6。

步驟3：拼接免登URL

• 拼接流程及示例見下表：

  流程	智能問數(shù)模塊示例
  1.獲取 Quick BI 域名	bi.aliyun.com
  2.獲取智能問數(shù)嵌入 URL	token3rd/copilot
  3.獲取智能問數(shù)模塊 ID	dd0****83f
  4.獲取 AccessTicket	fd138bcb-****-4fde-b413-81bcee59bdb6

• 拼接格式及智能問數(shù)URL如下：

  拼接格式為：https://<Quick BI域名>/<智能問數(shù)嵌入 URL>?copilotId=<智能問數(shù)模塊 ID>&accessTicket=<AccessTicket>

  則生成的URL為：https://bi.aliyun.com/token3rd/copilot?copilotId=dd0****83f&accessTicket=fd138bcb-****-4fde-b413-81bcee59bdb6

• 嵌入顯示

  • 若按問數(shù)資源嵌入了數(shù)據(jù)集或按分析主題嵌入了1個分析主題，嵌入界面平鋪展示有權(quán)限的全部數(shù)據(jù)集。

    

  • 若按分析主題嵌入了多個分析主題，嵌入界面展示全部和各分析主題下的數(shù)據(jù)集。

    

嵌入管理

在嵌入管理列表頁，您可以對已有的嵌入模塊進(jìn)行編輯（①）、調(diào)試（②）和關(guān)閉（③）。

• 單擊圖標(biāo)，編輯嵌入模塊。

  說明

  嵌入模塊名稱不允許編輯。

  

  編輯完成后單擊確定返回到嵌入管理列表頁，或者單擊確定并調(diào)試嵌入代碼進(jìn)入調(diào)試嵌入代碼界面。

• 單擊圖標(biāo)，調(diào)試嵌入代碼。

  

• 單擊圖標(biāo)，在彈出的二次確認(rèn)框中單擊確定，關(guān)閉嵌入模塊。