restoreEnvironment

Restores an environment from an environment backup created by the daily maintenance process.

Additionally, this command can complete these optional tasks:

  • Restore users and their predefined role assignments
  • Reset the daily maintenance start time to that of the environment based on the value in the backup snapshot
  • Restore the contents of the inbox and outbox and stored snapshot to match those in the backup snapshot

This command is to be used to restore environments that have experienced crashes or data loss due to application changes and cannot be restored from the backup snapshots that you created.

Applies to

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

Required Roles

  • Service Administrator
  • To restore users and predefined role assignments:
    • Service Administrator
    • Identity Domain Administrator and any predefined role

Usage

epmautomate restoreEnvironment ENV_BACKUP_NAME [UsersAndPreDefinedRoles=true|false] [DailyMaintenanceStartTime=true|false] [StoredSnapshotsAndFiles=true|false], where:
  • ENV_BACKUP_NAME is the name of the environment backup snapshot that you want to use to restore the current environment.

    Note:

    • This is not a backup snapshot that you manually created, but an environment backup created during a daily maintenance.
    • Use the listBackups command to see environment backups available in Oracle Object Storage. Each environment backup is stored in a folder; for example, 2026-05-23T09:57:25/Environment_Backup, indicating when it was created.
  • UsersAndPreDefinedRoles, optionally, indicates whether to restore users and their predefined role assignments. EPM groups and granular role assignments are always restored irrespective of this value. Default is false.
  • DailyMaintenanceStartTime, optionally, indicates whether to reset the maintenance start time of the restored environment to match the setting in the environment backup. The default is true. To keep the current maintenance start time of th3 environment, set this value to false.
  • StoredSnapshotsAndFiles=true|false, optionally, indicates whether to restore the contents of the inbox and outbox and stored snapshots from the environment backup. The default is false.

Example

epmautomate restoreEnvironment 2026-04-15T06:40:34/Environment_Backup DailyMaintenanceStartTime=false storedSnapshotsAndFiles=true