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 is a patch set update (PSU). 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.3.000

· 11.1.2.3.001

· 11.1.2.3.002

· 11.1.2.3.500

· 11.1.2.3.501

· 11.1.2.3.502

· 11.1.2.3.505

Caution: Oracle recommends using the same version of all Essbase portfolio products (Essbase, Essbase Administration Services, Hyperion Provider Services, and Essbase Studio) and components (server, client, runtime client, API, and JAPI). When only some Essbase portfolio products are included in a patch release, the last released versions of the products that are not included in the patch are supported.

Essbase Administration Services 11.1.2.3.505, Essbase 11.1.2.3.507, and Provider Services 11.1.2.3.507 are supported for use with Essbase Studio 11.1.2.3.507.

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.

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
• 20386599	In Essbase Studio, in Essbase Model Properties when the hierarchy setting of a dimension is set to Stored at Dimension Level it is not possible to use External Source consolidation for its members.
• 20320824, 20320819	Aggregate storage outlines require all members of stored hierarchies to have ADD (+) aggregation, except for label-only members and their children.
• 20053086	In Essbase Studio, an ASO deployment fails when Accounts is first dimension in outline.
•19658266, 19633851	A drill through report fails and returns an error message for a member that contains more than 1,000 children.

Known Issues in this Patch

The following issues are the noteworthy known issues of this patch.

Essbase Studio Server May Fail to Start

Depending on the release you have installed, Essbase Studio uses one of three different password encryption algorithms. The algorithms correspond to releases EPM 11.1.2.1, EPM 11.1.2.2 and EPM 11.1.2.3/BI Foundation 11.1.1.7. For example, if you installed EPM 11.1.2.2, your installation uses the 11.1.2.2 encryption algorithm.

If there is a mismatch between your release and the encryption algorithm, Essbase Studio Server fails to start and returns the following error message:

“Unable to decrypt catalog password.”

Notes:

· If you upgrade to a new release (from 11.1.2.1 or 11.1.2.2) and you are an EPM customer, the EPM Configuration Utility upgrades your encrypted password to use the algorithm for the new release. In some cases, this upgrade may fail and you will need to indicate the encryption algorithm manually.

· If you are a BI customer and upgrade to BI Foundation 11.1.1.7.0 (which includes Essbase Studio Release 11.1.2.3) the password is not re-encrypted with the algorithm corresponding to the new release. Instead, you need to indicate the new encryption algorithm manually.

To indicate the correct encryption algorithm, create or edit the Essbase Studio server.properties file to reflect the value of your Essbase Studio Server installation. See Working With Essbase Studio Server Properties in the Essbase Studio User’s Guide.

The possible values are 1, 2 and 3. EPM 11.1.2.1=1, EPM 11.1.2.2=2 and EPM 11.1.2.3/BI Foundation 11.1.1.7=2. For 11.1.1.7, you would use this setting:

password.encryption.version=2

(19073235)

Essbase Studio Catalog

Essbase Studio fails to start when the EPM System Configurator is used to configure Essbase Studio Catalog to SQL Server using JDBC URL.

If you complete the following steps to configure Essbase Studio Catalog to SQL Server using JDBC URL, Essbase Studio will fail to start:

1. In the Configure Database dialog box, select "Advanced database options for selected rows."

2. Check the "Edit and use modified JDBC URL" check box.

3. In the JDBC URL field, enter the JDBC URL for SQL Server.

Workaround: To configure Essbase Studio Catalog to SQL Server using JDBC URL, enter the JDBC URL in the server.properties file. The contents of server.properties will override the setting in the EPM System Registry.

For syntax and examples, see Essbase Studio Now Recognizes JDBC Connection URLs in the Documentation Updates section of this readme. For information on the server.properties file, see Working with Essbase Studio Server Properties in the Essbase Studio User's Guide.

(18691965)

Essbase Studio Console Log File

The Essbase Studio Console log file is created in a non-standard location and it has a non-standard name.

The file is created in: <EPM_ORACLE_HOME>\products\Essbase\EssbaseStudio\Console\workspace\metadata

The expected location for log files is in:
<EPM_ORACLE_INSTANCE>\diagnostics\logs

The name of the Essbase Studio log file is .log, which is non-standard and ambiguous.

(10390369)

Inconsistent Member Sort Order When Prefix/Suffix Transformations Are Applied

When dimension elements have sort orders applied to them and, in the Essbase model, the members based on those dimension elements have prefix or suffix transformations applied to them, these members will not sort correctly after the model is deployed.

Workaround: If you require prefix or suffix transformations on a member that has sort orders applied to the underlying dimension element, you can edit the key binding expression for the element to add the transformation. Do not use the transformation functionality in the Essbase model in this case.

For example, using the TBC database, a Product dimension is built using the following hierarchy:

FAMILY
|_ SKU

Before applying the transformation to the key binding expression, the dimension element properties are set as follows:

· Dimension element FAMILY—with Key and Caption Bindings set to PRODUCTDIM.FAMILY, and Sort Column set to PRODUCTDIM.FAMILY

· Dimension element SKU—with Key and Caption Bindings set to PRODUCTDIM.SKU, and Sort Column set to PRODUCTDIM.SKU

Now edit the key binding expression using concatenation to add a prefix or suffix.

For example, to add SKU from the PRODUCTDIM table as a suffix to the FAMILY dimension element, the additional text in bold below is added to the key binding expression:

connection : \'TBC-oracle'::'TBC.PRODUCTDIM'.'FAMILY' || "_" || connection : \'TBCoracle'::'TBC.PRODUCTDIM'.'SKU

(12815260)

Applying this Patch

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

Component	Patch ID
Essbase Studio Console MSI	20183684
Essbase Studio Server	20183692

Essbase Studio Console

To apply this patch to the Essbase Studio Console:

1. 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.

2. 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).

NOTES:

o <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.

o You must unzip the file on the platform for which it is intended. After you unzip the patch file, verify that the executable and library files have execute permission before you apply the patch. If you apply the patch and the executable and library files do not have execute permission, you will not be able to start Essbase Studio after applying the patch.

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_35

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_35 -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.

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

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

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

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

e. 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_35

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_35 -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.

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

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

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

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

Documentation Updates

Configuring Teradata as a Data Source

When configuring Teradata as a data source, ensure that you grant SELECT privileges to PUBLIC on the DBC.UDTInfo data dictionary table. The database administrator can add this privilege using the following command: GRANT SELECT ON DBC.UDTInfo to PUBLIC;

For further information on the privileges required, see the Teradata JDBC documentation for "Data Dictionary Access by DatabaseMetaData Methods."

Catalog Authentication

If you are configuring multiple Studio Servers using the EPM Configuration Utility, the access rights are applicable to all instances of Essbase Studio. For example, users with access to one instance of Essbase Studio will automatically have access to all other instances. Catalog Authentication enables you to set different access rights for a given user for different Essbase Studio instances. When Catalog Authentication is enabled, users must provide catalog database credentials in addition to the credentials provided to connect to Essbase Studio Server. They will first see an EPM dialog box to log into, and then an Essbase Studio catalog login dialog for the RDBMS user associated with the catalog.

There is a new server property, called server.catalogAuthentication that, when set to true, enables Catalog Authentication. See the server.catalogAuthentication topic in this readme for syntax.

To use Catalog Authentication:

1. In your database server instance, create one schema or database for each Essbase Studio instance you plan to create.

2. Run the EPM Configuration utility once for each Essbase Studio Server instance and associate each catalog to its own database schema. See the Oracle Enterprise Performance Management System Installation and Configuration Guide.
Note: Only one Essbase Studio Server will appear in the Shared Services Console. Any provisioning applied to this instance will apply to all installed instances.

3. Create server.properties files for each instance of Essbase Studio if they do not already exist. See Working with Essbase Studio Server Properties in the Essbase Studio User’s Guide.

4. In the server.properties file for each instance of Essbase Studio:

o Add the property, server.catalogAuthentication=true. This enables Catalog Authentication.

o Optional: Set the transport.port and server.httpPort properties so there are no conflicts between the ports. See transport.port and server.httpPort in the Essbase Studio User’s Guide.

5. Create RDBMS users with read (SELECT) privileges against the CP_PACKAGE Studio Server catalog table.
Note: The additional users are purely for authentication purposes. The Essbase Studio catalog is still manipulated and owned by the RDBMS user specified with the EPM Configuration utility.

6. When you connect to Essbase Studio, two login dialogs are displayed in succession:

o A login for the EPM user. This is a user created in the EPM Shared Services Console, provisioned with access to Essbase Studio.

o A login for the Essbase Studio catalog user. This is an RDBMS user created in step 2.

If both users are authenticated, you will be logged into Essbase Studio server with the matching Essbase Studio metadata catalog.

server.catalogAuthentication

Catalog Authentication enables you to set different access rights for a given user for different Essbase Studio instances. To enable Catalog Authentication, you set a new server property, server.catalogAuthentication in the Essbase Studio server.properties file.

Note: You must first create a server.properties file if it does not already exist. See Working with Essbase Studio Server Properties in the Essbase Studio User’s Guide.

Syntax:

server.catalogAuthentication=true|false

Example:

server.catalogAuthentication=true

The default value is false.

Encrypting the Catalog Password Manually In BI Installations

Note: This topic applies only to BI installations.

In BI installations of Essbase Studio, if the catalog 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.

3. Open the script file and set the ORACLE_HOME and ORACLE_INSTANCE environment variables.

Examples:

In the encryptPassword.bat script,
ORACLE_HOME=C:/mw/Oracle_BI1
ORACLE_INSTANCE=C:/mw/instances/instance1

In the In the encryptPassword.sh script,
ORACLE_HOME=/mw/Oracle_BI1
ORACLE_INSTANCE=/mw/instances/instance1

4. Set the JAVA_HOME environment variable and make sure it points to 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.

5. 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 $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

6. 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

7. 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.

Minischemas are Only a Graphical Representation of a Data Source

Minischemas are only a graphical representation of information about a data source. This information remains in the Essbase Studio catalog regardless of the state of the minischema. When a minischema is manually recreated after an upgrade to a new release, all Joins that exist in the previous release will be displayed properly.

Essbase Studio Now Recognizes JDBC Connection URLs

The EPM System Configurator generates an Essbase Studio custom URL based on user input and saves it in the Shared Services Registry. In this release, the EPM System Configurator gives you the option to enter a standard JDBC URL, which is saved in the Shared Services Registry.

Notes:

· You can override the settings stored in Shared Services Registry by adding them to the Essbase Studio server.properties file.

· Essbase Studio now accepts (recognizes) both custom Essbase Studio URLs and standard JDBC URLs set in catalog.url field of the server.properties file.

· For information on the server.properties file, see Working with Essbase Studio Server Properties in the Essbase Studio User's Guide.

Syntax for JDBC connection URLs in the server.properties file:

catalog.url=database_tag\://host:port/

Examples for JDBC connection URLs in the server.properties file:

· Oracle RAC:
catalog.url=jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(LOAD_BALANCE=on)
(ADDRESS=(PROTOCOL=TCP)(HOST=rac1.us.oracle.com)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=rac2.us.oracle.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=orcl)))

· Oracle LDAP:
catalog.url=jdbc:oracle:thin:@ldap://abcldap:11389/studio_ldap,cn=OracleContext,dc=us,dc=oracle,dc=com

· SQL Server:
catalog.url=jdbc:weblogic:sqlserver://abc1.us.oracle.com\HITTEST: 1434;databaseName=ps3_8396

· DB2:
catalog.url=jdbc:weblogic:db2://cypress.abcco.com\:50000;databaseName=EPM_Db

(17555511)

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 the catalog to a new release in a new environment, the deployment history, which is contained in the catalog, is also migrated. 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:

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

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

10. 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.

11.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)

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