downloadFile

Downloads a file from an environment to the local computer.

Use this command 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 or the Invalid File 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 Fusion Cloud Enterprise Data Management, Narrative Reporting, Sales Planning, and Strategic Workforce Planning.

Required Roles

• Service Administrator
• Any predefined role and the Migrations - Administer application role

Usage

epmautomate downloadFile "[FILE_PATH]/FILE_NAME]"

Tip:

Use the listFiles command to identify where the file you want to download is located.

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
• Download activity report 2025-06-01 20_38_43.html from the apr/2025-06-01 foler in an Account Reconciliation environment:

  epmautomate downloadfile "apr/2025-06-01 20_38_43/2025-06-01 20_38_43.html"