Refreshing Application Databases Using a Utility

The CubeRefresh utility creates or refreshes the database. Before it runs, it ensures that the application is not locked. While it runs, the application is locked when metadata is updated in the database. For example, if users are assigning access, this message displays: “Cannot process your request because the application is being refreshed.” This utility must be run on the same machine as the Planning server, not on a remote server.


Oracle recommends that you back up the application before creating or refreshing. See Backing Up Applications and Application Databases. Following these steps affects data in the database. When you use the create or refresh options, data might be replaced or erased, and Planning plan types rebuilt. For important information, see Considerations for Working with Essbase.

  To refresh the application database using a utility:

  1. Back up the application. See Backing Up Applications and Application Databases.

  2. Locate the CubeRefresh utility.

    The utility is in the planning1 directory. For the full path to planning1, see About EPM Oracle Instance.

  3. Launch CubeRefresh from the planning1 directory by entering the command and its parameters in the command line:

    Windows: CubeRefresh.cmd [-f:passwordFile] /A:application_name /U:user_name [/C|/R] /D [/F[S|V]][/RMIPORT:rmi_port] [/L] [/DEBUG]

    UNIX: [-f:passwordFile] /A:application_name /U:user_name [/C|/R] /D [/F[S|V]][/RMIPORT:rmi_port] [/L] [/DEBUG]

    • Optional: If an encrypted password file is set up, you can specify [-f:passwordFile] as the first parameter in the command line, where passwordFile is the full file path and name for the password file. See Suppressing Password Prompts in Planning Utilities.

    • application_name: The name of the Planning application on which to run the create or refresh.

    • user_name: The administrative user who has rights to create or refresh the application.

    • /C or /R: The function to perform on the application:

      • /C: Create the database outline.

      • /R: Refresh the database outline.

    • /D: Specify the database during create or refresh.

    • /F: Use security filters for all users of the application. Optionally, use with S, V, or SV:

      • /FS: Generate shared member security filters.

      • /FV: Validate security filters, but do not save the filters.

      • /FSV: Validate the shared member security filters.

    • /RMIPORT: Specify an RMI port number different from the preset value of 11333.

    • /-L: Default option, to create or refresh by connecting to an application server on a local or remote machine. (You can use /L to create or refresh without connecting to an application server, for example, if the application server is not running.)

    • /DEBUG: Specify detailed error messages.

  4. If prompted, enter your password.

  5. View the result of the application refresh, including errors. Completion status is shown on the console.

    This example shows a command line used to refresh a database for all users logged on to the specified application. It uses the default RMI port and includes shared member security filters:

    Windows:CubeRefresh.cmd /A:app1 /U:admin /R /D /FS /A:app1 /U:admin /R /D /FS