runIntegration

Applies to

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

Required Roles

Service Administrator
Power User

Usage

epmautomate runIntegration JOB_NAME importMode=Append|Replace|"Map and Validate"|"No Import"|Direct exportMode=Merge|Replace|Accumulate|Subtract|"No Export"|Check periodName={PERIOD_NAME} [inputFileName=FILE_NAME] [PARAMETERS]

For Standard Mode integrations, you must specify the values for importMode, exportMode, and periodName
For Quick Mode integrations, you must specify the value for exportMode
Parameter names and their values are case-sensitive

In this command:

JOB_NAME is the name of an integration job defined in Data Integration.
importMode determines how the data is imported into Data Integration. Acceptable import modes are:
- Append to add to the existing POV data in Data Integration.
- Replace to delete the POV data and replace it with the data from the file.
- Map and Validate to skip data import, but reprocess the data with updated mappings and logic accounts.
- No Import to skip data import into the Data Integration staging table.
exportMode determines how the data is loaded to the target application. For Quick Mode integrations, you cannot use Check and No Export as the value of exportMode parameter. Acceptable export mode values are:
- Merge to update the existing data and add new data.
- Replace to clear the existing data in the POV and load it with new data. For Standard mode, the data is cleared for Scenario, Version, Year, Period, and Entity dimensions. For Quick Mode, data is cleared for Year, Period, and Entity dimensions. You can define custom clear regions for both modes.
- Accumulate to add the data to the existing data. Applicable to Planning, Planning Modules, Financial Consolidation and Close, Tax Reporting, Profitability and Cost Management, and Enterprise Profitability and Cost Management.
- Subtract to subtract the data from existing balance. Applicable to Profitability and Cost Management, and Enterprise Profitability and Cost Management.
  For Quick Mode integrations:
  - You cannot use Check and No Export as the value of this parameter.
  - For Planning, Planning Modules, and Financial Consolidation and Close, only valid values are Replace, Merge, and Accumulate.
- No Export to skip data export. Use this mode to load data into the staging table for review before loading to the target application.
- Check to only perform a data validation check.
  
  For Oracle Fusion Cloud as a target, only these export modes are supported:
  - MERGE to merge the data in the Data Integration staging table with the existing data
  - NONE to skip data export from Data Integration to the application
periodName is the name of one ore more periods or period ranges, each enclosed in curly brackets, for which to import or export the data. Acceptable period naming conventions are as follows:
- For single period loads, specify the period name enclosed in curly brackets, for example, {Jan-21}
- For multi-period loads, enclose start and end period names in curly brackets, for example, {Jan-21}{Mar-21} (to load data for all periods starting Jan-21 and ending Mar-21)
- For Planning, Planning Modules, Financial Consolidation and CloseFreeForm, and Tax Reporting: You can specify the Business Process Period Name and year in the format {Jan#FY21}{Mar#FY21} to load data for all periods starting Jan-21 and ending Mar-21.
  Period name must be enclosed in curly brackets.
  - Single Period—Refers to the Data Management period name for a single period defined in Period mapping.
  - Multi-Period—Refers to a multi-period load. The parameter is specified in {Month-Year}{Month-Year} format. For example, {Jan-20}{Mar-20} for a multi-period load from Jan-20 to Mar-20.
  - Planning Period Name—Refers to a Planning period name in {Month#Year} format, for example, {Jan#FY20}{Mar#FY20}. Using this convention, you do not need to specify Data Integration period names. Instead you specify the member names for the Year and Scenario dimensions.
    This parameter is supported in the Planning,Tax Reporting, and Financial Consolidation and Close business processes. It is functional for both your service applications and cloud deployments derived from on-premises data sources.
    
    Using this convention is useful if triggered from an EPM Cloud Groovy script by capturing the Year and Period member names. The application period mapping or global period mapping must exist with the Year and Month in the target values of the period mapping.
  - Substitution Variable—This is an extension of the preceding Planning period name format whereby a substitution variable, instead of the actual Year and Month member names, may be specified in {Month#&CurYr}{&FcstMonth#&CurYr} format; for example, {Jan#&CurYr}{&FcstMonth#&CurYr}.
    A combination of both actual member names as well as substitution variables is supported.
    
    This format is supported in the Planning,Tax Reporting, and Financial Consolidation and Close business processes.
    
    The application period mapping or global period mapping must exist in the Data Integration of the environment where the command is run, with the Year and Month values available in the target values of the period mapping. In this case, Year and Month refer to the current value of the substitution variable during execution.
  - GLOBAL POV—Executes the data load for the Global POV period. Use the format {GLOBAL_POV}.
  Note:
  If you use any period naming parameter other than the parameters described in this discussion, you'll get an Invalid Input – HTTP 400 error message.
- {GLOBAL_POV} to execute the data load for the period defined in Global POV in the system or on the Application Settings in Data Integration.
  
  Note:
  {Month#Year} period naming convention format is supported for Planning, Planning Modules, Financial Consolidation and Close, and Tax Reporting. Under this convention, you can specify member names for the Year and Scenario dimensions instead of the Data Integration period names. This approach is useful if the command is triggered from a Groovy script by capturing the Year and Period member names.
  The {Jan#&CurYr}{&FcstMonth#&CurYr} substitution variable naming convention is an extension of the preceding period naming convention. You can specify substitution variable instead of the Year and Month member names if you are running this command against Planning, Planning Modules, Financial Consolidation and Close, and Tax Reporting. A combination of member names and substitution variables is also supported.
  The preceding period naming and substitution variable naming conventions work only if application period mappings or global period mappings with the Year and Month in the target values already exist in Data Integration.
inputFileName, for file-based data loads, specifies the name of the file, available in the inbox, from which data is to be imported. If you specify the directory name in the Integration definition, then pass only the file name. If you do not include a directory name in the Integration definition, use inbox/DIR_NAME/FILE_NAME format, for example, inbox/GLBALANCES.txt or inbox/EBSGL/GLBALANCES.txt. If the file has been uploaded to the default location in the environment, use #epminbox/FILE_NAME convention, for example, #epminbox/GLBALANCES.txt, to identify the input data file.
This parameter is applicable only to native file-based data loads. If you do not specify this parameter value for file-based data loads, this command imports data from the file specified in the integration definition. If you specify this parameter value for data loads that are not file-based, the command ignores it.
PARAMETERS, optionally, identifies runtime parameters in PARAMETER_NAME="PARAMETER" format. Parameters include both source filters and target options.

Note:
The only parameter that you can use at this time for a dimension (metadata) type of target application is "Refresh Database"=Yes|No.

Examples

Single period import:
epmAutomate runIntegration VisionDataLoad importMode=Replace exportMode=Merge periodName="{Mar-15}"
Multi-period Import:
epmAutomate runIntegration VisionDataLoad importMode=Replace exportMode=Merge periodName="{Mar-15}{Jun-15}"
Incremental file-based data integration:
epmAutomate runIntegration IncrementalFileLoad importMode=Replace exportMode=Merge periodName="{Jan-20}{Mar-20}" inputFileName=File1.txt