Professional Documents
Culture Documents
Management System
Backup and Recovery Guide
RELEASE 11.1.1.3
Updated: December 2010
EPM System Backup and Recovery Guide, 11.1.1.3
Copyright © 2008, 2010, Oracle and/or its affiliates. All rights reserved.
Authors: EPM Information Development Team
This software and related documentation are provided under a license agreement containing restrictions on use and
disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or
allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit,
perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation
of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to
change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S.
Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS:
Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers
are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition
Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and
adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to
the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial
Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software is developed for general use in a variety of information management applications. It is not developed or
intended for use in any inherently dangerous applications, including applications which may create a risk of personal
injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe,
backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates
disclaim any liability for any damages caused by use of this software in dangerous applications.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their
respective owners.
This software and documentation may provide access to or information on content, products, and services from third
parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with
respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any
loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
Contents
Documentation Accessibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Contents iii
Chapter 4. Essbase Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Essbase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Backing Up and Recovering Block Storage Databases . . . . . . . . . . . . . . . . . . . . . . . . 27
Preserving Environment Variable Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Backing Up and Restoring Aggregate Storage Applications . . . . . . . . . . . . . . . . . . . . . 50
Exporting and Importing Partition Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Integration Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Essbase Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Provider Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
iv Contents
Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation accessible, with
good usability, to the disabled community. To that end, our documentation includes features
that make information available to users of assistive technology. This documentation is available
in HTML format, and contains markup to facilitate access by the disabled community.
Accessibility standards will continue to evolve over time, and Oracle is actively engaged with
other market-leading technology vendors to address technical obstacles so that our
documentation can be accessible to all of our customers. For more information, visit the Oracle
Accessibility Program Web site at http://www.oracle.com/accessibility/.
5
6 Documentation Accessibility
About Backup and Recovery
1
In This Chapter
Assumed Knowledge........................................................................................ 7
Installation Documentation Roadmap .................................................................... 7
Repositories, Databases, and File Systems .............................................................. 8
Recovery Sequence .......................................................................................10
Assumed Knowledge
This guide is for administrators who install, configure, and manage Oracle Hyperion Enterprise
Performance Management System products. It assumes that you have the following skills and
knowledge:
l Security and server administration skills
l Windows or UNIX administration skills, depending on your operating system (OS)
l Web application server administration skills
l A strong understanding of your organization's security infrastructure, including
authentication providers such as Oracle Internet Directory, Lightweight Directory Access
Protocol (LDAP), Microsoft Active Directory, and use of Secure Sockets Layer (SSL)
l Strong relational database management system (RDBMS) administration skills
l A strong understanding of your organization's database and server environments, including
file systems
l A strong understanding of your organization's network environment and port usage
Assumed Knowledge 7
Management System Certification Matrix at http://www.oracle.com/technology/products/bi/
hyperion-supported-platforms.html.
Table 1 lists the documents to consult for instructions on performing essential installation tasks.
Meeting system requirements Oracle Hyperion Enterprise Performance Management System Certification Matrix
(http://www.oracle.com/technology/products/bi/hyperion-supported-platforms.
html)
Planning the installation Oracle Hyperion Enterprise Performance Management System Installation Start
Here
l Installing and configuring EPM System products Oracle Hyperion EPM System Installation and Configuration Guide
l Automatically deploying EPM System products
l Starting EPM System products
l Validating the installation
l Upgrading EPM System products
Securing EPM System and provisioning users Oracle Hyperion Enterprise Performance Management System Security
Administration Guide
Table 2 lists the documents to consult for additional installation tasks that you might need to
perform.
Manually deploying EPM System products Oracle Hyperion Enterprise Performance Management System Manual Deployment
Guide
Migrating from one environment to another Oracle Hyperion Enterprise Performance Management System Lifecycle
Management Guide
Enabling SSL Oracle Hyperion Enterprise Performance Management System SSL Configuration
Guide
Clustering EPM System applications for high Oracle Hyperion Enterprise Performance Management System High Availability Guide
availability
Physical Backup
Physical backups are copies of physical database files. For example, a physical backup might copy
database content from a local disk drive to another secure location.
A physical backup can be hot or cold:
l Hot backup—Users can make changes to the database during a hot backup. Log files of
changes made during the backup are saved, and the logged changes are applied to
synchronize the database and the backup copy. A hot backup is used when a full backup is
needed and the service level does not allow system downtime for a cold backup.
l Cold backup—Users cannot make changes to the database during a cold backup, so the
database and the backup copy are always synchronized. Cold backup is used only when the
service level allows for the required system downtime.
l Full—Creates a copy of data that can include parts of a database such as the control file,
transaction files (redo logs), archive files, and data files. This backup type protects data from
application error and safeguards against unexpected loss by providing a way to restore
original data. Perform this backup weekly, or biweekly, depending on how often your data
changes. Making full backups cold, so that users cannot make changes during the backups,
is recommended.
Note: The database must be in archive log mode for a full physical backup.
l Incremental—Captures only changes made after the last full physical backup. The files differ
for databases, but the principle is that only transaction log files created since the last backup
are archived. Incremental backup can be done hot, while the database is in use, but it slows
database performance.
In addition to backups, consider the use of clustering or log shipping to secure database content.
See the Oracle Hyperion Enterprise Performance Management System High Availability Guide and
the RDBMS documentation.
A logical export backup generates necessary Structured Query Language (SQL) statements to
obtain all table data that is written to a binary file. A logical export backup does not contain
database instance-related information, such as the physical disk location, so you can restore the
same data on another database machine. Periodic logical export backups (at least weekly) are
recommended in case physical backups fail or the database machine becomes unavailable.
Recovery Sequence
Restore Shared Services, and the components that you backed up for Shared Services, before
restoring other products.
Recovery Sequence 11
12 About Backup and Recovery
Common Backup Tasks
2
In This Chapter
Preparing for Backup ......................................................................................13
Database Backup .........................................................................................13
File System Backup........................................................................................14
Backing Up OS Settings ...................................................................................16
Note: You can also perform hot backups on EPM System products, with some limitations for
individual products as described later in this document. These backups must be
performed at the same time.
Database Backup
Back up these databases:
l Databases that store EPM System application data
l Shared Services databases:
m Relational database for Shared Services
This database contains Shared Services Registry, which stores most product
configuration settings.
See “Backing Up the Shared Services Relational Database ” on page 19.
m OpenLDAP database, if OpenLDAP is used as the Shared Services Native Directory
m Oracle Internet Directory database if Oracle Internet Directory is used as the Shared
Services Native Directory
See the Oracle Internet Directory documentation (http://download.oracle.com/docs/
cd/B28196_01/idmanage.1014/b15991.pdf).
For instructions on backing up an EPM System component, see the section of this guide that is
specific to the component. Example: See “Shared Services” on page 19 for instructions on
backing up Shared Services.
Also back up any database, using the vendor documentation, that you use to store or extract
data for use in product applications. Regular backups of database content are recommended for
these EPM System products:
l Oracle's Hyperion® Business Rules
l Oracle's Hyperion® Dashboard Development Services
l Oracle's Hyperion® Data Integration Management
l Oracle Hyperion Data Relationship Management, Fusion Edition
l Oracle Hyperion Financial Management, Fusion Edition
l Oracle Hyperion Performance Scorecard, Fusion Edition
l Oracle Hyperion Planning, Fusion Edition
l Oracle Hyperion Profitability and Cost Management, Fusion Edition
l Oracle's Hyperion Reporting and Analysis
Note: This item applies only to products that require a Web application server.
l Product applications and application data
l In Windows environments:
m Windows registry: HKEY_LOCAL_MACHINE and all of its subkeys
Note: For some EPM System components, you need only back up specific subkeys, as
described in the procedures for backing up those components.
Backing up the Windows registry enables system recovery if Windows is reinstalled. See
“Backing Up OS Settings” on page 16.
Not applicable for these products:
User home directories and application-specific directories or file systems must be backed
up. Periodically testing the restoration procedure is recommended.
Back up directories and files by copying them to another location. You can also use utilities
provided with your OS (such as the Windows 2003 Backup Utility) or other third-party backup
utilities. In the event of a failure, restore these directories and files by returning the copy to the
original location.
Backing Up OS Settings
You can back up system and product components by using the Windows regedit command
to create registry files. If a failure occurs, you can run the registry files to restore the components.
Note: The following procedure does not apply to Oracle's Hyperion® SQR® Production
Reporting Server, Smart View, or Provider Services.
Backing Up OS Settings 17
18 Common Backup Tasks
Foundation Services
3
In This Chapter
Shared Services ............................................................................................19
EPM Workspace ............................................................................................22
Performance Management Architect .....................................................................24
Calculation Manager.......................................................................................25
Smart View..................................................................................................25
Shared Services
Shared Services backups must be synchronized with product backups to preserve provisioning
data. For additional provisioning information, see the Oracle Hyperion Enterprise Performance
Management System Security Administration Guide.
Note: If you use Oracle Internet Directory as the Shared Services Native Directory, see the Oracle
Internet Directory documentation (http://download.oracle.com/docs/cd/B28196_01/
idmanage.1014/b15991.pdf) for backup instructions.
Caution! The Shared Services relational database and the OpenLDAP database must be
backed up at the same time. Ensure that the administrator does not register a
product-application or create an application group at backup time.
Shared Services 19
2 Run this command to create a hot backup of OpenLDAP:
HYPERION_HOME/products/Foundation/server/scripts/backup file
backup_folder, where backup file is backup.bat (Windows) or backup.sh (UNIX)
Examples:
l Windows
c:/Hyperion/products/Foundation/server/scripts/backup.bat
HSS_backup
l UNIX
/home/username/Hyperion/products/Foundation/server/scripts/
backup.sh /home/username /backups/HSS_backup
For Shared Services OpenLDAP recovery from a catastrophic failure, you must restore these
items:
OpenLDAP has two recovery modes, catastrophic and noncatastrophic. If the failure was not
catastrophic, the files present on the system at the time of failure are sufficient for recovery. For
Shared Services OpenLDAP recovery from a catastrophic failure, you must restore these items:
l An archival copy (or snapshot) of all database files
l All log files written after the snapshot was made
See http://www.oracle.com/technology/documentation/berkeley-db/db/utility/
db_recover.html.
When you recover Shared Services, the backed up configuration and data files are placed in a
subdirectory of HYPERION_HOME products/Foundation.
20 Foundation Services
See the Oracle Hyperion Enterprise Performance Management System Installation and
Configuration Guide.
2 Recover the Shared Services relational database with RDBMS tools, using the backup with the same
date as the OpenLDAP backup.
3 If you use OpenLDAP as Native Directory, recover the OpenLDAP database by running
HYPERION_HOME/products/Foundation/server/scripts/recover_file
backup_folder [catRecovery], where recover_file is recover.bat (Windows) or
recover.sh (UNIX), and [catRecovery] is the option used to recover from a catastrophic failure.
Examples:
Windows noncatastrophic recovery—C:/Hyperion/products/Foundation/server/
scripts/recover.bat c:/HSS_backup
The backed up configuration and data files are placed in a subdirectory of the Shared Services
home directory.
Shared Services 21
2 Using Oracle Hyperion Enterprise Performance Management System Installer, Fusion Edition, install
Shared Services binaries.
EPM Workspace
This section provides general backup and recovery procedures for EPM Workspace. For
procedures specific to Reporting and Analysis components, see Chapter 5, “Reporting and
Analysis.”
Tip: Rather than manually shut down EPM Workspace services, you can suspend them. See
“Suspending EPM Workspace and Reporting and Analysis Services” on page 22.
2 Back up all EPM Workspace components as described in “Preparing for Backup” on page 13, including
the entire registry and the repository database.
3 Back up ANDALE fonts (ANDALE*.ttf) in C:\WINDOWS\Fonts (Windows) or
HYPERION_HOME/products/biplus/fonts (UNIX).
4 Back up the file system. See “Backing Up the EPM Workspace File System” on page 23.
22 Foundation Services
Instead of shutting down services before performing a backup, you can suspend services by
putting them in maintenance mode. This process initially includes running a SQL statement to
insert a row in the v8_service_mode table in the Reporting and Analysis repository schema
with the values of v8_service_mode.name="MAINTENANCE" and
v8_service_mode.value = 1 (true) or 0 (false).
Service log messages indicate that the service is in maintenance mode. Messages are also logged
when maintenance mode is turned off.
EPM Workspace 23
Restoring EPM Workspace
ä To restore EPM Workspace after a failure:
1 Recover all components that you backed up, including the registry and the repository database.
Place the copied directories and files in their original locations.
2 Restart all products and related services.
See the Oracle Hyperion Enterprise Performance Management System Installation and
Configuration Guide.
24 Foundation Services
See the Oracle Hyperion Enterprise Performance Management System Installation and
Configuration Guide.
Calculation Manager
To enable recovery after a failure, you need back up only the database that you use with Hyperion
Calculation Manager, as described in the RDBMS documentation. As an extra precaution, you
can back up the product components in HYPERION_HOME/products/Foundation/CALC.
Smart View
ä To back up Smart View, copy the Microsoft Office data files to another location.
Include these file types:
l XLS and XLSX (Excel)
l DOC and DOCX (Word)
l PPT and PPTX (PowerPoint)
ä To recover from a failure, replace the backed up Microsoft Office data files in their original
locations.
Calculation Manager 25
26 Foundation Services
Essbase Components
4
In This Chapter
Essbase .....................................................................................................27
Integration Services........................................................................................51
Essbase Studio ............................................................................................51
Provider Services...........................................................................................52
Essbase
Regular Essbase backups, which should be integrated into production server maintenance, are
key to database maintenance. Backup frequency should be determined by the volatility of the
database and server environment and the need for rapid database restoration (should a server
interruption occur).
Restore refers to the process of returning a database to the state it was in when a backup was
performed. For block storage databases, you can use the automated Essbase backup and restore
feature or using manual procedures. For aggregate storage databases, you must use manual
backup and restore features.
Recover refers to the process of returning a database to a post-backup state that includes
transactions that occurred after the backup was performed. To recover a database, you must use
the automated backup and restore and the automated transaction logging and replay features.
For more information about MaxL statements and Administration Services Console options
discussed in this section, see the Oracle Essbase Technical Reference and Oracle Essbase
Administration Services Online Help, respectively.
Essbase 27
The use of the database backup and restore and transaction logging and replay features
eliminates the need for various manual steps and, therefore, enables administrators to back
up and recover databases more efficiently. Oracle recommends incorporating these features
in your backup and recovery strategy.
See:
m “Sequence for Fully Recovering Block Storage Databases” on page 28
m “Using Backup and Restore for Block Storage Databases” on page 29
m “Using Transaction Logging and Replay For Block Storage Databases” on page 36
l Manual backup and restore
Essbase customers who have designed a backup and restore strategy that uses manual
procedures and who do not need the functionality of transaction logging and replay can
continue using their manual strategy.
See “Using Manual Backup and Restore Procedures” on page 43.
Table 3 Example Sequence for Using Backup and Restore and Transaction Logging and Replay
28 Essbase Components
Time Period (Sequence ID) Transaction or Event
T5 (5) Update cells in a spreadsheet, and perform a lock and send to update the database.
T12 (8) Back up the database or manually save the changed outline.
Table 4 lists and describes the Essbase database files that are backed up automatically.
File Description
Essbase 29
File Description
dbname.esm Essbase Kernel file that contains control and disk volume information used for database recovery
dbname.otl Outline file, which stores all metadata for a database and defines how data is stored, but does not store data
itself
dbname.otl.keep Temporary backup of dbname.otl (created by operations that modify the outline and write it to a new file)
dbname.otn Temporary outline file created during a dimension build or outline editing
dbname.alg Spreadsheet update log that stores spreadsheet update transactions as a unit that can be used as the input source
for data loads
dbname.atx Spreadsheet update log that contains historical information for each transaction, such as user name, date, and
timestamp, and the number of transaction rows from the .atx file
In addition to the files that Essbase backs up, you must manually back up the files listed in
Table 5. You should back up these files at a later date than when the database backup is performed
(for example, a few days after). You should also back up rules files and ESSCMD or MaxL scripts
when you create or modify them.
Table 5 lists and describes theEssbase database files that must be backed up manually.
30 Essbase Components
File Description Location
.csc
.rul
.rep
.eqd
.sel
Caution! Before using the force option, ensure that you no longer need the current archive
file contents.
Essbase 31
Essbase to split the archive file into multiple files, with each file no larger than 2 GB. In the
essbase.cfg file, set the SPLITARCHIVEFILE configuration to TRUE.
The first (or main) archive file that Essbase creates uses the file name that you specify (for
example, samplebasic.arc). When the main archive file reaches the 2 GB limit, Essbase creates
another archive file. In naming the other archive files, Essbase increments the main archive file
name with “_x”, where x is an integer (starting with 1). Using the samplebasic.arc example,
if three archive files are created when backing up the Sample.Basic database, the file names would
be:
samplebasic.arc
samplebasic_1.arc
samplebasic_2.arc
All split archive files are created in the directory that you specified when specifying the file name
and location of the main archive file.
Note: When restoring a database in which the archive file is split into multiple files, Essbase
looks for multiple archive files, even if, after the backup, you set SPLITARCHIVEFILE to
FALSE for that database. Also, Essbase expects all of a database's archive files (main and
split) to be in the same directory.
Oracle Essbase Administration Services Backing Up Block Storage Databases Oracle Essbase Administration Services Online Help
For example, the following statement backs up the Sample.Basic database to the specified archive
file on Essbase Server:
alter database Sample.Basic archive to file '/Hyperion/samplebasic.arc';
If the samplebasic.arc file exists on Essbase Server, use force grammar to overwrite the file
contents. Example:
alter database Sample.Basic force archive to file '/Hyperion/
samplebasic.arc';
32 Essbase Components
Note: At a different point in time than when you back up the database, manually back up the
files listed in Table 5 on page 30.
ä To retrieve archive file information, use the query archive_file MaxL statement.
The syntax for the statement:
query archive_file BACKUP-FILE [get overview] [list disk volume];
In the MaxL Script Editor in Administration Services Console, you can view the results of the
query. Figure 1 shows overview information:
You can also view disk volume information in Administration Services Console when using the
Restore Database command.
Note: On Windows, Essbase adds the default ARBORPATH drive (for example, the C: drive) as a
disk volume, even if the database that you backed up does not store data on that disk
volume. See “Working with Disk Volumes” on page 35.
Essbase 33
Before restoring the database, you should terminate active client connections to the database.
In restoring a database, Essbase empties the database and locks it. Before extracting the contents
of the archive file, Essbase validates the file. Essbase then copies index and page files to the
specified disk volumes, and updates dbname.esm with disk volume information. See “Working
with Disk Volumes” on page 35.
If you have configured Essbase to split the archive file into multiple files (see “Configuring and
Specifying the Database Archive File” on page 31), you must specify only the file name of the
main archive file that you want to restore (for example, samplebasic.arc).
Note: When restoring a database in which the archive file is split into multiple files, Essbase
looks for multiple archive files, even if, after the backup, you set SPLITARCHIVEFILE to
FALSE for that database. Also, Essbase expects all of a database's archive files (main and
split) to be in the same directory.
Administration Services Restoring Block Storage Databases Oracle Essbase Administration Services Online Help
In MaxL, use the alter database statement with the restore from file grammar. The syntax for
the statement:
alter database appname.dbname [force] restore from file BACKUP-FILE
[replace disk volume VOL];
Typically, you restore a database to the application and database from which the backup was
taken and, therefore, the names in the archive file of the backed-up database and its associated
application, which are to be restored, are the same. If, however, the names of the backed-up
database and application differ from the application and database to which you are restoring
data, you must use force grammar. Syntax for the statement:
alter database appname.dbname force restore from file BACKUP-FILE;
For example, you can use the backup for Sample.Basic to restore to Sample.New (the database
name is different), MyCompany.Basic (the application name is different), or MyCompany.New
(both names are different).
The archive file contains the names of the application and database, the time the backup was
performed, and disk volume information. See “Retrieving Archive File InformationEssbase” on
page 33.
34 Essbase Components
Restoring Manually Backed Up Files
After restoring a backed-up database, you typically do not need to restore the files that you
manually backed up (see Table 5 on page 30).
Restore manually backed up files in these situations:
l If a server interruption corrupted any files, such as security files
l If you encounter problems (such as missing rules files or scripts) when replaying logged
transactions
For example, the following statement restores the Sample.Basic database using the
samplebasic.arc archive file and replaces the specified disk volumes:
Essbase 35
Table 6 lists the supported combinations of restoring backed-up databases between Unicode
and non-Unicode applications.
Table 6 Combinations of Backed Up and Restored Databases by Unicode and Non-Unicode Application Modes
Unicode Non-Unicode No
Category Transaction
Lock and send Update database cells with data from Smart View or Oracle Essbase Spreadsheet Add-in.
The operational parameters that are logged for each transaction vary. Table 8 shows the
parameters that are logged for three representative transactions:
36 Essbase Components
Table 8 Examples of Parameters Logged for Specific Transactions
Import data from different sources l User who submitted the request
to Essbase Server
l Start time
l End time
l Sequence ID
l RequestType
l Rule file name and location
l Data file name and location
l If SQL source, the SQL connection information
l If the data and rule files are on the client computer, archive the files to the Replay directory.
The directory path is logged for use during the replay operation.
Essbase autogenerates a unique file name for archived data and rule files, such as 98761234.
txt and 98761234.rul.
Update database cells with data l User who submitted the request
from Oracle Hyperion Smart View Start time
for Office, Fusion Edition or Oracle
l
Note: Replay is a reserved word and cannot be used as the name of a block or aggregate storage
database. If you named a database “replay” in the past, you must rename the database
before enabling the transaction logging and replay feature.
Essbase 37
Note: Do not change the NATIVE argument, which is a reserved field. For the log location,
Oracle recommends using a physical disk other than the disk on which the ARBORPATH
directory or disk volumes reside.
For example, the following statement enables transaction logging for all databases associated
with the Sample application:
TRANSACTIONLOGLOCATION Sample /Hyperion/trlog NATIVE ENABLE
As transactions are logged for the Sample.Basic database, the log store is written to:
/Hyperion/trlog/Sample/Basic
Depending on the number of databases for which you enable transaction logging, you might
want to create more than one centralized transaction log location; however, Oracle recommends
keeping the number of log locations to a minimum.
Additionally, by using multiple TRANSACTIONLOGLOCATION statements, you can enable
transaction logging at a more global level and, at the same time, disable logging at a more granular
level. In the essbase.cfg file, the more global enabling statement must precede the more
granular disabling statement for the override to take effect.
Consider the following examples:
l The first statement enables transaction logging for all applications and their associated
databases on Essbase Server; the second statement disables transaction logging for all
databases associated with a specific application (Sample):
TRANSACTIONLOGLOCATION /Hyperion/trlog NATIVE ENABLE
Note: Before renaming or copying an application or database for which transaction logging is
enabled, you must enable logging for the renamed or copied application or database and
specify the same LOGLOCATION that is specified for the source application and database.
By default, Essbase archives only data load and rules files for client data loads.
38 Essbase Components
To change the type of data to be archived, add the TRANSACTIONLOGDATALOADARCHIVE
configuration setting to the essbase.cfg file. The syntax for the statement:
TRANSACTIONLOGDATALOADARCHIVE [appname [dbname]] [OPTION]
Caution! Server data loads are replayed using the data load and rules files that are archived
on the server in the Replay directory. Do not rename these files. Also, if the
contents of the data load and rules files are changed before the replay operation,
the modified data is used during replay. Therefore, the data in the recovered
database will not be the same as the original data.
l SERVER_CLIENT—Archives server and client data.
l NONE—No data is archived.
If you select NONE and you use client data, Essbase cannot replay the data load. To recover
transactions, you must manually load the client data before you replay the remaining
transactions.
Caution! If you use server or SQL data and the data and rules files are not archived in the
Replay directory (for example, you did not use the SERVER or
SERVER_CLIENT option), Essbase replays the data that is in the data source,
which may or may not be the data that was originally loaded.
For example, the following statement archives server and client data for all databases on Essbase
Server:
TRANSACTIONLOGDATALOADARCHIVE SERVER_CLIENT
Administration Services Viewing Logged Transactions for Block Storage Oracle Essbase Administration Services Online Help
Databases
Essbase 39
Tool Topic Location
In Administration Services Console, use the Display Transactions command to view a list of
transactions, as shown in Figure 3 You can sort the list by the following attributes:
l Sequence ID
l Username
l Start Time
l End Time
l Request Type
Although you can sort the list of transactions, you must replay transactions in the same order
as the sequence ID.
When using the query database MaxL statement with the list transactions grammar, you can
specify whether to display the list output in the MaxL Shell window (the default) or to write the
list output to a specified file. The syntax for the statement:
query database appname.dbname list transactions [after TIME [[force]
write to file FILE-NAME]]];
For example, the following statement displays, in the MaxL Shell window, the transactions in
the Sample.Basic database that were logged after the last replay request was originally executed
or after the last restored backup's time (whichever occurred later):
query database Sample.Basic list transactions;
Writing the output to a file is useful for processing the log information with other tools. For
example, you can import the file contents into a relational database and write a tool to analyze
the information.
When using the write to file grammar, the list output is written to a comma-separated file on
the Essbase Server computer. Provide the full pathname to an existing directory on Essbase Server
and the name of the output file. If only the output file name is provided, Essbase writes the file
to ARBORPATH/app.
40 Essbase Components
When writing to an existing output file, use force grammar to overwrite the file.
For example, the following statement writes Sample.Basic database transactions that were logged
after November 20, 2007, at 12:20:00 to a CSV file in the Sample.Basic database directory:
query database Sample.Basic list transactions after '11_20_2007:12:20:
00' write to file '/Hyperion/products/Essbase/EssbaseServer/app/Sample/
Basic/listoutput.csv';
l 1—(Default) Specifies the security settings of the user who originally performed the
transaction.
l 2—Specifies the security settings of the administrator performing the replay operation.
l 3—Specifies the security settings of the user who originally performed the transaction. If
that user no longer exists or that user's username was changed, the security settings of the
administrator performing the replay operation are used.
Each logged transaction is assigned a sequence ID, indicating the order in which the transaction
was performed. To ensure the integrity of the restored data after a replay, Essbase enforces the
replay of transactions in the same order in which they were originally performed. For example,
if a data load was followed by a calculation, replaying the calculation before the data load would
produce incorrect results; the data load transaction must be replayed before the calculation
transaction.
The order of sequence IDs is tracked across multiple replay commands. After a transaction has
been replayed, you can replay only transactions with a greater sequence ID. For example, after
replaying transactions with sequence IDs of 1, 2, and 3, you can only replay transactions with a
sequence ID of 4 or greater.
Transactions that are executed and logged after the restore operation are not replayed, unless
you replay those transactions using their sequence IDs. After restoring a database, Oracle
Essbase 41
recommends that you finish replaying the transactions that were logged after the backup and
before the restore and that are needed to fully recover the database; then you can continue
executing new transactions.
Note: You can skip replaying a transaction if you are absolutely sure that the transaction results
are not required to recover the database. For example, if you performed two full data loads
with identical data, it is only necessary to replay one of the data loads.
Administration Services Replaying Logged Transactions for Block Storage Oracle Essbase Administration Services Online Help
Databases
The replay functionality is the same whether you use Administration Services Console or MaxL.
To selectively replay transactions, enter a comma-separated string of sequence ID ranges. A range
can consist of one or more transactions:
l One transaction: n to n; for example, 1 to 1
l Multiple transactions: x to y; for example, 20 to 100
For example, the following statement replays the transactions in the Sample.Basic database with
sequence IDs 1–10 and 20–100:
alter database Sample.Basic replay transactions using sequence_id_range
1 to 10,20 to 100;
42 Essbase Components
Replay directory: After you have replayed transactions, the data and rules files associated with
the replayed transactions can be removed from the ARBORPATH/app/appname/dbname/
Replay directory (see “Configuring Transaction Replay” on page 38). You can delete all of the
files in the Replay directory, or follow these guidelines for selectively removing files:
l Remove the data and rules files in chronological order, from earliest to latest.
l Do not remove data and rules files with a timestamp that is later than the timestamp of the
most recent archive file.
Note: Oracle recommends waiting until several subsequent database backups have been taken
before deleting files associated with transaction logging and replay.
Note: Back up and restore the source and target databases at the same time. See “Backing
Up and Restoring Partitioned Databases” on page 36.
Essbase 43
Table 9 Essbase Files to Back Up
dbname.esm Essbase Kernel file that contains control information used for ARBORPATH/app/appname/dbname/
database recovery
dbname.ind Free fragment file for data and index free fragments ARBORPATH/app/appname/dbname/
dbname.otl Outline file, which stores all metadata for a database and defines ARBORPATH/app/appname/dbname/
how data is stored, but does not store data itself
.csc
.rul
.rep
.eqd
.sel
1Back up all .ind files related to a database, because a database may have multiple .ind files.
2Back up all .pag files related to a database, as a database may have multiple .pag files.
3Shut down the Agent before backing up 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 the entire Essbase directory structure. Back up data
on every disk volume.
To restore a database, ensure that the application is stopped, and replace the files on disk with
the corresponding backed up files.
44 Essbase Components
1. “Putting a Database in Read-Only Mode” on page 45
2. “Performing a File Backup” on page 45
3. “Returning a Database to Read-Write Mode” on page 46
4. “Restoring the File Backup” on page 46
After you perform the backup, return the database to read-write mode.
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 backup. 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, when the operation cannot be canceled.
Caution! 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.
Essbase 45
ä To back up data, use a third-party backup utility to back up the files listed in
archive.lst and in Table 9, “Essbase Files to Back Up,” on page 44, or back up the entire
Essbase directory structure.
Note: 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.
46 Essbase Components
Loading an export file into a database fails 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 longer than if the outlines were identical.
l Data integrity is verified because every block is checked to confirm whether corresponding
page and index files match.
l Exporting data, clearing all data from the database, and reloading the text file can reduce
fragmentation.
Note: You can export subsets of data by creating reports or calculation scripts. Using calculation
scripts, you can export data to text or binary files, or directly into a relational database.
See the Oracle Essbase Database Administrator's Guide.
Exporting Data
The same basic information is required, regardless of the method used to export data:
l Names of export data files
l The amount of data to export
m All data
m Level 0 blocks only (blocks containing only level 0 sparse member combinations; these
blocks may contain data for upper-level dense dimension members)
m Data from input blocks only (blocks containing data from a previous data load or
spreadsheet lock and send)
l Whether to export data in a columnar or noncolumnar 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 noncolumnar format, sparse members identifying a data block are included
only once for the block. Because the export file in noncolumnar format is smaller than in
columnar format, reloading a file in noncolumnar format is faster.
Essbase 47
ä To export data, use a tool:
Administration Services Exporting Databases Oracle Essbase Administration Services Online Help
Report Writer Use a Report Writer script to export selected Oracle Essbase Database Administrator's Guide
data.
Calculation script (block storage DATAEXPORT calculation commands Oracle Essbase Technical Reference
only)
Note: To improve export performance, you can export data in parallel to a specified number of
files.
Administration Services Performing a Data Load or Dimension Build Oracle Essbase Administration Services Online Help
48 Essbase Components
Tool Topic Location
Calculation script DATAIMPORTBIN (exported binary files only) Oracle Essbase Technical Reference
ä To clean block status in a database after exporting all data and reloading, run the following
calculation script:
Set ClearUpdateStatus Only;
Calc All;
Administration Services Exporting LROs Oracle Essbase Administration Services Online Help
As part of your database restore procedure, import the LROs that you previously exported.
Oracle Essbase Administration Services Importing LROs Oracle Essbase Administration Services Online Help
Essbase 49
l dbname.tct
l dbname.ind
2 Restart the database.
3 Reload from data or export files that you created before the corruption.
default Tablespace directory (can be in multiple locations that (Default location) ARBORPATH/app/appname/
you define) default
temp Tablespace directory (can be in multiple locations that (Default location) ARBORPATH/app/appname/
you define) temp
ARBORPATH/app/appname/log/
ARBORPATH/app/appname/metadata/
50 Essbase Components
ä To back up an aggregate storage database:
1 Stop the application.
2 Use the file system to copy the contents of the application directory (ARBORPATH/app/appname),
excluding the temp directory.
Integration Services
ä To back up Integration Services:
1 Perform a complete backup of the Oracle Essbase Integration Services catalog repository.
2 Optional: Export all models and metaoutlines into XML files.
3 Create and save a list of all source Open Database Connectivity (ODBC) Data Source Names (DSNs)
that were set up.
4 Keep a current copy of installed software, along with all property files such as ais.cfg.
Essbase Studio
ä To back up and restore Essbase Studio components to a previous state:
1 Stop the Oracle Essbase Studio server.
Integration Services 51
2 Perform a complete backup of the Oracle Essbase Studio metadata repository.
3 Keep a current copy of installed software and all property files (server.properties,
essbase.properties, and eas.properties).
Provider Services
Back up these files and folders:
l HYPERION_HOME/products/Essbase/aps/bin/datasources.xml file—Contains all
data source connection information for the various providers.
l HYPERION_HOME/products/Essbase/aps/data folder—Contains all Smart Slice
definitions managed centrally by Oracle Hyperion Provider Services. Back up the entire
folder, including subfolders.
l APS_HOME/bin/essbase.properties file
52 Essbase Components
Reporting and Analysis
5
In This Chapter
Backing Up Reporting and Analysis ......................................................................53
Backing Up the Reporting and Analysis File System....................................................53
Restoring Reporting and Analysis ........................................................................54
Dashboard Development Services .......................................................................54
Financial Reporting ........................................................................................55
Production Reporting ......................................................................................55
Tip: Rather than manually shutting down Reporting and Analysis services before
performing a backup, you can suspend the services. See “Suspending EPM Workspace
and Reporting and Analysis Services” on page 22.
l Directories in the file system identified in “Backing Up the Reporting and Analysis File
System” on page 53
l ANDALE fonts (ANDALE*.ttf) in C:\WINDOWS\Fonts (Windows) or HYPERION_HOME/
products/biplus/fonts (UNIX).
Note: The following commands assume that the Hyperion home directory is C:/
Hyperion.
l regsvr32 C:/Hyperion/products/biplus/bin/QIQZip.dll
l regsvr32 C:/Hyperion/products/biplus/bin/DDSUtil.dll
l regsvr32 C:/Hyperion/products/biplus/bin/DDSFW.dll
l regsvr32 C:/Hyperion/products/biplus/bin/DDSHelper.dll
l regsvr32 C:/Hyperion/products/biplus/bin/DDSListBar.ocx
l regsvr32 C:/Hyperion/products/biplus/bin/Srcvw3.dll
l regsvr32 C:/Hyperion/products/biplus/bin/MBSplit.ocx
l regsvr32 C:/Hyperion/products/biplus/bin/UniBox10.ocx
Financial Reporting
ä To enable recovery of Financial Reporting, back up related components as described in
Chapter 2, “Common Backup Tasks.”
Production Reporting
ä To enable Production Reporting recovery:
1 Back up Oracle Enterprise Performance Management Workspace, Fusion Edition and related
components. See “Backing Up EPM Workspace” on page 22.
2 Back up these Microsoft Windows directories:
l %windir%/sqr.ini
l %windir%/sqr64.ini
l %windir%/libsti.ini
3 Back up these directories in HYPERION_HOME/products/biplus:
l bin/SQR/...
l common/SQR/...
l common/docs/Activator
l common/docs/defaults
l common/docs/Server
l common/docs/samples/Production Reporting
l common/Server
ä To recover Production Reporting after a failure, replace the backed-up components in their
original locations, and restore the database.
Financial Reporting 55
56 Reporting and Analysis
Financial Performance
6 Management Applications
In This Chapter
Planning.....................................................................................................57
Business Rules .............................................................................................58
Financial Management ...................................................................................58
Performance Scorecard ...................................................................................60
Profitability and Cost Management.......................................................................60
Strategic Finance ..........................................................................................61
Planning
ä To enable Planning recovery from a failure:
1 Back up related components, such as the Planning relational database, as described in Chapter 2,
“Common Backup Tasks.”
Tip: Rather than back up the entire Windows registry, you can back up only these keys for
Planning: HKLM/Software/Hyperion* nodes and HKLM/System/
CurrentControlSet/Services/Hyperion*.
2 Back up the Essbase outline files for your applications.
3 Back up the full export of Essbase data.
4 Back up any calc scripts and substitution variables associated with Essbase.
5 Back up the Business Rules .properties file in the WEB-INF/classes directory. For example,
HYPERION_HOME/deployments/AppServer/HyperionPlanning/webapps/
HyperionPlanning/WEB-INF/classes.
6 Back up the file system folder where it contains Planning Shared Libraries, such as C:/Windows/
System32.
7 UNIX: Back up custom scripts, such as startup files associated with Planning.
8 Ensure that the backup of HYPERION_HOME/products/Planning directory includes these files,
and back them up manually if it does not:
l PlanningCalcMgrLog4j.properties
l PlanningSystemDB.properties
l HBRServer.properties
Planning 57
l essbase.properties
Note: Restore the Business Rules.properties file to the location from which you created
the backup.
3 Restore the Planning databases.
4 Restart all servers and services.
Business Rules
ä To enable recovery after a failure:
1 Back up related components daily to a storage device, as described in Chapter 2, “Common Backup
Tasks,” including databases for the products that you use with Oracle's Hyperion® Business Rules (such
as Planning).
2 Back up the AdminServices/storage directory daily.
3 Back up all XML files in AdminServices/server daily.
Financial Management
Most Financial Management configuration information is in the Windows registry in
HKEY_LOCAL_MACHINE/SOFTWARE/Hyperion Solutions/Hyperion Financial
Management. Distribued Component Object Model (DCOM) security information is associated
with HFMServer.exe and HsvDataSource.exe. Because it is difficult to back up and restore
this information, use the following procedure on every application and Web server to back up
Financial Management.
Financial Management 59
Performance Scorecard
ä To enable recovery from a failure, regularly back up these items:
1 Regularly back up these items:
l Related components as described in Chapter 2, “Common Backup Tasks.”
l The directory containing annotations, notes, attachments, and custom image files. By
default, this is HYPERION_HOME/deployments/Application Server/
webappsconf/attachments.
l HPSConfig.properties and HPSAlerter.properties in HYPERION_HOME/
deployments/Application Server/webappsconf/config.
2 If you generated an Essbase database of application data, back up the database as described in
Chapter 4, “Essbase Components.”
3 If you installed the ETL Import Export Utility, back up these directories:
l HYPERION_HOME/products/PerformanceScorecard/tools/config
l HYPERION_HOME/products/PerformanceScorecard/tools/bin
ä To recover from a failure, replace the copied directories and files in their original locations,
and restore the database.
Strategic Finance
ä To enable Strategic Finance recovery from a failure:
l Back up related components as described in Chapter 2, “Common Backup Tasks.”
l Record the optional RDBMS connection information.
l Back up the application data folder (HYPERION_HOME/products/hsf/hsfdata by
default).
l Copy hsf95.xml and hsf95.properties in HYPERION_HOME/common/config/
product/hsf/9.5 to another location.
l Copy customization files such as .coa files, currdata.dat, consdata.dat, and
convert.idx to another location or to a storage device.
l If you use custom templates, back up the contents of the server program directory,
including .coa, .idx , .dat , .txt ,.xml, .drs, .alt , and .alc files.
Note: Use of the back up open files option of standard backup products is recommended, in
case Strategic Finance is holding files open when the backup goes through the application
data folder. If the open files are not backed up, the backup image may not be fully
consistent.
Strategic Finance 61
62 Financial Performance Management Applications
Data Management
7
In This Chapter
Data Integration Management ............................................................................63
Data Relationship Management ..........................................................................63
FDM .........................................................................................................64
ERP Integrator ..............................................................................................64
FDM
FDM uses separate databases and schemas for each application that you create.
ä To recover after a failure, restore the directory to its original location, and restore the
database as described in the database vendor documentation.
ERP Integrator
ä To enable ERP Integrator recovery after a crash, regularly back up the database schema that
stores the mapping tables and data staging tables.
64 Data Management
A B C D E F H I L M O P R S W
Index
A E
archiving Essbase files, 45 ENDARCHIVE command (Essbase), 46
EPM Workspace
backup, 22
B file system backup, 23
backup preliminaries, 13
recovery, 24
backup types
suspending services, 22
database, 9
ERP Integrator backup and recovery, 64
file system, 10
Essbase
BEGINARCHIVE command (Essbase), 45
archive replay data, removing, 42
Business Rules
archiving data, 45
backup, 58
backing up and restoring data files, 43
recovery, 58
backing up files during runtime, 44
backup (manual procedures), 43
C backup and recovery overview, 27
Calculation Manager backup and recovery, 25 BEGINARCHIVE command, 45
binary data export and import, 46
block storage database
D backup and recovery, 27
Dashboard Development Services
backup and restore feature, 29
backup, 54
recovery sequence, 28
recovery, 54
restoring, 33
Data Integration Management
transaction logging and replay, 36
backup, 63
calc scripts, clearing after export, 49
recovery, 63
data corruption, avoiding, 45
Data Relationship Management
data export, 46
backukp, 63
database
recovery, 64
aggregate storage, 50
database backup
backup caution, 45
common tasks, 13
large files, 48
logical, 10
resolving corruption, 49
physical, 9
restoring, 46
with Lifecycle Management, 10
dirty status after reloads, 48
databases
disk volumes, 35
Shared Services Registry, 13
environment variables, preserving, 50
OpenLDAP, 13
essential files, 44
Oracle Internet Directory, 13
exported data reloads, 46
disk volumes, backing up Essbase data on, 44
exporting data in parallel, 48
Index 65
A B C D E F H I L M O P R S W
66 Index
A B C D E F H I L M O P R S W
R
recovery sequence, 10
regedit, component backup with, 17
Reporting and Analysis
backup, 53
file system backup, 53
recovery, 54
suspending, 22
S
services, suspending for EPM Workspace and
Reporting and Analysis, 22
Shared Services
cold backup, 21
hot backup , 19
recovery from catastrophic failure, 20
recovery from cold backup, 21
recovery from hot backup, 20
relational database backup, 19
Smart View
backup, 25
recovery, 25
Strategic Finance
backup, 61
recovery, 61
system variable backup, 17
W
Windows registry settings backup, 16
Index 67
A B C D E F H I L M O P R S W
68 Index