跳轉到

U-Office Force X 連接器技術手冊

概要

U-Office Force X 連接器是用來連接 UOF X 伺服器並取得某種特定資料使用，系統內有各種不同的運行資料，隨著使用更高版本的 UOF X，可以讀取更多支援的資料內容。

對於組織而言，無須開發商的支援，利用連接器就可直接使用 UOF X 提供的基礎資料，讓報表維護者自行設計組織專用的報表，搭配各種豐富的資料展示元件，完成以往曠日廢時難以達成的任務。

此份文件旨在說明 U-Office Force X 連接器與 UOF X 伺服器 Public API 之間的通訊內容定義，文件內容隨時會因為 UOF X 版本升級而擴充。

參數與查詢

連接器需要輸入一些參數才能正確的取出特定的資料，根據不同的 ModuleCode 對應到系統的不同模組，每個模組需要輸入的參數略有不同，返回的資料也都不一樣。

所有參數列舉如下:

  • SiteUrl :
    UOF X 站台的 api 站台網址，需先確認 UOF X 站台可以正常登入使用
  • CompanyCode :
    用來區分不同分公司的代號，輸入不同的公司代號，則能取用不同公司的資料，當然你也必須擁有那間公司的管理權限
  • ModuleCode :
    模組代碼，用來告訴 API 目前將取用的模組
  • FeatureType :
    功能代碼，用來告訴 API 目前將取用的功能，通常與 ModuleCode 匹配為一組，不同的組別代表執行不同的查詢功能，返回不同的資料集
  • DataKey :
    資料識別碼，用來告訴 API 資料集的某種特徵，通常用於資料過濾
  • DataKey2 :
    資料識別碼2，用來告訴 API 資料集的其他特徵，通常用於資料的二次篩選之用
  • Status :
    狀態碼，較常使用於資料狀態篩選
  • StartTime :
    開始時間，當資料集有時間特性，有些查詢可以使用此欄位標示資料的開始時間，做為資料篩選
  • EndTime :
    結束時間，當資料集有時間特性，某些查詢使用此欄位標示資料的結束時間，做為資料篩選之用
  • RequestHeaderName1 :
    呼叫時，一併送出的 Request 自訂表頭1 的名稱，通常用來通過特定防火牆之用
  • RequestHeaderValue1 :
    呼叫時，一併送出的 Request 自訂表頭1 的內容，通常用來通過特定防火牆之用
  • RequestHeaderName2 :
    呼叫時，一併送出的 Request 自訂表頭2 的名稱，通常用來通過特定防火牆之用
  • RequestHeaderValue2 :
    呼叫時，一併送出的 Request 自訂表頭2 的內容，通常用來通過特定防火牆之用

目前支援的模組查詢功能，實際的輸入值與返回資料表，請參閱如下文件 :