EPM Automate Utility Commands

applydatagrants

Refreshes the data grants, which control access to Essbase data slices, so that they match the data grants defined in an Oracle Profitability and Cost Management Cloud application.

User and group level data grants that you make in the Oracle Profitability and Cost Management Cloud application are automatically synchronized in Essbase. Use this command to synchronize access to Essbase data if you suspect a discordance between the data grant in the application and the filters in Essbase.

The time required to complete this operation depends on the size of the application. Make sure that the data grant refresh operation finishes before the application is backed up during the next maintenance window. Because the application should not be used while this operation is in progress, Oracle recommends that you schedule this operation for a time when users are not working with the application.

Usage: epmautomate applydatagrants APPLICATION_NAME, where APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application for which data grants are to be recreated.

Example: epmautomate applydatagrants BksML12

clearcube

Deletes specific data from input and reporting cubes using the settings specified in a job of type clear cube. This command does not delete the application definition in the application’s relational tables. See Clearing Cubes in Administering Planning for Oracle Planning and Budgeting Cloud.

Usage: epmautomate clearcube JOB_NAME, where: JOB_NAME is the name of a job defined in the application.

Example: epmautomate clearcube ClearPlan1

clearpov

Clears model artifacts and data from a Point of View (POV) combination in an application.

Usage: epmautomate clearpov APPLICATION_NAME POV_NAME PARAMETER=VALUE Delimiter="DELIMITER" where:

  • APPLICATION_NAME is the name of an Oracle Profitability and Cost Management Cloud application
  • POV_NAME is a POV in the application. This value is required.
  • PARAMETER=VALUE indicates runtime parameters and their values to clear the POV. Specify as many parameter and value pairings as the process requires. Valid parameters, at least one of which is required, and their values:

    • isManageRule=true|false

      specifies whether to clear rules
    • isInputData=true|false specifies whether to clear input data

    • isAllocatedValues=true|false specifies whether to clear allocation values

    Note:

    Parameter values (true or false) must be in all lower case.

  • Delimiter="DELIMITER" specifies the delimiter used in POV values. Delimiter must be enclosed in double quotation marks.

Example: epmautomate clearpov BksML12 2012_Jan_Actual isManageRule=true isInputData=true isAllocatedValues=true DELIMITER=”_”

copypov

Copies the model artifacts and Essbase cube data from a source POV to a destination POV.

Usage: epmautomate copypov APPLICATION_NAME SOURCE_POV_NAME TARGET_POV_NAME PARAMETER=VALUE Delimiter="DELIMITER", where:

  • APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application that contains the source POV.
  • SOURCE_POV_NAME is the name of the source POV in the specified application

  • TARGET_POV_NAME is the name of a valid target POV in Draft status

  • PARAMETER=VALUE indicates runtime parameters and their values to copy the POV. Specify as many parameter and value pairings as the process requires. Valid parameters and their values:

    • isManageRule=true|false

      specifies whether to clear rules
    • isInputData=true|false specifies whether to clear input data

    • modelViewName specifies the name of the data slice that is to be copied from the source POV to the target POV.

    • createDestPOV=true|false specifies whether to create the target POV if it does not exist

    • isAllocatedValues=true|false specifies whether to clear allocation vales

    Note:

    Parameter values (true or false) must be in all lower case.

  • Delimiter="DELIMITER" specifies the delimiter used in POV values. Delimiter must be enclosed in double quotation marks.

Example:epmautomate copypov BksML12 2012_Jan_Actual 2012_Feb_Actual isManageRule=true isInputData=true modelViewName="Balancing - 5 Customer Costs" createDestPOV=true DELIMITER=”_”

copysnapshotfrominstance

Migrates (clones) an instance by copying a snapshot from an instance (source) to the current instance (target); for example from a test instance to a production instance. Start an EPM Automate Utility session and sign into the target instance before running this command.

Usage: epmautomate copysnapshotfrominstance SNAPSHOT_NAME USERNAME PASSWORD_FILE URL IDENTITYDOMAIN,where:

  • SNAPSHOT_NAME is the name of an existing snapshot in the source instance.

  • USERNAME is the user name of a Service Administrator of the source instance.

  • PASSWORD_FILE is the name and location of the file containing the encrypted password of the Service Administrator of the source instance.
  • URL is the URL of the source instance.

  • IDENTITYDOMAIN is the identity domain of the source instance.

Example: epmautomate copysnapshotfrominstance "Artifact Snapshot" serviceAdmin C:\mySecuredir\password.epw https://test-cloud-pln.pbcs.us1.oraclecloud.com myprodIdentityDomain

createreconciliations

Copies the profiles to a specified period.

Usage: epmautomate createreconciliations PERIOD SAVED_FILTER, where:

  • PERIOD is the name of a period
  • SAVED_FILTER is the name of a saved public filter. If you do not specify a saved filter, the utility copies all applicable profiles

Examples:

  • epmautomate createreconciliations “January 2015”
  • epmautomate createreconciliations “January 2015” “Corporate Recs”

deletefile

Deletes a file or application snapshot from the default upload location, a Data Management folder, or from profitinbox/profitoutbox. To delete a file from a location other than the default upload location, you must specify the file location.

Usage: epmautomate deletefile FILE_NAME

Examples:

  • Delete from default upload location: epmautomate deletefile data.csv

  • Delete from default download location: epmautomate deletefile outbox/data.csv

  • Delete artifact backup (named applicationbackupOctober30): epmautomate deletefile applicationbackupOctober30

  • Delete from profitinbox: epmautomate deletefile profitinbox/data.csv

  • Delete fromprofitoutbox: epmautomate deletefile profitoutbox/data.csv

  • Delete from a Data Management folder: epmautomate deletefile outbox/dm_data/data.csv

deletepov

Deletes model artifacts and Essbase cube data from a POV.

Usage: epmautomate deletepov APPLICATION_NAME POV_NAME Delimiter="DELIMITER", where:

  • APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application that contains the POV to be deleted.
  • POV_NAME is the name of the POV to be deleted. This value is required.

  • Delimiter="DELIMITER" specifies the delimiter used in POV values. Delimiter must be enclosed in double quotation marks.

example: epmautomate deletepov BksML12 2012_Jan_Actual Delimiter="_"

deploycube

Deploys or redeploys the calculation cube of an Oracle Profitability and Cost Management Cloud application.

Usage: epmautomate deploycube APPLICATION_NAME PARAMETER=VALUE comment="comment" where:

  • APPLICATION_NAME is the name of an Oracle Profitability and Cost Management Cloud application
  • PARAMETER=VALUE indicates runtime parameters and their values to deploy the cube. Specify as many parameter and value pairings as the process requires. Valid parameters and their values:

    Note:

    Parameter values (true or false) must be in all lower case.

    • isKeepData=true|false

      specifies whether to preserve existing data, if any
    • isReplaceCube=true|false specifies whether to replace the existing cube

      Note:

      Values of isKeepData and isReplaceCube cannot both be set to true.

    • isRunNow=true|false specifies whether to run the process right away

  • comment is an optional comment enclosed in double quotation marks

Example: epmautomate deploycube BksML12 isKeepData=true isReplaceCube=false isRunNow=true comment=”Test cube deployment”

downloadfile

Downloads a file from a service instance to the local computer. This command is used to download data, metadata, and back up snapshots for local storage. The file is downloaded into the folder from which you run the utility.

Usage: epmautomate downloadfile "[FILE_PATH]/FILE_NAME"

Examples:

  • Download daily maintenance snapshot: epmautomate downloadfile "Artifact Snapshot"

  • Download a custom snapshot: epmautomate downloadfile "mySnapshot"

  • Download a file from default download location: epmautomate downloadfile data.csv

  • Download from a Data Management folder: epmautomate downloadfile outbox/dm_data/data.csv

  • Download from profitoutbox: epmautomate downloadfile profitOutbox/data.csv

enableapp

Enables an application.

Usage: epmautomate enableapp APPLICATION_NAME, where APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application that you want to enable.

Example: epmautomate enableapp BksML12

encrypt

Uses Advanced Encryption Standard (AES) to encrypt Oracle Enterprise Performance Management Cloud password, and optionally, the internet proxy server password, and stores it in a password file. Encrypting password is a onetime process.

Usage: epmautomate encrypt PASSWORD KEY PASSWORD_FILE [ProxyServerPassword=PROXY_PASSWORD] where:

  • PASSWORD is the password of the Service Administrator in the service. You cannot use corporate credentials with the EPM Automate Utility.

  • KEY is the private key that is to be used to encrypt the password.

  • PASSWORD_FILE is the name and location of the file that stores the encrypted password. The password file must use the .epw extension.

  • ProxyServerPassword=PROXY_PASSWORD is the password to authenticate the user with the proxy server. Required only if authentication at proxy server is enabled for your network.

Examples:

  • Encrypt only EPM Cloud password: epmautomate encrypt P@ssword1 myKey C:\mySecuredir\password.epw

  • Encrypt EPM Cloud and internet proxy server passwords: epmautomate encrypt E@xample1 myKey C:\mySecuredir\password.epw ProxyServerPassword=E@xample1

exportdata

Exports application data into a ZIP file using the export data settings, including file name, specified in a job of type export data. The exported data file is stored in the default download location from where you can download it to your computer. Use the Inbox/Outbox Explorer to view details of the exported file.

Usage: epmautomate exportdata JOB_NAME [FILE_NAME], where: JOB_NAME is the name of a job defined in the application and FILE_NAME is the name of the ZIP file (optional) into which data is to be exported.

Example: epmautomate exportdata dailydataexport dailyData.zip

exportMapping

Exports mapping rules of a specific dimension or location to create a mapping rule file. You must specify the file name and a location within the outbox (for example, outbox/exportedAccountMap.txt or outbox/france sales/exportedAccountMap.txt) to export mappings. Use the downloadfile command to download the exported mapping file to a local computer.

Usage: epmautomate exportMapping DIMENSION_NAME|ALL FILE_NAME LOCATION, where

  • DIMENSION_NAME|ALL is the source dimension from which mappings are to be exported. Specify the name of the dimension from which mappings are to be exported or ALL to export mappings from all dimensions of a location.

  • FILE_NAME is a unique name for the mapping file and a location within the outbox.

  • LOCATION is the Data Management location for which mapping rules should be exported.

Examples:

  • epmautomate exportMapping Account outbox/exportedAccountMap.txt "France Sales"
  • epmautomate exportMapping ALL "outbox/france sales/exportedAccountMap.txt" "France Sales"

exportmetadata

Exports metadata into a file using the settings specified in a job of type export metadata. The file containing the exported data is stored in the default download location from where you can download it to a local computer.

Optionally, you can specify a file name for the exported data, which overrides the default file name (job name that is used to export metadata). Metadata is exported as a ZIP file only.

Usage: epmautomate exportmetadata JOB_NAME [FILE_NAME], where JOB_NAME is the name of a job defined in the application and FILE_NAME is the name of the ZIP file into which metadata is to be exported.

Example: epmautomate exportmetadata dailyAccountexport Accountexport.ZIP

exportqueryresults

Runs a query defined in an application and exports results into a text file. The query result file is stored in profitoutbox; you can download it using the downloadfile command.

Usage: epmautomate exportqueryresults APPLICATION_NAME fileName=FILE_NAME [queryName=QUERY_NAME] [exportOnlyLevel0Flg=true], where:

  • APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application in which you want to run the query
  • fileName is the name of the .TXT file that will store the query results
  • queryName is an optional parameter that identifies a query that is defined in the application. Query names that contain space character must be enclosed in double quotation marks.

    Do not specify a query name if you want to export all Essbase data belonging to the application.

    The following conditions may cause this command to create an empty data file:

    • A badly formed query that retrieves no data
    • A query that generates too much data. In this scenario, consider narrowing the scope of the query so that it retrieves less data or break the query into smaller queries

      See Managing Oracle Profitability and Cost Management Cloud Queries in Administering Oracle Profitability and Cost Management Cloud.

  • exportOnlyLevel0Flg is an optional parameter that specifies whether the data retrieved by the query should be at the lowest granularity. Specify this parameter value in all lower case.

    This parameter is ignored if you are exporting all application data by omitting the query name.

Examples:

  • Export all application data:

    epmautomate exportqueryresults BksML12 fileName=”MyQuery1.txt”
  • Export results of a specific query:

    epmautomate exportqueryresults BksML12 fileName=”MyQuery1.txt” queryName=”My Product Query” exportOnlyLevel0Flg=true

exportsnapshot

Repeats a previously performed export operation to create a snapshot of Migration content. You can download the exported snapshot from the default location.

Usage: epmautomate exportsnapshot SNAPSHOT_NAME where SNAPSHOT_NAME is the name of an existing snapshot in Migration. This snapshot is replaced by the new snapshot.

Example: epmautomate exportsnapshot October16FullApp

exporttemplate

Exports an application as a template into a .ZIP file. The exported file is stored in profitoutbox. You can download it to a local computer using the downloadfile command.

Usage: epmautomate exporttemplate APPLICATION_NAME File_Name, where:

  • APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application that you want to export as template
  • File_Name is the name for the template file

Example: epmautomate exporttemplate BksML12 template1

feedback

Sends feedback to Oracle and to the Service Administrators of the instance. This command, which mimics the Provide Feedback feature of the service, is especially useful for providing feedback (text only) to Oracle in cases where the user interface is unresponsive or you encounter an issue while running the utility.

For information on the Provide Feedback feature, see Providing Feedback to Oracle in Using Oracle Planning and Budgeting Cloud.

Note:

Comments must be enclosed in quotation marks.

Usage: epmautomate feedback "comment" [screenshot="FILE_PATH"]

Examples:

  • Windows: epmautomate feedback "runplantypemap CampaignToReporting ClearData=True did not clear data from aggregate storage" screenshot=C:/feedback/issue.jpg
  • Linux: epmautomate feedback "runplantypemap CampaignToReporting ClearData=True did not clear data from aggregate storage" screenshot=/scratch/screens/issue.jpg

getsubstvar

Retrieves the values of substitution variables and displays them on screen in CUBE_NAME.SUBSTVAR=value format, for example, Plan2.CurYear=2016. Application level substitution variable values are displayed in ALL.SUBSTVAR=value format, for example, ALL.CurYear=2016

Usage: epmautomate getsubstvar CUBE_NAME|ALL [name=VARIABLE_NAME], where:

  • CUBE_NAME is the cube (for example, Plan1, Plan2) from which you want to retrieve the substitution variable. Use ALL to retrieve substitution variables at the application level.

  • name=VARIABLE_NAME optionally identifies the substitution variable for which you want to retrieve value. If you do not specify a variable name, the command retrieves the value of all substitution variables.

Examples:

  • Get the value of all substitution variables at the application and cube level: epmautomate getsubstvar ALL

  • Get the value of one specific substitution variable at the application level: epmautomate getsubstvar ALL name=CurYear

  • Get the value of all substitution variables at the cube level: epmautomate getsubstvar Plan2

  • Get the value of a specific substitution variable at the cube level: epmautomate getsubstvar Plan2 name=CurYear

help

Displays help for all commands.

Usage: epmautomate help

Example: epmautomate help

importbalances

Uses Data Management to import balances data from a data load definition.

Usage: epmautomate importbalances DL_DEFINITION PERIOD where:

  • DL_DEFINITION is an existing data load definition in Oracle Account Reconciliation Cloud.

  • PERIOD is the name of a period.

Example: epmautomate importbalances DailyLoad “January 2016”

importdata

Imports data from a file into the application using the import data settings specified in a job of type import data. Use the uploadfile command to upload the file containing application data to the default upload location.

Optionally, you can specify the name of the ZIP, CSV or TXT (Essbase format data file) file from which data is to be imported. If you specify a file name, the import file name in the job is ignored.

If the job is defined to import data in Essbase format, the ZIP file must contain an Essbase format TXT file. For other import jobs, the ZIP file may contain one or more CSV files that identifies the import sequence in the file names; for example, data1-3.csv, data2-3.csv, and data3-3.csv.

Usage: epmautomate importdata JOB_NAME [FILE_NAME], where: JOB_NAME is the name of a job defined in the application and FILE_NAME identifies the ZIP or CSV file from which data is to be imported.

Example: epmautomate importdata dailydataload dailydata.zip

importMapping

Imports mappings from a mapping import file, which was previously uploaded to the service. Use the uploadfile command to upload files into Data Management inbox or a folder within it.

Usage: epmautomate importMapping DIMENSION_NAME|ALL FILE_NAME IMPORT_MODE VALIDATION_MODE LOCATION, where

  • DIMENSION_NAME|ALL indicates the recipient of the mapping. Specify the name of the dimension into which mappings are to be imported or ALL to import all mappings included in the file to appropriate dimensions.

  • FILE_NAME is the name and location of the mapping import file available in Data Management inbox or a directory within it. Specify the file name (TXT files in standard Data Management format) and its path (for example, inbox/AccountMap.txt or inbox/pbcs_maps/AccountMap.txt).

  • IMPORT_MODE is either REPLACE to clear existing mapping rules before importing mappings or MERGE to add new mapping rules to exiting rules.

  • VALIDATION_MODE is TRUE to validate target members against the application or FALSE to load the mapping file without running validations.

  • LOCATION is the Data Management location for which mapping rules should be loaded.

Examples:

  • epmautomate importMapping Account inbox/AccountMap.txt MERGE FALSE "France Sales"
  • epmautomate importMapping ALL "inbox/France Sales/AllMaps.txt" MERGE FALSE "France Sales" (loads mappings from the mapping import file into all mapped dimensions in France Sales location)

importmetadata

Imports metadata into the application using the import data settings specified in a job of type import metadata. Optionally, you can specify the name of the ZIP file from which metadata is to be imported. Use the uploadfile command to upload the file containing the metadata to the default upload location.

The contents of the ZIP file that you specify take precedence over the file names defined in the job. The ZIP file may contain one or more CSV files. The file names containing metadata for dimensions should match the import file names defined in the job or end with _DIMENSIONNAME.csv; for example, metadata_Entity.csv, metadata_HSP_Smart Lists.csv, and metadata_Exchange Rates.csv.

Note:

Only the metadata for the dimensions for which metadata import is set up in the job is imported. Metadata for other dimensions, if contained in the ZIP file, are ignored.

Note:

An ambiguous import situation is created if both of the following conditions are true for the ZIP file:

  • Zip contains a metadata file with a name that matches the file name defined in the job

  • Zip contains a metadata file or files with names that end in _DIMENSIONNAME.CSV or _DIMENSIONNAME.TXT, where DIMENSIONNAME is the name of the dimension into which metadata is being imported.

Oracle recommends that the ZIP file contains a metadata file with a name identical to that referenced in the job or a file with a name that ends in _DIMENSIONNAME.CSV (or _DIMENSIONNAME.TXT), but not both. For example, if you are loading a job that references the metadata file Employees_A-Z.CSV into the Employees dimension, your ZIP file may include Employees_A-Z.CSV or New_Employees.CSV, but not both. If your ZIP contains Employees_A-Z.CSV and New_Employees.CSV, the utility may select either file for import depending on the order of the files in ZIP. Employees_A-Z.CSV file is a possible match for import because its name matches the file name referenced in the job; New_Employees.CSV is also a possible match because its name matches the _DIMENSIONNAME.CSV pattern.

Usage: epmautomate importmetadata JOB_NAME [FILE_NAME] , where JOB_NAME is the name of a job defined in the application and FILE_NAME is the name of the ZIP file from which metadata is to be imported.

Example: epmautomate importmetadata importAccount importAccount.zip

importpremappedbalances

Imports pre-mapped balance data from a file in the Oracle Account Reconciliation Cloud repository.

Usage: epmautomate importpremappedbalances PERIOD FILE_NAME BALANCE_TYPE CURRENCY_BUCKET, where:

  • PERIOD is the name of a period
  • FILE_NAME is the name of the CSV file containing the data to be imported
  • BALANCE_TYPE is SRC or SUB
  • CURRENCY_BUCKET is Entered, Functional or Reporting

Example: epmautomate importpremappedbalances “January 2015” dailydata.csv SRC Reporting

importpremappedtransactions

Imports pre-mapped transactions from a CSV file in the Oracle Account Reconciliation Cloud repository.

Usage: epmautomate importpremappedtransactions PERIOD TRANSACTION_TYPE FILE_NAME DATE_FORMAT, where:

  • PERIOD is the name of a period
  • TRANSACTION_TYPE is one of the following:
    • BEX for adjustment to explained balance

    • SRC for adjustment to source system

    • SUB for adjustment to subsystem

  • FILE_NAME is the name of the CSV file from which data is to be imported
  • DATE_FORMAT is date format text string; for example, MMM d, yyyy.

Example: epmautomate importpremappedtransactions “January 2015” “BEX” transactions.csv “MMM d, yyyy”

importprofiles

Imports new profile definitions from a CSV file in the Oracle Account Reconciliation Cloud repository.

Usage: epmautomate importprofiles FILE_NAME PROFILE_TYPE METHOD DATE_FORMAT, where:

  • FILE_NAME is the name of the CSV file from which data is to be imported
  • PROFILE_TYPE is either profiles or children
  • METHOD is either Replace or Update
  • DATE_FORMAT is a date format text string; for example, MMM d, yyyy

Example: eppmatomate importprofiles NewRecProfiles.csv Profiles Replace “MMM d, yyyy”

importrates

Imports currency rates from a CSV file in the Oracle Account Reconciliation Cloud repository.

Usage: epmautomate importrates PERIOD RATE_TYPE REPLACE_MODE FILE_NAME, where:

  • PERIOD is the name of a period
  • RATE_TYPE is a predefined rate type
  • REPLACEMENT_MODE is Replace or ReplaceAll
  • FILE_NAME is the name of the CSV file from which rates are to be imported

Example: epmautomate importrates “January 2015” Actual ReplaceAll avgrates.csv

importsnapshot

Imports the contents of a snapshot into the service instance. The snapshot you import must be available in the default upload location. Use the uploadfile command to upload a snapshot to the default location.

The activities that you can complete using this command depend on your role.

  • Service Administrators can import only application artifacts into a service instance.

  • Identity Domain Administrators can import only identity domain artifacts.

  • Service Administrators who are also assigned the Identity Domain Administrator role can import application content into the service instance and identity domain artifacts (users and their role assignments) into the identity domain of the service instance.

    If a user, who is not in the identity domain, is referenced in the snapshot being imported, the utility creates a user in the identity domain and assigns the default password that you specify in the command. By default, the user will be required to reset password during first sign in.

Usage: epmautomate importsnapshot SNAPSHOT_NAME [userPassword=DEFAULT_PASSWORD] [resetPassword=true|false], where

  • SNAPSHOT_NAME is the name of a snapshot in the default upload location.

  • userPassword indicates the default password that you want to assign to new users who are created in the identity domain. The password that you specify must meet the minimum identity domain password requirements.

  • resetPassword indicates whether the new user must change the password at the first log in. Unless this optional parameter is set to false, the new user will be forced to change the password at the first sign in.

Examples:

  • Import application artifacts

    epmautomate importsnapshot October16FullApp

  • Import application and identity domain artifacts (for Service Administrators with Identity Domain Administrator role only.)

    • epmautomate importsnapshot October16FullApp userPassword=Password1

      This command forces new users to reset their password after they sign in for the first time.

    • epmautomate importsnapshot October16FullApp userPassword=Password1 resetPassword=false

      This command allows users to retain the default password if they so choose.

importsupplementaldata

Note:

All command parameters must be enclosed in double quotation marks.

Imports supplemental data from a file into the application. Use the uploadfile command to upload the file containing the data to the default upload location.

Usage: epmautomate importsupplementaldata "FILE_NAME" "DATA_SET_NAME" "YEAR" "PERIOD_NAME" "SCENARIO_NAME", where:

  • FILE_NAME is the name of a CSV file, available in the default upload location, that contains properly formatted supplemental data.

  • DATA_SET_NAME is the name of the data set into which the supplemental data in the file should be imported.

  • YEAR is the year for which the data set is deployed.

  • PERIOD_NAME is name of the period to which the data set is deployed.

  • SCENARIO_NAME is the name of the scenario to which the data set is deployed.

Example: epmautomate importsupplementaldata "DatasetImport.csv" "EmployeeDataSet" "FY17" "Jan" "Actual"

importtemplate

Creates an application structure by importing from a template file that exists in profitinbox. You can upload a template file into profitinbox using the uploadfile command.

Usage: epmautomate importtemplate APPLICATION_NAME File_Name isApplicationOverwrite=true|false, where:

  • APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application that you want to create by importing the template
  • File_Name is the name of the .ZIP file containing application template. This file must exist in profitinbox.
  • isApplicationOverwrite specifies whether to overwrite the existing application, if any. Specify this parameter value in all lower case.

Example: epmautomate importtemplate BksML12 template1.zip isApplicationOverwrite=true

importtmpremappedbalances

For a specific data source, imports pre-mapped balances data from a file in Oracle Account Reconciliation Cloud repository into Transaction Matching.

See Importing Data in Reconciling Accounts with Oracle Account Reconciliation Cloud for import file format requirements and information about importing data.

Note:

Unlike from the Jobs screen, you can import pre-mapped balances data only from one file at a time.

Use the uploadfile command to upload the balances file to the service.

Usage: epmautomate importtmpremappedbalances RECONCILIATION_TYPE DATA_SOURCE FILE_NAME [DATE_FORMAT], where:

  • RECONCILIATION_TYPE is the reconciliation type defined in Oracle Account Reconciliation Cloud.

  • DATA_SOURCE is the identifier of the data source associated with the reconciliation type that you specified.

  • FILE_NAME is the name of the CSV file containing details of the balances to import. This file must be available in the service.

  • DATE_FORMAT is an optional parameter that indicates the format of the date fields included in the balances import file. Default is DD-MMM-YYYY, which is the only currently supported format.

Example: epmautomate importtmpremappedbalances "INTERCOMPANY" "AP" dailybalances.csv

importtmpremappedtransactions

For a specific data source, imports pre-mapped transactions data from a file in Oracle Account Reconciliation Cloud repository into Transaction Matching. Use the uploadfile command to upload the transactions file to the service.

See Importing Data in Reconciling Accounts with Oracle Account Reconciliation Cloud for import file format requirements and information about importing data.

Note:

  • Unlike from the Jobs screen, you can import pre-mapped transactions data only from one file at a time.

  • After importing pre-mapped transactions for all data sources, run the runautomatch command.

Usage: epmautomate importtmpremappedtransactions RECONCILIATION_TYPE DATA_SOURCE FILE_NAME [DATE_FORMAT], where:

  • RECONCILIATION_TYPE is a reconciliation type defined in Oracle Account Reconciliation Cloud.

  • DATA_SOURCE is the identifier of the data source associated with the reconciliation type that you specified.

  • FILE_NAME is the name of the CSV file containing the transactions to import. This file must be available in the service.

  • DATE_FORMAT is an optional parameter that indicates the format of the date fields included in the transactions import file. Default is DD-MMM-YYYY, which is the only format that is currently supported.

Example: epmautomate importtmpremappedtransactions "INTERCOMPANY" "AP" dailydata.csv

listfiles

Lists the files in the default location, Data Management folders, and profitinbox/profitoutbox. This command does not list Migration snapshots.

Usage: epmautomate listfiles

loaddata

Load data into a calculation cube using a file available in profitinbox. Use the uploadfile command to load files into profitinbox.

Usage: epmautomate loaddata APPLICATION_NAME PARAMETER=VALUE[rulesFileName=File_Name] dataFileName=File_Name, where:

  • APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application into which you want to load data
  • PARAMETER=VALUE indicates runtime parameters and their values to load data. Specify as many parameter and value pairings as the process requires. Valid parameters and their values:

    • clearAllDataFlag=true|false specifies whether to clear existing data in the application cube
    • dataLoadValue=OVERWRITE_EXISTING_VALUES|ADD_TO_EXISTING specifies how to handle existing data

    Note:

    Rule file name and data file name must be enclosed in double quotation marks.

  • [rulesFileName=File_Name] name of a rules file (optional) available in profitinbox
  • dataFileName=File_Name specifies a data load file available in profitinbox.

Example: epmautomate loaddata BksML12 clearAllDataFlag=true dataLoadValue=”OVERWRITE_EXISTING_VALUES” rulesFileName=”rule1.txt” dataFileName=”data1.txt”

loaddimdata

Loads dimension metadata from one or more files in profitinbox into an application. Use the uploadfile command to load files into profitinbox.

Usage: epmautomate loaddimdata APPLICATION_NAME dataFileName=File_Name [stringDelimiter="DELIMITER"], where:

  • APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application into which you want to load dimension metadata
  • dataFileName=File_Name specifies a dimension metadata load file available in profitinbox. To load metadata from multiple files, list the file names separated by a delimiter
  • stringDelimiter="DELIMITER" specifies the delimiter used to separate metadata file names. Delimiter must be enclosed in double quotation marks.

Example: epmautomate loaddimdata BksML12 dataFileName=”dimdata1.txt#dimdata1.txt” stringDelimiter="#"

login

Establishes a secure connection to a service instance. You sign in to initiate a session, which remains active until you sign out. You cannot use corporate credentials to sign in with this utility.

Note:

When using this command in batch files to automate activities, Oracle recommends that you use encrypted passwords to avoid recording clear text passwords in batch files.

Usage:
  • Using unencrypted password: epmautomate login USERNAME PASSWORD URL IDENTITYDOMAIN [ProxyServerUserName=PROXY_USERNAME ProxyServerPassword=PROXY_PASSWORD ProxyServerDomain=PROXY_DOMAIN]

  • Using encrypted passwords: epmautomate login USERNAME PASSWORD_FILE URL IDENTITYDOMAIN [ProxyServerUserName=PROXY_USERNAME] [ProxyServerDomain=PROXY_DOMAIN]

In these commands:

  • USERNAME is the user name of a Service Administrator.

  • PASSWORD is the password of the Service Administrator.

  • PASSWORD_FILE is the name and location of the file that stores the encrypted password of the Service Administrator. See the encrypt command.

  • URL is the URL of the service instance to which to connect.

  • IDENTITYDOMAIN is the identity domain of the service instance.

  • ProxyServerUserName is the user name to authenticate a secure session with the proxy server that controls access to the internet. Required only if authentication at proxy server is enabled for your network.

  • ProxyServerPassword is the password to authenticate the user with the proxy server. Required only if authentication at proxy server is enabled for your network and you are not using a password encryption file.

  • ProxyServerDomain is the name of the domain defined for the proxy server. Required only if authentication at proxy server is enabled for your network and a proxy server domain is configured.

Note:

The utility detects and uses the internet proxy settings on your computer. If the proxy settings require you to authenticate with the proxy server, then you must enter the proxy server domain, user name, and password as parameters to this command. Contact your network administrator for help with proxy server domain name and credentials.

Examples:

  • Using an unencrypted password, no proxy authentication:

    epmautomate login serviceAdmin P@ssword1 https://test-cloud-pln.pbcs.us1.oraclecloud.com myIdentityDomain

  • Using an encrypted password, no proxy authentication:

    epmautomate login serviceAdmin C:\mySecuredir\password.epw https://test-cloud-pln.pbcs.us1.oraclecloud.com myIdentityDomain

  • Using encrypted EPM Cloud password, if authentication at proxy server is enabled with server domain:

    epmautomate login serviceAdmin C:\mySecuredir\password.epw https://test-cloud-pln.pbcs.us1.oraclecloud.com myIdentityDomain ProxyServerUserName=john.doe@example.com ProxyServerPassword=example ProxyServerDomain=example

  • Using encrypted EPM Cloud password, if authentication at proxy server is enabled without a server domain:

    epmautomate login serviceAdmin C:\mySecuredir\password.epw https://test-cloud-pln.pbcs.us1.oraclecloud.com myIdentityDomain ProxyServerUserName=john.doe@example.com ProxyServerPassword=example

  • Using encrypted passwords, if authentication at proxy server is enabled with server domain:

    epmautomate login serviceAdmin C:\mySecuredir\password.epw https://test-cloud-pln.pbcs.us1.oraclecloud.com myIdentityDomain ProxyServerUserName=john.doe@example.com ProxyServerDomain=example

  • Using encrypted passwords, if authentication at proxy server is enabled without a server domain:

    epmautomate login serviceAdmin C:\mySecuredir\password.epw https://test-cloud-pln.pbcs.us1.oraclecloud.com myIdentityDomain ProxyServerUserName=john.doe@example.com

logout

Terminates your current connection with a service instance.

Usage: epmautomate logout

maskData

Masks application data to ensure data privacy. Use this command only on test instances to hide sensitive data from application developers.

WARNING: Do not use this command on production instances because it randomizes current application data, rendering it meaningless. You cannot undo the effects of this command. If you mistakenly masked the data in a service instance, you must restore the data from a back up or from the maintenance snapshot.

Usage: epmautomate maskData [–f] where -f is an option to force the start of the masking process without user confirmation. If you do not use the -f option, the utility prompts you to confirm your action.

provisionreport

Generates a provisioning report (.CSV file) and stores it in the default download location from where you can download it to your computer. This report contains information on the roles assigned to users and inheritance information that shows the sequence of inheritance starting with the original role that was responsible for granting the provisioned role to the user.

Usage: epmautomate provisionreport REPORT_NAME where REPORT_NAME is the name of the report file.

Example: epmautomate provisionreport myProvReport.CSV

recreate

Restores a service instance to a clean state by refreshing the deployment. This process deletes the existing application and all user defined artifacts from the service instance. After recreating the service, you can create a new application or import an application using Migration or the EPM Automate Utility.

Caution:

Using this command results in the loss of existing data and artifacts. Perform a complete backup of the application before you recreate a service instance.

Usage: epmautomate recreate [-f] where -f is the option to force the recreate process to start without user confirmation. If you do not use the -f option, the utility prompts you to confirm your action.

Example: epmautomate recreate -f recreates the current instance without prompting for confirmation.

refreshcube

Refreshes the application cube. Typically, you refresh the cube after importing metadata into the application.

The time required to complete a cube refresh operation depends on the changes that you made to the application structure and the impact it has on the cube. For example, a refresh after updating a sparse block storage cube member may not take much time while a cube refresh after updating a dense block storage cube member or an aggregate storage cube member could take a considerable amount of time. You must ensure that the cube refresh operation complete before the application is backed up during the next maintenance window.

Usage: epmautomate refreshcube [JOB_NAME] where

JOB_NAME is, optionally, the name of a job defined in the application

Example: epmautomate refreshcube dailyCubeRefresh

replay

Replays Oracle Smart View for Office load on a service instance to enable performance testing under heavy load to verify that user experience is acceptable when the service is under specified load.

You must create the replay file that identifies the Smart View activities that should be executed on the service. See Preparing to Run the Replay Command for details information on how to create the replay file.

Usage: epmautomate replay REPLAY_FILE_NAME.csv [duration=N] [trace=true] where:

  • REPLAY_FILE_NAME is a CSV file that stores the activities to be executed on the service instance.

  • Duration this optional parameter indicates the number of minutes for which activities are executed on the service instance.

    Activities in the HAR file are run one time if this value is not set. If the activities in the HAR file are completed within the time specified by this parameter, the utility reruns the HAR file until the activities are complete. For example, assume that you set duration=10 to replay a HAR file that takes three minutes to run. In this scenario, the replay command runs the HAR file activities four times (lasting 12 minutes) until the fourth iteration is complete.

  • trace=true is an optional setting that instructs the utility to create trace files in XML format.

    If this optional setting is specified, the utility creates one folder for each HAR file included in the replay CSV file and stores all related trace files in it. For each activity in the HAR file, the utility generates one trace file that contains Smart View response. Trace files are named trace-N.xml; for example, trace-1.xml where N is a counter that starts at 1.

    The folders that store the trace files are created in the directory from which EPM Automate Utility is run. The utility uses a combination of current server system time and HAR file name in YYYY_MM_DD_HH_MM_SS_HAR_FILE_NAME format to name the folders. For example, if HAR file name is forecast1.har, the folder name may be 2016_06_08_10_21_42_forecast1.

Example: epmautomate replay forecast1.csv duration=15

See A Sample Replay Session for detailed steps involved in executing this command.

resetservice

Restarts the service instance. Use this command only when you observe severe performance degradation or if you receive error messages indicating that the instance is unusable. Service reset does not affect your application customizations (for example, locale change, settings related to theme and currency, etc.). Reset takes up to 15 minutes.

Note:

Comments must be enclosed in quotation marks.

Usage: epmautomate resetservice "comment"

Example: epmautomate resetservice "Users experience unacceptably slow connections"

runautomatch

Runs the Auto Match process to match transactions using the rules defined by a Service Administrator. You can monitor the status of the auto match process on the Job History tab in Oracle Account Reconciliation Cloud.

Note:

Run this command after you import transactions data into Transaction Matching using the importtmpremappedtransactions command. After running auto match, run the importtmpremappedbalances command to import balances data into Transaction Matching.

Usage: epmautomate runautomatch RECONCILIATION_TYPE, where RECONCILIATION_TYPE is a reconciliation type defined in Oracle Account Reconciliation Cloud.

Example: epmautomate runautomatch INTERCOMPANY

runbatch

Executes a Data Management batch.

If batch execution mode in Data Management is set to Serial, control is returned when all the jobs in the batch are completed; if it is set to Parallel, control is returned when all jobs in the batch are submitted for execution.

Usage: epmautomate runbatch BATCH_NAME, where

BATCH_NAME is the name of a batch defined in Data Management.

Examples: epmautomate runbatch Accounting_batch

runbusinessrule

Launches a business rule or ruleset.

Usage: epmautomate runbusinessrule RULE_NAME [PARAMETER=VALUE], where:

  • RULE_NAME is the name of a business rule exactly as it is defined in the service instance.

  • PARAMETER=VALUE indicates optional runtime parameters and their values required to execute the business rule.

    Specify runtime parameters for launching rules only. If you are executing rulesets, the command ignores any runtime parameters that you specify. Rulesets are run using default values that you specified while creating the ruleset using Oracle Hyperion Calculation Manager.

    Note:

    The rule is executed against the plan type to which it was deployed.

    Use PARAMETER=VALUE pairing to specify as many runtime prompts as the business rule requires. The following example uses two runtime prompts (Period and Entity) and their values (Q1 and USA).

Example: epmautomate runbusinessrule RollupUSSales Period=Q1 Entity=USA

runcalc

Runs calculations in an application.

Usage: epmautomate runcalc APPLICATION_NAME POV_NAME PARAMETER=VALUE [comment="comment"] Delimiter="DELIMITER", where:

  • APPLICATION_NAME is the name of the Oracle Profitability and Cost Management Cloud application that contains the POV to be calculated.
  • POV_NAME is the name of the POV to be calculated.

  • PARAMETER=VALUE indicates runtime parameters and their values to run the calculation. Specify as many parameter and value pairings as the process requires. Valid parameters and their values:

    • exeType=ALL_RULES|RULESET_SUBSET|SINGLE_RULE identifies the rule execution type. This is a required parameter.

      Depending on the value set for exeType, the following parameters may be specified:

      • If you specify exeType=ALL_RULES, do not include rule subset or single rule related parameters such as subsetStart, subsetEnd, ruleSetName, and ruleName.

      • If you specify exeType=SINGLE_RULE, specify the values for ruleSetName and ruleName only.

      • If you specify exeType=RULESET_SUBSET, specify the values for subsetStart and subsetEnd.

    • subsetStart specifies the sequence number of the first rule in the rule set to run
    • subsetEnd specifies the sequence number of the last rule in the rule set to run
    • ruleSetName identifies the rule set that contains the calculations you want to run
    • ruleName name of the rule to run (to run a single rule)
    • isClearCalculated=true|false specifies whether to clear existing calculations
    • isExecuteCalculations=true|false specifies whether to run calculations
    • isRunNow=true|false set this value to true to run the process now
    • comment is an optional comment enclosed in double quotation marks
    • Delimiter is the delimiter used in POV values

    Note:

    Parameter values (true or false) must be in all lower case.

Example: epmautomate runcalc BksML12 2012_Jan_Actual isClearCalculated=true isExecuteCalculations=true isRunNow=true subsetStart=10 subsetEnd=20 ruleSetName=”Utilities Expense Adjustment" ruleName="Occupancy Expense Allocations" exeType=”ALL_RULES” comment=”Test calculation” Delimiter="_"

rundatarule

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

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. 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. Acceptable values are:

    Note:

    For Oracle Financial Consolidation and Close Cloud, only the following 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

    Note:

    For Oracle Fusion Cloud as a target, only the following 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
    • STORE_DATA to merge the data in the Data Management staging table with the existing data

    • 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

  • FILE_NAME is an optional file name. If you do not specify a file name, EPM Automate Utility 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.

Note:

Import and Export mode settings are case-sensitive.
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

runDMReport

Creates a Data Management report and stores it in the outbox/reports folder. Use the downloadfile command to download the report to a local computer.

The generated report is named based on the ID of the Data Management job that generates the report and the report format. For example, if the report job ID is 2112 and the report output format that you specify is PDF, the report name is 2112.pdf. The report name is displayed in the console after the report is generated. You can also identify the report name from the Process Details tab in Data Management or by using the listfiles command.

Usage: epmautomate runDMReport REPORT_NAME PARAMETER=Value "Report Output Format=[PDF|HTML|XLS|XLSX]", where

  • REPORT_NAME is the name of the Data Management report template to be used for generating the report.

  • PARAMETER=Value indicates report parameters and their values. You specify as many parameters as required in PARAMETER=Value format. The list of required parameters depends on the report that you want to generate.

    Note:

    Report run time parameters are defined when you design your reports. To run this command, you must generate and copy these parameters and values to the utility from the Workflow tab. To generate runtime parameters of a report, in the Workflow tab of Data Management, click Report Execution and then select a group from Report Group. Select the report for which you want to generate the parameters, then click Create Report Script. Optionally, specify report parameter values, then select an output format, and then click OK. Use the parameters shown in Generate Report Script to specify runtime parameters and values to generate the report

  • Report Output Format indicates the report output format. Valid options are PDF, HTML,XLS, and XLSX. The default report format is PDF.

Example: epmautomate runreport "TB Current Location By Target Acct (Cat,Per)" "Period=Jul 14" "Category=Forecast" "Location=FCSTtoVISCONSOL1" "Rule Name=FCSTtoVISCONSOL1" "Report Output Format=HTML"

runplantypemap

Copies data from a block storage database to an aggregate storage database or from a block storage to another block storage based on the settings specified in a job of type plan type map.

Usage: epmautomate runplantypemap JOB_NAME [clearData=true|false], where:

  • JOB_NAME is the name of a job of type plan type map defined in the application.

  • clearData is an optional setting that indicates whether the data in the target database should be removed before copying data. If this parameter value is not set, the default value True is used.

Example: epmautomate runplantypemap CampaignToReporting clearData=false

setdemodates

Use this command only on installations setup with Oracle internal demo data.

For Oracle Account Reconciliation Cloud only: Renames the periods in Oracle Account Reconciliation Cloud to be consistent with the specified date. It also resets dates for all reconciliations that have associated Demo Code attribute values of setdemodate or setdemodatenostatuschage.

This command handles reconciliations in up to two periods; a current period and a prior (historic) period. If reconciliations from more than two periods are tagged with the Demo Code attribute, the command treats those periods as being in the prior period. Reconciliations that do not have this attribute value are not affected.

  • If the value is setdemodate, the command resets the reconciliation dates based on the specified date and returns it to Open with Preparer status

  • If the value is setdemodatenostatuschage, the command resets the reconciliation dates based on the specified date without changing the reconciliation status

For Oracle Financial Consolidation and Close Cloud and Oracle Tax Reporting Cloud only: This command resets the tasks start and end dates, and other related date information, to make the tasks look good for a demo. It calculates the new task dates based on the value of the SETDEMODATES attribute set in the task along with the value of the Demo Date value that you provide. If Demo Date value is not specified, the command uses today's date to calculate the new task dates.

Note:

Tasks in schedules that do not have SETDEMODATES value are not affected.

Based on the Demo Date that you specify, this command moves forward all dates associated with the task. This includes core run time dates (start date, end date, etc.) and ancillary dates including those of history, individual workflow due dates, and start date (actual). Task status is not affected.

Usage: epmautomate setdemodates [DEMO_DATE] where DEMO_DATE is an optional date in YYYY-MM-DD format. Reconciliations are reset to the current date if you do not specify this value.

Example: epmautomate setdemodates 2017-02-15

setperiodstatus

Sets a specific period status.

Usage: epmautomate setperiodstatus PERIOD STATUS, where:

  • PERIOD is the name of a period
  • STATUS is OPEN, CLOSED or LOCKED

Example: epmautomate setperiodstatus “January 2015” OPEN

setsubstvars

Creates or updates substitution variables at application or cube level. You cannot use this command to set multiple values and/or functions for substitution variables.

Usage: epmautomate setsubstvars CUBE_NAME SUBSTVAR=VALUE [SUBSTVAR=VALUE], where:

  • CUBE_NAME is the cube (for example, Plan1, Plan2) for which the substitution variable is created or updated. Use All instead of acube name to set or update substitution variable at the application level.

  • SUBSTVAR is the name of the substitution variable for which a value is to be set or updated.

  • VALUE is the new substitution variable value.

Examples:

  • Create or update one substitution variable at the application level: epmautomate setsubstvars ALL CurYear=2015 CurPeriod=Jan

  • Create or update substitution variables at cube level: epmautomate setsubstvars Plan2 CurYear=2013 CurPeriod=Jan

uploadfile

Uploads a file from the local computer to the service. Use this command to upload files containing data, metadata, rule definitions, dimension definitions, mapped transactions, templates, and backup snapshots.

Usage: epmautomate uploadfile "FILE_NAME" [DATA_MANAGEMENT_FOLDER | profitinbox]

Examples:

  • Upload into default location: epmautomate uploadfile "C:/pbcsdata/quarterlydata.csv"

  • Upload into a Data Management folder: epmautomate uploadfile "C:/fdmee_data/data.zip" inbox/repository

  • Upload into profitinbox (Oracle Profitability and Cost Management Cloud): epmautomate uploadfile "C:/profitability_data/data.zip" profitinbox

userauditreport

Generates a user audit report (.CSV file) and stores it in the default download location from where you can download it to your computer. This report contains information on the users who signed into a service instance over a specified period of time. It shows the IP address of the computer from which the user logged in and the date and time at which the user accessed the service instance.

Usage: epmautomate userauditreport FROM_DATE TO_DATE REPORT_NAME where:

  • FROM_DATE indicates the start date (in YYYY-MM-DD format) of the period for which the audit report is to be generated

  • TO_DATE indicates the end date (in YYYY-MM-DD format) of the period for which the audit report is to be generated

  • REPORT_NAME is the name of the report file

Example: epmautomate userauditreport 2016-10-15 2016-12-15 myAuditReport.CSV