extractPackage

Runs an extract package consisting of multiple extracts for an application using a single operation. The results of each extract in the package are added to one ZIP file, which can be written to the staging area or to a global connection.

Applies to

Oracle Fusion Cloud Enterprise Data Management

Required Roles

  • Service Administrator
  • User (with Data Manager permission)

Usage

epmautomate extractPackage APPLICATION_NAME EXTRACT_PACKAGE_NAME FILE_NAME.zip [connection=CONNECTION_NAME], where:
  • APPLICATION_NAME is the name of an Cloud EDM application.
  • EXTRACT_PACKAGE_NAME is the name of the package defined in the Cloud EDM application.
  • FILE_NAME is the name for the extract ZIP file that will contain the results of the extraction. This file is created in the staging area or written to a global connection if a connection name is specified.

    A package may contain one or more extract profiles, each with a distinct name. The extract package ZIP file will contain the output files of the extracts in the package. The number of files in the ZIP file is determined by the settings in the package.

  • CONNECTION_NAME, optionally, is the global connection name (instance location) defined in Cloud EDM. It identifies the location to which the ZIP file containing the results of the extraction is to be uploaded.

    If a connection name is specified, the ZIP file containing extracted data is uploaded to the target environment (inbox for an Oracle Fusion Cloud Enterprise Performance Management environment or the specified document account for Oracle ERP). If a value is not specified, the export file is created in the default outbox (staging area) of the Cloud EDM environment.

Examples

  • Extract COARedesignMaps package to a file in the Cloud EDM staging area:
    epmautomate extractPackage FinancialsCloud COARedesignMaps COARedesign.zip
  • Extract COARedesignMaps package to a file and upload it to an Oracle Fusion Cloud EPM inbox using a connection.
    epmautomate extractPackage CorporateAccount COARedesignMaps COARedesign.zip Connection=EPM_cloud_pln