Oracle® Fusion Middleware Reference Guide for Oracle Business Intelligence Applications 11g Release 1 (11.1.1) Part Number E16816-01 |
|
|
View PDF |
This chapter describes Oracle BI Applications Patching, and contains the following topics:
Section 5.2, "What Is Included in Oracle BI Applications Patches?"
Section 5.3, "Where Updates Are Made by Oracle BI Applications Patches?"
Section 5.5, "Diagnosing Whether Oracle BI Applications Patches Are Applied Correctly"
Section 5.6, "Rolling Back Failed Oracle BI Applications Patches"
Section 5.7, "What Happens if Conflicts Are Detected When Applying an Oracle BI Applications Patch?"
This chapter supplements the information provided in Oracle Fusion Middleware Patching Guide for patching Oracle Fusion Middleware products.
Patching involves copying a small collection of files over an existing installation. A patch is normally associated with a particular version of an Oracle product. A patch set is a single patch that contains a collection of patches that are designed to be applied at the same time.
Oracle Fusion Middleware Patching Guide provides a full description of the types of patches available and the instructions to apply them. Before applying a patch to an Oracle Business Intelligence Applications system, make sure to review Oracle Fusion Middleware Patching Guide, as well as the readme.txt file provided with the patch. The readme file will describe the content of the patch and may contain additional information and instructions.
An Oracle BI Applications patch can include bug fixes, metadata, and binary file updates. The exact updates made will depend on the patch contents, and can include any of the following:
Metadata patch - updates pre-built content as follows:
Oracle BI Presentation Catalog - dashboard and report updates.
Oracle Business Intelligence Repository (RPD) - Presentation layer, Business Model and Mapping layer, and Physical layer updates.
Oracle BI Applications Configuration Manager (ACM), and Functional Setup Manager
Oracle Business Intelligence Data Warehouse Administration Console (DAC) - table and column updates
Informatica Repository
Binary patch - updates binary files (files with extensions such as DLL, JAR, and EXE) as follows:
Oracle BI Applications Configuration Manager
DAC Client and Server
Note: An Oracle BI Applications patch does not include the following:
Oracle Business Intelligence platform
For information about patching the Oracle Business Intelligence platform, see 'Patching Oracle Business Intelligence Systems' in Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition
Informatica PowerCenter tool
Patches to Informatica PowerCenter binary files are available as hot fixes from Informatica Corporation.
The exact updates made by a patch depends on what is in that particular patch, but can consist of a combination of the content types described in Section 5.2.
If the content of the patch contains just binary updates, then these updates are made directly to the Oracle home, and only to the Oracle home.
If the content of the patch contains metadata updates it is important to note that it is not only the Oracle home that will be updated. For each metadata type that can be patched (for more information, see Section 5.2) one copy is kept in the Oracle home and another is deployed for use at runtime. A patch containing metadata updates will update both the Oracle home content as well as the runtime, or deployed content.
For example, patch updates to the Oracle BI Presentation Catalog will be copied to the Oracle home location that keeps track of the version of the Oracle BI Presentation Catalog last delivered by Oracle, and will also update the Oracle BI Presentation Catalog that has been deployed for use at runtime.
You can apply a patch to Oracle BI Applications or Oracle BI Applications Configuration Manager (ACM) using the following procedures:
To apply an Oracle BI Applications patch:
Copy or download the OPatch archive.
For example, you might copy a downloaded archive called 1234567.zip, to the folder /scratch/patchBase.
(Optional) Prepare the apply-patch.properties file.
The apply-patch.properties file is optional:
it is only required for metadata updates (for more information, see Section 5.2)
if you omit it, a dialog is displayed to request the information that is needed
To apply changes to the metadata types being patched, you specify values in the apply-patch.properties file for the different metadata types. For example, the location of the runtime Oracle BI Presentation Catalog.
A sample properties file described in Section 5.8, "Sample Patch Properties File", lists each metadata type. You only need to supply values that correspond to the metadata types being patched.
For more information about what is included in the patch:
see the README.txt file in the OPatch archive
run the 'opatch query' command (for example, opatch query 456789.zip
) to list bugs fixed, and the contents of the patch
Once the property values are completed, save this to: /scratch/patchBase/apply-patch.properties
Note: If you do not specify this file in the OPatch command, properties that are required will be requested when you are applying the patch.
Backup all metadata.
Metadata must be backed up using your normal backup mechanisms. For more information, see Oracle Fusion Middleware Administrator's Guide.
Stop the Oracle Business Intelligence components.
Since the patch will make updates to the runtime metadata you must do this to avoid locking issues; the patch might fail if you do not do this. In addition, not all metadata updates will be visible until Oracle Business Intelligence is restarted.
Use Fusion Middleware Control to stop Oracle Business Intelligence components. For more information, see 'Starting and Stopping Oracle Business Intelligence' in Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.
Note: If the patch contains RPD updates only, you need stop just the BI Server component. If the patch contains Oracle BI Presentation Catalog updates only, you need stop just the BI Presentation Services component.
Apply an Oracle BI Applications metadata patch.
You apply the patch using the copy of OPatch in the Oracle home.
For UNIX use the following syntax:
./opatch apply -pre <path to patch properties file> -opatch_pre_end <path to unzipped patch dir>
For example, if you copied your patch archive to /scratch/patchBase/1234567.zip, and your properties file is in /scratch/patchBase/apply-patch.properties, enter the following command:
./opatch apply -pre /scratch/patchBase/apply-patch.properties -opatch_pre_end /scratch/patchBase/1234567.zip
If the patch includes Oracle BI Repository (RPD) updates and the environment is clustered, you must scale out the RPD so that the repository can be shared by all Oracle BI Servers participating in a cluster.
For more information, see 'Uploading and Sharing the Oracle BI Repository' in Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.
Re-start the Oracle Business Intelligence components.
For more information, see 'Starting and Stopping Oracle Business Intelligence' in Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.
Note: If the patch contained only RPD updates, and you stopped just the BI Server in step 4, then you need only restart the BI Server. If the patch contained only Oracle BI Presentation Catalog updates, and you stopped the BI Presentation Services in step 4, then you need only restart the BI Presentation Services.
To apply an Oracle BI Applications Configuration Manager (ACM) patch:
Copy or download the OPatch archive.
For example, you might copy a downloaded archive called 1234567.zip, to the folder /scratch/patchBase.
Backup all metadata.
Metadata must be backed up using your normal backup mechanisms. For more information, see Oracle Fusion Middleware Administrator's Guide.
Stop the Oracle Business Intelligence components.
Since the patch will make updates to the runtime metadata you must do this to avoid locking issues; the patch might fail if you do not do this. In addition, not all metadata updates will be visible until Oracle Business Intelligence is restarted.
Use Fusion Middleware Control to stop Oracle Business Intelligence components. For more information, see 'Using Fusion Middleware Control to Start and Stop Oracle Business Intelligence System Components and Java Components' in Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.
If the patch contains ACM binary updates, you must also stop the Admin server.
Use Oracle WebLogic Server Administration Console to stop the Admin server. For more information, see 'Using Oracle WebLogic Server Administration Console to Start and Stop Java Components ' in Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.
Apply a BI Applications Configuration Manager patch.
You apply a BI Applications Configuration Manager patch using the copy of OPatch in the Oracle home.
Note: A data warehouse schema must have already been created using the Repository Creation Utility (RCU).
For UNIX use the following syntax:
./opatch apply -post <hostname:port:servicename/SID> <data_warehouse_schema_username> <data_warehouse_schema_password> -opatch_post_end <path to unzipped patch dir>
For example, if you copied your patch archive to /scratch/patchBase/456789.zip, enter the following command:
./opatch apply -post mycomputer.mycompany.com:1521:mydatabase mydbusername mydbpassword -opatch_post_end /scratch/patchBase/456789.zip
Re-start the Oracle Business Intelligence components
For more information, see 'Using Fusion Middleware Control to Start and Stop Oracle Business Intelligence System Components and Java Components' in Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.
Re-start the Admin server (if stopped in step 4).
For more information, see 'Using Oracle WebLogic Server Administration Console to Start and Stop Java Components' in Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.
During the application of a patch, OPatch will output status results to the command window. If the patch applied correctly the last statement will be "OPatch succeeded". If there are any errors these will be reported and captured in the log file located in <ORACLE_HOME>/cfgtoollogs/opatch/opatch<timestamp>.log.
If you roll back a patch with metadata updates, different steps are required compared to if you roll back a patch with just binary file updates.
To rollback a failed Oracle BI Applications patch:
Rollback the OPatch archive.
This step removes the OPatch inventory metadata, allowing the patch to be applied again in the future. However, it does not update the changes made to the metadata (see next step).
./opatch rollback -ID 1234567
Where 1234567 is the patch id.
Replace the updated metadata from your backup area.
Only complete this step if the patch contains metadata updates to the Oracle Business Intelligence Repository (RPD), Oracle BI Presentation Catalog, Informatica Repository, or DAC.
In order to get the metadata that was updated by the patch to be as it was before the patch, you need to manually copy the metadata from your backup area (see step 3 of the 'apply' flow above). You must copy this to both the Oracle home and the runtime locations.
Warning: If you roll back you will lose any customizations made since the patch was applied.
For DAC and Informatica PowerCenter metadata patches, the updates included in the patch will replace metadata in customer repositories. If customers have made any changes to the metadata since the initial install these changes are lost, and will need to be reapplied after the patch. For this reason there are no conflicts during the patch apply cycle itself for these metadata types.
When you patch the Oracle Business Intelligence Repository (RPD) and Oracle BI Presentation Catalog, updates are merged into the existing customer runtime repositories. However, there will be cases where the metadata included in the patch cannot be merged without user intervention, that is, a choice needs to be made.
Where such a conflict occurs the patch will fail to apply, and details of the conflicts will be given in the log file. These conflicts need to be resolved first and then the patch re-applied.
In order to resolve the conflicts customers can use the standard Oracle Business Intelligence platform tools appropriate for the metadata type in questions. For example, for conflicts in the Oracle Business Intelligence Repository (RPD) use the Oracle BI Administration Tool, and for conflicts in the Oracle BI Presentation Catalog use the Catalog Manager. Using these tools customers need to resolve the conflicts, re-apply the patch, and then apply their customizations on top of the patched metadata.
Section 5.7.1, "Resolving Conflicts for Oracle BI Presentation Catalog Updates"
Section 5.7.2, "Resolving Conflicts for Oracle Business Intelligence Repository (RPD) Updates"
To resolve conflicts for Oracle BI Presentation Catalog updates:
Follow the instructions outlined here to resolve conflicts for the Oracle BI Presentation Catalog updates.
For more information, see 'Configuring and Managing the Oracle BI Presentation Catalog' in Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.
Open Catalog Manager (CatMan1).
Open your runtime Oracle BI Presentation Catalog (offline).
Open another Catalog Manager (CatMan2).
Open the Oracle home Catalog (offline).
For the list of objects with conflicts (see patch log):
Navigate to and Archive (using CatMan1).
Navigate to and Copy from the Oracle home (CatMan2).
Paste into the runtime Catalog (CatMan1), choosing the 'force' copy operation.
The runtime Oracle BI Presentation Catalog now has its conflicting objects reset to the Oracle home equivalent.
Re-apply the patch.
To resolve conflicts for Oracle Business Intelligence Repository (RPD) updates:
Follow the instructions outlined here to resolve conflicts for Oracle Business Intelligence Repository (RPD) updates.
For more information, see 'Applying a Repository Patch' in Oracle Fusion Middleware Metadata Repository Builder's Guide for Oracle Business Intelligence Enterprise Edition.
Retrieve the Oracle Business Intelligence Repository 'diff' file from the location in the log.
Open the Oracle BI Administration Tool.
Open the modified/customer repository.
Select File, and Merge from the menu.
Select merge type as Patch Repository Merge.
Select the patch 'diff' file.
The location for this file specified in the patch apply logs.
Choose the original repository to be the "original" Oracle Business Intelligence Repository (RPD) in the Oracle home.
Enter the password for the original RPD.
Display the next page of the Wizard to see a list of conflicts.
For each conflict mentioned in the patch log, select "current", (accepting the change from the patch).
Re-apply the patch.
You can modify the example apply-patch.properties file described in this section, to reference in the OPatch apply command.
The OPatch command must include the full file path, for example if the file is in: /scratch/biapps/mwhome/Oracle_BI1/apply-patch.properties, then you would enter the following opatch command:
./OPatch/opatch apply -pre /scratch/biapps/mwhome/Oracle_BI1/apply-patch.properties -opatch_pre_end 1234567.zip
Note: The latest version of this file is available in the patch archive at custom/ patch.properties.
The contents of the apply-patch.properties file is as follows:
# #BI Applications Apply Patch Properties # #RPD #The following properties are required if the patch contains updates to the RPD (aka Oracle Business Intelligence Repository) #Full path to target RPD File (that is, the RPD file used in the runtime system) rpd.targetRPDFile = #password for the target RPD rpd.targetPassword = #password for the original RPD (that is, the RPD file shipped by Oracle, in Oracle home) rpd.originalPassword = #Web Catalog #The following properties are required if the patch contains updates to the Web Catalog (aka Oracle BI Presentation Catalog) #Root Directory of target Web Catalog (that is, the Web Catalog used in the runtime system) webcat.target.root = #Root Directory of target Oracle Instance (under instances) oracle.instance.root = #Informatica Content #The following properties are required if the patch contains updates to the shipped Informatica content #Informatica Home Directory (under which server/bin/pmrep lives) infa.home = #Informatica Repository Name infa.repo.name = #Informatica Repository Domain infa.repo.domain = #Informatica Repository Username infa.repo.username = #Informatica Repository Password infa.repo.password = #Informatica Repository Hostname infa.repo.hostname = #Informatica Repository Server Port (default is 6001) infa.repo.port = #DAC Content #The following properties are required if the patch contains updates to the shipped DAC content #DAC repository hostname dac.repo.hostname = #DAC repository server port (default is 1521) dac.repo.port = #DAC repository server servicename/SID dac.repo.serviceName = #DAC repository username dac.repo.username = #DAC repository password dac.repo.password =