downloadSnapshot

This operation utilizes Oracle EPM's migration capability to enable a snapshot to be moved across environments.  This operation downloads a snapshot and saves it as an artifact.

This operation would be used for the build operation for projects using snapshots to deploy EPM snapshot files often in a clone type operation where the snapshot already exists.

Applies to

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management, Oracle Strategic Workforce Planning Cloud, and Oracle Sales Planning Cloud.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Oracle EPM Account

FDEPM_CLOUD_ACCOUNT_CODE

Yes

Oracle EPM Account will be required on either the plugin input or Target. If a value is set on both then, the plugin input will take precedence.

See Special Considerations below for instructions on how to create Oracle EPM account.

Project Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Snapshot to download from EPM

FDEPM_SNAPSHOT_TO_DOWNLOAD

No

The Snapshot name to be dowloaded by the download operation. An artifact will be created based on the FDEPM_SNAPSHOT_BASE_NAME property and workflow execution id.

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Oracle EPM Snapshot Timeout

FDEPM_INP_SNAPSHOT_TIMEOUT

No

Time to wait in seconds for the snapshot to be imported, uploaded or downloaded.  Defaults to 300.


Artifacts

This operation produces artifacts that will be stored in the artifacts repository.

Endpoint Selection

This operation will select all available endpoints associated to the target.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

Oracle EPM Account

Before using this plugin operation, navigate to Topology → Integrations → Cloud, then create an account with provider OracleEPM for each one of your SaaS environments. This account will store the URL and credentials to make HTTPS requests to your SaaS environment. The account will be reusable by all Oracle EPM Plugin operations. All fields shown are required.

 

The following macros are not currently supported in the footer:
  • style