Table of Contents
- Title and Copyright Information
- Documentation Accessibility
- Documentation Feedback
- 1 About EPM Automate
-
2
Command Reference
- About Running EPM Automate Commands
- Running EPM Automate
- Commands at a Glance
-
EPM Automate Commands
- addUsers
- addUsersToGroup
- addUsersToTeam
- addUserToGroups
- applicationAdminMode
- applyDataGrants
- archiveTmTransactions
- assignRole
- autoPredict
- calculateModel
- clearCube
- clearDataByPointOfView
- clearDataByProfile
- clearPOV
- cloneEnvironment
- compactCube
- copyDataByPointOfView
- copyDataByProfile
- copyFileFromInstance
- copyFromObjectStorage
- copyFromSFTP
- copyOwnershipDataToNextYear
- copyPOV
- copySnapshotFromInstance
- copyToObjectStorage
- copyToSFTP
- createGroups
- createNRSnapshot
- createReconciliations
- deleteFile
- deleteGroups
- deletePointOfView
- deletePOV
- deployCube
- deployEJTemplates
- deployFormTemplates
- deployTaskManagerTemplate
- dismissIPMInsights
- downloadFile
- enableApp
- enableQueryTracking
- encrypt
- essbaseBlockAnalysisReport
- executeAggregationProcess
- executeBurstDefinition
- executeReportBurstingDefinition
- exportAccessControl
- exportAppAudit
- exportAppSecurity
- exportARApplicationProperties
- exportBackgroundImage
- exportCellLevelSecurity
- exportConsolidationJournals
- exportData
- exportDataManagement
- exportDimension
- exportDimensionMapping
- exportEJJournals
- exportEssbaseData
- exportJobConsole
- exportLibraryArtifact
- exportLibraryDocument
- exportLogoImage
- exportMapping
- exportMetadata
- exportOwnershipData
- exportQueryResults
- exportSnapshot
- exportTemplate
- exportTaskManagerAccessControl
- exportValidIntersections
- extractDimension
- extractPackage
- feedback
- getApplicationAdminMode
- getDailyMaintenanceStartTime
- getEssbaseQryGovExecTime
- getIdleSessionTimeout
- getIPAllowlist
- getRestrictedDataAccess
- getSubstVar
- getVirusScanOnFileUploads
- groupAssignmentAuditReport
- help
- importAppAudit
- importAppSecurity
- importARApplicationProperties
- importBackgroundImage
- importBalances
- importCellLevelSecurity
- importConsolidationJournals
- importData
- importDataManagement
- importDimension
- importEJDimensionMembers
- importJobConsole
- importLibraryArtifact
- importLogoImage
- importMapping
- importMetadata
- importOwnershipData
- importPreMappedBalances
- importPreMappedTransactions
- importProfiles
- importRates
- importRCAttributeValues
- importReconciliationAttributes
- importSDMDimensionMembers
- importSnapshot
- importSupplementalCollectionData
- importSupplementalData
- importTemplate
- importTMAttributeValues
- importTmPremappedTransactions
- importValidIntersections
- invalidLoginReport
- listBackups
- listFiles
- loadData
- loadDimensionViewpoint
- loadDimData
- loadViewpoint
- login
- logout
- maskData
- mergeDataSlices
- mergeSlices
- optimizeASOCube
- programDocumentationReport
- provisionReport
- purgeArchivedTmTransactions
- purgeTmTransactions
- recomputeOwnershipData
- recreate
- refreshCube
- removeUserFromGroups
- removeUsers
- removeUsersFromGroup
- removeUsersFromTeam
- renameSnapshot
- replay
- resetService
- restoreBackup
- restructureCube
- roleAssignmentAuditReport
- roleAssignmentReport
- runAutoAlert
- runAutomatch
- runBatch
- runBusinessRule
- runCalc
- runComplianceReport
- runDailyMaintenance
- runDataRule
- runDMReport
- runIntegration
- runIntercompanyMatchingReport
- runMatchingReport
- runPipeline
- runPlanTypeMap
- runRuleSet
- runSupplementalDataReport
- runTaskManagerReport
- sendMail
- setApplicationAdminMode
- setDailyMaintenanceStartTime
- setDemoDates
- setEJJournalStatus
- setEncryptionKey
- setEssbaseQryGovExecTime
- setIdleSessionTimeout
- setIPAllowlist
- setManualDataAccess
- setPeriodStatus
- setRestrictedDataAccess
- setSubstVars
- setVirusScanOnFileUploads
- simulateConcurrentUsage
- skipUpdate
- snapshotCompareReport
- sortMember
- unassignRole
- updateGuidedLearningSettings
- updateUsers
- upgrade
- uploadFile
- userAuditReport
- userGroupReport
- validateConsolidationMetadata
- validateModel
- Exit Codes
-
3
Command Execution Sample Scenarios
- About Copying Sample Scripts
-
Sample Scenarios for All Services
- Back up Application Snapshot to a Computer
- Inform Users of Daily Maintenance Completion
- Copying a Snapshot to or from Oracle Object Storage
- Create Users and Assign Them to Predefined Roles
- Count the Number of Licensed Users (Users Assigned to Roles)
- Create Audit Reports of Users Assigned to Roles
- Create Role Assignment and Revocation Audit Report
- Mask Access Logs and Activity Report to Comply with Privacy Laws
- Automate Activity Report Downloads to a Local Computer
- Download Access Logs from an Environment
- Automate the Cloning of Environments
- Clone from Primary to Standby Environment Daily After Daily Maintenance is Complete on the Primary Environment
- Remove Unnecessary Files from an Environment
- Find and Download Files from an Environment
- Recreate an Old Cloud EPM Environment for Audits
- Automate Database Access Audit and Compliance
- Replicate Users and Predefined Role Assignments
- Create a Quarterly Cloud EPM Upgrade Cadence
- Create a Quarterly Cloud EPM Upgrade Cadence with Six Week Test Cycles
-
Sample Scenarios for Planning, Consolidation, Tax Reporting, and Enterprise Profitability and Cost Management
- Automate the Export of a Large Number of Cells from an Aggregate Storage Cube
- Import Metadata into an Application
- Import Data, Run a Calculation Script, and Copy Data from a Block Storage Database to an Aggregate Storage Database
- Export and Download Metadata and Data
- Export and Download Application Data
- Automate the Archiving of Application Audit Records
- Upload a Data File to an Environment and Run a Data Load Rule
- Automate Daily Data Integration
- Sample Scenarios for Account Reconciliation
- Sample Scenarios for Profitability and Cost Management
- Sample Scenarios for Cloud EDM
- Automating Script Execution
- Monitoring EPM Automate Activities
- 4 Running Commands without Installing EPM Automate
- 5 Replicating Cloud EPM Environments
- A Preparing to Run the simulateConcurrentUsage Command
- B Preparing to Run the Replay Command
- C Handling Special Characters
-
D
Commands Specific to Each Cloud EPM Service
- Account Reconciliation Commands
- Financial Consolidation and Close Commands
- Narrative Reporting Commands
- Cloud EDM Commands
- Planning, Planning Modules, FreeForm, Strategic Workforce Planning, and Sales Planning Commands
- Profitability and Cost Management Commands
- Enterprise Profitability and Cost Management Commands
- Tax Reporting Commands