Preparing Essbase Data for Upgrading

The Essbase Staging Tool simplifies preparing data for upgrade. If you need to replicate data, use the following procedure. You must replicate all applications. If you do not want some of the applications in the upgraded environment, delete them after completing the entire upgrade process.

Notes:

If you are upgrading from an earlier release and an application has more than 127 linked reporting objects, perform the following procedure to export linked reporting objects before you run the Staging Tool.

Tip:

To determine how many linked reporting objects an application has, use the MAXL command query database DBS-NAME list lro all;, for example, MAXL> query database sample.basic list lro all;.

  To export linked reporting objects:

  1. On the machine hosting the earlier release of Essbase, export linked reporting objects by backing up the application linked reporting object data to a specified directory by using the following MAXL command:

    EXPORT database DBS-NAME LRO to server directory ‘directoryName’;

    For example:

    MAXL> EXPORT database Sample.Basic LRO to server directory ‘V1’;

    In this example, Sample.Basic LRO data is exported to Sample-Basic-V1 in ARBORPATH/app, where ARBORPATH is the server ARBORPATH.

  2. Delete the linked reporting objects from the earlier release application with the following MAXL command:

    ALTER database DBS-NAME delete LRO all;

    For example:

    MAXL> ALTER database sample.basic delete LRO all;
  3. Move the application to Release 11.1.2.1 using the Staging Tool, described in the next procedure.

  4. Note that you must manually import the linked reporting objects later in the upgrade process.

Tip:

If you want to maintain your earlier release environment, reimport the linked reporting objects on the source system after the upgrade process is complete.

  To prepare Essbase data for upgrading perform the following tasks on the machine hosting the earlier release installation:

  1. Oracle recommends that you perform data validation for Essbase applications:

    • Start Essbase Server.

    • Use the MaxL command alter system resync sss to sync up security information.

    • For BSO applications, use the MaxL command alter database applicationName.databaseName validate using default error_file; against the database. If the validation returns errors, revert to a backup that is free of errors.

    • Stop Essbase Server and back up all application files, database files, and the security file.

    • Restart Essbase Server and then in Administration Services Console, run a full restructure on the database.

  2. Using Administration Services, edit Application Properties for each application (select General then Startup) to ensure that Start application when Essbase Server starts is NOT selected.

    You can also view this property for all applications using the MAXL command display application all; to ensure that autostartup is set to FALSE for all applications. (Use the MAXL command alter application DBSName disable autostartup; to turn off the property for each application as needed.)

  3. If you have not already done so, download files for Release 11.1.2.1 and extract the contents of the System Installer ZIP file.

    If you have not yet downloaded the System Installer ZIP file, download it from the Oracle Software Delivery Cloud. See Preparing for Installation.

    Extract the contents to a directory that does not have spaces in the name.

    Tip:

    Use a zip file extraction program that can handle long path names, such as 7-Zip.

  4. In the SystemInstallerExtractLocation/Migration directory, look for EssStagingTool.zip and extract the contents to any empty directory (EssStagingToolExtractLocation) on the machine hosting the earlier release of Essbase.

    Use the version of the Staging Tool for the platform from which you are upgrading. For example, if you are upgrading from a 32-bit machine to a 64-bit machine, use the 32-bit Staging Tool.

  5. From a command line, run the following script from the EssStagingToolExtractLocation directory:

    essStage.bat|sh username [agentPort]

    where username is the name of any Essbase user who is an administrator. agentPort is optional and specifies the port on which the Essbase instance is running. The default value is 1423.

  6. When prompted, enter the Administrator password.

    The Staging Tool queries Essbase for a list of applications and the disk volumes that are defined, and for ASO applications it queries for a list of table spaces that are defined.

  7. At the prompt, review the list of methods for preparing data for upgrade, and then select a method:

    • Same-named disk volumes, table spaces, and ARBORPATH on source and target. This option is the fastest. If you select this method, the system you are upgrading on must use the same disk volume, table spaces, and ARBORPATH as the earlier release.

    • Differently-named disk volumes, table spaces, or ARBORPATH on source and target. If you select this method, you can specify a different disk volume, table spaces, or ARBORPATH on the system you are upgrading to than what is defined on the earlier release system.

      Note:

      If you select this method, make note of the new ARBORPATH location. During configuration with EPM System Configurator, you enter this location on the Essbase configuration page, for Full path to application location (ARBORPATH).

    • Consolidated disk volumes or tablespaces on target by exporting data. Select this method if you want to consolidate disk volumes on the system to which you are upgrading. This method exports data to text files so that you can later import them on the upgraded system. Because this method is the slowest, use it only if you need to consolidate disk volumes, for example if the source machine has volumes defined for c, d, and e drives and the target machine has only c and d drives. This option performs some data validation during export.

  8. Select whether you want to apply this method to all applications or to only some applications.

    Note that all applications must be replicated to ensure the integrity of the essbase.sec file. If you select only some applications, you must select a second method of preparing the data for all remaining applications.

    If you select Yes for Select all applications, proceed to step 11.

  9. If you selected No for Select all applications, enter the number for each application to which you want to apply the first data preparation method that you selected. When you are finished selecting applications, press Enter.

  10. If you selected No for Select all applications, select the data preparation method to use for all of the remaining applications.

    If you selected Same-named disk volumes, table spaces, and ARBORPATH on source and target or Differently-named disk volumes, table spaces, or ARBORPATH on source and target, the Staging Tool automatically selects Consolidated disk volumes or tablespaces on target by exporting data for the remaining applications.

  11. Depending on the data preparation method that you selected, the next steps vary:

    • If you selected Same-named disk volumes, table spaces, and ARBORPATH on source and target, enter Y to proceed with preparing data.

      The Staging Tool prepares essbase.cfg, essbase.sec, data, and applications for file transfer.

    • If you selected Differently-named disk volumes, table spaces, or ARBORPATH on source and target:

      1. Specify a new ARBORPATH location for the machine on which you are upgrading and then press Enter. The ARBORPATH for the current release is displayed in parentheses for your reference.

        Caution!

        The ARBORPATH that you specify cannot be the directory that is to be used as EPM_ORACLE_INSTANCE, which in a default installation is Oracle/Middleware/user_projects/epmsystem1. (EPM_ORACLE_INSTANCE must be an empty directory.)

        Tip:

        ARBORPATH is the location for applications; previous releases used ARBORPATH to refer to the installation location. ESSBASEPATH is now used to define the installation location. For more information, see “Understanding How Essbase Files Are Stored” in the Oracle Essbase Database Administrator's Guide.

      2. If prompted, specify a new disk volume for the machine on which you are upgrading and then press Enter. The disk volume for the current release is displayed in parentheses for your reference.

      3. If prompted, specify a new default tablespace for the machine on which you are upgrading and then press Enter. The default tablespace for the current release is displayed in parentheses for your reference. (This step applies only to ASO applications.)

      4. Enter Y to proceed with preparing data.

      The Staging Tool prepares essbase.cfg, essbase.sec, data, and applications for file transfer, updating internal references to ARBORPATH, disk volumes, and tablespaces as needed. Later in the upgrade process you must run a script (editagtsec.msh) to update disk volume settings in essbase.sec for the relocated applications.

    • If you selected Consolidated disk volumes or tablespaces on target by exporting data:

      1. Specify the directory to which to export data, and then enter Y to proceed with preparing data.

        The tool prepares a list of data to export, and then copies the data to the export directory you specified. It shuts down Essbase before copying files. If it cannot shut down Essbase, you are prompted to shut down Essbase.

      2. If you are prompted to shut down Essbase, shut it down, and then press Enter to continue.

      The Staging Tool prepares data files, exported data along with a script to import it, and a script for editing the security file.

      Note that with this option, you must perform additional tasks later in the process: You must run a script (editagtsec.msh) to update disk volume settings in essbase.sec for the relocated applications. You must manually import LROs and data later in the upgrade process using a script (importdata.msh).

    The Staging Tool displays the processing status for each application.

    If the Staging Tool displays the error “Cannot open file [%s]” for sample applications, you can ignore the message. EPM System Installer installs sample applications on the new host machine.

    Note that the Staging Tool copies all of the files and directories under the specified ARBORPATH, disk volume locations, and tablespace locations.

  12. Review the methods for transferring the processed files, select a method, and then enter Y to continue.

    • Automatically copy files to a mounted or mapped file system. If you select this option, the Staging Tool prompts you for the mounted drive location for each of the destination ARBORPATH, table space, disk volume, and export data directory directories. Specify the mounted path of the same ARBORPATH path that you specified during the data preparation method. The destination path for tablespace should map to the tablespace specified in the data preparation method. The destination path for disk volume path should map to complete paths and not just to disk volume.

      Specify an existing, empty directory.

      If errors occur during file transfer, the Staging Tool closes and shuts down Essbase.

      The Staging Tool also prepares a file with file transfer instructions. If the copy process fails for any reason, follow the instructions in EssStagingToolExtractLocation/work/FileTransferSteps.txt to manually copy the data to the machine on which you plan to upgrade Essbase.

    • Get a list of file transfer instructions. If you select this option, the Staging Tool exports data and prepares a file with file transfer instructions. Review EssStagingToolExtractLocation/work/FileTransferSteps.txt for details and follow the steps to manually copy the data to the machine on which you plan to upgrade Essbase.

    • Exit. If there were any failures or errors during the application processing, you can exit, correct the errors, and restart the Staging Tool.

    The Staging Tool notes when the file transfer is complete and shuts down Essbase.

  13. If needed, update the files on the target machine to ensure that they have the same owner as the user who will install Essbase.

    EssStagingToolExtractLocation/work/FileTransferSteps.txt includes the list of files to update.

  14. (Optional) Review the log file, EssStagingToolExtractLocation/essStaging.log, for details of the Staging Tool actions.

    You can use the log during configuration with EPM System Configurator to remind you of the options you specified.

    If you realize that you made mistakes in your entries for the Staging Tool, you can rerun it.

  15. On the target machine hosting the new release, make required updates to essbase.cfg: Update the DISKVOLUMES, SSAUDIT, SSAUDITR, and TransactionLogLocation settings to reflect new directory locations.

Note:

The Staging Tools copies ARBORPATH/app/appname/dbname/Replay, which is related to the transaction logging and replay feature. Because Oracle recommends a fresh implementation of transaction logging and replay in any given Essbase release, Oracle recommends that you delete these files on the upgraded system before you proceed. As a best practice, the files in the LOGLOCATION and Replay directories should be backed up periodically.

When you have finished preparing Essbase data for upgrading, return to Replicating Data to replicate data for other EPM System products.