Working with Hyperion Essbase Files and Cross-Platform Environments

This chapter introduces the file types that Hyperion Essbase uses, describes operations that you can perform on Hyperion Essbase files, and discusses some of the issues that you face when working with Hyperion Essbase files on different platforms.

This chapter contains the following sections:

• About Hyperion Essbase File Types
• Operating on Applications, Databases, and Related Objects
• Porting Applications Across Platforms

About Hyperion Essbase File Types

The following table lists the file types that Hyperion Essbase uses to store applications and databases:

The following table lists the types of Hyperion Essbase files that are stored in the \ESSBASE\BIN directory:

The following table lists the types of Hyperion Essbase files that are stored in the \ESSBASE\API sub-directories:

Operating on Applications, Databases, and Related Objects

You can use Hyperion Essbase Application Manager to copy, rename, delete, and lock each of the following:

• Applications
• Databases
• Related objects, such as outlines, calc scripts, report scripts, rules files, and data sources

Hyperion Essbase stores each application as a collection of files in the Hyperion Essbase application directory (for example,\ESSBASE\APP\appname)on the server. Hyperion Essbase stores each database as a collection of files on the database directory of the server (for example,\ESSBASE\APP\appname\dbname).

Files that are related to applications and databases are called objects. The common types of objects are outlines, calc scripts, report scripts, rules files, and data sources. You typically store objects on the server in the appname or dbname directory or on the client machine under the \ESSBASE\CLIENT\appname or dbname directory.

In addition to the standard object types, Hyperion Essbase also supports the following objects:

• Linked reporting objects, which are files or cell notes that are associated with specific data cells in a database. For more information, read Linking Objects to Hyperion Essbase Data .
• Visual Basic programming objects (.OCX) for creating OLAP-aware modules. This feature is available with Hyperion Objects, licensed separately.

Copying an Application

When you copy an application, Hyperion Essbase copies all files associated with the application to the destination application. Before copying, make sure that you have enough disk space to contain a full copy of the application, databases, and related files.

1. Connect to the server on which the application resides.
2. From the Application Desktop window, select the application.
3. Select Application > Copy. The following dialog box is displayed:

   Figure 49-1: Application Copy Dialog Box

   

4. In the Application text box, enter the name of the copy of the application.
5. Click OK. Hyperion Essbase creates a new application and a new database directory structure on the server under the\ESSBASE\APP directory.

You can also use create application in MaxL or the COPYAPP command in ESSCMD to perform this task. For more information, see the online Technical Reference in the DOCS directory.

Renaming an Application

When you rename an application, the application and the application directory (ESSBASE\APP\appname) are renamed. All objects within the application (for example databases or calc scripts) with the same name as the application are not renamed.

1. Connect to the server on which the application resides.
2. From the Application Desktop window, select the application.
3. Select Application > Rename. The following dialog box is displayed:

   Figure 49-2: Rename Application Dialog Box

   

4. In the To text box, enter the new name for the application. The name can be up to 8 alphanumeric characters.
5. Click OK. Hyperion Essbase renames the application and directory name under the\ESSBASE\APP directory.

You can also use alter application in MaxL or the RENAMEAPP command in ESSCMD to perform this task. For more information, see the online Technical Reference in the DOCS directory.

Deleting an Application

When you delete an application, all objects within the application are also deleted. The\ESSBASE\APP\appname directory and all files located in the directory are deleted.

1. Connect to the server on which the application resides.
2. From the Application Desktop window, select the application.
3. Select Application > Delete. The following dialog box is displayed:

   Figure 49-3: Confirm Delete Dialog Box for Applications

   

4. Click Yes or No.

You can also use drop application in MaxL or the DELETEAPP command in ESSCMD to perform this task. For more information, see the online Technical Reference in the DOCS directory.

Copying a Database

When you copy a database, all files associated with the database are also copied to the destination application. Before copying, make sure you have enough disk space to contain a full copy of the databases and of the related files.

1. Connect to the server on which the database resides.
2. From the Application Desktop window, select the application that contains the database.
3. Select the appropriate database in the selected application.
4. Select Database > Copy. The following dialog box is displayed:

   Figure 49-4: Database Copy Dialog Box

   

5. To copy the database to another database within the same application, in the Database text box type a new database name. Click OK.
6. To copy the database to another database in a different application (the other application must already exist), from the Application list box, select the application name. Then type the name of the new database and click OK.

You can also use create database in MaxL or the COPYDB command in ESSCMD to perform this task. For more information, see the online Technical Reference in the DOCS directory.

Renaming a Database

When you rename a database, the database, the database directory (ESSBASE\APP\appname\dbname), and the outline file (.OTL) are renamed. All other objects in the database (for example, calc scripts) with the same name as the database are not renamed.

1. Connect to the server on which the application resides.
2. From the Application Desktop window, select the application that contains the database.
3. Select the appropriate database in the selected application.
4. Select Database > Rename. The following dialog box is displayed:

   Figure 49-5: Rename Database Dialog Box

   

5. In the To text box, enter the new name for the database.
6. Click OK. Hyperion Essbase renames the database and the directory under the \ESSBASE\APP\appname directory.

You can also use alter database in MaxL or the RENAMEDB command in ESSCMD to perform this task. For more information, see the online Technical Reference in the DOCS directory.

Deleting a Database

When you delete a database, all objects within the database are also deleted. The \ESSBASE\APP\appname\dbname directory and all files located in the directory are deleted.

1. Connect to the server on which the application that contains the database resides.
2. From the Application Desktop window, select the application that contains the database.
3. Select the appropriate database in the selected application.
4. Select Database > Delete. The following dialog box is displayed:

   Figure 49-6: Confirm Delete Dialog Box for Databases

   

5. Click Yes or No.

You can also use drop database in MaxL or the DELETEDB command in ESSCMD to perform this task. For more information, see the online Technical Reference in the DOCS directory.

Copying Objects

Objects related to databases or applications are outlines, calc scripts, report scripts, rules files, and data sources. You can copy any of these objects, except outlines, to another application, database, server, or client location.

1. Connect to the server on which the object resides.
2. From the Application Desktop window, select the application.
3. Select the appropriate database in the selected application.
4. In the Application Desktop window, click the button corresponding to the object file.
5. Select File > Copy. The following dialog box is displayed:

   Figure 49-7: Copy to Server Object Dialog Box

   

6. In the File Name text box, enter the name of the object.
7. Select the server, application, and database names correspond to the destination of the new object.
8. Click OK.

Renaming Objects

You can rename any object, except outlines. An outline always has the same name as the database, so you need to rename the database to rename the outline.

1. Connect to the server on which the object resides.
2. From the Application Desktop window, select the application.
3. Select the appropriate database in the selected application.
4. In the Application Desktop window, click the button corresponding to the object file.
5. Select File > Rename. The following dialog box displayed:

   Figure 49-8: Rename Object Dialog Box

   

6. In the To text box, enter the new name.
7. Click OK.

Deleting Objects

You can delete any object, except an outline. An outlines is a required part of a database, so you need to delete the database to delete the outline.

1. Connect to the server on which the object resides.
2. From the Application Desktop window, select the application.
3. Select the appropriate database in the selected application.
4. In the Application Desktop window, click the button corresponding to the object file.
5. Select File > Delete. The following dialog box is displayed:

   Figure 49-9: Confirm Delete Dialog Box for Objects

   

6. Click Yes or No.

Locking and Unlocking Objects

Hyperion Essbase uses a check-out facility for server-based objects to ensure that no more than one user attempts to modify an object at one time. This section describes how to lock and unlock objects.

Locking Objects

By default, whenever a user opens a server-based object, Hyperion Essbase locks the object. If a second user attempts to open the same object, a message is displayed. The message indicates that the object is locked and tells the user who locked it.

You can avoid the lock error by unchecking "Lock file" in the Application Desktop window before attempting to open an object. This action essentially opens the file in read-only mode, and you cannot save any changes you make.

Unlocking Objects

There are two ways to unlock a previously locked object:

• Save the locked file to the server.
• Select File > Unlock. This action unlocks a file that you previously locked but did not save to the server.

Porting Applications Across Platforms

The Hyperion Essbase OLAP Server runs on multiple platforms, including Windows platforms and UNIX platforms. For a list of supported platforms and information on how to install and configure the Hyperion Essbase server on each platform, see the Hyperion Essbase Installation Guide.

After you install an application, you may want to port the application to a server that may be running a different operating system. This section describes how to port an installed Hyperion Essbase application to another Hyperion Essbase server machine.

Porting Hyperion Essbase applications across servers involves these steps:

1. Identifying compatible files
2. Checking file names
3. Transferring compatible files
4. Reloading the database

Identifying Compatible Files

If you are porting a Hyperion Essbase application to a server running a different operating system, you need to identify which Hyperion Essbase files are compatible with the new operating system.

The following file types are compatible between operating systems:

• ASCII text files. The Hyperion Essbase ASCII text files are calc scripts (.csc) and report scripts (.rep). Also, data files can be ASCII text files.
• Data load rules files. These files are binary files, but they are compatible between operating systems. Data load rules files have the extension.rul.
• Outline files. These files are binary files, but they are compatible between operating systems. Outline files have the extension.otl.

The following file types are incompatible between operating systems and need to be redefined or reloaded on the new server:

• Database files with the extensions.db and.dbb
• Data files with the extension.pag
• Index files with the extension.ind
• Security files with the extension.sec
• Application files with the extensions.app and.apb
• Hyperion Essbase kernel files with the extension.esm

Checking File Names

When transferring files to a UNIX system, you need to be aware of the case of file names. UNIX is a case-sensitive operating system, and files are recognized only if they have the correct case. For example, in certain MaxL or ESSCMD operations, you need to specify a file name, and the file name must be entered with the correct case.

The Hyperion Essbase system files use the following naming conventions on UNIX systems:

• Executable files have no extension and are uppercase (ESSBASE, ESSCMD).
• Static library files have the file extension.a and are in lowercase (libessnet.a).
• Shared library files have the file extension.sl on HP-UX,.so on Solaris, and.a on AIX. These file names are in lowercase (for example, libesscur.sl).
• Security files have the file extension .sec and are in lowercase (essbase.sec).
• Message database files have the file extension.mdb and are in lowercase (essbase.mdb).
• Online help files have the file extension.hlp and are in lowercase (esscmd.hlp).

Hyperion Essbase files on UNIX systems are capitalized with proper case: the first letter is uppercase, and the remaining letters are lowercase. The following table gives examples of names for different file types:

Table 49-5 lists several examples of valid and invalid file names on UNIX systems:

AcTuAlS.rUl

Transferring Compatible Files

If two servers are connected, you can create the application and database directories on the new server and use either FTP (File Transfer Protocol) or Hyperion Essbase Application Manager to transfer the compatible application files. If the servers are not connected, you need to redefine server information on the new server before reloading the database.

Using FTP to Transfer

Using FTP, you can transfer files directly between operating systems. You should transfer only the files compatible between operating systems, and you should transfer the files in binary mode.

If you have files with the wrong case on a UNIX server, Hyperion Essbase Application Manager can see these files but cannot open them. After you use FTP to transfer files, you should rename the files on the server to ensure that they are capitalized with proper case. Alternatively, you can use FTP to rename the file when you transfer the file:

ftp>put oldfile Newfile

Using Hyperion Essbase Application Manager to Transfer

Using Hyperion Essbase Application Manager, you can transfer files from the client machine to the server by using File > Save As. For example, you can connect to a Windows NT server, open an outline, and then save it to a UNIX server. The file types you can transfer from Hyperion Essbase Application Manager are outline files, report scripts, calc scripts, and rules files.

When you save a file from Hyperion Essbase Application Manager to a UNIX server, proper case is applied automatically regardless of what case you type.

Redefining Server Information

If the server you are porting to is not connected to the existing server, you need to redefine some Hyperion Essbase server information on the new server.

1. To create users and specify their privileges, use Hyperion Essbase Application Manager on the new server. See Managing Security at Global and User Levels for help.
2. To create the applications and databases that you want to port, use Hyperion Essbase Application Manager on the new server. See Creating Applications and Databases for help.
3. Copy the outline files (.otl) for the databases that you want to port from the old server to the same directory location on the new server. Make sure the application is not running while you copy these files.
4. Copy compatible files from the old server to the new server. For help, see Identifying Compatible Files.
5. Reload the database. For help, see Reloading the Database.

Reloading the Database

Database files, such as.db, .pag, .esm, and.ind, are not compatible between operating systems. If you port an application to a server on a different operating system, you need to repopulate the database by reloading the data from a data file and a data load rules file (if applicable). One way you can reload is to export the data to an ASCII text file, transfer the text file to the new server, and then use the text file to load data.

Copyright © 1991-2000 Hyperion Solutions Corporation. All rights reserved.