Backup and Recovery

In This Section:

Essbase Backup

Essbase Recovery

If you are upgrading from a previous release of Essbase, see the Hyperion Essbase - System 9 Installation Guide.

Essbase Backup

A key part of a database maintenance routine includes regular backups of Essbase files and data. It is important to integrate regular database backups into production server maintenance.

The frequency of backups depends on the volatility of the database and server environment, and the demand for quick database restores in the event of server crashes.

See these topics:

Backing up Files

Regularly back up the server, application, and database files listed in Table 64:

Table 64. Files to Back Up





Essbase index file



Essbase data file



Essbase Kernel file that contains control information used for database recovery



Transaction control table



Free fragment file for data and index free fragments



Outline file, which does not store data but stores all metadata for a database and defines how data is stored


Application file containing application settings



Database file containing database settings



Linked Reporting Objects



Essbase security file



Backup of the Essbase security file



Essbase Server configuration file


.otl, .csc, .rul, .rep, .eqd, .sel

Database artifact files


ESSCMD or MaxL scripts


No defined storage location

[a] Back up all .ind files related to a database because a single database can have multiple .ind files.

[b] Back up all .pag files related to a database because a single database can have multiple .pag files.

[c] Shut down the Agent before backing up the essbase.sec.

When performing a file system backup, use the file system backup software of your choice. You can back up specific directories or files, or you can back up the entire Essbase directory structure. Be sure to back up data on every disk volume. See Specifying Disk Volumes.

Typically, you should perform a backup after Essbase applications and databases, and the Agent, are shut down.

Backing Up Files During Run-Time

If any Essbase databases must be running at the time of the backup, follow these steps:

Placing a Database in read-only mode

Placing the database in read-only (or archive) mode protects the database from updates during the backup process.

*  To place a database in read-only mode, use a tool:





alter database begin archive

Essbase Technical Reference



Essbase Technical Reference

After you perform the backup, return the database to read-write mode.

    The begin archive command performs the following tasks:

    • Commits modified data to disk.

    • Switches the database to read-only mode.

    • Reopens the database files in shared, read-only mode.

    • Creates in the ARBORPATH\app\appname\dbname directory a file (default name of archive.lst) containing a list of files to be backed up.

    Attempting to modify data during the backup process results in an error message that data is in read-only mode.

    Begin archive does not perform the backup; it protects the database during the backup process. If you cancel the BEGINARCHIVE ESSCMD command or the alter database begin archive MaxL statement and you receive a “can’t cancel” message, the system may be in the final stage of writing items to the drive and has reached the point where the operation cannot be cancelled.


    If you back up data without using begin archive, ensure that all Essbase applications are closed and that all users are logged off during the backup process to avoid corrupting the database.

    Performing a File Backup

    After putting the database in read-only mode, you are ready to perform the backup.

    *  To back up data, use a third-party backup utility to back up the files listed in archive.lst and the files listed in Table 64, Files to Back Up, or back up the entire Essbase directory structure.

      Returning a Database to read-write mode

      *  To return the database to read-write mode, after performing a backup, use a tool:





      alter database end archive

      Essbase Technical Reference



      Essbase Technical Reference

        The end-archive utility:

        • Returns the database to read-write mode.

        • Re-opens database files in exclusive, read-write mode.


        You must use the end-archive utility to put the database back into read-write mode, even if you shut down and restart the database. The end-archive utility does not restart the database.

        Backing Up Data

        Exporting data copies it to a file that you specify.

        When exporting data to a text file; the data is not compressed. The text export file contains data only and does not include control, outline, or security information.

        Consider exporting data to:

        • Transfer data across platforms

        • Back up only part of the data; for example, level 0 blocks

        • Create an exported file in text format, rather than binary format

        The advantages of exporting data are:

        • You can use text export files to load data from the source database into databases on other platforms. The option to export a database in column format enables you to manipulate the export file and use it with a rules file to load the data back or to another database.

          Loading an export file into a database will fail if the database outline does not contain all the members found within the export file.

          If the outline changes between the time that the export file is created and reloaded (and the new outline contains all the members found within the export file), the load time might be significantly higher than if the outlines were identical.

        • Data integrity is verified because every block is checked to confirm whether corresponding page and index files match.

        • Exporting data, clearing all data from the database, and reloading the text file can reduce fragmentation.

        The disadvantages of exporting data are:

        • Unless dynamic calculations are executed at the time of the export, only stored data and data from previously calculated Dynamic Calc And Store members are included in the export.

        • During a database export, users cannot write to the database. After an export has started, users can do read operations. Exports of large databases require considerable amounts of time, during which users can only read the data.


        You can export subsets of data by creating reports (see Exporting Text Data Using Report Scripts) or calculation scripts (see Using DATAEXPORT to Export Data).

        Exporting Data

        *  To export data, use a tool:




        Administration Services

        Exporting Databases

        Essbase Administration Services Online Help

        Report Writer

        Use a Report Writer script to export selected data.

        Exporting Text Data Using Report Scripts

        Calculation script (block storage only)

        DATAEXPORT calculation commands

        Using DATAEXPORT to Export Data



        Essbase Technical Reference


        export data

        Essbase Technical Reference


        To improve export performance, you can export data in parallel to a specified number of files.

          All methods require the same basic information:

          • Names of export data files

          • The amount of data to export

            • All data

            • Level 0 blocks only (blocks containing only level 0 sparse member combinations; these blocks may contain data for upper level dense dimension members)

            • Data from input blocks only (blocks containing data from a previous data load or spreadsheet Lock & Send)

          • Whether to export data in a columnar or non-columnar format

            In each row, the columnar format displays a member name from every dimension. Names can be repeated from row to row.

            The columnar format provides a structure to the exported data, so that it can be used for further data processing by applications other than Essbase tools; for example, relational databases. In non-columnar format, sparse members identifying a data block are included only once for the block. Because the export file in non-columnar format is smaller than in columnar format, reloading a file in non-columnar format is faster.

          Exporting Files Larger Than 2 GB

          Some file management systems do not support text files larger than 2 GB. On any operating system, if Essbase anticipates that an export file exceeds 2 GB, it creates two or more export files, as needed. The requested file name for the main file is used. An underscore and a sequential cardinal number are appended to the names of the additional files, starting with _1. For example, if the requested file name is expJan.txt and the exported data would exceed 4 GB, Essbase creates three files, naming them expJan.txt, expJan_1.txt, and expJan_2.txt. Exported data files can be reloaded in any sequence.

          Essbase Recovery

          This section discusses recovery procedures.

          Restoring the File Backup

          To restore a database, replace the files on disk with the corresponding files from backup.

          The application should be stopped, unless you are restoring from an export file. In that case, ensure the application is not accepting client connections.

          Restoring the Data Backup

          *  To reload exported data, use a tool:




          Administration Services

          Performing a Data Load or Dimension Build

          Essbase Administration Services Online Help



          Essbase Technical Reference


          import data

          Essbase Technical Reference

          Calculation script

          DATAIMPORTBIN (exported binary files only)

          Essbase Technical Reference

            When you reload data that has been exported, the data is marked as input data. If you reload data exported from level 0 blocks or input blocks, you must recalculate the database after reloading. When Essbase recalculates the database, it recalculates every data block.

            If you export all data in a database and then reload, Essbase marks all blocks in the database as input blocks. Consequently, if you try to clear data, no data is cleared because the database contains no non-input blocks.

            When you reload data that has been exported, Essbase also marks the data blocks as dirty. If you had calculated the database prior to exporting it, to save time during the next calculation, you should set the status of the blocks as clean. If you had not calculated the database prior to exporting it, it is not necessary to set the status of the blocks as clean.

            *  To clean block status in a database after exporting all data and reloading, you can run the following calculation script:

            Set ClearUpdateStatus Only;
            Calc All; 

              Restoring Corrupted Databases

              If there is a problem with any one of the following essential database files, the entire database becomes corrupted and Essbase Server cannot start the database:

              • essn.pag

              • essn.ind

              • dbname.esm

              • dbname.tct

              • dbname.ind

              To restore the database, delete these file, restart the database, and reload from data files or from export files backed up prior to the corruption.