importSnapshot

Imports the contents of a snapshot into the service environment. The snapshot you import must be available in the default upload location.

Use the uploadFile command to upload a snapshot or the copySnapshotFromInstance command to copy it from another instance.

• The following are not part of Planning, Planning Modules, and FreeForm application snapshots:
  • Audit data
  • Job Console data
  Use the cloneEnvironment command or the Clone Environment feature if you want to copy audit and Job Console data to the target environment.

  Snapshot import 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, import of snapshot may fail.

• Snapshots do not contain the Data Management staging table data. To import this data, use the exportDataManagement and importDataManagement commands or the Data Management System Maintenances Scripts interface. You may use the cloneEnvironment command or the Clone Environment feature to create an identical copy of the environment, including the Data Management staging table data.

The activities that you can complete using this command depend on your role.

• Service Administrators can import only application artifacts into an environment.
• You need both Service Administrator and Identity Domain Administrator roles to import application content into the service environment and identity domain artifacts (users and their predefined role assignments) into the identity domain of the environment.

  If a user who is not in the identity domain is referenced in the snapshot being imported, EPM Automate creates a user in the identity domain and assigns the default password that you specify in the command or a temporary unique password to each user if you do not specify a password in the command. By default, the user will be required to reset password during first sign in.

Note:

• For business processes other than Account Reconciliation, Profitability and Cost Management, and Oracle Enterprise Data Management Cloud: While loading metadata, Oracle Enterprise Performance Management Cloud may make multiple loading passes if the previous attempt resulted in rejected records because shared members come before base members in the outline. Such attempts may increase the command processing time.
• Users who are members of groups in Access Control must be assigned to a predefined role. Attempts to assign a user, who is not assigned to a predefined role, to a group is not permitted.

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

Required Roles

Service Administrator, Power User assigned to the Migration Administrator application role

Identity Domain Administrator role is required to import users and predefined role assignments.

Usage

epmautomate importSnapshot SNAPSHOT_NAME [importUsers=true|false] [userPassword=DEFAULT_PASSWORD] [resetPassword=true|false] where:

• SNAPSHOT_NAME is the name of a snapshot in the default upload location.
• importUsers, optionally, specifies whether to import users and their predefined role assignments from the snapshot. Default is false. Use importUsers=true to import users and predefined role assignments into the identity domain if the source snapshot contains data on new users or if new roles have been assigned to current users.

  User login values are not case-sensitive. For example, the user login value [e-mail] is treated as being identical to [e-mail] or any variation in its case. If any variation matches a user login existing in the identity domain, this command does not import the user from the snapshot.

  Note:

  • Import of users and their predefined roles fails if a user who is not an Identity Domain Administrator performs the import operation. 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.
  • 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.
  • This command does not change existing users' passwords in the target environment even if it is different in the source snapshot.
• userPassword, optionally, indicates the default password to assign to new users who are created in the identity domain. The password that you specify must meet the minimum password requirements. If you do not specify a value for this parameter, a unique temporary password is assigned to each user.
• resetPassword, optionally, indicates whether the new user must change the password at the first log in. Default is true, requiring new users to change the password at the first sign in. If this value is set to true, new users will receive account activation emails prompting them to change passwords.

Examples

• Import application artifacts only: epmautomate importSnapshot April16FullApp
• Import application and identity domain artifacts (requires Service Administrator and Identity Domain Administrator roles):
  • Assign a unique temporary password to each new user and force them to reset their password after they sign in for the first time:

    epmautomate importSnapshot April16FullApp importUsers=true

  • Assign a specific password and allow users to not change it if they so choose. Not recommended for imports into production environments:

    epmautomate importSnapshot April16FullApp importUsers=true userPassword=P@ssw0rd1 resetPassword=false