Running Data Rules

Executes an Oracle Hyperion Financial Data Quality Management, Enterprise Edition data load rule based on the start period and end period, and import or export options that you specify.

Prerequisites

Data Rules: Data load rules define how Integrations load data from a file. You must have predefined data load rules to load data.
You must have the required privileges to execute a specific data rule.

REST Resource

POST /aif/rest/{api_version}/jobs

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table A-1 Parameters

Name	Description	Type	Required	Default
`api_version`	Version of the API you are working with, such as V1	Path	Yes	None
`jobType`	should be set to "DATARULE"		Yes	None
`jobName`	The name of a data load rule defined in FDMEE. You should enclose the rule name in quotation marks if it contains a space.		Yes	None
`startPeriod`	The first period for which data is to be loaded. This period name must be defined in FDMEE period mapping.		Yes	None
`endPeriod`	The last period for which data is to be loaded. This period name must be defined in FDMEE period mapping.		Yes	None
`importMode`	determines how the data is imported into FDMEE. Acceptable values are: APPEND to add to the existing POV data in FDMEE REPLACE to delete the POV data and replace it with the data from the file RECALCULATE to skip importing the data but re-process the data with updated Mappings and Logic Accounts. NONE to skip data import into FDMEE staging table		Yes	None
`exportMode`	determines how the data is exported into FDMEE. Acceptable values for anOracle Hyperion Planning application are: STORE_DATA to merge the data in the FDMEE staging table with the existing Planning data ADD_DATA to add the data in the FDMEE staging table to Planning SUBTRACT_DATA to subtract the data in the FDMEE staging table from existing Planning data REPLACE_DATA to clear the POV data and replace it with data in the FDMEE staging table. The data is cleared for Scenario, Version, Year, Period, and Entity NONE to skip data export from FDMEE to Planning Acceptable values for Financial Consolidation and Close and Tax Reporting applications are: MERGE—By default, all data load is processed in the Merge mode. If data already existed in the application, the system overwrites the existing data with the new data from the load file. If data does not exist, the new data will be created. REPLACE—The system first clears any existing data in the application for those referenced in the data load file. Then the system performs the data load in Merge mode. NONE—Skips the data export from FDMEE to Financial Consolidation and Close		Yes	None
`fileName`	An optional file name. If you do not specify a file name, this API imports the data contained in the file name specified in the load data rule. The data file must already reside in the INBOX prior to data rule execution.		Yes	None

Example URL

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

Example of Request Body

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

Response

Supported Media Types: application/json

Table A-2 Parameters

Name	Description
`status`	Status of the job: -1 = in progress; 0 = success; 1 = error; 2 = cancel pending; 3 = cancelled; 4 = invalid parameter
jobStatus	A text representation of the job status, with one of the following values "RUNNING", "SUCCESS". "FAILED"
jobId	The process ID generated in FDMEE for the job
logFileName	Log File containing entries for this execution.
outputFileName	Name of the output file generated, if any.
processType	Type of the process executed. Will contain "COMM_LOAD_BALANCES" for all Data Rule executions
executedBy	Login name of the user used to execute the rule.
details	Returns the exception stack trace in case of an application error

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "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

}