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

copyToObjectStorage

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

If you are copying a snapshot, this command zips the content of the snapshot before copying it to Oracle Object Storage.

To facilitate fast copying of files, this command chunks large files (larger than 100 MB) into 10 MB segments (named FILE_NAME/FILE_NAME_object_store_bytes_seg_0 through FILE_NAME/FILE_NAME_object_store_bytes_seg_n) and creates a manifest file (named FILE_NAME/FILE_NAME.manifest). File segments are stored in Oracle Object Storage along with the manifest file. In the Object Storage Console, the file is displayed as a logical directory containing the file segments and the manifest file.

Files smaller than 100 MB are not segmented and are stored with the original file name.

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 copyToObjectStorage SOURCE_FILE_NAME USERNAME PASSWORD URL where:

  • SOURCE_FILE_NAME is the name of the file or snapshot in Oracle Enterprise Performance Management Cloud. If you are copying a snapshot, do not specify the ZIP extension.
  • USERNAME is the ID of a user who has the required access rights to write to 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 with an optional object name appended.

    The URL format without object name:

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

    The URL format with object name:

    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, optionally, is name that you want to use for the file on Oracle Oracle Object Storage Cloud. If an object name is not specified, the file will be copied with its original name.

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

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 to an Object Storage bucket and rename it:

    epmautomate copyToObjectStorage "Artifact Snapshot" oracleidentitycloudservice/jDoe example_pwd URL_OF_THE_ORACLE_OBJECT_STORAGE_BUCKET/Snapshot_04_30_21

  • Copy a file to an Object Storage bucket:

    epmautomate copyToObjectStorage example_file.txt oracleidentitycloudservice/jDoe example_pwd URL_OF_THE_ORACLE_OBJECT_STORAGE_BUCKET

  • Copy a file to an Object Storage bucket and rename it:

    epmautomate copyToObjectStorage example_file.txt eoracleidentitycloudservice/jDoe example_pwd URL_OF_THE_ORACLE_OBJECT_STORAGE_BUCKET/epm_text_file.txt