SAP BusinessObjects Patch Update Guide

SAP BusinessObjects Business Intelligence suite 4.0 Support Package 4

2012-08-16

Copyright

2012 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP
BusinessObjects Explorer, StreamWork, SAP HANA and other SAP products and services mentioned
herein as well as their respective logos are trademarks or registered trademarks of SAP AG in
Germany and other countries.Business Objects and the Business Objects logo, BusinessObjects,
Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products
and services mentioned herein as well as their respective logos are trademarks or registered
trademarks of Business Objects Software Ltd. Business Objects is an SAP company.Sybase and
Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, and other Sybase products and services
mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase,
Inc. Sybase is an SAP company. Crossgate, m@gic EDDY, B2B 360, B2B 360 Services are
registered trademarks of Crossgate AG in Germany and other countries. Crossgate is an SAP
company. All other product and service names mentioned are the trademarks of their respective
companies. Data contained in this document serves informational purposes only. National product
specifications may vary.These materials are subject to change without notice. These materials are
provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only,
without representation or warranty of any kind, and SAP Group shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP Group products and services
are those that are set forth in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an additional warranty.
2012-08-16

Contents

Chapter 1

Installation...............................................................................................................................5

1.1
1.1.1
1.1.2
1.1.3

About this Document...............................................................................................................5

Chapter 2

Planning..................................................................................................................................7

2.1
2.2
2.3
2.4
2.5
2.6

SAP BusinessObjects Patches................................................................................................7

Chapter 3

Installation scenarios............................................................................................................13

3.1
3.2
3.3
3.4

Applying Patches to a system with multiple SAP BusinessObjects products..........................13

Chapter 4

Patch installation on Windows..............................................................................................15

4.1
4.2
4.3
4.3.1
4.3.2
4.4
4.4.1

To install SAP BusinessObjects Patches for server components on Windows.......................15

Chapter 5

Patch installation on UNIX....................................................................................................21

5.1

To install the SAP BusinessObjects patch on UNIX................................................................21

Purpose...................................................................................................................................5
Constraints..............................................................................................................................5
Variables..................................................................................................................................6

Patch platform support.............................................................................................................9

Patch language support............................................................................................................9
Patch installation limitations and restrictions...........................................................................10
Planning your Patch installation..............................................................................................10
Downloading Patches.............................................................................................................11

Updating a distributed SAP BusinessObjects Business Intelligence suite deployment............13

Updating web application components...................................................................................13
Saving web.xml file modifications...........................................................................................14

To install SAP BusinessObjects Patches for client components on Windows.........................16

Silent installation on Windows................................................................................................16
To run a silent installation using a response file on Windows..................................................17
Silent installation parameters on Windows.............................................................................18
Uninstalling SAP BusinessObjects Patches on Windows.......................................................18
To uninstall SAP BusinessObjects Patches on Windows........................................................18

2012-08-16

Contents

5.2
5.2.1
5.2.2
5.3

Silent installation on UNIX......................................................................................................22

To run a silent installation using a response file on UNIX........................................................22
Silent installation parameters on UNIX...................................................................................23
To uninstall SAP BusinessObjects Patches on UNIX..............................................................24

2012-08-16

Installation

Installation

1.1 About this Document

This guide is intended for the system administrator or IT professional who is responsible for the
installation, deployment, and maintenance of SAP BusinessObjects Business Intelligence suite.
Topics covered in this guide include:
Patch installation on Windows
Patch installation on UNIX
Silent Patch installation
Uninstalling Patches
It is recommended that this guide be used in conjunction with the following Patch documentation:
The Patch Release Notes and Fixed issues document which contains information about important
issues, limitations, and work-arounds for the Patch release, as well as information about the defects
addressed by the Patch.

1.1.1 Purpose
This document is intended as a reference for use by system administrators when updating the BI suite
with the most recent Patch. For the latest information, updates, and other information, visit the support
site at service.sap.com/bosap-support.

1.1.2 Constraints
This guide does not describe how to set up a host operating system, supported database, web application
server, or web server. If you are planning to use a dedicated database, web application server, or web
server, it must be installed and functioning before SAP BusinessObjects Business Intelligence platform
can be installed. Refer to the vendor documentation for more information on installing or upgrading
these components.

2012-08-16

Installation

1.1.3 Variables
The following variables are used throughout this guide.
Variable

Description

<INSTALLDIR>

The directory where the BI platform is installed.

On a Windows machine, the default directory is C:\Program Files (x86)\SAP
BusinessObjects\.

2012-08-16

Planning

Planning

2.1 SAP BusinessObjects Patches

A separate Patch is available for each SAP BusinessObjects package, as outlined in the following table.

2012-08-16

Planning

Patch

Description

SAP BusinessObjects Business Intelligence

Use this Patch to update the BI platform installations.
platform Patch
This Patch is also intended for SAP BusinessObjects
Edge Business Intelligence (BI)
SAP BusinessObjects Business Intelligence
Use this Patch to update the BI platform Client Tools
platform Client Tools Patch
installations. Client tools include:
Web Intelligence Rich Client
Business View management tool
Report Conversion tool
Web services query tool
Universe design tool
Information design tool
Translation management tool
Data Federation administration tool
Widgets for SAP BusinessObjects Business Intelligence platform
Translation management tool
Developer Components
SAP BusinessObjects Business Intelligence platform Java SDK
SAP BusinessObjects Business Intelligence platform .NET SDK
SAP BusinessObjects Business Intelligence platform Web Services Consumer SDK
SAP Crystal Reports Java SDK
SAP Crystal Reports 2011 Patch

Use this Patch to update SAP Crystal Reports 2011 installations.

Note:
If you are running SAP Crystal Reports 2011, see "Patch
installation limitations and restrictions".

SAP Crystal Reports for Enterprise Patch

Use this Patch to update SAP Crystal Reports for Enterprise installations.

SAP Crystal Server 2011 Patch

Use this Patch to update SAP Crystal Server 2011 installations.

SAP BusinessObjects Live Office Patch

Use this Patch to update SAP BusinessObjects Live

Office installations.

2012-08-16

Planning

Patch

Description

SAP Crystal Presentation Design Patch

Use this Patch to update SAP Crystal Presentation Design installations.

SAP BusinessObjects Dashboard Design

Patch

Use this Patch to update SAP BusinessObjects Dashboard Design installations.

SAP BusinessObjects Explorer Patch

Use this Patch to update SAP BusinessObjects Explorer

installations.

2.2 Patch platform support

The following table shows the platform support for each Patch.
Support Package

Windows

AIX

Solaris

Linux

SAP BusinessObjects Business Intelligence

platform
SAP BusinessObjects Business Intelligence
platform Client Tools
SAP Crystal Reports 2011
SAP Crystal Server 2011
SAP Crystal Reports for Enterprise
SAP BusinessObjects Live Office
SAP Crystal Presentation Design
SAP BusinessObjects Dashboard Design
SAP BusinessObjects Explorer

2.3 Patch language support

A Patch only contains string resources for English, and any string fix resolutions contained in the Patch
will be displayed in English. Translations for string fixes are added to the next available Support Package
containing the fix.

2012-08-16

Planning

2.4 Patch installation limitations and restrictions

The following limitations and restrictions apply to Patch installation:
Patches are maintenance installations, not complete product installations. An SAP BusinessObjects
product must be installed in order to install a Patch.
A Patch only updates files that are already installed. For example, if you previously performed a
custom installation, the Patch will only update the subset of files that were installed during the original,
custom installation.
Patches can only be installed in their entirety. You cannot install a subset of Patch updates.
It is required that all components in a SAP BusinessObjects system be at the same maintenance
level. For example, SAP BusinessObjects server, client, and web components must be at the same
maintenance level. If you update one component of your SAP BusinessObjects system, you must
also update the other components. If you uninstall a Patch for one component in your system, you
must uninstall the same Patch for the other components.
If you install a new SAP BusinessObjects product or component to your system after Patch installation,
you must re-apply the Patch to the machine where you installed the new product or component to
ensure that all SAP BusinessObjects products and components are at the same Patch level.
Patches are designed for a specific maintenance package level. For example, a Patch designed for
Support Package 2 cannot be installed if your system is at only the Support Package 1 level. You
must upgrade to the Support Package 2 level before installing that Patch.

Patches designed for the same Support Package level are cumulative. Therefore, it is unnecessary
to install an earlier Patch from a particular Support Package level on top of a later Patch at that same
level.
The Patch installation program can automatically redeploy web application components to the web
application server only if the bundled Tomcat web server was used, and those components were
deployed automatically at initial installation time. If the web application components were initially
deployed using the WDeploy tool, you must use WDeploy to redeploy those components after
installing the Patch. For more information see "Updating web application components".
If you are performing a silent installation using a response file, you must create the response file
with the setup.exe or install.sh file from the target Patch installation package. Response files
generated for a Patch installation are specific to that Patch, and cannot be shared between full
installations and update installations, or between Support Package installations and Patch installations.

2.5 Planning your Patch installation

Before applying a Patch to your system the following planning steps are recommended:

10

Review the Patch Release Notes and Fixed Issues document to determine if defects addressed by
the Patch are relevant to your SAP BusinessObjects installation, and for important issues, limitations,
and works-arounds for the Patch release.

2012-08-16

Planning

Identify all SAP BusinessObjects products and components that require updates.
For the SAP BusinessObjects 4.0 release, Patches are provided for each product that has its own
installer. Refer to "SAP BusinessObjects Patches" to identify the Patches required for your upgrade.
On windows, installed patches can be determined from the Windows Add/Remove Programs
list.
On unix, installed patches can be determined by running <install
path>\modifyorremoveproduct.sh
It is required that all SAP BusinessObjects products and components be at the same support package
and patch level. If you have a distributed installation or you are running multiple SAP BusinessObjects
products, ensure that all products and distributed components are updated. This includes BI platform
servers, client tools, web components, and other SAP BusinessObjects products such as SAP
Crystal Reports and Live Office.
If you have SAP BusinessObjects web application components installed, ensure that you have
defined an update path for these components. The update path depends on how you initially deployed
the web application components. For more information, see "Updating web application components".

Before you begin, review "Patch installation limitations and restrictions".

Review "Patch installation scenarios". The scenarios may help you plan your upgrade.
Before you begin, gather all required documentation. Depending on your upgrade, additional
documentation such as the SAP BusinessObjects Business Intelligence Platform Installation Guide
may be required.

2.6 Downloading Patches

SAP BusinessObjects Patches are available for download from the SAP Support Portal: http://ser
vice.sap.com/patches.

11

2012-08-16

Planning

12

2012-08-16

Installation scenarios

Installation scenarios

This topic describes common Patch installation scenarios that may help you plan your Patch installation.

3.1 Applying Patches to a system with multiple SAP BusinessObjects products

Due to product interdependencies, it is required that all SAP BusinessObjects products be at the same
maintenance level. For example, if you want to apply a patch to SAP Crystal Reports on a system where
you run SAP Crystal Reports, Live Office, and the BI platform, you must apply patches for all three
products so that all products are running at the same patch level. In this scenario, you must apply a
SAP Crystal Reports patch, a Live Office patch, and an BI platform patch.

3.2 Updating a distributed SAP BusinessObjects Business Intelligence suite

deployment
If you are installing a patch on a distributed BI suite deployment, where servers and components are
installed across multiple computers, you must first install the patch on the computer where the Central
Management Server (CMS) is installed.
If your deployment has multiple clusters, the credentials for the first CMS that you upgrade must be
used when upgrading the other clusters.

3.3 Updating web application components

How you apply a patch update to BI platform web application components depends on how the
components were originally deployed.
One of the following three scenarios apply:

13

If you deployed the BI platform WAR files to the default, bundled Tomcat server using the installation
program, the patch installation program allows you to update them automatically.

2012-08-16

Installation scenarios

Follow the patch installation program steps in this guide.

If you deployed the BI platform WAR files manually to your web application server, updates must
be applied manually after installing the patch.
Manual deployment instructions for web application components are found in the SAP
BusinessObjects Business Intelligence Platform Web Application Deployment Guide.

If you deployed the BI platform WAR files using the WDeploy tool to your web application server,
you can apply updates manually or use the WDeploy tool after installing the patch.
Instructions for the WDeploy tool are found in the SAP BusinessObjects Business Intelligence
Platform Web Application Deployment Guide.

You must first install the patch to obtain the updated WAR files in order to redeploy them manually or
using the WDeploy tool. If you are applying multiple patch updates in a row, install all updates first to
obtain a final set of WAR files once that can be redeployed once.
Note:
You must update any deployed BI platform WAR files as part of your Patch upgrade. It is required that
all BI suite components, including web applications, be at the same version level.

3.4 Saving web.xml file modifications

When a patch is installed, the web.xml files for SAP BusinessObjects web applications that have been
deployed to a web application server are overwritten. This means that any customizations that you've
made by changing the web.xml files are lost after applying a Patch update.
If you modified a web.xml file for a web application and do not want to lose your modifications, you
must make the modifications in the BI platform installation directory. On Windows systems, this directory
is <INSTALLDIR>\SAP BusinessObjects Enterprise XI 4.0\warfiles\webapps. On UNIX
systems, this directory is <INSTALLDIR>/sap_bobj/enterprise_xi40/warfiles/webapps.
Then, after you've applied the patch, rebuild the affected .war files and redeploy the .war files to the
web application server.

14

2012-08-16

Patch installation on Windows

Patch installation on Windows

You must have Administrator privileges on your Windows system to run a SAP BusinessObjects Patch
installation.
In order to free resources on the machine on which you are installing this patch, it is recommended that
you use the Central Management Console (CMC) to stop all of the BI platform servers on the machine
before installing the patch, with the following exceptions:
Server Intelligence Agent (SIA)
Central Management Server (CMS)
Input and Output File Repository Servers (FRS)
CMS system database
These services and servers must be running for the installation to proceed.
Note:
If you have modified web.xml files for web applications, see "Saving web.xml file modifications" before
you apply a patch.
Note:
If you are updating a product that contains server components, the installation program prompts you
for information for your deployment's Central Management Server (CMS). This is required to update
content that is stored in the CMS database, such as localized strings for server properties.

4.1 To install SAP BusinessObjects Patches for server components on Windows

This procedure is used to install patches that update the SAP BusinessObjects Business Intelligence
platform server package running on Windows. This package updates BI platform server components.
1. Launch the installation by running setup.exe
2. Choose a language for the installation program to use during the installation process, and click OK.
The installation program checks your system to ensure the proper prerequisites are in place
3. Click Next.
4. In the "Welcome" dialog box, click Next to proceed.
5. In the "License Agreement" dialog box, review the contents of the End User License Agreement,
and click Next to proceed if you agree to the terms.
If the patch includes server components, the "CMS" dialog box is displayed.

15

2012-08-16

Patch installation on Windows

6. Type the Hostname, Port Number, and Administrator Password for your deployment's CMS, and
click Next to continue.
7. In the "Start Installation" dialog box, click Next to begin the installation.
The update will install.
Note:
If web applications are updated as part of the patch, depending on the options you chose when you
originally installed SAP BusinessObjects BI Platform a post installation dialog box may appear with
additional instructions for redeploying your .war files.
8. Click Finish.

4.2 To install SAP BusinessObjects Patches for client components on Windows

This procedure is used to install Patches for SAP BusinessObjects client applications. This includes
the following packages:
SAP BusinessObjects Business Intelligence platform Client
SAP BusinessObjects Business Intelligence platform Live Office
SAP Crystal Reports for Enterprise
SAP Crystal Reports 2011
SAP Crystal Presentation Design
SAP BusinessObjects Dashboard Design
1. Launch the installation by running setup.exe
2. Choose a language for the installation program to use during the installation process, and click OK.
The installation program will perform a check to ensure the required prerequisites are in place.
3. Click Next.
4. In the "Welcome" dialog box, click Next.
5. In the "License Agreement" dialog box, review the contents of the End User License Agreement,
and click Next to proceed if you agree to the terms.
6. In the "Start Installation" dialog box, click Next to begin the installation.
The "Installation Progress" dialog box appears.

4.3 Silent installation on Windows

16

2012-08-16

Patch installation on Windows

4.3.1 To run a silent installation using a response file on Windows

Patches can be installed silently using a response file.
Silent installation is particularly useful when you need to quickly perform multiple installations or automate
installations.
To run a silent installation using a response file you must first create a .ini file using the installation
program. Once you have created the .ini file, you can run a silent installation by running the set
up.exe command and specifying the path to the .ini file.
Note:

If you are performing a silent installation using a response file, you must create the response file
with the setup.exe or install.sh file from the target Support Package or Patch installation
package. Response files cannot be shared between refresh installations,update installations, Support
Package installations or Patch installations.
When creating a response file with the GUI installation program, passwords entered via the GUI are
not written to the response file: Replace the starred entries (********) with your passwords before
performing a silent installation.

1. Create an installation .ini file (a response file).

a. Open a command line console.
b. From the directory that contains the SAP BusinessObjects setup.exe file, run the setup.exe
command with the write option (-w) specified:
setup.exe -w <responsefilepath\filename.ini>

where filename.ini is the name you have given to the response file and responsefilepath
is the location where you want the file created.
Note:
If a file path is not specified, the file is stored in the directory that setup.exe is run from. The
installation program must have write permissions on this directory.
c. Press Enter to launch the installation program.
d. Follow the on-screen instructions to enter your preferred installation settings until you reach the
Start installation dialog box.
e. Click Cancel to abort the installation setup.
All parameters from the installation program, both user defined and default, are recorded in the
.ini file which is saved to the directory you specified.
2. You can now run a response file installation using the .ini file by issuing setup.exe command
with the read option specified (-r):
Log files for the install are stored at <install dir>\InstallData\logs.

17

2012-08-16

Patch installation on Windows

4.3.2 Silent installation parameters on Windows

The following table lists parameters that are used for response file silent installation on Windows. It is
recommended that you create response files using the SAP BusinessObjects setup program (set
up.exe) as described in "To run a silent installation using a response file on Windows".
Parameter

RemoteCMSname

Description

Specifies the name of the Central Management Server (CMS)

remoteCMSname="<servername>"

remotecmsport

Specifies the port used by the CMS

remotecmsport="6400"

remotecmsadminMust specifie the "administrator" account for the CMS.

name
remotecmspassword

Specifies the password for the Administrator account for the CMS.
remotecmspassword="<myPassword>"

4.4 Uninstalling SAP BusinessObjects Patches on Windows

Patches can only be uninstalled one at a time, in the reverse order of installation. When uninstalling
Patches, ensure that all of the products in your deployment are at the same version before using the
system.

4.4.1 To uninstall SAP BusinessObjects Patches on Windows

1. In Windows, click Start, point to Settings, and then select Control Panel.
2. Double-click Add or Remove Programs.
3. Highlight the Patch entry in the list of programs and click Change/Remove.
The "Application Maintenance" dialog box appears.

18

2012-08-16

Patch installation on Windows

4. Select Remove and click Yes.

5. Wait while the appropriate files are removed and the necessary configuration is carried out. Click
Finish.

19

2012-08-16

Patch installation on Windows

20

2012-08-16

Patch installation on UNIX

Patch installation on UNIX

In order to free resources on the machine on which you are installing this patch, it is recommended that
you use the Central Management Console (CMC) to stop all of the BI platform servers on the machine
before installing the patch, with the following exceptions:
Server Intelligence Agent (SIA)
Central Management Server (CMS)
Input and Output File Repository Servers (FRS)
CMS system database
These services and servers must be running for the installation to proceed.
Note:
If you have modified web.xml files for web applications, see "Saving web.xml file modifications" before
you apply a Patch.
Note:
If you are updating server components, the installation program prompts you for information for your
deployment's Central Management Server (CMS). This is required to update content that is stored in
the CMS database, such as localized strings for server properties.

5.1 To install the SAP BusinessObjects patch on UNIX

1. Launch the installation by running the following command from the patch installation source file
location:
setup.sh InstallDir=<INSTALLDIR>
where <INSTALLDIR> is the installation directory of your SAP BusinessObjects product.
2. Select the language you want the installation program to run in and press Enter.
A dialog box appears that shows the installation directory you have specified.
3. Verify the installation directory and press Enter to start the installation.
The installation program will check to ensure the required prerequisites are in place.
4. Press Enter to continue.
A Welcome screen will be displayed.
5. Press Enter to continue.

21

2012-08-16

Patch installation on UNIX

The license agreement will be displayed.

6. Review the content of the License agreement and press Enter to agree and proceed.
If the patch includes server components, you will be prompted for your CMS credentials.
7. Enter your CMS credentials and press Enter to start the installation.
The progress indicator displays the status of the installation.
Note:
If web applications are updated as part of the patch, depending on the options you chose when you
originally installed SAP BusinessObjects BI Platform a post installation screen may appear with
additional instructions for redeploying your .war files.
8. Press Enter to complete the installation.
To review details of the installation, you can view the contents of the installation log file located in
<INSTALLDIR>/InstallData/logs/

5.2 Silent installation on UNIX

5.2.1 To run a silent installation using a response file on UNIX

Patches can be installed silently using a response file.
Silent installation is particularly useful when you need to quickly perform multiple installations or automate
installations.
To run a silent installation using a response file you must first create a response file.
The following steps describe how to create a response file using the SAP BusinessObjects installation
program. Once you have created the response file, you can run a silent installation by running the
./setup.sh command and specifying the path to the response file.
Note:

If you are performing a silent installation using a response file, you must create the response file
with the setup.exe or setup.sh file from the target support package or patch installation package.
Response files cannot be shared between support package installations and patch installations.
When creating a response file with the GUI installation program, passwords entered via the GUI are
not written to the response file: Replace the starred entries (********) with your passwords before
performing a silent installation.

1. Create a response file.

22

2012-08-16

Patch installation on UNIX

a. From the patch installation source file location, run the .setup.sh command with the write
option (-w) specified:
./setup.sh installDir=<INSTALLDIR> -w <responsefilepath/filename.ini>

where <INSTALLDIR> is the SAP BusinessObjects installation directory and <response

filepath/filename.ini> is the path and file name for the response file you are creating.
b. Press Enter to launch the installation program.
c. Follow the on-screen instructions to enter your preferred installation settings until you reach the
Start installation dialog box of the setup program, the press Enter.
The settings are recorded in the response file.
2. You can now run a response file installation by issuing ./setup.sh command with the -r option
specified:
./setup.sh InstallDir=<INSTALLDIR> -r

<responsefilepath/filename.ini>

where <responsefilepath/filename.ini> is the path and name of the response file you
created.
3. Press Enter to launch the installation.

5.2.2 Silent installation parameters on UNIX

The following table lists parameters that are commonly used for response file silent installation on UNIX.
It is recommended that you create a response files using ./setup.sh and the -w parameter, as
described in "To run a silent installation using a response file on UNIX".
Parameter

RemoteCMSname

Description

Specifies the name of the Central Management Server (CMS)

remoteCMSname="<servername>"

23

2012-08-16

Patch installation on UNIX

Parameter

remotecmsport

Description

Specifies the port used by the CMS

remotecmsport="6400"

remotecmsadminSpecifies the administrator account for the CMS.

name
remotecmspassword

Specifies the password for the Administrator account for the CMS.
remotecmspassword="<myPassword>"

5.3 To uninstall SAP BusinessObjects Patches on UNIX

1. To uninstall a patch, execute the following command from the root directory of your SAP
BusinessObjects installation:
./modfiyOrRemoveProducts.sh

The "Add or Remove Programs" dialog box is displayed.

2. Select the SAP BusinessObjects patch you want to remove and press Enter.
You will be prompted for your Central Management Server credentials.
3. Enter your CMS credentials and press Enter.
4. Select Uninstall Product and press Enter.
A confirmation dialog box is displayed.
5. Select Yes and press Enter.
The uninstallation process begins.

24

2012-08-16