Oracle Cloud Working with EPM Automate for Oracle Enterprise Performance Management Cloud,
E71316-02
Copyright 2016, Oracle and/or its affiliates. All rights reserved.
Primary Author: EPM Information Development Team
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS:
Oracle programs, including any operating system, integrated software, any programs installed on the
hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer
software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental
regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including
any operating system, integrated software, any programs installed on the hardware, and/or documentation,
shall be subject to license terms and license restrictions applicable to the programs. No other rights are
granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron,
the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro
Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless
otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates
will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party
content, products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
Documentation Accessibility ...................................................................................................................... v
Documentation Feedback ......................................................................................................................... vii
1
1-1
Windows ....................................................................................................................................................
1-2
Linux/UNIX ..............................................................................................................................................
1-2
Command Reference
EPM Automate Utility Commands Applicable Across Services .......................................................
2-1
2-7
3-1
3-1
3-2
3-2
3-3
3-3
3-3
to Planning...................................................................................................................................
3-5
3-5
iii
3-6
3-8
iv
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at http://www.oracle.com/pls/topic/lookup?
ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers that have purchased support have access to electronic support
through My Oracle Support. For information, visit http://www.oracle.com/pls/
topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?
ctx=acc&id=trs if you are hearing impaired.
Documentation Feedback
Send feedback on this documentation to: epmdoc_ww@oracle.com
Follow EPM Information Development on these social media sites:
LinkedIn - http://www.linkedin.com/groups?gid=3127051&goback=.gmp_3127051
Twitter - http://twitter.com/hyperionepminfo
Facebook - http://www.facebook.com/pages/Hyperion-EPM-Info/102682103112642
Google+ - https://plus.google.com/106915048672979407731/
#106915048672979407731/posts
YouTube - https://www.youtube.com/user/EvolvingBI
vii
1
About the EPM Automate Utility
The EPM Automate Utility enables Service Administrators to remotely perform tasks
within service instances. It enables Service Administrators to automate many
repeatable tasks including the following:
Import and export metadata and data
Refresh the application
Run business rules on data
Copy data from one database to another; typically, from a block storage database to
an aggregate storage database or from a block storage database to another block
storage database
Upload files into service instances, list files, and delete files from the service
Run a Data Management batch rule and get the output log file
Export and import application and artifact snapshots
Import pre-mapped balance data into Oracle Account Reconciliation Cloud cloud
Import currency rates, pre-mapped transactions, and profiles into Oracle Account
Reconciliation cloud
Copy profiles to a period to initiate the reconciliation process
You can create scripts that are capable of completing a wide array of tasks and
automate their execution using a scheduler. For example, you can create a script to
download the daily maintenance backup from service instances to create local backups
of your artifacts and data.
Video overview of the EPM Automate Utility
Tutorial: How to execute Oracle Planning and Budgeting Cloud tasks using
EPM Automate Utility
Windows
Note:
Windows
By default, the EPM Automate Utility is installed in C:/Oracle/EPM Automate.
To install the utility:
1. From the Windows computer where you want to install the utility, access a service
instance.
administrator.
6. In User Account Control, click Yes.
7. Follow onscreen prompts to complete the installation.
Linux/UNIX
To install the utility:
1. Access a service instance.
2. On the Home page, tap or click Navigator.
3. Under Install, tap or click EPM Automate (For Linux/Unix).
4. Save the installer (EPMAutomate.tar) in a directory in which you have read/
write/execute privileges.
5. Using a command such as the following, extract the contents of the installer:
tar -xvf EPMAutomate.tar
1-2 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
2
Command Reference
Information that you need to run the utility are organized based on the service with
which you are working. Typically, to work with a service you should refer to two
sections: general and a service specific section.
EPM Automate Utility Commands Applicable Across Services
Oracle Planning and Budgeting Cloud-Specific Commands
Data Management-Specific Commands
Oracle Account Reconciliation Cloud-Specific Commands
Note: The utility uses the proxy settings specified on your computer.
Table 2-1
Table 2-1
(Cont.) EPM Automate Utility Commands That Work with All Services
Command
Description
help
Displays help.
Usage: epmautomate help (to access the command
reference page from where you can access descriptions of all
EPM Automate Utility commands) or epmautomate
COMMAND_NAME help to display help for a specific
command.
Example: epmautomate login help
encrypt
2-2 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Table 2-1
(Cont.) EPM Automate Utility Commands That Work with All Services
Command
Description
login
logout
uploadfile
Table 2-1
(Cont.) EPM Automate Utility Commands That Work with All Services
Command
Description
downloadfile
listfiles
deletefile
exportsnapshot
importsnapshot
2-4 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Table 2-1
(Cont.) EPM Automate Utility Commands That Work with All Services
Command
Description
copysnapshotfrominsta
nce
recreate -f
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
provisionreport
Table 2-1
(Cont.) EPM Automate Utility Commands That Work with All Services
Command
Description
userauditreport
feedback
Note:
Comments must be enclosed in
quotation marks.
Usage: epmautomate feedback "comment"
Example: epmautomate feedback "runplantypemap
CampaignToReporting ClearData=True did not
clear data from aggregate storage"
2-6 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Table 2-1
(Cont.) EPM Automate Utility Commands That Work with All Services
Command
Description
resetservice
Note:
Comments must be enclosed in
quotation marks.
Usage: epmautomate resetservice "comment"
Example: epmautomate resetservice "Users
experience unacceptably slow connctions"
EPM Automate Utility Commands for Oracle Planning and Budgeting Cloud
You must be a Service Administrator to execute these commands. To complete tasks
using the utility, you may also need to use some of the commands discussed in EPM
Automate Utility Commands Applicable Across Services.
Table 2-2
Command
Description
importdata
exportdata
Exports application data into a file using the export data settings,
including file name, specified in a Planning job of type export
data. You can view details of the exported file using the
Planning Inbox/Outbox Explorer.
Optionally, you can specify a file name for the exported data.
Data is exported as a ZIP file only.
Data is exported as a .ZIP file only. The exported file is stored in
thePlanning inbox/outbox.
Usage: epmautomate exportdata JOB_NAME
[FILE_NAME], where: JOB_NAME is the name of a job defined in
the Planning application and FILE_NAME is the name of
the .ZIP file into which data is to be exported.
Example: epmautomate exportdata dailydataexport
dailyData.zip
refreshcube
2-8 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Table 2-2
Command
Description
runbusinessrule
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
runplantypemap
Table 2-2
Command
Description
importmetadata
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.
Usage: epmautomate importmetadata JOB_NAME
[FILE_NAME] , where JOB_NAME is the name of a job defined in
the Planning application and FILE_NAME is the name of the ZIP
file from which metadata is to be imported.
Example: epmautomate importmetadata importAccount
importAccount.zip
exportmetadata
2-10 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Table 2-2
Command
Description
setsubstvars
Table 2-3
Command
Description
rundatarule
2-12 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Table 2-3
Command
Description
runbatch
Command
Description
importpremappedbalances
Table 2-4
Command
Description
importrates
importprofiles
2-14 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Status Codes
Table 2-4
Command
Description
createreconciliations
setperiodstatus
setdemodates
Status Codes
The EPM Automate Utility returns a code to indicate the status of the operation.
Table 2-5
Status Code
Description
Cancel pending.
Incorrect parameters.
Insufficient privileges.
Invalid command.
Invalid parameter.
10
Expired password.
11
Windows
Before running the EPM Automate Utility, ensure that you can access Oracle Planning
and Budgeting Cloud from the computer from which you are running the utility.
To run the EPM Automate Utility on a Windows client:
1. Click Start, then All Programs, then EPM Automate, and then Launch EPM
2. Optional: Navigate to the directory from which you want to perform operations
3. Optional: Generate a password encryption file. You use the password encryption
2-16 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Linux
Note:
Ensure that JAVA_HOME is set in the PATH variable of your .profile file or
as a shell environment variable.
To run the EPM Automate Utility on a Linux client:
1. Open a terminal window and navigate to the directory where you installed the
2. Optional: Generate a password encryption file. You use the password encryption
2-18 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
3
Command Execution Sample Scenarios
Oracle Planning and Budgeting Cloud Sample Scenarios
Oracle Account Reconciliation Cloud Sample Scenarios
Scenario 2: Import Data, Run a Calculation Script, and Copy Data from a Block Storage
Database to an Aggregate Storage Database
In this scenario, you run a sequence of commands to complete these steps:
Sign in to the instance.
Upload a file data.csv.
Import data from data.csv into the application using job loadingq1data.
Refresh the cube.
Run business rule RevenueAllocation deployed to plan type RollupUSSales
with runtime prompts Quarter=Q1 Entity=USA to transform data.
Push data to an aggregate storage database using job CampaignToReporting.
Sign out.
epmautomate login serviceAdmin C:\mySecuredir\password.epw
https://test-cloud-pln.pbcs.us1.oraclecloud.com myIdentityDomain
epmautomate uploadfile data.csv
epmautomate importdata loadingq1data data.csv
epmautomate refreshcube
epmautomate runbusinessrule RevenueAllocation Quarter=Q1 Entity=USA
epmautomate runplantypemap CampaignToReporting clearData=true
epmautomate logout
3-2 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Prerequisites
The identity domain used by the service instance you are cloning (source) and the
service instance that you are creating as the clone (target) should use an identical set of
users and role assignments.
If the source and target reside in the same data center, they should share an
identity domain.
If the source and target do not share a data center, you must manually create the
set of users and role assignments of the source in the identity domain of the target.
Cloning an Instance
This scenario uses the following source information:
URL: https://test-cloud-pln.pbcs.us1.oraclecloud.com
Identity Domain: myprodIdentityDomain
To clone a service instance, you run commands that complete these steps:
Sign in to the target instance where you want to establish the clone using these
credentials:
User name: serviceAdmin
Password file: C:/mySecuredir/password2.epw
You must create this file. See the encrypt command in Oracle Planning and
Budgeting Cloud-Specific Commands.
URL: https://test-cloud-pln.pbcs.us2.oraclecloud.com
Identity Domain: myNewIdentityDomain
Re-create the service instance.
Delete Artifact Snapshot if it is present.
Clone the instance by copying the snapshot Artifact Snapshot from the source
instance.
Import artifacts from Artifact Snapshot.
Sign out.
epmautomate login serviceAdmin C:\mySecuredir\password2.epw
https://test-cloud-pln.pbcs.us2.oraclecloud.com myNewIdentityDomain
epmautomate recreate -f
epmautomate deletefile "Artifact Snapshot"
epmautomate copysnapshotfrominstance "Artifact Snapshot" C:\mySecuredir\password.epw
https://test-cloud-pln.pbcs.us1.oraclecloud.com myprodIdentityDomain
epmautomate importsnapshot "Artifact Snapshot"
epmautomate logout
3-4 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Scenario 7: Import Data into Data Management, Run a Data Load Rule, and Export Data
to Planning
Prerequisites
The following definitions in Data Management:
A data load rule definition named VisionActual
Period definitions Mar-15 through Jun-15
A properly formatted data file (GLActual.dat) that contains data.
Importing Data into Data Management and Running a Data Load Rule
To import data and run data load rule, you run commands that complete these steps:
Sign in to the service instance.
Upload a file GLActual.dat that contains data for periods Mar-15 through
Jun-15 into Data Management folder inbox/Vision
Import data from GLActual.dat into Data Management using data load rule
VisionActual, start period Mar-15, end period Jun-15, and import mode
REPLACE.
Export data with the STORE_DATA option to merge the data in the Data
Management staging table with existing Oracle Hyperion Planning data.
Sign out.
epmautomate login serviceAdmin C:\mySecuredir\password.epw
https://test-cloud-pln.pbcs.us1.oraclecloud.com myIdentityDomain
epmautomate uploadfile GLActual.dat inbox/Vision
epmautomate rundatarule VisionActual Mar-15 Jun-15 REPLACE STORE_DATA inbox/Vision/
GLActual.dat
epmautomate logout
If you repurpose this script for your use, modify the values of SET url, SET
user, and SET NumberOfBackups parameters as needed.
See Automating Script Execution for information on scheduling the script using
Windows Task Scheduler.
@echo off
rem Sample script to download and maintain 10 maintenance backups
rem Update the following three parameters
SET
SET
SET
SET
SET
url=https://test-cloud-pln.pbcs.us1.oraclecloud.com
user=serviceAdmin@oracle.com
NumberOfBackups=10
password=%1
SnapshotName=Artifact Snapshot
3-6 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
If you repurpose this script for your use, ensure that you modify the values of
SET url, SET user, and SET domain parameters. Additionally, you may
modify the values of dataimportfilename, dataexportfilename,
importdatajobname, exportdatajobname, br_clear,
br_calculatebalancesheet, and br_allocatetarget parameters to
suit your requirements
See Automating Script Execution for information on scheduling the script using
Windows Task Scheduler.
@echo off
rem
rem
rem
rem
rem
rem
SET
SET
SET
SET
SET
SET
SET
SET
SET
SET
SET password=%1
rem Executing EPM Automate commands
CD /D %~dp0
call epmautomate login %user% %password% %url% %domain%
IF %ERRORLEVEL% NEQ 0 goto :ERROR
for /f %%i in ('call epmautomate listfiles') do if %%i==%dataimportfilename% (call
epmautomate deletefile %%i)
IF %ERRORLEVEL% NEQ 0 goto :ERROR
call epmautomate uploadfile %dataimportfilename%
IF %ERRORLEVEL% NEQ 0 goto :ERROR
3-8 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
Note:
The following script assumes that you pass parameter values in this format as
part of script execution: clone username passwordsource URL source
identity doamin target URL target password target identity
domain. For example, clone serviceAdmin@oracle.com P@ssw0rd
https://test-cloud-pln.pbcs.us1.oraclecloud.com
myIdentityDomain https://test-cloudpln.pbcs.us2.oraclecloud.com P@ssw0rd2
myNewIdentityDomain.
Note:
The source and target instances in this sample use different identity domains.
Before running this script, you must manually create the set of users and role
assignments of the source in the identity domain of the target.
See Automating Script Execution for information on scheduling the script using
Windows Task Scheduler.
@echo off
SET /A ARGS_COUNT=0
FOR %%A in (%*) DO SET /A ARGS_COUNT+=1
if %ARGS_COUNT% == 0 (
cls
echo.
echo Welcome to Clone
echo Type Clone help and press ^ENTER for help.
echo.
exit /b 0
)
IF /I %1=="help" goto :HELP
REM echo %ARGS_COUNT%
if %ARGS_COUNT% NEQ 7 (
goto :HELP
)
set user=%1
set password=%2
set url1=%3
set domain=%4
set url2=%5
set tgtPassword=%6
set tgtDomain=%7
set returnValue=0
CD /D %~dp0
echo Login to Target Environment
call epmautomate login %user% %tgtPassword% %url2% %tgtDomain%
IF %ERRORLEVEL% NEQ 0 (
echo Login into target environment failed with error %ERRORLEVEL%.
goto :END
)
echo Recreating Target Environment
call epmautomate recreate -f
IF %ERRORLEVEL% NEQ 0 (
echo Recreate failed on target environment with error %ERRORLEVEL%.
goto :END
)
echo Deleting Old Artifact Snapshot from the Target Environment
call epmautomate deletefile "Artifact Snapshot" > NUL
IF %ERRORLEVEL% NEQ 0 (
IF %ERRORLEVEL% NEQ 8 (
echo deletefile failed on target environment with error %ERRORLEVEL%.
goto :END
)
)
echo Copying Artifact Snapashot from the Source Environment to Target
call epmautomate copysnapshotfrominstance "Artifact Snapshot" %password% %url1%
%domain%
IF %ERRORLEVEL% NEQ 0 (
echo Login into target environment failed with error %ERRORLEVEL%.
goto :END
)
echo Importing Snapshot into the Target Environment
call epmautomate importsnapshot "Artifact Snapshot"
IF %ERRORLEVEL% NEQ 0 (
echo Restore failed on target environment with error %ERRORLEVEL%.
goto :END
)
echo Logging out from the Target Environment
call epmautomate logout
IF %ERRORLEVEL% NEQ 0 (
echo Logout failed with error %ERRORLEVEL%.
goto :END
)
echo Clone on target completed
:printOnConsole
echo.
echo %1
echo.
:HELP
echo.
echo Usage : Clone ^<user name^> ^<Source password^> ^<Source domain^> ^<Source
URL^> ^<Target URL^> ^<Target password^> ^<Target domain^>
echo All the values are mandatory for clone to execute
exit /B 0
:END
set returnValue=%ERRORLEVEL%
exit /B %returnValue%
3-10 Working with EPM Automate for Oracle Enterprise Performance Management Cloud
This is a manually created file. See the encrypt command in EPM Automate
Utility Commands Applicable Across Services
Service URL: https://test-cloud-arcs.us1.oraclecloud.com
Identity domain: myARCSDomain
Scenario 1: Load Preformatted Balances into a Period
Scenario 2: Use a Snapshot to Recover From Crash
For example, the preceding sample script is designed to be run every day to
download artifact snapshots created during the maintenance window.
6. In the next screen, specify other schedule parameters, and then click Next.
7. In Action, ensure that Start a program is selected.
8. In Start a Program, complete these steps:
a. In Program/script, browse and select the script that you want to schedule.
b. In Add arguments (optional), enter the password of the Service Administrator
d. Click Next.
9. In Summary, select Open the Properties dialog for this task when I click Finish,
10. In General, select these security options, and then click OK.
3-12 Working with EPM Automate for Oracle Enterprise Performance Management Cloud