データ・ルールの実行

開始期間と終了期間および指定したインポートまたはエクスポート・オプションに基づいて、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: FDMEEのステージング表のデータを既存のPlanningデータから削除します

  • REPLACE_DATA: POVデータをクリアしてFDMEEのステージング表のデータで置換します。データがクリアされる対象は、シナリオ、バージョン、年、期間およびエンティティです

  • 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

}