Oracle Essbase Studio

 

Release 11.1.2.2.100 Patch Set Update (PSU): 11.1.2.2.106

Readme

About this Patch. 1

Patch Type. 1

Supported Paths to this Patch. 2

Prerequisites. 2

Required User Rights. 2

Setting Connections to Teradata Data Sources. 2

Supported Platforms. 2

Supported Languages. 3

Defects Fixed in this Patch. 3

Documentation Updates. 3

Encrypting the Catalog Password Manually in BI Installations. 3

Clearing Deployment History. 5

Applying this Patch. 6

Rolling Back this Patch. 7

Troubleshooting FAQs. 8

Why do I get the following patch conflict error message when running OPatch?. 8

Why do I get the OUI-67078 warning message when applying OPatch?. 8

How can I find out which releases and patches of EPM System products are installed in a deployment?. 8

I applied the patch successfully but I don’t see the changes from the patch in the product. What should I do?. 9

About this Patch

This Readme file describes the defects fixed in this patch and the requirements and instructions for applying this patch.

Caution: You are urged to carefully read and understand the following requirements. Failure to comply may result in applying a patch that can cause your application to malfunction, including interruption of service and/or loss of data. Before installing or applying this patch:

Verify that your system configuration (product version, patch level, and platform) exactly matches what is specified in the Readme.

Patch Type

This PSU replaces files in the existing installation and does not require a full installation.

Supported Paths to this Patch

You can apply this patch to the following releases:

11.1.2.2.100

11.1.2.2.101

11.1.2.2.102

11.1.2.2.103

11.1.2.2.104

Prerequisites

Required User Rights

The user applying the patch should be the user who was set up to install and configure EPM System products. Required user privileges or rights:

Windows:

Use the user account that has Local administrator rights and was set up for installation and configuration. This user is an administrator and is the same for all EPM System products. Assign local policies if required by the product. Such assignments typically are: “Act as part of the operating system, Bypass traverse checking, Log on as a batch job, Log on as a service.”

UNIX/Linux:

Use the account that was used to install EPM System products and has Read, Write, and Execute permissions on $MIDDLEWARE_HOME. If you installed other Oracle products, the user who installed EPM System products must be in the same group as the user who installed the other Oracle products. OPatches are not intended to be applied using a root user.

Setting Connections to Teradata Data Sources

To set the connection properties to a Teradata data source, add the following line to server.properties:

server.jdbc.teradata.properties=property1=value1,property2=value2...

For example, to specify the character set UTF16, add the line:  

server.jdbc.teradata.properties=charset=UTF16

Supported Platforms

Applies to all supported platforms.

Information about system requirements and supported platforms for EPM System products is available in a spreadsheet format in the Oracle Enterprise Performance Management System Certification Matrix. This matrix is posted on the Oracle Fusion Middleware Supported System Configurations page on the Oracle Technology Network (OTN):

http://www.oracle.com/technetwork/middleware/ias/downloads/fusion-certification-100350.html

Supported Languages

Applies to all supported languages.

Information about supported languages for EPM System products is available in a spreadsheet format on the Translation Support tab in the Oracle Enterprise Performance Management System Certification Matrix. This matrix is posted on the Oracle Fusion Middleware Supported System Configurations page on OTN:

http://www.oracle.com/technetwork/middleware/ias/downloads/fusion-certification-100350.html

Defects Fixed in this Patch

Defect Number

Defect Fixed

·    17974800

Essbase Studio does not allow setting a hierarchy as stored when all children have consolidation property as ignored (~) for an ASO cube.

·   17866197

There are two new global methods to clean up the deployment history for each cube.


Usage:

Open the Studio command line client and enter:

call 'util'::'globalCleanModelHistoryAndLeaveLastSucc'():


It will keep the most recent (last) successful deployment record for each cube If a cube, however, had never been deployed successfully, all its deployment history records will be removed.

OR

call 'util'::'globalCleanModelHistory'():

It will remove all deployment records no matter they are successful or failure.

·   17075388

When changing the Essbase Studio server default port to custom port by using
epmsys_registry utility or server.properties file in <EPM_Instance_Home>/bin,
Essbase Studio Server cannot stop by stopEssbaseStudio.sh (or .bat) or stopServer.sh (or bat).

 

Documentation Updates

Encrypting the Catalog Password Manually in BI Installations

Note: This method of password encryption is only for BI Installations. For EPM installations, passwords are encrypted via the EPM System Configurator.

In BI installations of Essbase Studio, if the catalog database password is changed, the new password must be encrypted manually. The encrypted password must then be added to the Essbase Studio server.properties file before you can start Essbase Studio Server.

Essbase Studio provides two password encryption scripts, encryptPassword.bat.template and encryptPassword.sh.template, which are located in ORACLE_HOME/products/Essbase/EssbaseStudio/Server/scripts.template.

To run a script, complete the following steps:

1.    Copy the required script for your platform from ORACLE_HOME/products/Essbase/EssbaseStudio/Server/scripts.template and add it to ORACLE_INSTANCE/EssbaseStudio/essbasestudio1/bin/.

2.    Rename the script by removing the .template file name extension. For example, encryptPassword.bat or encryptPassword.sh.

Open the script file and set the EPM_ORACLE_HOME and EPM_ORACLE_INSTANCE environment variables.

Examples:

In the encryptPassword.bat script,

EPM_ORACLE_HOME=C:/mw/Oracle_BI1
EPM_ORACLE_INSTANCE=C:/mw/instances/instance1

In the encryptPassword.sh script,

EPM_ORACLE_HOME=/mw/Oracle_BI1
EPM_ORACLE_INSTANCE=/mw/instances/instance1

3.    Set the JAVA_HOME environment variable and make sure it points to EPM_ORACLE_HOME/jdk.

Examples:

In the encryptPassword.bat script, JAVA_HOME=%EPM_ORACLE_HOME%/jdk.
In the encryptPassword.sh script, JAVA_HOME=$EPM_ORACLE_HOME/jdk.

4.    Change the line in the script that starts with “java” by replacing java with JAVA_HOME/bin/java.

Examples

In the encryptPassword.bat script, change:

java -DEPM_ORACLE_INSTANCE=%ORACLE_INSTANCE% -cp %CPATH%com.hyperion.cp.config.EncryptPassword %1

To

%JAVA_HOME%/bin/java -DEPM_ORACLE_INSTANCE=%ORACLE_INSTANCE% -cp %CPATH%com.hyperion.cp.config.EncryptPassword %1

In the encryptPassword.sh script, change:

java -DEPM_ORACLE_INSTANCE=$ORACLE_INSTANCE -cp $CPATHcom.hyperion.cp.config.EncryptPassword $1

To

$JAVA_HOME/bin/java -DEPM_ORACLE_INSTANCE=$ORACLE_INSTANCE -cp $CPATHcom.hyperion.cp.config.EncryptPassword $1

5.    Launch the script by running the following command:

On Unix

$ORACLE_INSTANCE/EssbaseStudio/essbasestudio1/bin/encryptPassword.sh unencrypted password

On Windows

%ORACLE_INSTANCE%/EssbaseStudio/essbasestudio1/bin/encryptPassword.bat unencrypted password

6.    The output, which is the encrypted password, must be saved to server.properties manually. To add the encrypted password to the server.properties file, open the file and add the following line:

catalog.password=encrypted_password

Note: For more information on managing the Essbase Studio catalog in BI installations, see your BI documentation.

Clearing Deployment History

Each time you deploy an Essbase model, deployment history data is collected and stored in the Essbase Studio catalog. When you migrate your catalog from one release to another, and when you export and import the catalog when moving from one environment to another, Essbase Studio Server uses the deployment history data contained in the catalog. If there are many rejected records, the history can grow too large, causing the migration to fail.

In this release, two new utilities for clearing deployment history are available:

·         globalCleanModelHistoryAndLeaveLastSucc clears deployment history for all cubes and all models in the catalog and leaves the latest successful record for each deployed Essbase cube.

·         globalCleanModelHistory clears all deployment history for all cubes and all models in the catalog, including successful records.

Note: Another utility, cleanModelHistory, is documented in the Essbase Studio User’s Guide. cleanModelHistory clears deployment history for a single Essbase cube.

To run the utilities for clearing deployment history, complete the following steps:

1.    Go to: MIDDLEWARE_HOME/user_projects/epmsystem1/bin.

2.    Call start_BPMS_bpms1_CommandLineClient.bat|sh to start the Essbase Studio command line client. A command window called the CPL Shell is displayed.

3.    At the prompt, enter a valid Essbase Studio administrator user name and password.
 
Note: You must have Essbase Studio administrator privileges to use Essbase Studio utilities to clear deployment history.

4.    Run the command for the utility you are using, with the appropriate syntax:
 
call 'util'::'globalCleanModelHistoryAndLeaveLastSucc'();
 
call 'util'::'globalCleanModelHistory'();

Examples:

call 'util'::'globalCleanModelHistoryAndLeaveLastSucc'();

This command removes all entries in the deployment history for all data sets and leaves the latest successful record for each deployed Essbase cube.

call 'util'::'globalCleanModelHistory'();

This command clears the entire deployment history for all data sets, including successful records.
(18049932)

Applying this Patch

The section includes important information about installing this patch of Essbase Studio.

Component

Patch ID

Essbase Studio Console

17595842

Essbase Studio Server

17595836

 

Essbase Studio Console

To apply this patch to the Essbase Studio Console:

5.    Uninstall the Essbase Studio Console:

a.    In Windows Control Panel, navigate to Add or Remove Programs.

b.    Select the appropriate item, and then click Remove.

6.    Run the EssbaseStudioConsole.exe file, pick a destination folder, and complete the installation.

Essbase Studio Server

To apply this patch to the Essbase Studio Server:

1.    Stop Essbase Studio Server.

2.    Download and unzip the downloaded patch file, <PATCH FILE NAME>.zip, to the <EPM_ORACLE_HOME>/OPatch directory (by default, Oracle/Middleware/EPMSystem11R1/OPatch).

NOTE: <PATCH FILE NAME>.zip is the name that My Oracle Support assigns to this patch. When you download the file, a message indicates the file name.

3.    From a command line, change the directory to <EPM_ORACLE_HOME>/OPatch.

4.    To apply the patch, enter the following command on one line:

Windows:
opatch.bat apply <EPM_ORACLE_HOME>/OPatch/<PATCH DIRECTORY> -oh <EPM_ORACLE_HOME>
-jre <MIDDLEWARE_HOME>/jdk160_29


NOTE: The default for <EPM_ORACLE_HOME> is C:/Oracle/Middleware/EPMSystem11R1. The default for <MIDDLEWARE_HOME> is C:/Oracle/Middleware.

UNIX/Linux:
./opatch apply <EPM_ORACLE_HOME>/OPatch/<PATCH DIRECTORY> -oh <EPM_ORACLE_HOME> -jre <MIDDLEWARE_HOME>/jdk160_29 -invPtrLoc <EPM_ORACLE_HOME>/oraInst.loc

NOTE: The default for <EPM_ORACLE_HOME> is $HOME/Oracle/Middleware/EPMSystem11R1. The default for <MIDDLEWARE_HOME> is $HOME/Oracle/Middleware.

5.    Re-start Essbase Studio Server.

6.    Update the Essbase Studio catalog:

You must update the Essbase Studio catalog in order to use it with this patch. This is accomplished by issuing the “reinit” command in the Essbase Studio command line client, as described below.

c.     Go to <MIDDLEWARE_HOME>/user_projects/epmsystem1/bin.

d.    Call start_BPMS_bpms1_CommandLineClient.bat|sh to start the Essbase Studio command line client.
A command window called the CPL Shell is displayed.

e.    At the prompt, enter a valid admin user name and password.
NOTE: You must have Essbase Studio administrator privileges to use the reinit command.

f.     At the prompt, enter the following command:
reinit

g.    Type exit to close the CPL Shell.

The Essbase Studio catalog is now ready for use.

Rolling Back this Patch

Essbase Studio Console

To remove this patch for Essbase Studio Console:

1.    In Windows Control Panel, navigate to Add or Remove Programs.

2.    Select the appropriate item, and then click Remove.

3.    Re-install the console using the previous version of the Essbase Studio Console Installer.

 

Essbase Studio Server

To roll back this patch on Essbase Studio Server:

1.    Stop Essbase Studio Server.

2.    From a command line, change the directory to <EPM_ORACLE_HOME>/OPatch (by default, Oracle/Middleware/EPMSystem11R1/OPatch)

3.    To roll back the patch, enter the following command on one line:

Windows:
opatch.bat rollback -id <PATCH ID> -oh <EPM_ORACLE_HOME> -jre <MIDDLEWARE_HOME>/jdk160_29

NOTE: The default for <EPM_ORACLE_HOME> is C:/Oracle/Middleware/EPMSystem11R1. The default for <MIDDLEWARE_HOME> is C:/Oracle/Middleware.


UNIX/Linux:
./opatch rollback -id <PATCH ID> -oh <EPM_ORACLE_HOME> -jre <MIDDLEWARE_HOME> /jdk160_29 -invPtrLoc <EPM_ORACLE_HOME>/oraInst.loc

NOTE: The default for <EPM_ORACLE_HOME> is $HOME/Oracle/Middleware/EPMSystem11R1. The default for <MIDDLEWARE_HOME> is $HOME/Oracle/Middleware.

4.    Restart Essbase Studio Server.

5.    Update the Essbase Studio catalog:

You must update the Essbase Studio catalog in order to complete a roll back of this patch. This is accomplished by issuing the “reinit” command in the Essbase Studio command line client, as described below.

h.     Go to <MIDDLEWARE_HOME>/user_projects/epmsystem1/bin.

i.      Call start_BPMS_bpms1_CommandLineClient.bat|sh to start the Essbase Studio command line client.
A command window called the CPL Shell is displayed.

j.     At the prompt, enter a valid admin user name and password.
NOTE: You must have Essbase Studio administrator privileges to use the reinit command.

k.    At the prompt, enter the following command:
reinit

Troubleshooting FAQs

Why do I get the following patch conflict error message when running OPatch?

If the patch that you apply conflicts with a previously applied patch, you may receive the following error message when running OPatch:

Patch(es) <PreviousPatch#> conflict with the patch currently being installed (<NewPatch#>).

If you continue, patch(es) <PreviousPatch#> will be rolled back and the new patch (<NewPatch#>) will be installed.

If a merge of the new patch (<NewPatch#>) and the conflicting patch(es) (<PreviousPatch#>) is required, contact Oracle Support Services and request a Merged patch.

This error is returned when one patch attempts to update a previously patched file. When this conflict happens, you can either (1) roll back the previous patch and apply the new patch (this action might be appropriate if the previous patch was not critical) or (2) request a “merged patch” consisting of the new patch and the patch that it conflicts with. To request a merged patch, contact your Oracle Support representative. 

Why do I get the OUI-67078 warning message when applying OPatch?

This warning means that the patch being applied is a superset of a patch already on the deployment and the existing patch will be rolled back. The following snippet shows the context of this warning.

The following warnings have occurred during OPatch execution:
1) OUI-67078:Interim patch 12345678 is a superset of the patch(es) [77777777] in OH C:\Hyperion
-----------------------------------------------------------------------------------
OPatch Session completed with warnings.

How can I find out which releases and patches of EPM System products are installed in a deployment?

In EPM System Release 11.x, you can use the lsinventory command to OPatch to find the release and patches that are installed in an Oracle Home. For example, enter the following command on one line:

Windows:

opatch.bat lsinventory -oh <EPM_ORACLE_HOME> -jdk <MIDDLEWARE_HOME>/jdk160_29

UNIX/Linux:

./opatch lsinventory -oh <EPM_ORACLE_HOME> -jdk <MIDDLEWARE_HOME>/jdk160_29 –invPtrLoc <EPM_ORACLE_HOME>/oraInst.loc

I applied the patch successfully but I don’t see the changes from the patch in the product. What should I do?

When patching an .EAR file for an application, you may need to delete the cached files in the following folders in order to see the changes provided with the patch:

<MIDDLEWARE_HOME>/user_projects/domains/<DOMAIN_NAME>/servers/
<MANAGED_SERVER_NAME/tmp/

<MIDDLEWARE_HOME>/user_projects/domains/<DOMAIN_NAME>/servers/
<MANAGED_SERVER_NAME/cache