downloadFile

Downloads a file from an environment to the local computer.

Use this command is to download data, metadata, and back up snapshots for local storage. The file is downloaded into the folder from which you run EPM Automate.

If this command is executed to download the current snapshot while the snapshot of the environment is being generated; for example, during the daily maintenance, you will receive the File not found error.

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, Oracle Sales Planning Cloud, and Oracle Strategic Workforce Planning Cloud.

Required Roles

Service Administrator

Usage

epmautomate downloadFile "[FILE_PATH]/FILE_NAME"

Examples

  • Download maintenance snapshot: epmautomate downloadFile "Artifact Snapshot"
  • Download a custom snapshot: epmautomate downloadFile "mySnapshot.zip"
  • Download a Narrative Reporting maintenance snapshot: epmautomate downloadFile "EPRCS_Backup.tar.gz"
  • 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