cloneEnvironment

Clones the current environment and, optionally, identity domain artifacts (users and predefined role assignments), Data Management records, audit records, Job Console records, contents of the inbox and outbox, and stored snapshots. This command is an alternative to using the Clone Environment feature in Migration.

Initiate cloning after the scheduled daily maintenance of the source and target environments. If the daily maintenance of the source environment starts while cloning is in progress, the cloning process will be terminated. The cloning process on the target environment is not affected even if the cloning is in progress at the start time of the daily maintenance. In this scenario, the daily maintenance will run after the cloning is complete.

If the cloning of your environment takes a long time, reschedule the daily maintenance start time on the source environment to avoid the cloning process from being terminated. See these information sources for information on resetting the daily maintenance start time.

• setDailyMaintenanceStartTime
• Managing Daily Maintenance in Getting Started with Oracle Enterprise Performance Management Cloud for Administrators
• Viewing and Setting the Daily Maintenance Window Time in REST API for Oracle Enterprise Performance Management Cloud

Note:

• Account Reconciliation: After cloning, the target Account Reconciliation application settings will reset to their default values. If you wish to retain the target application settings, export them from the source environment using the exportARApplicationProperties command. Then, after the cloning is complete, import the application properties into the target environment using the importARApplicationProperties command.
• Data Management: Cloning of Data Management records may take a long time if the staging tables contain a very large number of records. Similarly, cloning the contents of the inbox and outbox, and stored snapshots may take considerable time, especially if they contain a large amount of data.
• Legacy Environments: Cloning maintains the current Oracle Essbase version as discussed in these scenarios:
  • Scenario 1: You are cloning a source legacy environment that uses an Essbase version that does not support Hybrid cubes to a target legacy environment that uses an Essbase version that supports Hybrid cubes. In this scenario, the Essbase in the target environment is downgraded to match the version in the source environment.
  • Scenario 2: You are cloning a source legacy environment that uses an Essbase version that supports Hybrid cubes to a target legacy environment that uses an Essbase version that does not support Hybrid cubes. In this scenario, the Essbase in the target environment is upgraded to match the version in the source environment.
  • Scenario 3: You are cloning a source legacy environment that uses an Essbase version that does not support Hybrid cubes to a target EPM Standard Cloud Service or EPM Enterprise Cloud Service environment, which, by default, uses an Essbase version that supports Hybrid cubes. In this scenario, the Essbase in the target environment is not downgraded to match the version in the source environment.
• Planning: Cloning may fail if the Planning business process contains a renamed seeded period member that has been supplanted by a custom period member. For example, you renamed the seeded YearTotal Period member to unused_YearTotal and then added an alternate type period member with the original seeded member name (YearTotal in this example). In this scenario, cloning of the environment may fail.

For detailed information on these topics, see Cloning EPM Cloud Environments in Administering Migration for 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, Sales Planning, and Strategic Workforce Planning.

Required Roles

Service Administrator

Identity Domain Administrator role is required to clone users and predefined roles.

Usage

epmAutomate cloneEnvironment TARGET_USERNAME TARGET_PASSWORD TARGET_URL [SnapshotName=NAME] [UsersAndPreDefinedRoles=true|false] [DataManagement=true|false] [appAudit=true|false] [jobConsole=true|false] [storedSnapshotsAndFiles=true|false] [DailyMaintenanceStartTime=true|false], where:

Note:

• The dataManagement parameter does not apply to Oracle Enterprise Data Management Cloud and Narrative Reporting environments.

  Clone Data Management records only if both the source and target environments are on the same monthly update or the target environment is one update newer than the source environment. For example, you can clone 22.01 Data Management records to another 22.01 environment or to a 22.02 environment only.

• The jobConsole parameter applies to Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management, Sales Planning, and Strategic Workforce Planning only.
• The appAudit parameter applies to Planning, Planning Modules, FreeForm, Enterprise Profitability and Cost Management, Sales Planning, and Strategic Workforce Planning only.

  Audit information for Financial Consolidation and Close and Tax Reporting is, by default, included in the snapshot.

• If dataManagement, jobConsole, or appAudit parameter is not applicable to an environment, EPM Automate ignores the value you specify.

• TARGET_USERNAME is the ID of a Service Administrator in the target environment. You must use the target identity domain user name (not the SSO user name). If you plan to clone user and role assignments in the target environment, this user must have the Identity Domain Administrator role also.
• TARGET_PASSWORD is the location of the encrypted password file of the user identified by TARGET_USERNAME.
• TARGET_URL is the EPM-CLOUD_BASE_URL of the environment that will become the cloned environment.
• SnapshotName, optionally, is the name of a snapshot that should be used for cloning. This snapshot must be present in the source environment. Default is Artifact Snapshot, which uses the last maintenance snapshot to clone the environment.
• UsersAndPreDefinedRoles, optionally, identifies whether to clone users and their predefined role assignments (Access Control groups are always cloned). Default is false.

  For this option to work, the user identified by TARGET_USER_NAME must have the Identity Domain Administrator role in the target environment.

  Import of users and their predefined roles will fail if a user who is not an Identity Domain Administrator clones an environment after selecting this check box. The following error is recorded in the Migration Status Report: Failed to import External Directory Artifact <artifact_name>. User <user_name> is not authorized to perform this operation. The user needs to have Identity Domain Administrator role to perform this operation.
  • If you are not importing users and a user in the source snapshot is not assigned to a predefined role on the target environment, an error (EPMIE-00070: Failed to find user during assigned roles import) is displayed.
  • The Identity Domain Administrator role assignment is not cloned. Users with only the Identity Domain Administrator role assignment are not cloned to the target environment.

    Users assigned to a combination of Identity Domain Administrator role and predefined roles in the source environment are cloned, but assigned only to the respective predefined roles in the target environment. These users will not have the Identity Domain Administrator role in the target environment.

  • Changes to the predefined roles of the user will be updated based on the roles assigned in the source snapshot. However, role assignments in the target will not be removed to match those in the source snapshot. For example, assume that jdoe is assigned to the Power User predefined role in the target environment, but has only the User role in the source snapshot. In this situation, this command assigns jdoe to the User role and does not remove the Power User role assignment in the target environment.
  • This command does not delete existing users from the target environment if they don't exist in the source snapshot. For example, jdoe has an account in the target environment, but this account is not present in the source snapshot. In this situation, the account of jdoe in the target environment is not deleted.
  • This command adds users that do not exist in the target environment; it does not update current user properties in the target environment even if those are different in the source snapshot. For example, if the last name of jdoe in the source snapshot is spelled differently in the target environment, the change will not be made in the target environment. A random password is assigned to new users in the target environment. New users will receive account activation emails prompting them to change passwords.
  • This command does not change existing users' passwords in the target environment even if it is different in the source snapshot.
• dataManagement=true|false, optionally, clones Data Management records in the source environment to the target environment. Default is true, which clones Data Management records. Set this value to false if you do not want to clone Data Management records.
• appAudit=true|false, optionally, clones the audit records in the source environment to the target environment. Default is true, which clones application audit data. Set this value to false if you do not want to clone application audit data to the target environment.
• jobConsole=true|false, optionally, clones the Job Console records in the source environment to the target environment. Default is true. Set this value to false if you do not want to clone Job Console records.
• storedSnapshotsAndFiles, optionally, identifies whether the command should clone the contents of inbox and outbox, and stored snapshots. Default is false.

  Note:

  Only the top level folders in the inbox and outbox are cloned; subfolders are not. If you need to retain the contents of the subfolders, back them up to a local computer and then upload them to the target environment.
• DailyMaintenanceStartTime, optionally, resets the maintenance start time of the cloned target environment to that of the source environment. Default is true. To keep the current maintenance start time of the target environment, set this value to false.

Examples

• Clone the environment, users and predefined role assignments, audit data, job console records, and Data Management records. Also change the maintenance start time of the target environment to that of the source environment:

  epmAutomate cloneEnvironment serviceAdmin Password.epw https://test-cloudpln.pbcs.us1.oraclecloud.com UsersAndPreDefinedRoles=true

• Clone the environment including the contents of inbox and outbox, stored snapshots, but not the users and predefined role assignments, Data Management records, audit data, and Job Console records, without changing the maintenance start time of the target environment:

  epmAutomate cloneEnvironment serviceAdmin Password.epw https://test-cloudpln.pbcs.us1.oraclecloud.com DataManagement=false appAudit=false jobConsole=false storedSnapshotsAndFiles=true DailyMaintenanceStartTime=false

• Clone the entire environment (users and predefined role assignments, audit data, Job Console records, inbox and outbox contents, stored snapshots, and Data Management records) using a custom snapshot. Also change the maintenance start time of the target environment to that of the source environment:

  epmAutomate cloneEnvironment serviceAdmin Password.epw https://test-cloudpln.pbcs.us1.oraclecloud.com UsersAndPreDefinedRoles=true storedSnapshotsAndFiles=true SnapshotName=SampleSnapshot