執行資料規則

根據開始期間和結束期間，以及您指定的匯入或匯出選項，執行 Oracle Hyperion Financial Data Quality Management, Enterprise Edition 資料載入規則。

必備條件

  • 資料規則：資料載入規則定義 Integrations 從檔案載入資料的方式。您必須有預先定義的資料載入規則，才能載入資料。

  • 您必須具有必要的權限，才能執行特定的資料規則。

REST 資源

POST /aif/rest/{api_version}/jobs

要求

支援的媒體類型：application/json

參數

下表彙總用戶端要求。

表格 A-1 參數

名稱 描述 類型 必要 預設值
api_version 您使用的 API 版本，例如 V1 路徑 是 無
jobType 應該設為 "DATARULE"   是 無
jobName FDMEE 中所定義之資料載入規則的名稱。如果規則名稱包含空格，您應以引號括住規則名稱。   是 無
startPeriod 要載入資料的第一個期間。FDMEE 期間對映中必須定義此期間名稱。   是 無
endPeriod 要載入資料的最後一個期間。FDMEE 期間對映中必須定義此期間名稱。   是 無
importMode 決定如何將資料匯入 FDMEE。

可接受的值如下：

  • APPEND 表示新增至 FDMEE 中現有的 POV 資料

  • REPLACE，刪除 POV 資料並以來自檔案的資料取代

  • RECALCULATE 會略過匯入資料，但會以更新的「對映」和「邏輯科目」重新處理資料。

  • NONE 表示略過將資料匯入 FDMEE 臨時資料表

   是 無
exportMode 決定如何將資料匯出至 FDMEE。

若為 Oracle Hyperion Planning 應用程式，可接受的值如下：

  • STORE_DATA 表示合併 FDMEE 臨時資料表中的資料與現有的 Planning 資料

  • ADD_DATA 表示將 FDMEE 臨時資料表中的資料新增至 Planning

  • SUBTRACT_DATA 表示從現有的 Planning 資料中減去 FDMEE 臨時資料表中的資料

  • REPLACE_DATA 表示清除 POV 資料，並以 FDMEE 臨時資料表中的資料取代。會針對 Scenario、Version、Year、Period 及 Entity 清除資料

  • NONE 表示略過將資料從 FDMEE 匯出至 Planning

若為 Financial Consolidation and Close 和 Tax Reporting 應用程式，可接受的值如下：

  • MERGE - 依預設會在「合併」模式中處理所有資料載入。如果資料已存在於應用程式中，系統會以載入檔案的新資料覆寫現有資料。如果資料不存在，將建立新資料。

  • REPLACE - 系統會先為資料載入檔案中參照的資料，清除應用程式中的任何現有資料。接著，系統會在「合併」模式中執行資料載入。

  • NONE - 略過將資料從 FDMEE 匯出至 Financial Consolidation and Close 的程序

   是 無
fileName 選擇性的檔案名稱。如果您不指定檔案名稱，此 API 會匯入在載入資料規則中指定的檔案名稱內包含的資料。在資料規則執行之前，資料檔案必須已經位於「收件匣」中。   是 無

URL 範例

https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/aif/rest/V1/jobs

要求內文的範例

{"jobType":"DATARULE",
"jobName":"aso to bso dr",
"startPeriod":"Dec-18",
"endPeriod":"Dec-18",
"importMode":"REPLACE",
"exportMode":"NONE",
"fileName":""
}

回應

支援的媒體類型：application/json

表格 A-2 參數

名稱 描述

status

工作的狀態：-1 = 進行中；0 = 成功；1 = 錯誤；2 = 取消擱置中；3 = 已取消；4 = 無效的參數

jobStatus

工作狀態的文字表示法，包含下列其中一個值：「RUNNING」、「SUCCESS」、「FAILED」

jobId

FDMEE 中為工作產生的程序 ID

logFileName

包含這次執行之相關項目的日誌檔。

outputFileName

所產生之輸出檔案的名稱 (若有的話)。

processType

所執行之程序的類型。對於所有「資料規則」執行，將會包含「COMM_LOAD_BALANCES」

executedBy

用於執行規則之使用者的登入名稱。

details

如果發生應用程式錯誤，則傳回例外堆疊追蹤

回應內文的範例

以下顯示回應內文的範例 (JSON 格式)。

{
    "jobStatus": "RUNNING"
"jobId": 2019
"logFileName": "\outbox\logs\Account Reconciliation Manager_2019.log"
"outputFileName": null
"processType": "COMM_LOAD_BALANCES"
"executedBy": "admin"
"status": -1
"links": [1]
    0:  {
    "rel": "self"
    "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/aif/rest/V1/jobs/2019"
    "action": "GET"
}
"details": null

}