UOFX Connector

Summary 提要

Item	Description
Release State	General Availability
Products	Power BI (Semantic models)
Authentication Types Supported	UsernamePassword

Note
UsernamePassword 由 UOFX 系統的管理者使用串接金鑰功能來產生，在連接器輸入參數的的時候，大小寫必須完全吻合.

一、Prerequisites 先決條件

• 要使用 UOFX Connector，您必須擁有一份 [UOFX] 公司管理者配發的 ClientId 與 ApiKey，用來連接 UOFX 的 API。
• 一份連接器的技術手冊，上面記載著如何設定呼叫參數的說明

如何產生UOFX 金鑰

1. 以公司管理員身分登入UOFX站台，切換至 管理者模式，開啟 [串接模組/金鑰管理]功能，點擊右上角 [新增金鑰] 以建立新的金鑰

   
   

2. 請輸入 Client名稱 ，[類別]設定為 資料查詢金鑰(OData) ，且設定此金鑰 [可以使用的功能]

   
   

3. 其他設定可依照組織規定進行設定，且點按[自動產生]後，再點按[確定]

   
   

4. 產生金鑰之後，須將 Client名稱 與 金鑰 ，以安全的管道交給 PowerBI Desktop 使用者

Note
請確認 UOFX 站台版本必須在 v2.110.1 以上版本，才支援 Power BI 的整合功能.

二、Capabilities Supported 能力的支援

• DirectQuery (Power BI semantic models)

三、手動安裝 UOFX Connector

若需使用 [UOFX連接器]，請聯絡一等一客服窗口，下載UOFX連結器 (.mez) 檔案並放至指定位置，才可在 Power BI Desktop 中使用，請依照以下步驟完成安裝設定：

1. 下載與安裝 Power BI Desktop 請至微軟官方網站下載 Power BI Desktop 安裝程式： 👉 Power BI Desktop 下載頁面

2. 調整 Power BI 安全性設定 Power BI 預設僅允許經微軟認證的延伸模組載入，請依以下步驟調整設定，允許自訂 Connector 執行：

   (1) 開啟 Power BI Desktop

   (2) 點選左上角的 檔案 → 選項與設定 → 選項

   (3) 選擇左側 安全性 項目

   (4) 調整如下設定：允許 Power BI Desktop 載入自訂開發的連接器（副檔名為 *.mez），完成後關閉視窗即可。

   • [ ] (建議使用) 只允許經過 Microsoft 認證和其他信任的協力廠商延伸模組載入
   • [V] (不建議) 允許任何延伸模組載入，而不經過驗證或警告

3. 放置 .mez 檔案至指定資料夾

4. 將提供的 UOFXConnector.mez 檔案複製到以下資料夾路徑：

   C:\Users\你的使用者名稱\Documents\Power BI Desktop\Custom Connectors

5. 若找不到該路徑，請手動建立以下資料夾結構：

   C: ..\Documents\Power BI Desktop\Custom Connectors

注意：檔案必須放在上述指定路徑，Power BI 才能成功載入 UOFX Connector。

四、使用 UOFX connector 從 Power Query Desktop 連線到 UOFX

1. 在 PowerBI Desktop 上方工具列點擊 [取得資料]

   
   

2. 點擊 其他 的分類，選擇 UOFX Connector 並且按下 [連接]

   
   

3. 在連接器的設定畫面，輸入 UOFX 的 SiteUrl、CompanyCode 與其他參數 (內容參考技術手冊)後，按下 [確定]。

   
   

4. 如果你是第一次連線，此時將出現輸入串接金鑰的畫面，輸入從 UOFX 管理者取得的金鑰資訊，輸入至 ClientId 與 ApiKey 欄位，並且按下 [連接]。

   
   

5. 如果一切順利，我們將在導覽器看到 UOFX 站台回傳的查詢結果，選擇我們想要抓取的資料表，並且按下 [載入]。

   
   

6. 資料回到 PowerBI Desktop 之後，我們可以對資料集加以應用，可以建立表格，或者執行運算.

五、串接金鑰的變更

1. 有時候串接金鑰已經失效，UOFX 公司管理元配發一個新的給你，我們可以重新修改金鑰，此時可以點擊主選單的 [檔案] > [選項與設定] > [資料來源設定]。

   
   

2. 出現 [資料來源設定] Dialog 之後，點選 [UOFX 認證]，再點擊 [編輯權限...]。

   
   

3. 在編輯權限 Dialog 點擊 [編輯...]

   
   

4. 出現 UOFX 認證的 Dialog，就可以重新輸入 ClientId，ApiKey 的內容，按下 [儲存] 之後，就可以重新查詢資料。

六、Troubleshooting 故障排除

當連線無法成功建立時，出現 api call failed 的錯誤，請檢查您的SiteUrl，CompanyCode、ModuleCode 等參數是否正確,並檢查 ClientId 與 ApiKey 的內容大小寫是否正確，也有可能串接金鑰已經被關閉，建議與系統管理者聯絡。