Commands at a Glance

This is an alphabetical listing of all EPM Automate commands.

Table 2-1 All EPM Automate Commands

Command Name PLN, SWP, SP, FF FCC TR PCM EPCM AR EDM NR
addUsers Yes Yes Yes Yes Yes Yes Yes Yes
addUsersToGroup Yes Yes Yes Yes Yes Yes Yes Yes
addUsersToTeam   Yes Yes     Yes    
addUserToGroups Yes Yes Yes Yes Yes Yes Yes Yes
applicationAdminMode Yes Yes Yes   Yes      
applyDataGrants       Yes        
archiveTmTransactions           Yes    
assignRole Yes Yes Yes Yes Yes Yes Yes Yes
autoPredict* See Footnote Yes              
calculateModel         Yes      
clearCube Yes       Yes      
clearDataByPointOfView         Yes      
clearDataByProfile   Yes Yes          
clearPOV       Yes        
cloneEnvironment Yes Yes Yes Yes Yes Yes Yes Yes
copyDataByPointOfView         Yes      
copyDataByProfile   Yes Yes          
copyFileFromInstance Yes Yes Yes Yes Yes Yes Yes Yes
copyFromObjectStorage Yes Yes Yes Yes Yes Yes Yes Yes
copyOwnershipDataToNextYear   Yes Yes          
copyPOV       Yes        
copySnapshotFromInstance Yes Yes Yes Yes Yes Yes Yes  
copyToObjectStorage Yes Yes Yes Yes Yes Yes Yes Yes
createGroups Yes Yes Yes Yes Yes Yes Yes Yes
createNRSnapshot               Yes
createReconciliations           Yes    
deleteFile Yes Yes Yes Yes Yes Yes Yes Yes
deleteGroups Yes Yes Yes Yes Yes Yes Yes Yes
deletePointOfView         Yes      
deletePOV       Yes        
deployCube       Yes        
deployEJTemplates   Yes            
deployFormTemplates   Yes Yes          

deployTaskManagerTemplate

  Yes            
dismissIPMInsights** Yes              
downloadFile Yes Yes Yes Yes Yes Yes Yes Yes
enableApp       Yes        
enableQueryTracking Yes       Yes      
encrypt Yes Yes Yes Yes Yes Yes Yes Yes
essbaseBlockAnalysisReport Yes Yes Yes          
executeAggregationProcess Yes       Yes      
executeBurstDefinition               Yes
executeReportBurstingDefinition Yes Yes Yes   Yes      
exportAccessControl           Yes    
exportAppAudit Yes Yes Yes   Yes      
exportAppSecurity Yes Yes Yes   Yes      
exportARApplicationProperties           Yes    
exportBackgroundImage           Yes    
exportCellLevelSecurity Yes   Yes   Yes      
exportData Yes Yes Yes   Yes      
exportConsolidationJournals   Yes            
exportDataManagement Yes Yes Yes Yes Yes      
exportDimension             Yes  
exportDimensionMapping             Yes  
exportEJJournals   Yes            
exportEssbaseData Yes Yes Yes   Yes      
exportJobConsole Yes Yes Yes   Yes      
exportLibraryArtifact               Yes
exportLibraryDocument Yes Yes Yes   Yes      
exportLogoImage           Yes    
exportMapping Yes Yes Yes Yes Yes Yes    
exportMetadata Yes Yes Yes   Yes      
exportOwnershipData   Yes Yes          
exportQueryResults       Yes        
exportSnapshot Yes Yes Yes Yes Yes Yes Yes  
exportTemplate       Yes        
exportTaskManagerAccessControl   Yes Yes          
exportValidIntersections Yes Yes Yes   Yes      
extractDimension             Yes  
feedback Yes Yes Yes Yes Yes Yes Yes Yes
getApplicationAdminMode Yes Yes Yes   Yes Yes    
getDailyMaintenanceStartTime Yes Yes Yes Yes Yes Yes Yes Yes
getEssbaseQryGovExecTime Yes Yes Yes Yes Yes      
getIdleSessionTimeout Yes Yes Yes Yes Yes Yes Yes Yes
getIPAllowlist Yes Yes Yes Yes Yes Yes Yes Yes
getRestrictedDataAccess Yes Yes Yes Yes Yes Yes Yes Yes
getSubstVar Yes Yes Yes   Yes      
getVirusScanOnFileUploads Yes Yes Yes Yes Yes Yes Yes Yes
groupAssignmentAuditReport Yes Yes Yes Yes Yes Yes Yes Yes
help Yes Yes Yes Yes Yes Yes Yes Yes
importAppAudit Yes       Yes      
importAppSecurity Yes Yes Yes   Yes      
importARApplicationProperties           Yes    
importBackgroundImage           Yes    
importBalances           Yes    
importCellLevelSecurity Yes   Yes   Yes      
importConsolidationJournals   Yes            
importData Yes Yes Yes Yes Yes      
importDataManagement Yes Yes Yes Yes Yes      
importDimension             Yes  
importJobConsole Yes Yes Yes   Yes      
importLibraryArtifact               Yes
importLogoImage           Yes    
importMapping Yes Yes Yes Yes Yes Yes    
importMetadata Yes Yes Yes   Yes      
importOwnershipData   Yes Yes          
importPreMappedBalances           Yes    
importPreMappedTransactions           Yes    
importProfiles           Yes    
importRates           Yes    
importRCAttributeValues           Yes    
importReconciliationAttributes           Yes    
importSnapshot Yes Yes Yes Yes Yes Yes Yes  
importSupplementalCollectionData   Yes Yes          
importSupplementalData   Yes Yes          
importTemplate       Yes        
importTMAttributeValues           Yes    
importValidIntersections Yes Yes Yes   Yes      
invalidLoginReport Yes Yes Yes Yes Yes Yes Yes Yes
listBackups Yes Yes Yes Yes Yes Yes Yes Yes
listFiles Yes Yes Yes Yes Yes Yes Yes Yes
loadData       Yes        
loadDimData       Yes        
loadViewpoint             Yes  
login Yes Yes Yes Yes Yes Yes Yes Yes
logout Yes Yes Yes Yes Yes Yes Yes Yes
maskData Yes Yes Yes   Yes      
mergeDataSlices Yes       Yes      
mergeSlices       Yes        
optimizeASOCube       Yes        
programDocumentationReport       Yes        
provisionReport Yes Yes Yes Yes Yes Yes Yes Yes
purgeArchivedTmTransactions           Yes    
purgeTmTransactions           Yes    
recomputeOwnershipData   Yes Yes          
recreate Yes Yes Yes Yes Yes Yes Yes Yes
refreshCube Yes Yes Yes   Yes      
removeUserFromGroups Yes Yes Yes Yes Yes Yes Yes Yes
removeUsers Yes Yes Yes Yes Yes Yes Yes Yes
removeUsersFromGroup Yes Yes Yes Yes Yes Yes Yes Yes
removeUsersFromTeam   Yes Yes     Yes    
renameSnapshot Yes Yes Yes Yes Yes Yes Yes  
replay Yes Yes Yes Yes Yes Yes Yes Yes
resetService Yes Yes Yes Yes Yes Yes Yes Yes
restoreBackup Yes Yes Yes Yes Yes Yes Yes Yes
restructureCube Yes Yes Yes          
roleAssignmentAuditReport Yes Yes Yes Yes Yes Yes Yes Yes
roleAssignmentReport Yes Yes Yes Yes Yes Yes Yes Yes
runAutomatch           Yes    
runBatch Yes Yes Yes Yes Yes Yes    
runBusinessRule Yes Yes Yes          
runCalc       Yes        
runComplianceReport           Yes    
runDailyMaintenance Yes Yes Yes Yes Yes Yes Yes Yes
runDataRule Yes Yes Yes Yes Yes Yes    
runDMReport Yes Yes Yes Yes Yes Yes    
runIntegration Yes Yes Yes Yes Yes Yes    
runIntercompanyMatchingReport   Yes            
runMatchingReport           Yes    
runPlanTypeMap Yes              
runRuleSet Yes Yes Yes          
runSupplementalDataReport   Yes Yes          
runTaskManagerReport   Yes Yes          
sendMail Yes Yes Yes Yes Yes Yes Yes Yes
setApplicationAdminMode Yes Yes Yes   Yes Yes    
setDailyMaintenanceStartTime Yes Yes Yes Yes Yes Yes Yes Yes
setDemoDates   Yes Yes     Yes    
setEJJournalStatus   Yes            
setEncryptionKey Yes Yes Yes Yes Yes Yes Yes Yes
setEssbaseQryGovExecTime Yes Yes Yes Yes Yes      
setIdleSessionTimeout Yes Yes Yes Yes Yes Yes Yes Yes
setIPAllowlist Yes Yes Yes Yes Yes Yes Yes Yes
setManualDataAccess Yes Yes Yes Yes Yes Yes Yes Yes
setPeriodStatus           Yes    
setRestrictedDataAccess Yes Yes Yes Yes Yes Yes Yes Yes
setSubstVars Yes Yes Yes   Yes      
setVirusScanOnFileUploads Yes Yes Yes Yes Yes Yes Yes Yes
simulateConcurrentUsage Yes Yes Yes          
skipUpdate Yes Yes Yes Yes Yes Yes Yes Yes
snapshotCompareReport Yes Yes Yes   Yes      
sortMember Yes       Yes      
unassignRole Yes Yes Yes Yes Yes Yes Yes Yes
updateUsers Yes Yes Yes Yes Yes Yes Yes Yes
upgrade Yes Yes Yes Yes Yes Yes Yes Yes
uploadFile Yes Yes Yes Yes Yes Yes Yes Yes
userAuditReport Yes Yes Yes Yes Yes Yes Yes Yes
userGroupReport Yes Yes Yes Yes Yes Yes Yes Yes
validateConsolidationMetadata   Yes            
validateModel         Yes      
  • * This command is supported only if Hybrid Oracle Essbase cubes are enabled in the application. Strategic Workforce Planning and Sales Planning do not support Hybrid Essbase. This command is not supported for FreeForm.
  • ** This command is not supported for FreeForm.

Abbreviations

  • PLN: Planning (including Planning Modules)
  • FF: FreeForm
  • SWP: Strategic Workforce Planning
  • SP: Sales Planning
  • FCC: Financial Consolidation and Close
  • TR: Tax Reporting
  • PCM: Profitability and Cost Management
  • EPCM: Enterprise Profitability and Cost Management
  • AR: Account Reconciliation
  • EDM: Oracle Enterprise Data Management Cloud
  • NR: Narrative Reporting