全部產品
Search
文件中心

Quick BI:配置全域參數

更新時間:Jun 30, 2024

Quick BI提供全域參數來設定一些變數,在配置報表時,可以通過引用全域變數的方式支援一些需要參數變化的情境。本文為您介紹跳轉、郵件訂閱和報表嵌入等情境的全域參數配置方法。

背景資訊

在報表的使用過程中,使用者經常有這樣的需求:以一個銷售團隊為例,如果該銷售團隊的業務範圍是全國,那麼意味著該銷售團隊需要隨時掌握30多個省的銷售情況,而且每一個省還有若干個城市,每一個城市還有若干個縣;隨著業務量的不斷增大和擴容,該銷售團隊所要查閱的銷售資料也會日益增加。在如此龐大且複雜的資料中,如果能夠實現每一個地區的負責人只看到自己負責的那份資料,那麼既可以提高相關責任人的工作效率,又可以避免泄露敏感的商業資料。

全域參數是為報表提供一個標準化的入口,允許報表使用者在預覽報表時能夠通過URL參數注入的方式,動態改變報表內部圖表和查詢控制項的過濾條件,從而達到從外部控製圖表內部資料展示結果的效果。全域參數的作用對象目前主要有以下兩種:

  • 查詢控制項:查詢控制項接受到全域參數後,會直接以全域參數注入的條件作為預設值,綁定到某個具體的子組件上。

    說明

    實際作用的圖表還需要依賴於對應子組件選擇的作用範圍。因為只是改變了預設值,所以其實報表使用者可以改變子組件的實際值來脫離全域參數的控制。

  • 圖表:全域參數關聯到的圖表,本質上是在圖表最後的查詢SQL上拼接and片段(例如and area = '華北'),這個過程是伺服器直接解析全域參數配置產生的,因此報表使用者無法更改這個結果,只能通過最終產生的sqlText來驗證資料結果。

全域參數配置說明

全域參數配置的入口位於報表頂部。建立報表時,全域參數表徵圖image.png會被隱藏起來,只有儲存後才會展示。全域參數配置頁面如下所示。

image

地區

描述

全域參數配置入口。

全域參數配置依賴於報表內部的組件資料模型,建議在每次更新完圖表模型後重新設定全域參數。

設定全域參數名稱。命名規則如下:

  • 長度不能超過50個字元。

  • 僅支援英文、數字和底線。

您可以單擊建立表徵圖,建立多個全域參數。

選擇參數關聯控制項與圖表。

  • 當關聯對象為查詢控制項時,需要選擇一個查詢控制項內的關聯條件。查詢控制項關聯條件的展示類型,會限制後續全域參數接收實值型別範圍(比如無法將文本類型或者單日期格式的全域參數注入到日期區間類型的組件中),如果查詢控制項關聯條件的展示類型有衝突,全域參數則無法正常儲存。

  • 當關聯對象為圖表時,系統會將圖表按照資料集進行分類,選擇資料集中的某個欄位並選中靶心圖表表時,全域參數注入的條件會自動填滿到被選中圖表的SQL查詢中。當選中多個資料集的欄位時,選中欄位的類型和粒度(年、月、日、時、分、秒)必須保持一致,否則參數配置失敗。

  • 如果同時關聯查詢控制項圖表時,要求查詢控制項的關聯條件類型必須和圖表資料集的欄位類型一致,並且因為查詢控制項的關聯條件限制了輸入值的模型,因此在注入全域參數時,應該盡量滿足查詢控制項的關聯條件的注入要求,才能保證查詢控制項和圖表同時生效。

說明

為了保證參數注入的準確性和有效性,實際使用中應該盡量確保每個參數的職責是明確和單一的,謹慎將一個全域參數關聯到多個查詢控制項,或者混合使用查詢控制項和資料集,如實際業務需要,建議添加多個參數分別控制不同的查詢控制項和圖表。

欄位選擇:

  • 查詢控制項以及圖表欄位選擇類型支援時間(暫不支援時分秒)、文本(包括地理、url)、數實值型別,預留位置。

    預留位置配置方式請參見預留位置image

參數設定。

  • 參數名稱:預設與設定的全域參數名稱一致。命名規則如下:

    • 長度不能超過50個字元。

    • 僅支援英文、數字和底線。

    說明

    參數名稱未填寫或參數配置出現衝突時,頁面會提示報錯,此時全域參數無法儲存。

  • 參數別名:如果需要中文資訊提示,可在此處設定。

  • 是否必須設定:選中後,查詢控制項和圖表會去檢測相應的參數是否有注入值,如果沒有注入值,查詢控制項會優先使用編輯狀態設定的預設值,圖表則會取數失敗(全域參數不可為空)。

  • 是否允許查詢控制項變更輸入值:選中後,對應參數關聯的子條件在預覽狀態下預設鎖定,即無法變更查詢控制項子條件的操作符和值。

說明
  • 為了保證參數的有效性,全域參數的配置過程中是即時檢測的,一個參數出現衝突時,所有全域參數都無法儲存。

  • 全域參數配置的過程依賴當前報表的內容,報表出現變更可能會導致已經配置的全域參數注入失效,因此建議每次報表變更後複查全域參數的配置是否有效。如果全域參數的配置出現衝突時,請根據提示調整對應參數的內容。

全域參數使用情境

跳轉情境

以熱門排行榜(訂單資訊)跳轉交叉表(商品資訊)為例。

  1. 登入Quick BI控制台

  2. 進入儀表板頁面。

  3. 淘寶商品訂單詳情儀表板中,建立商品資訊交叉表,並配置交叉表全域參數。

    1. 資料頁簽選擇銷售資料為資料集,並命名為淘寶商品訂單詳情

      image

    2. 添加交叉表至儀表板中,命名為商品資訊,並在儀表板頂部功能表列,單擊儲存

      image

    3. 在儀表板頂部功能表列,單擊全域參數表徵圖。

    4. 全域參數配置頁面,按照下圖樣本,配置全域參數後,單擊確定

      image

    5. 在儀表板頂部功能表列,單擊儲存並發布

  4. 訂單銷售詳情儀表板中,建立訂單資訊熱門排行榜,並設定跳轉至商品資訊交叉表。

    1. 在儀表板編輯頁面的資料頁簽,選擇銷售資料為資料集,並命名為訂單銷售詳情

      image

    2. 添加如下圖熱門排行榜到儀表板,並命名為訂單資訊

      image.png

    3. 單擊分析頁簽,在資料互動地區的跳轉配置右側,單擊image.png表徵圖。

      image.png

    4. 跳轉頁面,按照下圖設定參數後,單擊確定

      跳轉設定更詳細的操作,請參見跳轉設定與展示

      image

    5. 單擊熱門排行榜訂單資訊中的目標訂單編號,將自動跳轉至儀表板淘寶商品訂單詳情,並顯示目標訂單編號的商標資訊。

      跳轉的頁面如下圖所示。

      image

郵件訂閱情境

在做郵件訂閱任務的時候,可以通過全域參數,給報表內的圖表注入過濾條件。以下僅介紹郵件訂閱中全域參數的使用,建立訂閱任務的詳細操作,請參見建立訂閱任務

  1. 在郵件訂閱的建立任務頁面,設定訂閱任務的內容為一個配置過全域參數的儀表板。

    設定為一個配置過全域參數的儀表板後,系統會自動帶出相應的全域參數列表,且全域參數初始狀態是未配置,預設不生效。image

    參數值設定為空白和參數未設定是兩個不同的狀態。參數值設定為空白,如果在關聯的查詢控制項允許為空白,會將關聯條件的值重設為空白值。參數值未設定,則不會對查詢控制項和圖表造成影響。

  2. 單擊操作列的表徵圖,對全域參數進行配置。

    參數配置項的內容會隨著參數關聯欄位的類型自動匹配。關聯圖表時,參數配置允許切換條件形式;關聯查詢控制項時,只允許變更操作符和值。image

    完成訂閱任務的參數配置後,即可保證每次在做訂閱任務時,對應的參數會自動注入到報表的過濾條件中。