1. Working with EPM Automate for Oracle Enterprise Performance Management Cloud
  2. Command Reference
  3. EPM Automate Commands
  4. copyFromObjectStorage

copyFromObjectStorage

Copies a file or backup snapshot from an Oracle Object Storage bucket to the current environment.

If you are copying a backup snapshot, this command copies it from the Object Storage bucket and extracts its contents in Oracle Enterprise Performance Management Cloud.

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

Required Roles

Service Administrator

Usage

epmautomate copyFromObjectStorage USERNAME PASSWORD URL TARGET_FILE_NAME where:

  • USERNAME is the ID of a user who has the required access rights in Oracle Object Storage Cloud.

    For users created in a federated identity provider, specify the fully-qualified name of the user (for example, exampleIdP/jdoe or exampleIdP/john.doe@example.com, where exampleIdP is the name of the federated identity provider). For other users, provide the User ID.

  • PASSWORD is the Swift password or auth token associated with the user. This password is not the same as the password that you use to sign into the Object Storage Console. Auth token is an Oracle-generated token that you use to authenticate with third-party APIs, for example to authenticate with a Swift client. For instructions to create this token, see To create an auth token in Oracle Cloud Infrastructure Documentation .
  • URL is the URL of the Oracle Object Storage Cloud bucket, including the bucket name and the name of the object to be copied.

    The URL format:

    https://swiftobjectstorage.region_identifier.oraclecloud.com/v1/namespace/bucket_name/object_name

    Components of this URL:
    • region_identifier is a Oracle Cloud Infrastructure hosting region.
    • namespace is the top-level container for all buckets and objects. Each Oracle Cloud Infrastructure tenant is assigned a unique system-generated and immutable Object Storage namespace name at account creation time. Your tenancy's namespace name, for example, axaxnpcrorw5, is effective across all regions.
    • bucket_name is the name of a logical container where you store your data and files. Buckets are organized and maintained under compartments. A system generated bucket name, for example, bucket-20210301-1359 reflects the current year, month, day, and time.
    • object_name is name of the snapshot or file that you want to copy from Oracle Object Storage Cloud. This value must exactly match the full name of the object in Object Storage Cloud. Do not use an extension such as .zip unless the object name contains it.

    For more information, see these topics in Oracle Cloud Infrastructure Documentation

  • TARGET_FILE_NAME is a unique name for the file or snapshot in the EPM Cloud environment. When copying snapshots, do not specify the ZIP extension so that this file name can be used with the importSnapshot command.

    Files larger than 100 MB are stored in Oracle Object Storage within a logical directory along with the manifest file that identifies its segments. Specify the name of the logical directory as the TARGET_FILE_NAME.

Examples

In these examples, replace URL_OF_THE_ORACLE_OBJECT_STORAGE_BUCKET with a working URL in this format: https://swiftobjectstorage.region_identifier.oraclecloud.com/v1/namespace/bucket_name/.

  • Copy a snapshot named backup_Snapshot_12_05_20.zip from Oracle Object Storage bucket to EPM Cloud and rename it:

    epmautomate copyFromObjectStorage oracleidentitycloudservice/jDoe example_pwd URL_OF_THE_ORACLE_OBJECT_STORAGE_BUCKET/backup_Snapshot_12_05_20.zip snapshot_from_osc

  • Copy a snapshot named backup_Snapshot_12_05_20 from Oracle Object Storage bucket to EPM Cloud and rename it:

    epmautomate copyFromObjectStorage oracleidentitycloudservice/jDoe example_pwd URL_OF_THE_ORACLE_OBJECT_STORAGE_BUCKET/backup_Snapshot_12_05_20 snapshot_from_osc

  • Copy a snapshot named backup_Snapshot_12_05_20 from Oracle Object Storage bucket to EPM Cloud without renaming it:

    epmautomate copyFromObjectStorage oracleidentitycloudservice/jDoe example_pwd URL_OF_THE_ORACLE_OBJECT_STORAGE_BUCKET/backup_snapshot_12_05_20 backup_snapshot_12_05_20

  • Copy a file to EPM Cloud from Oracle Object Storage bucket:

    epmautomate copyFromObjectStorage oracleidentitycloudservice/jDoe example_pwd URL_OF_THE_ORACLE_OBJECT_STORAGE_BUCKET/example_file.txt copied_from_osc.txt