1. Essbase Independent Deployment
  2. Migrate Essbase Applications
  3. Migrate From Oracle Analytics Cloud - Essbase and OCI Marketplace Deployment Instances
  4. Migrate Applications Using Migration Utility

Migrate Applications Using Migration Utility

As an Essbase Service Administrator, you can use the Migration Utility (migrationTools.jar) to migrate an entire Essbase instance (all applications, users and groups, and other artifacts) from one cloud instance to another in a single process.

You can use Migration Utility to migrate from source applications and elements from Oracle Analytics Cloud - Essbase deployments as well as other Essbase deployments on OCI via Marketplace. The utility migrates multiple applications at one time. It also migrates artifacts, rules, users and groups.

Note that the Essbase Command-line Interface (CLI) commands, lcmimport and lcmexport do not migrate users and groups.

Before using the Migration Utility, complete the following prerequisite: Set Up the SSL Certificate.

Use Cases for Migration Utility

Here are some use cases for migrating with the Migration Utility.

  • Migrate Essbase users from WebLogic LDAP in the source to OCI Identity and Access Management (IAM) or Oracle Identity Cloud Service (IDCS) in the target.
  • Use Migration Utility for basic deployments that aren’t customized. If your deployment includes customizations, such as custom Single Sign On solutions, use CLI instead of Migration Utility.
  • When the source Essbase deployment is from
    • Oracle Analytics Cloud - on Oracle Cloud Infrastructure, using IDCS Native Security, or
    • Oracle Analytics Cloud - on Oracle Cloud Infrastructure Classic, using IDCS Native Security, or
    • Oracle Analytics Cloud - on Oracle Cloud Infrastructure Classic, using Embedded LDAP
    • Essbase Marketplace on Oracle Cloud Infrastructure, using OCI Identity and Access Management (IAM) or Oracle Identity Cloud Service (IDCS), or
    • Essbase Marketplace on Oracle Cloud Infrastructure, using Embedded LDAP
    then before using the Migration utility steps below to export, first create a new confidential application as outlined in Create a Confidential Identity Application. Also, before using the Migration Utility to import, change the host and IAM/IDCS details in import.properties to point to the target Essbase instance.

Steps to Migrate Cloud Applications and Users using Migration Utility

  1. Before you use the Migration Utility, if you haven’t already, patch your source Essbase instance to the latest version.

  2. If it isn't already installed, download and install Java SE Development Kit (JDK) 8 from Oracle Technology Network.

  3. Set the JAVA_HOME environment variable name on your system to point to the JDK installation folder. If the installation path contains any spaces, enclose the path in the variable value, within quotation marks, for example, "C:\Program Files\Java\jdk1.8.0_171".

  4. Sign in to the target Essbase web interface, and navigate to the Console.

  5. In the Console, go to Desktop Tools, and expand Command Line Tools.

  6. Click Download next to Migration Utility.

  7. Download the Migration Utility zip file to a local drive. For best results, choose a path that has no spaces, for example, C:\Oracle.

  8. Extract the zip file, and see the extracted files (properties, jar, and readme) in the migrationTools folder.

  9. Before you run the Migration Utility export, edit the export.properties file, located in the same directory as the utility. Provide the details of the Essbase source instance that you are migrating from.

    Export Property Description
    userName Required. Essbase administrator user name.
    password Required. Essbase administrator password.
    host Required. IP address of the load balancer, if a load balancer was configured during Essbase deployment. Otherwise, the host name or IP address that corresponds with the Essbase public IP address.
    port Optional. Source Essbase instance's HTTP listening port. If source instance is configured in secure (TLS) mode and isTLS=true port 443 is assumed. If source instance is configured with LDAP identity provider, set port as 80.
    isTLS Optional: true or false. If true, source instance is configured in secure (TLS) mode using the specified port value.
    proxy Optional. HTTP proxy host address, if the connection to the source Essbase instance requires a proxy. Proxy host and proxy port are separated by a colon. If the proxy port is omitted, its value is assumed to be 80. Example with port omitted: www-proxy-example.com. Example with port included: www-proxy-example.com:80
    skiprole Optional. Default is false. Set to true only if the source instance is Oracle Analytics Cloud - Essbase and you want to migrate IDCS roles. Leave empty otherwise.
    skipdata Optional. Default is false. Set to true if only schemas of the Essbase application should be exported.
    skipUser Optional: true or false. Set to true only if there is no need to export users and/or groups. Default value is false.
    idcsHost Required only when migrating users and/or groups from an instance deployed on OCI via Marketplace. Source IAM or IDCS identity domain host. From the Identity Domain URL (example: https://idcs-<string_of_numbers_and_letters>.identity.oraclecloud.com), extract only the domain part after the string. Example: identity.oraclecloud.com
    idcsTenant Required only for migrating users and/or groups from an instance deployed on OCI via Marketplace. The source host's identity domain tenancy identifier in IAM or IDCS. From the Identity Domain URL (example: https://idcs-<string_of_numbers_and_letters>.identity.oraclecloud.com), extract only idcs-<string_of_numbers_and_letters>.
    clientId Required only for migrating users and/or groups from an instance deployed on OCI via Marketplace. The source host's client identifier for OAuth authorization, found in the integrated confidential identity application.
    clientSecret Required only for migrating users and/or groups from an instance deployed on OCI via Marketplace. The source host's client secret for OAuth authorization, found in the integrated confidential identity application.
    appId Required only for migrating users and/or groups from an instance deployed on OCI via Marketplace. Identifier of the integrated confidential identity application on the OCI identity domain (IAM or IDCS). This identity application should be configured with application roles grantable to users and groups. This property enables granting roles to migrated users and groups.

  10. Edit the import.properties file, located in the same directory as the utility. Provide the details of the Essbase target instance that you are migrating to.

    Import Property Description
    userName Required. Target instance's Essbase administrator user name.
    password Required. Target instance's Essbase administrator password.
    host Required. Target instance's IP address of the load balancer, if a load balancer was configured during Essbase deployment. Otherwise, the host name or IP address that corresponds with the Essbase public IP address.
    port Optional. Target Essbase instance's HTTP listening port. If target instance is configured in secure (TLS) mode and isTLS=true port 443 is assumed. If source instance is configured with LDAP identity provider, set port as 80.
    isTLS Optional: true or false. If true, target instance is configured in secure (TLS) mode using the specified port value.
    userPassword Optional. Initial password to be assigned to any new users the utility migrates to the integrated identity application in IAM or IDCS. To change the passwords after migration, use the OCI Console.
    proxy Optional. HTTP proxy host address, if the connection to the target Essbase instance requires a proxy. Proxy host and proxy port are separated by a colon. If the proxy port is omitted, its value is assumed to be 80. Example with port omitted: www-proxy-example.com. Example with port included: www-proxy-example.com:80
    skipUser Optional: true or false. Set to true only if there is no need to import users and/or groups. Default value is false.
    idcsHost Required only for migrating users and/or groups to an instance deployed on OCI via Marketplace. Target identity domain host. From the Identity Domain URL (example: https://idcs-<string_of_numbers_and_letters>.identity.oraclecloud.com), extract only the domain part after the string. Example: identity.oraclecloud.com
    idcsTenant Required only for migrating users and/or groups to an instance deployed on OCI via Marketplace. The target host's identity domain tenancy identifier. From the Identity Domain URL (example: https://idcs-<string_of_numbers_and_letters>.identity.oraclecloud.com), extract only idcs-<string_of_numbers_and_letters>.
    clientId Required only for migrating users and/or groups to an instance deployed on OCI via Marketplace. The target host's client identifier for OAuth authorization, found in the integrated confidential identity application.
    clientSecret Required only for migrating users and/or groups to an instance deployed on OCI via Marketplace. The target host's client secret for OAuth authorization, found in the integrated confidential identity application.
    appId Required only for migrating users and/or groups to an instance deployed on OCI via Marketplace. Identifier of the integrated confidential identity application on the OCI identity domain (IAM or IDCS). This identity application should be configured with application roles grantable to users and groups. This property enables granting roles to migrated users and groups.
    overwrite Optional. Set to true if applications to be imported already exist on the target, and you want to overwrite them. Default value is false.
    certificates Optional. Full path to all trust certificate files for all TLS/SSL servers. For Windows, escape backslashes with another backslash. Example: C:\\migrationTools\\all_certs.pem

  11. Run Migration Utility in Java with the export command to export all applications, users, and groups from the Essbase source instance catalog to a compressed file. 

    java -jar -Dhttps.proxyHost=<proxy-url> -Dhttps.proxyPort=<nn> migrationTools.jar export export.properties <new_tar_file>

    Example:

    java –jar -Dhttps.proxyHost=www-proxy-abcdef.example.com -Dhttps.proxyPort=80 migrationTools.jar export export.properties export.tar.gz

  12. Run Migration Utility in Java with the import command to import the compressed file to the target instance.

    java -jar -Dhttps.proxyHost=<proxy-url> -Dhttps.proxyPort=<nn> migrationTools.jar import import.properties <existing_tar_file>

  13. After you run the import, the data is migrated to the Essbase catalog of the target instance.