外部資料來源

一、何謂「外部資料來源」?¶

跨系統資料整合
當組織的表單有需要跨系統進行資料整合或數據交換時，可以使用UOF X系統的「外部資料來源」設定來達成；當使用者在UOF X系統填寫表單後，會依照「外部資料來源」的設定將表單內容傳送至指定的外部系統進行處理。
從外部系統取得表單欄位資料
當組織的表單欄位選項需要從外部系統中取得時，也可以使用UOF X系統的「外部資料來源」設定來達成；當使用者在UOF X系統填寫表單時，表單欄位的選項可以自動從外部資訊中取得，提供使用者更便捷的填寫體驗和更準確的資料輸入，降低手動輸入錯誤的風險。
使用外部資料來源優勢
- 整合與靈活性：外部資料來源允許組織的表單與外部系統進行數據整合，實現跨系統的資料交換與共享；同時也支援多樣的資料格式，確保資料在系統之間的準確解析和處理，例如支援JSONPath、SQL語言等。
- 即時與提高效率：外部資料來源具有即時的數據傳遞與同步，確保表單填寫後的數據能夠及時傳遞至外部系統，減少了手動輸入或資料轉換的工作，提高了工作效率。
- 安全性：外部資料來源允許設定授權和驗證機制，確保僅授權的使用者能夠使用外部系統的數據。
- 可擴展性：可以擴展至多個外部系統，實現與不同外部系統的整合，滿足不同業務需求。

二、應用情境¶

各行各業的表單皆有不同應用「外部資料來源」的商業邏輯，以下列舉幾個可透過UOF X系統的「外部程式站點」和「從外部系統取得表單欄位資料」運用情境供組織來參考。

外部程式站點 ¶

財務金流系統：
在UOF X系統申請[費用請款單]，使用外部程式站點，自動將費用或出納數據連接至組織的財務系統。
人力資源系統：
- 當人員提交[人事異動申請單]，使用外部程式站點，自動將員工資料連接至人力資源系統進行員工資料調整。
- 人員提交[請假單]在表單結案後，使用外部程式站點，自動將請假期間連接至薪資管理系統進行薪資調整。
ERP系統：
[設計暨工程變更申請單]由相關單位審核後，使用外部程式站點，自動將貨物與料號型號、數量連接至ERP系統，讓採購訂料。
CRM系統：
人員在填寫[客戶基本資料表]時，使用外部程式站點，將資料自動在CRM系統建檔。

欄位資料來源 ¶

人力資源系統：
人員填寫[培訓課程申請單]時，透過使用表單欄位取得外部資料來源，其中 職前訓練 、 產業人才投資課程 的欄位，會分別出現不同的課程供人員選取。
ERP系統：
在[請採購單]中，透過使用表單欄位取得外部資料來源，從供應鏈管理系統中取得資料，不同的供應商，會出現各自廠商所提供原物料的料號、規格與庫存數量供人員取得最新資料。

這些情境中，外部程式資料來源的目的是使組織的表單系統能夠與外部系統進行整合，或將表單數據拋出至外部系統，組織可確保不同系統之間的資料一致性，並提供更準確的資訊供使用者體驗。

三、開始使用「外部資料來源」¶

外部資料來源類別¶

首先，組織可以根據需求和外部資料來源的複雜度進行適當的分類，分類的目的是讓維護人員能夠更輕鬆地找到外部資料來源，提高日常維護的效率。在建立分類結構時，建議與相關的業務團隊或負責人進行溝通，確保分類方式符合組織的實際需求，以下提供常見的分類方式：

依 驗證類型 分類：根據外部資料來源所連接的資料庫或API進行分類，例如：SQL類型、API類型。這種分類方式可以讓維護人員快速找到相關的外部系統類型並進行修改或新增。
依 表單類別 分類：根據表單的類別或功能將外部資料來源進行分類，例如：將差勤相關的外部資料來源放在一個分類下，將財務系統相關的外部資料來源放在另一個分類下，以此類推。這種分類方式可以根據不同的業務需求對外部資料來源進行分組，方便相關團隊或負責人進行維護和管理。

管理者首頁>串接服務>外部資料來源

上架/下架程序¶

在使用「外部程式站點」或「欄位資料來源」之前，BPM管理者 需要進行一個重要的步驟，即「上架」外部資料來源；「上架」 意指是將外部資料來源設定為可用狀態，只有在外部資料來源上架後， 表單設計者 才能在設計表單時選擇並使用這些外部資料來源主檔。

若你需要維護外部資料來源，則需要進行「下架」外部資料來源，例如：進行更新或修正資料。「下架」 意指將外部資料來源設定為 不可使用 的狀態，當外部資料來源下架時，表單設計者也將無法在表單設計時看到該外部資料來源。透過下架外部資料來源的方式，可以確保在進行維護作業期間，表單設計者不會誤用或選擇到需要維護的外部資料來源。

因此，系統透過引導性步驟，協助管理者在建檔或維護的過程中，順利進行外部資料來源的上架和下架操作，這些步驟包含 「基本設定→程式設定→參數設定→檢閱並上架」 ，清晰地指導管理者完成相應的程序，使其能夠有效地掌握上下架外部資料來源的流程。

透過上述說明，系統透過外部資料來源上架/下架的程序，我們可以確保外部資料來源的可用性，使其能夠被表單設計者正確地應用於表單設計中，同時也提供了一個安全的維護機制，當有人在維護外部資料來源時，讓表單設計者也不會受到維護作業的干擾或錯誤，而因此影響設計表單的作業。

匯出與匯入¶

BPM管理者 可以透過匯出與匯入功能將已建立的外部資料來源資料匯入系統中，快速完成設定。

在接下來的兩個章節中，我們將分別專注於 「SQL外部資料來源」 和 「API外部資料來源」 的詳細說明，以便你能夠更好地運用這些功能來提升外部資料來源的效果和準確性。

四、SQL外部資料來源¶

Step1：基本設定¶

外部資料來源類別：選擇適合的 外部資料來源 類別，以將資料來源進行分類和組織。
資料來源名稱：替SQL資料來源指定一個描述性且易於識別的名稱。
外部連線：選擇你所要的外部連線。

Step2：程式設定¶

SQL指令：你可以編寫SQL指令來串接外部系統中所需的商業邏輯，讓欄位或是流程可執行該指令，也可以在SQL指令中設定參數後，下一個步驟再指定參數來源。
備註說明：你所填寫的備註內容，表單設計者在設定 欄位串接外部資料 或 站點串接外部資料 時，可以看到此則備註說明。

Step3：參數設定¶

參數名稱：你可以為每個參數命名，提供給表單設計者在站點加入外部資料來源時，可以清楚識別所要設定的項目，建議取一個容易理解用途的名稱。
參數來源：你可以根據表單的特定需求，從以下三種不同的來源中獲取參數值。

參數來源	定義
單據資訊	你可以從單據的相關資訊中取得參數的值，例如：申請者/上一位簽核者(帳號、姓名、員工編號、主要部門職稱代號、主要部門代號)、申請時間、表單發佈版本，這些資訊可以用於商業邏輯的判斷，以確保表單的合法性。
常數(固定值)	你可以直接指定固定的值作為參數的來源，這些值在串接過程中是不變的，可用於特定的資料來源需求。
設計表單時再指定	若選擇此選項，表示你必須在設計表單時，在欄位或是流程中綁定外部資料來源時，必須要明確指定其參數來源為表單的哪一個欄位，換句話說，我們可以將使用者所填寫的資料，動態即時取得外部資料，使表單能靈活根據不同情況取得所需的資料。

支援測試功能：
1. 當你進行參數設定後，你可以選擇進行測試，在測試過程中，你需要提供具體的參數值，系統會模擬實際呼叫外部資料來源的過程，並回傳取得的資料結果。
2. 透過測試功能，管理者可以立即檢查外部資料來源的設定是否正確。他們可以使用各種不同的參數值進行測試，並及時預覽系統拋出的回傳值，讓管理者能夠確保外部資料來源在實際應用中的結果有符合預期，若不符合預期也可及時調整和修正該設定。

Step4：檢閱並上架¶

在最後的檢閱步驟，你可以對外部資料來源進行檢查，確保所有設定正確無誤；如果確定沒有問題，你可以選擇上架資料來源，如此一來，表單設計者才能在設計表單時選擇並使用這些外部資料來源。

五、API外部資料來源¶

Step1：基本設定¶

外部資料來源類別：選擇適合的 外部資料來源 類別，以將資料來源進行分類和組織。
資料來源名稱：替API資料來源指定一個描述性且易於識別的名稱。
外部連線：選擇你所要的外部連線。

Step2：程式設定¶

API URL ：你可以設定資料來源目標API位址(URL)，此URL是指向外部系統的API端點，UOF X將會透過此URL取得資料來源；若UOF X需要傳遞特定參數給外部API時，也可以在下一個步驟新增所需要的參數清單且對應指定其參數來源。例如：你需要某些資料是來自外部系統，但這些資料並不在UOF X系統內部，此時可以設定一個特定的URL，指向外部系統的API端點，以便UOF X能夠與外部系統進行資料的串接。
Method ：提供兩種常見的呼叫API的方法，選擇使用哪種方法取決於具體的情境和需求，選擇正確的方法能夠確保資料有效的串接與整合。
1. Get方法 ：向外部資料來源請求取得指定資源的內容，常應用於 取得資料 ，例如瀏覽網頁、讀取文件或檢索資料。
  - 參數傳遞 ：Get方法將參數以查詢字串(query string)的形式附加在URL的尾部，例如：http://example.com/page?param1=value1&param2=value2。
  - 可快取 ：由於Get方法的請求是不會對資源進行修改，所以瀏覽器和代理伺服器可以將資料暫存起來，下次有相同的Get發送請求時，將直接快取資料，而不需再向伺服器發送請求，從而提高效能。
  - 限制：由於URL的長度和某些伺服器的限制，Get方法的資料傳遞容量有限。
2. Post方法 ：向伺服器 提交資料 ，並請求處理資料，通常用於新增、更新或刪除資源，例如提交表單、發佈文章或執行某些操作。
  - 參數傳遞 ：Post方法將參數和資料包含在請求的主體(body)中，而不是附加在URL上，因此可以傳遞大量資料。
  - 安全性 ：相對於Get方法，Post方法的資料傳遞較為安全，因為參數不會顯示在URL中，而是隱藏在請求的主體中，且無長度限制。
  - 非快取 ：Post方法的請求通常不會被瀏覽器和代理伺服器快取，因為它可能會對資料進行修改。
備註說明 ：你所填寫的備註內容，表單設計者在設定 欄位串接外部資料 或 站點串接外部資料 時，可以看到此則備註說明。

Step3：參數設定¶

參數名稱：你可以為每個參數命名，提供給表單設計者在站點加入外部資料來源時，可以清楚識別所要設定的項目，建議取一個容易理解用途的名稱。
參數來源：你可以根據表單的特定需求，從以下三種不同的來源中獲取參數值。

參數來源	定義
單據資訊	你可以從單據的相關資訊中取得參數的值，例如：申請者/上一位簽核者(帳號、姓名、員工編號、主要部門職稱代號、主要部門代號)、申請時間、表單發佈版本，這些資訊可以用於商業邏輯的判斷，以確保表單的合法性。
常數(固定值)	你可以直接指定固定的值作為參數的來源，這些值在串接過程中是不變的，可用於特定的資料來源需求。
設計表單時再指定	若選擇此選項，表示你必須在設計表單時，在欄位或是流程中綁定外部資料來源時，必須要明確指定其參數來源為表單的哪一個欄位，換句話說，我們可以將使用者所填寫的資料，動態即時取得外部資料，使表單能靈活根據不同情況取得所需的資料。

支援測試功能：
1. 當你進行參數設定後，你可以選擇進行測試，在測試過程中，你需要提供具體的參數值，系統會模擬實際呼叫外部資料來源的過程，並回傳取得的資料結果。
2. 透過測試功能，管理者可以立即檢查外部資料來源的設定是否正確。他們可以使用各種不同的參數值進行測試，並及時預覽系統拋出的回傳值，讓管理者能夠確保外部資料來源在實際應用中的結果有符合預期，若不符合預期也可及時調整和修正該設定。

Step4：檢閱並上架¶

在最後的檢閱步驟，你可以對外部資料來源進行檢查，確保所有設定正確無誤；如果確定沒有問題，你可以選擇上架資料來源，如此一來，表單設計者才能在設計表單時選擇並使用這些外部資料來源。

以上為外部資料來源主檔的設定說明，設定完成後將可至 外部程式站點 或 欄位串接外部資料 使用。