runDataRule

Executes a Data Management data load rule based on the start period and end period, and import or export options that you specify.

Note:

This command cannot be used to execute direct data load integration from data sources into Oracle Enterprise Performance Management Cloud. Use the EPM Integration Agent to integrate direct data loads. For detailed information, see Performing a Direct Data Load using the EPM Integration Agent in Administering Data Integration for Oracle Enterprise Performance Management Cloud .

Applies to

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Account Reconciliation, Profitability and Cost Management, Enterprise Profitability and Cost Management, Oracle Sales Planning Cloud, and Oracle Strategic Workforce Planning Cloud.

Required Roles

Service Administrator, Power User

Usage

epmautomate runDataRule RULE_NAME START_PERIOD END_PERIOD IMPORT_MODE EXPORT_MODE [FILE_NAME] where:
  • RULE_NAME is a name of a data load rule defined in Data Management. You should enclose the rule name in quotation marks if it contains space.

  • START_PERIOD is the first period for which data is to be loaded. This period name must be defined in Data Management period mapping.

  • END_PERIOD is, for multi-period data load, the last period for which data is to be loaded. For single period load, enter the same period as start period. This period name must be defined in Data Management period mapping.

  • IMPORT_MODE determines how the data is imported into Data Management.

    Import mode settings are case-sensitive. Acceptable values are:

    • APPEND to add to the existing POV data in Data Management
    • REPLACE to delete the POV data and replace it with the data from the file
    • RECALCULATE to recalculate the data
    • NONE to skip data import into Data Management staging table
  • EXPORT_MODE determines how the data is exported to the application.

    Export mode settings are case-sensitive. Acceptable values are:

    • STORE_DATA to merge the data in the Data Management staging table with the existing data. Always use this export option in the Data Management jobs used to load metadata.
    • ADD_DATA to add the data in the Data Management staging table to the application.
    • SUBTRACT_DATA to subtract the data in the Data Management staging table from existing data.
    • REPLACE_DATA to clear the POV data and replace it with data in the Data Management staging table. The data is cleared for Scenario, Version, Year, Period, and Entity.
    • NONE to skip data export from Data Management to the application.

    Note:

    For Financial Consolidation and Close, only these export modes are supported:

    • MERGE to merge the data in the Data Management staging table with the existing data
    • REPLACE to remove entries from DM staging table and replace with those from the data load
    • NONE to skip data export from Data Management to the application

    For Oracle Fusion Cloud as a target, only these export modes are supported:

    • MERGE to merge the data in the Data Management staging table with the existing data
    • NONE to skip data export from Data Management to the application
  • FILE_NAME is an optional file name. If you do not specify a file name, EPM Automate imports the data contained in the file name specified in the load data rule. This file must be available in the inbox folder or in a folder within it.

    When loading Bank Administration Institute (BAI) format files for Account Reconciliation, do not specify a value for this parameter. You must always specify the file name for loading BAI files in the data rule definition.

    Note:

    If a path is specified in the data rule, do not specify the file path in the command; specify only the file name. If a path is not specified in the data rule; specify the full path to the data file.

Examples

  • Multi-period Import:

    epmautomate runDataRule VisionActual Mar-15 Jun-15 REPLACE STORE_DATA inbox/Vision/GLActual.dat

  • Single-period Import:

    epmautomate runDataRule "Vision Actual" Mar-15 Mar-15 REPLACE STORE_DATA inbox/Vision/GLActual.dat