SAP BusinessObjects BI Customization Guide
SAP BusinessObjects BI Customization Guide
SAP BusinessObjects BI Customization Guide
1 Document History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2 Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1 About this guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Terminology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2 Before you begin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Customizing SAP BusinessObjects Business Intelligence platform . . . . . . . . . . . . . . . . . . . . . . . 8
Customizing SAP Crystal Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Customizing SAP Crystal Reports for Enterprise. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
The following table provides an overview of the enhancements made to this document.
The SAP BusinessObjects Business Intelligence Suite provides a set of tools and templates that allow you to
customize the SAP BusinessObjects Business Intelligence platform, the SAP Crystal Reports Designer, and
SAP Crystal Reports for Enterprise. This guide shows you how to use these tools and templates to create your
desired customizations.
Depending on the needs of your customers, you can remove features and language packs to reduce the size of
the installation program and the installed product. And if you want to differentiate your system and apply your
own unique corporate branding, you can personalize the appearance of your products, including product name,
logos, colors, and other elements of the user interface. Your customization can be as simple as a logo change,
or as detailed as a complete re-skinning.
The best thing is that your customizations are supported throughout the life cycle of the products. It is easy to
maintain your changes during future upgrades and updates.
This guide is meant for anyone customizing SAP BusinessObjects Business Intelligence Suite products. You
won't need to read the entire document; the Before you begin [page 8] section describes the relevant
workflows for each major area of product customization and tells you where to find the information you need.
Guide conventions
Variable Description
2.1.1 Terminology
Term Definition
Add-on products Products that work with the BI platform but have their own
installation program.
Auditing Data Store (ADS) The database used to store auditing data
Bundled database; bundled web application server The database or web application server shipped with the BI
platform
You can change the cluster key in the CCM, but you cannot
reset the key like a password. It contains encrypted content
and is important not to lose.
CMS database The database used by the CMS to store information about
the BI platform
Server Intelligence Agent (SIA) A process that manages a group of servers, including stop
ping, starting, and restarting servers
This guide covers the different types of customization for the different products in the SAP BusinessObjects
Business Intelligence suite. You need to read only those sections that cover the products you are planning to
customize.
You can customize many aspects of the Business Intelligence platform deployment:
You can customize the web applications, the installation program, or both. The following diagram illustrates the
workflow where all types of customizations are performed:
There are many customizations you can perform to enhance and personalize the design and customer
experience for your SAP Crystal Reports users:
● Install and run the SAP BusinessObjects customization tool. For details, see Quick start for Crystal Reports
[page 69].
● If you want to customize the SAP Crystal Reports installation program, you can change its appearance,
hide unwanted screens from users in the wizard, and remove unused features to reduce the installed
product size on client machines.
See the SAP Crystal reports 2020 Customization [page 69] for “SAP Crystal Reports 2020
Customization” in this document.
● If you want to customize the report designer, you can change the default splash screen or start page. You
can also customize the product name, menus, and other assets of the report designer.
See Customizing the report designer [page 88] in this document.
The following diagram illustrates the workflow where all types of customizations are performed:
You can make a variety of customizations to SAP Crystal Reports for Enterprise in order to personalize the
design of the program and enhance the customer experience for your users:
● Customize the installation program by changing its appearance, hiding unwanted screens, and removing
unused files to reduce the installed product size on client machines.
For more information, see the Introduction [page 106] for the “SAP Crystal Reports for Enterprise
Customization” section in this document.
● Customize the report designer by changing the default splash screen or start page. You can also customize
the product name, menus, and other assets of the report designer.
For more information, see Customizing the report designer [page 120] in the “SAP Crystal Reports for
Enterprise Customization” section of this document.
3.1 Introduction
The SAP BusinessObjects Business Intelligence platform can be repackaged and sold by partners. You can
customize the installed product and the installation program in order to target a specific customer base, or to
resell it as part of your own product. The SAP BusinessObjects customization tool customizes the SAP
BusinessObjects Business Intelligence platform and its installation program with changes such as the
following:
To make customizations, you write a configuration file to specify the changes then run the SAP
BusinessObjects customization tool to create a customized installation program. Customers can use this
installation program to install a customized version of the product.
The customization tool is available for Windows and Unix. It can be used to customize a full installation
program, a Support Package installation program, and a Patch installation program.
Note
This tool does not perform customizations on the SAP BusinessObjects Business Intelligence platform
Client Tools.
This section shows you how to run the customization tool to create a customized installation program for the
SAP BusinessObjects Business Intelligence platform (BI Platform). It uses the sample configuration file that is
provided with this tool. When you are finished this tutorial, you can run your customized installation package
and install a customized version of the BI Platform.
The customizations include changing the default installation type, removing features, hard-coding the product
keycode, changing the default installation folder, renaming the product, and changing the Windows Start menu
shortcut for the Central Configuration Manager feature. They are described in more detail in the configuration
file.
Note
The customization tool may take several minutes to complete. You can check its progress by viewing
the log file.
The BI Platform is installed with the customizations described in the configuration file.
This section shows you how to run the customization tool to create a customized installation program for the
SAP BusinessObjects Business Intelligence platform (BI Platform). It uses the sample configuration file that is
provided with this tool. When you are finished this tutorial, you can run your customized installation package
and install a customized version of the BI Platform.
The customizations include changing the default installation type, removing features, hard-coding the product
keycode, changing the default installation folder, and renaming the product. They are described in more detail
in the configuration file.
Verify that the customized installation program was created at /usr/jdoe/bip/output. Ensure no errors
were reported in the log file custombip.log.
Note
The customization tool may take several minutes to complete. You can check its progress by viewing
the log file.
The BI Platform is installed with the customizations described in the configuration file.
● A Windows machine with WinZip/WinRAR to extract .rar files and execute .exe files.
3. Select B SBOP BI platform (former SBOP Enterprise) SBOP BI PLATFORM (ENTERPRISE) SBOP BI
PLATFORM 4.3 .
4. Select Installation and Upgrade, and then select your platform.
[You can choose the OS from the drop-down.]
5. Select all of the packages titled SBOP BI PLATFORM <version> SERVER plus any additional add-on
products you require, then follow the instructions on the website to download and extract the packages.
Note
You should ensure that you download the .rar and .exe package at same location in a Windows machine
or system.
The software may take a long time to download, and you may need to contact the system administrator to
ensure your company's firewall will not terminate the download process.
Caution
● Ensure that you have downloaded the .executable (exe) as well as the .rar file in the same location for
a successful installation.
● If you download the server installation program without the SAP Download manager, it results in failed
or partial downloads.
Note
You can download the ONE Installer package from either Installation & Upgrades or Support Packages &
Patches category and use the package for fresh and update installation scenarios. For more information on
installing support packages and patches, see the SAP BusinessObjects Business Intelligence Platform
Support Package Update Guide.
1. Download the installation program. See To download the server installation program [page 16].
2. Decide what customizations are required. See Creating the configuration file [page 19].
3. Write the configuration file to specify the customizations.
4. Run the customization tool to create a customized installation program.
5. Run the customized installation program to install a customized version of SAP BusinessObjects Business
Intelligence platform.
You may want to validate the configuration file before running the tool. Use the validate command-line
parameter.
Customers prefer a smaller installation program and a smaller installed product. To keep the product as small
as possible:
The product name and version number appear in several places in the installation program and in the installed
product. Ensure you verify customizations in the following locations:
It is good practice to consider how the customized name appears in all supported languages.
You must apply the same customizations to Support Packages and Patches as you applied to the main release.
If you release a customized main installation program, then try to release a Support Package or Patch
Test rollback, modify, and repair installations for Support Packages and
Patches
Rollback, modify, and repair are supported for customized Support Packages and Patches, provided they have
been customized in a manner consistent with the main installation package. It is recommended to test these
scenarios.
Related Information
The following section describes the customizations you can make to the installation program by editing the
configuration file:
The SAP BusinessObjects customization tool uses information in the configuration file to perform the
customizations. The configuration file is an XML document, and you use XML elements to describe your
customizations. The sample configuration file is contained in this folder in the installation program:
Windows Collaterals\Tools\CustomizationTool
\example_customization_win_boe.xml
The configuration file for the full installation program can have any name, for example, oem.xml.
The configuration file for the Support Package installation program is described in the section How to
customize update installation programs [page 42].
Note
The configuration file must be written in correct XML syntax. Use an XML editor to create and edit the file,
and verify the format is correct before running the tool.
Example
● Change the product long name to Custom Company Server for all languages.
● Change the product short name to Custom CS for all languages.
● Remove the installation screen titled Choose Installation Type and set the installation type to Custom.
● Specify that the only language packs included in the installation package are English, French, German,
Italian, and Chinese.
<oem name="CustomCompanyServer">
<cloneProduct sourceId="product.businessobjects64-4.0-core-32">
<replaceString id="product.boe64_name" value="Custom Company Server"
lang="all"/>
<replaceString id="product.boe64_shortname" value="Custom CS" lang="all"/>
<replaceProperty id="InstallType" defaultValue="custom"/>
<removeDialog id="ChooseInstallType.dialog"/>
<languageIncludeList value="en;fr;de;it;zh_CN"/>
</cloneProduct>
</oem>
You can customize the product name and version number. Use the replaceString element with the desired
string ID:
There are four strings that represent the product name and version number: the product long name, the
product short name, the product version number, and the product major version number. The full product
name is composed of the product long name and the version number. The product short name and product
major version are used in the Windows shortcut menu.
Note
You should customize the product version and product major version together. For example, if you change
product version to 1.0 you should also customize product major version to 1. Otherwise the version number
in the menus will not match the version number in the product.
Example
Change the product long name to Sales Insight Platform and the product short name to Sales Platform for
English. Change the product long name to Sales Insight Platform (French) and the product short name to Sales
Platform (French) for French. Change the product version to 1.0 and the product major version to 1 for both
The customization appears below. Notice the version number “FP3” is not removed:
When you run the installation program, you may see instances of “FP3” in the product name. To remove “FP3”,
modify the lines in the following files:
You must modify one file for every language that the installation program supports. For a list of language codes,
see Language codes [page 49]. When you run the customization tool and then run the installation program, all
instances of “FP3” will be removed. This process will be simplified in a future release.
Example
To remove “FP3” from the English installation program, modify the following files:
● product.lang_en.uitext.xml
● setup.ui.framework.lang_en.uitext.xml
The Windows Start menu contains shortcuts for features such as the Central Management Console and BI
launch pad. You can customize the name, location, and tooltip for each shortcut. Any shortcut that you do not
customize will be grouped under the default Start menu, SAP BusinessObjects BI platform 4.
Attribute Value
duSourceId The shortcut deployment unit ID that you want to modify. Typical values include:
● product.businessobjects64.shortcut.ccm-4.0-core
Central Configuration Manager
● product.businessobjects64.shortcut.infoview-4.0-core
BI launch pad
● product.businessobjects64.shortcut.cmc-4.0-core
Central Management Console
For a complete list of sourceId values, see Shortcut deployment unit IDs (Windows only)
[page 47].
linkFullPath The full path to the shortcut link. Be sure to add .lnk to shortcut link or the link will not be cre
ated. You can put the shortcut link on the Start menu or you can put it on the desktop. The SAP
BusinessObjects customization tool will create the links correctly.
You can specify one link for each language. For a list of language codes, see Language codes
[page 49].
description The tooltip string to display when the user hovers the mouse over the shortcut. You can specify
one tooltip for each language.
Note
You can customize the link, but not the tooltip, for the following shortcuts:
Example
This example customizes the name of the Central Management Console shortcut to Sales Insight Manager for
English and Sales Insight Manager (French) for French, and places the shortcuts under the Start menu entry
called Sales Insight Platform 1. It also customizes the tooltip to Launch Sales Manager for English and Launch
Sales Manager (French) for French. The shortcut name and tooltip will remain unchanged for all other
languages.
<shortcut duSourceId="product.businessobjects64.shortcut.cmc-4.0-
core">
<arg id="linkFullPath" value="[programmenufolder]\Sales Insight
Platform 1\Sales Insight Manager.lnk" lang="en"/>
<arg id="linkFullPath" value="[programmenufolder]\Sales Insight Platform 1
(French)\Sales Insight Manager (French).lnk" lang="fr"/>
<arg id="description" value="Launch Sales Manager" lang="en"/>
<arg id="description" value="Launch Sales Manager (French)"
lang="fr" />
</shortcut>
There are two links for the Tomcat shortcut: Tomcat Administration and Tomcat Configuration, shown below:
<shortcut duSourceId="product.businessobjects64.shortcut.tomcat-4.0-core"
pathToTarget="http://localhost:[TomcatConnectionPort]/manager/html">
<arg id="linkFullPath" value="<full path to shortcut link>" lang="<language
list>"/>
<arg id="description" value="<tooltip string>" lang="<language list>"/>
</shortcut>
Use this shortcut element to customize the Tomcat Configuration link. Note the pathToTarget element.
<shortcut duSourceId="product.businessobjects64.shortcut.tomcat-4.0-core"
pathToTarget="[INSTALLDIR]tomcat\bin\tomcat7w.exe">
<arg id="linkFullPath" value="<full path to shortcut link>" lang="<language
list>"/>
<arg id="description" value="<tooltip string>" lang="<language list>"/>
</shortcut>
Example
This example customizes the name of the Tomcat Administration shortcut to tomcat(english and french)
shortcut1 for English and French installations, and tomcat (German) shortcut1 for German installations. It
places the shortcuts in the Start menu entry called Company Programs . It customizes the tooltip to
tomcat(english and french) shortcut1 for English and French, tomcat (all others) shortcut1 for all other
languages.
<shortcut duSourceId="product.businessobjects64.shortcut.tomcat-4.0-core"
pathToTarget="http://localhost:[TomcatConnectionPort]/manager/html">
<arg id="linkFullPath" value="[programmenufolder]\Company Programs
\tomcat(english and french) shortcut1.lnk" lang="en;fr"/>
<arg id="linkFullPath" value="[programmenufolder]\Company Programs\tomcat
(German) shortcut1.lnk" lang="de"/>
<arg id="linkFullPath" value="[programmenufolder]\Company Programs\tomcat
(all others) shortcut1.lnk" lang="it;zh_cn"/>
<arg id="description" value="tomcat(english and french) shortcut1"
lang="en;fr"/>
<arg id="description" value="tomcat (German) shortcut1" lang="de" />
<arg id="description" value="tomcat (all others) shortcut1"
lang="it;zh_cn" />
</shortcut>
<shortcut duSourceId="product.businessobjects64.shortcut.tomcat-4.0-core"
pathToTarget="[INSTALLDIR]tomcat\bin\tomcat7w.exe">
<arg id="linkFullPath" value="[programmenufolder]\Company Programs
\tomcat(english and french) shortcut2.lnk" lang="en;fr"/>
<arp duSourceId="product.businessobjects64.arp-4.0-core">
<arg id="publisher" value="<publisher name>"/>
<arg id="display_name" value="<product name>" lang="<language list>"/>
<arg id="display_icon" value="<full path to icon>"/>
</arp>
Icons displayed in the Windows Add Remove Program utility are typically 16x16. Refer to Windows
documentation for complete information on creating the icon.
Example
Change the product name in the Windows ARP utility to Sales Insight Platform. This change will only affect
English installations. Change the publisher to Data Excellence Corp. Replace the display icon with the icon
located at C:\SAPCustomTool\DEC_logo.ico.
Note
To use this example you must put an icon called DEC_logo.ico in the location C:\SAPCustomTool.
<arp duSourceId="product.businessobjects64.arp-4.0-core">
<arg id="publisher" value="Data Excellence Corp"/>
<arg id="display_name" value="Sales Insight Platform" lang="en"/>
<arg id="display_icon" value="C:\SAPCustomTool\DEC_logo.ico"/>
</arp>
You can customize the default installation folder. Use the replaceProperty element with
id="InstallDir":
Note
On Windows installations, the default installation folder must be a subfolder of C:\Program Files
(x86). It cannot be a subfolder of C:\Program Files (x64).
Example
You can customize the default value of the user input that is collected by the installation program. Use the
replaceProperty element with id="<property id>" and the new default value:
For a list of property IDs, see Installation screen and property IDs [page 50].
The Windows installation program collects user input using dialog boxes, radio buttons, and other user
interface elements. The Unix and Linux installation program collects user input using the console entry. Both
installation programs are customized in the same way.
Example
On the installation screen called Choose Install Type, the default install type is Full. This example changes the
default install type to Custom/Expand.
You can remove installation screens from the installation program. Use the removeDialog element with the
installation screen ID:
For a list of installation screen IDs, see Installation screen and property IDs [page 50].
Example
This example shows how to remove the installation screen titled Select Java Web Application Server.
<removeDialog id="ChooseWebAppServer.dialog"/>
You can embed a keycode in the installation program so the customer does not need to enter one. This task
involves:
Example
Use the replaceProperty element with id="ProductKey" to provide a default keycode. Keycodes must
have the format XXXXX-XXXXXXX-XXXXXXX-XXXXXXX-XX.
Use the removeDialog element with id="EnterProductKey.dialog" to remove the installation screen for
the license key.
Related Information
SAP BusinessObjects Business Intelligence platform is composed of many optional features. You can remove a
feature from the installation program. Use the removeFeature element with id="<feature id>":
When you specify that a feature will be removed, the SAP BusinessObjects customization tool removes all
executables, installation screens, and other files that belong to that feature. Removing unnecessary features is
a good way to reduce the size of the customized product.
Note
Do not remove every database access component. You must leave at least one database access
component in order for the connection server to start and function correctly.
Remove the Crystal Reports feature. This removes all Crystal Reports servers, files, and resources.
<removeFeature id="CrystalReportsServers"/>
Related Information
Prerequisites are conditions that must exist on the host machine in order for the installation program to
succeed. The installation program verifies the existence of these prerequisites before starting, and displays the
results in the Prerequisite check screen. Removing the Prerequisite check screen prevents prerequisite checks
from being performed. Use the removeDialog element with id="CheckPreRequisites.dialog".
Note
It is recommended that you remove this installation screen only if you are performing the prerequisite
checks by some other means. If the prerequisites are not met, the installation program will fail.
Example
This example removes the Prerequisite check screen and prevents prerequisite checks from being performed.
<removeDialog id="CheckPreRequisites.dialog"/>
The installation program allows the user to select which language packs to install. A language pack contains
translated versions of all the strings that are used by the installed product. By default, all possible language
packs are included in the installation program. You can specify which language packs to include. Use the
languageIncludeList element with a list of language codes:
Language packs can be large. The installation program will be smaller if fewer language packs are included.
Example
Include English, French, and German language packs in the installation program. The user can select from this
list during installation.
<languageIncludeList value="en;fr;de"/>
If the user installs a web application server other than the default one, the WDeploy tool will run when the
installation is finished. On Windows platforms, WDeploy is a GUI tool while on Unix and Linux platforms, it is a
script.
You can turn this feature off. Use with the replaceProperty element with defaultValue="0"
Example
The default database is included with the installation program, and customers can choose to use it as the
system database. The default database is Sybase SQL Anywhere.
If the default database is not required you can remove it and force customers to choose another. Removing the
default database is a good way to reduce the size of the installation program.
This example removes the default database. It also removes the installation screen titled Select Default or
Existing Database, and sets the user input property to Use an existing database.
<removeFeature id="PlatformServers.IntegratedDB.SQLAnywhere"/>
<removeDialog id="SelectDataSource.dialog"/>
<replaceProperty id="SelectIntegratedDatabase" defaultValue="0"/>
The installation program stores image and text files as resources in this folder:
\dunit\product.businessobjects64-4.0-core-32\setup.ui.framework\resources
You can customize the resources in this folder. Resources that are commonly customized include:
To customize a resource:
1. Create a custom resources folder, for example (on Windows)C:\SAPCustomTool\MyResources. The file
can have any name, but will be visible to customers. Use the same folder for all resources that you
customize.
2. Create a new resource with the same name and filepath as the original resource, and place it into the
custom resources folder. See the related topics section for specific examples.
3. Add the <resources> element to the configuration file to specify the location of the custom resources
folder, for example:
<resources cleanTarget="no" sourcePath="C:\SAPCustomTool\MyResources"/>
cleanTarget
If you set the attribute cleanTarget='yes', the customization tool will delete the original resources folder
and use only those resources included in the custom resources folder. This option is not recommended.
Related Information
You can customize the images in the installation program including the welcome screen, the top image for all
screens, and the billboard for the progress dialog. Images are stored as files in the resources folder:
dunit\product.businessobjects64-4.0-core-32\setup.ui.framework\resources
You customize an image by creating a new image file, putting the file in the custom resources folder, and adding
the resources element to the configuration file.
Related Information
You can customize the license agreement that is presented to the user during installation. License agreements
are stored as text files in the resources folder:
dunit\product.businessobjects64-4.0-core-32\setup.ui.framework\resources\<language
code>
For example, on Windows platforms, the English license agreement is located here:
dunit\product.businessobjects64-4.0-core-32\setup.ui.framework\resources\en
\license_en.rft
On Unix and Linux platforms, the English license agreement is located here:
dunit/product.businessobjects64-4.0-core-32/setup.ui.framework/resources/en/
license_en.txt
You customize the license agreement by creating a new license file, putting the file in the custom resources
folder, and adding the resources element to the configuration file.
dunit\product.businessobjects64-4.0-core-32\setup.ui.framework\resources\ja
\license_ja.rtf
Related Information
The SAP BusinessObjects Business Intelligence platform installation program stores tools, samples, and
documentation in the Collaterals folder of the installation program. By default, a customized installation
program will contain the default Collaterals folder with the default contents. You can remove unnecessary
items from the Collaterals folder in order to reduce the size of your customized installation program. Use
the collaterals element with cleanTarget="yes" and sourcePath="<full path to custom
Collaterals folder>":
Note
You must set the cleanTarget attribute to yes so the customization tool will replace the original folder
with the new folder.
1. Copy the contents of the existing Collaterals folder to a new location, for example (on Windows) C:
\SAPCustomTool\Utilities.
2. Remove any items from C:\SAPCustomTool\Utilities that are not required by your customized
installation program. See below for more information.
3. Add the <collaterals> element to the configuration file to specify the location of the custom collaterals
folder, for example:
Collaterals > Add-Ons Provides connectivity to SAP systems. Remove if there is no need to connect to
> SAP SAP systems.
Collaterals > Add-Ons Subversion is the default version control sys Remove if the LCM feature is removed.
> Subversion tem that is used by Lifecycle Management
(LCM).
Collaterals > Add-Ons The server monitoring feature can integrate Remove if integration with IBM Tivoli is not
> Tivoli Agent with IBM Tivoli, and this item provides the required.
connectivity.
Collaterals > SAP Solution Manager Diagnostics (SMD) Remove if the SMD feature is removed.
DiagnosticsAgent7.3 agent. SMD is used by SAP Support tools to
troubleshoot installed product.
Collaterals > Docs Documentation in every language that SAP Remove any languages that are not in
BusinessObjects Business Intelligence cluded in the customized installation pro
platform supports. gram. For a list of language codes, see Lan
guage codes [page 49].
Collaterals > Tools > The SAP BusinessObjects customization Remove this folder if the customers do not
CustomizationTool tool. need to customize their own installation
programs.
Collaterals > Tools > Command-line utility for Lifecycle Manage Remove if the LCM feature is removed.
LCM command line tool ment (LCM).
Collaterals > Tools > WDeploy is used to deploy web applications Not recommended to remove. Remove only
wdeploy to web application servers other than Tom if customers will use Tomcat exclusively.
cat.
The SAP BusinessObjects customization tool is included with the SAP BusinessObjects Business Intelligence
platform installation package in this location:
Collaterals\Tools\CustomizationTool
On Windows platforms, the tool is named customizationtool.exe. On Unix and Linux platforms, the tool is
named customizationtool.sh
Note
The customization tool may take several minutes to complete. You can check its progress by viewing the
log file.
This example runs the customization tool on a Windows platform. To use this example you must:
C:\SAPCustomTool\packages\Collaterals\Tools\CustomizationTool
\customizationtool.exe
xml=C:\SAPCustomTool\oem.xml packageDir=C:\SAPCustomTool\packages outputDir=C:
\SAPCustomTool\output
logDetail=error > C:\oemlog.log
packageDir Full path to the folder that contains the installation pro packageDir=C:\SAPCustomTool
gram you are modifying. \packages\DATA_UNITS
\BusinessObjectsServer_win
The installation program is downloaded from SAP Serv
ice Marketplace in order to start the installation of SAP
BusinessObjects Business Intelligence platform. It con
tains the folders Collaterals, dunit, langs, and
setup.engine in addition to other binaries.
outputDir Full path to the folder where the customized installation outputDir=C:\SAPCustomTool
program will be created. Must be empty before running \output
the tool.
baselinePath Full path to a root folder containing the original, Assume you want to customize SAP
non-customized versions of all previous full and
BusinessObjects Business Intelligence
update installation programs you have custom
platform 4.0 Support Package 5 and you cus
ized.
tomized the previous programs: 4.0 SP2
Use a semicolon (; - Windows) or colon (: -
(Full install), 4.0 SP4. Custom
Unix) to separate multiple root folders.
ize 4.0 Support Package 5, and provide the
root folder path to the non-customized pack
ages for the 4.0 SP2 full installation and SP4
update installation. For example, if the non-
customized packages are contained in the fol
lowing directory structure:
C:\productUpdates\4.0\
\SP2 Full\
\SP4\
● error
● warn
● info
● debug
● trace
Related Information
Quick start for the Business Intelligence platform (Windows) [page 14]
Quick start for the Business Intelligence platform (Unix or Linux) [page 15]
Update installation programs are minor releases, Support Packages or Patches that contain updates to your
existing BI platform software. Support Packages contain more updates than Patches but are released less
frequently. You can use the SAP BusinessObjects customization tool to customize these update installation
programs, but some modifications to the command line and configuration file are required.
You can customize the same aspects of update installation programs as you did in the main installation
program. Because minor release, Support Package and Patch updates contain fewer installation screens, not
all of the customization steps apply. It is recommended to run the minor release, Support Package or Patch
before customizing it to determine what customizations you require.
Update installation programs use the same architecture as a main installation program for the BI platform (full
installation), so you can use the customization tool as described inCreating the configuration file [page 19] and
Running the tool [page 37], with some modifications to the command line and the configuration file. See How
to customize update installation programs [page 42] in this section.
No. As with non-customized versions of the BI platform, you only need to install the updates that you want. This
may be a minor release, Support Package, a Patch, or any valid combination of the three updates.
Yes. Both customized and non-customized updates may be applied to your customized installation. However,
non-customized minor release, Support Package, or Patch installation programs will not display your branding
or installation customizations (such as removed features or shortcut changes) you created for the main
installation program.
This scenario is not supported. The customizations that you make to update installation programs must be
consistent with the original customizations.
Ensure you have customized and installed the main installation program, such as SAP BusinessObjects
Business Intelligence platform Support Package 4 (full installation) using the instructions in Quick start for the
Business Intelligence platform (Windows) [page 14], and that the non-customized installation program is
located in C:\SAPCustomTool\packages.
This section shows you how to run the SAP BusinessObjects customization tool to customize the installation
program for a Support Package (update installation). It uses the sample configuration file provided with the
customization tool. Notice that the sample configuration file contains the <cloneProduct> element for the
main installation program as well as the <clonePatchProduct> element for a Support Package update
installation program.
Note
You can run this example only when a Support Package is available on https://support.sap.com/home.html
.
1. Download the installation program for the BI Platform 4.0 Support Package to the folder C:
\SAPCustomTool\SupportPackage.
Use the configuration tool as described in Creating the configuration file [page 19] and Running the tool [page
37] to customize update installation programs for minor releases, Support Packages, and Patches, with the
following differences:
● The configuration file must use the clonePatchProduct element (with the correct product ID), instead of
the cloneProduct element.
● The configuration file must contain the complete, original <cloneProduct> element used when
customizing the main installation package that you are updating, with no modifications. Do not add or
remove features in the <cloneProduct> element as it may cause unpredictable results, especially when
customizations involve removing features.
● The configuration file cannot contain more than one clonePatchProduct. If you are customizing both a
Support Package and a Patch for example, you must create two configuration files: one file containing
cloneProduct and clonePatchProduct for the Support Package, and the other file containing
cloneProduct and clonePatchProduct for the Patch.
● Refer to all prerequisite installation programs using the baselinePackages command.
All configuration file elements and command-line parameters can be used to customize update installation
programs, but not all of them are applicable to every minor release, Support Package, or Patch. Run the
installation program for the update first to determine what you need to customize, then use the information in
Creating the configuration file [page 19] and IDs and codes for BI Platform customization [page 44] to create
the customization file.
The configuration file for Support Packages and Patches must contain the product version in the
clonePatchProduct element as shown below:
product.boe64.patch-4.x.x.x-core-32
Example
This example configuration file customizes the SAP BusinessObjects Business Intelligence platform 4.1 Patch
1, which has the product version product.boe64.patch-4.1.0.1-core-32. The configuration file
customizes the product long name to Custom Company Server and the product short name to Custom CS.
Use the command line parameter baselinePath to refer to a root folder containing the original, non-
customized versions of all previous full or update installation programs you have customized. This means you
must keep the original installation packages.
Note
This parameter replaces the baselinePackages parameter introduced in 4.0 Feature Pack 3.
To simplify the baselinePath parameter value, reference a single root folder - the customization tool will
ignore unneeded files and folders. Otherwise, use a semicolon (; - Windows) or colon (; - Unix) in the
baselinePath value to specify multiple root folders. Consider the following examples on Windows.
Assume you are customizing BI platform 4.0 Support Package 5 Patch 2 and you customized the previous
programs: 4.0 SP2 (Full install), 4.0 SP4, 4.0 SP5, 4.0 SP5 Patch 1. Assume the non-
customized installation programs are located in the following directory structure:
C:\productUpdates\4.0\
\SP2 Full\
\SP4\
\SP5\
\SP5 Patch 1\
Assume you are customizing BI platform 4.1 Support Package 1 and you customized the previous programs:
4.0 SP2 (Full install), 4.0 SP4, 4.0 SP5, 4.1. Assume the non-customized installation
programs are located in the following directory structure:
C:\productUpdates\
\4.0\
\SP2 Full\
\SP4\
\SP5\
\4.1\
\Full\
baselinePath=C:\productUpdates\
The following section contains a list of all the IDs and codes you can use to customize the installation program:
● Feature IDs
● Shortcut deployment unit IDs (Windows only)
● String IDs
● Language codes
● Installation screen and property IDs
Use these IDs in the removeFeature element to remove features and their components from the installation
program and the installed product.
For example, this ID will remove all the web tier components, including JavaWebApps1 and
IntegratedTomcat:
<removeFeature id="WebTier"/>
If you remove the web tier feature, the web tier components will be removed from the
installation program. However, the WebTier radio button will still be visible from the
Choose Install Type screen. That is, the user will still see the three radio buttons: Full,
Custom/Expand, and WebTier. This is a known issue and will be fixed.
Note
Do not remove every database access component. You must leave at least one database access
component in order for the connection server to start and function correctly.
○ DataAccess.DataFederator
○ DataAccess.HPNeoView
○ DataAccess.MySQL
○ DataAccess.GenericJDBC
○ DataAccess.GenericODBC
○ DataAccess.GenericOLEDB
○ DataAccess.OptionalDataDirectODBC
○ DataAccess.MaxDB
○ DataAccess.SAPHANA
○ DataAccess.Salesforce (Salesforce.com)
○ DataAccess.Netezza
○ DataAccess.Microsoft_AnalyticalServices
○ DataAccess.MicrosoftExchange
○ DataAccess.MicrosoftOutlook
○ DataAccess.Microsoft_SQLServer
○ DataAccess.Microsoft_Access
○ DataAccess.Ingres
○ DataAccess.Greenplum
○ DataAccess.IBMDB2
○ DataAccess.Informix
○ DataAccess.ProgressOpenEdge
○ DataAccess.Oracle
○ DataAccess.Sybase
○ DataAccess.Teradata
○ DataAccess.SAPBW
○ DataAccess.SAPERP
○ DataAccess.XMLWebServices
○ DataAccess.OData
○ DataAccess.Excel
○ DataAccess.SAP (security and data access for SAP BW and R/3 systems)
○ DataAccess.PersonalFiles
○ DataAccess.JavaBean
○ DataAccess.OpenConnectivity
○ DataAccess.HSQLDB
○ DataAccess.Derby
Related Information
Use the deployment unit IDs in the shortcut element to change the location and name of the program
shortcuts in the Windows Start menu.
product.businessobjects64.shortcut.wdeploy- WDeploy
4.0-core
Related Information
Customizing the Windows Start menu shortcuts (Windows only) [page 23]
You can change the value of all strings in the installation program. You can replace a string for all languages or
for a specific language. Use the replaceString element, for example:
The SAP BusinessObjects customization tool uses these language codes to represent supported languages:
language Code
English EN
Czech CS
Danish DA
Dutch NL
Finnish FI
French FR
German DE
Hungarian HU
Italian IT
Japanese JA
Korean KO
Norwegian Bokmal NB
Polish PL
Portuguese PT
Romanian RO
Russian RU
Slovak SK
Spanish ES
Swedish SV
Thai TH
Turkish TR
Use the installation screen IDs in the removeDialog element to remove screens from the installation program.
For example, use this element to remove the User Information screen:
<removeDialog id="EnterProductKey.dialog"/>
Use the properties and the property values to prepopulate user input. For example, use this element to set the
default installation type to custom:
Note
Select Installer SelectUILanguage. SortedAvailableSetup Set of language codes that the installa
Language dialog Languages tion program can be run in, for example
"en;ja"
Configure Sybase GetSQLAnywhereInf SQLAnywhereServerNam The SQL Anywhere server name (Unix
SQL Anywhere o.dialog e and Linux only)
Configure HTTP GetWACSPort.dialo WACSPort Port number for the web application
Listening port g container service
ExistingAuditingDBUs Username
er
ExistingAuditingDBPa Password
ssword
ExistingAuditingDBUs Username
er
ExistingAuditingDBPa Password
ssword
ExistingAuditingDBUs Username
er
ExistingAuditingDBPa Password
ssword
ExistingAuditingDBPa Password
ssword
ExistingAuditingDBPa Password
ssword
ExistingCMSDBPasswor Password
d
ExistingCMSDBPasswor Password
d
ExistingCMSDBPasswor Password
d
ExistingCMSDBPasswor Password
d
ExistingCMSDBPasswor Password
d
ExistingCMSDBPasswor Password
d
LCMPassword Password
Related Information
4.1 Introduction
You can apply your own branding (or “skinning”) to the BI launch pad, OpenDocument, and Crystal Reports
JavaScript viewer web applications. For example, you can customize your BI platform systems by applying your
own corporate identity elements.
You can customize many aspects of the BI platform web applications, and you may choose to customize only a
subset of these options.
This section is intended for web application designers, developers, and system administrators who are
customizing BI platform web applications. Familiarity with the basics of CSS design and Java web application
archives is required. If you are deploying customizations, then you should also be familiar with the methods to
install and deploy BI platform web applications to an application server.
For information on installing the SAP BusinessObjects Business Intelligence platform, see the Business
Intelligence Platform Installation Guide.
For information on deploying BI platform web applications using the WDeploy tool, see the Business
Intelligence Platform Web Application Deployment Guide.
To make and deploy your customizations, you should understand the following concepts:
The installation package is the set of binaries that are downloaded from SAP Service Marketplace in order to
start the installation of SAP BusinessObjects Business Intelligence platform. It contains the folders
Collaterals, dunit, langs, and setup.engine in addition to other binaries.
Customization template
BOE.war is the primary web application archive for the BI platform. BI launch pad, OpenDocument, the Crystal
Reports JavaScript viewer, and the changes you make in template.zip to their respective branding bundles
are included by the installation program in BOE.war. To deploy your customizations and make these
applications available to your customers, you must deploy BOE.war to your Java application server either
during or after the installation process.
Branding bundles
A branding bundle is a JAR file that contains the custom resources (CSS, icons, images, JavaScripts) that you
include in the installation program within template.zip. The following branding bundles are included:
\com.businessobjects.webpath.InfoViewBranding\web
\css
customize.css
\images
favicon.ico
\theme
*.png, *.gif
● com.businessobjects.webpath.OpenDocumentBranding.jar (OpenDocument)
This branding bundle consists of two main folders: a css folder containing a custom CSS file, and an
images folder containing a theme subfolder with custom logos and images.
\com.businessobjects.webpath.InfoViewBranding\web
\service
\css
customize.css
\images
\com.businessobjects.webpath.CrystalReports_oem\web
CustomListener.js
\WEB-INF\classes
JSAPI-properties.json
\images
*.png
The SAP BusinessObjects Business Intelligence platform installation program can deploy BOE.war only to the
bundled Tomcat web application server. Other supported web application servers require that you deploy the
web applications after the installation is complete. It is recommended that you use the WDeploy tool.
Before performing customizations on your production systems, it is good practice to test your customizations
first on a test installation. In a default installation that uses the bundled Tomcat server, you can instantly see
the effects of your changes by making temporary modifications to the webpath.InfoViewBranding,
webpath.OpenDocumentBranding, and webpath.CrystalReports_oem folders in the Tomcat work
directory: \SAP BusinessObjects\tomcat\work\Catalina\localhost\BOE\eclipse\plugins
\webpath.OpenDocumentBranding\web\service. These folders have the same structure as the branding
resources contained in template.zip.
Note
The Tomcat work directory is not permanent and your temporary changes are deleted after a Tomcat
restart.
This section shows you the basic steps required to customize and deploy one of the BI platform web
applications: BI launch pad. The steps shown are also applicable to OpenDocument and the Crystal Reports
JavaScript viewer.
This quick start describes the end-to-end customization, including performing a full installation of SAP
BusinessObjects Business Intelligence platform and the deployment of BOE.war to an application server.
These steps may take considerable time.
1. Locate template.zip in your SAP BusinessObjects Business Intelligence platform installation package
at: \Collaterals\Tools\CustomizationTemplate.
2. Extract the contents of template.zip to a working folder.
template.zip contains the branding bundles, for example, \SAP BusinessObjects Enterprise XI
4.0\warfiles\webapps\BOE\WEB-INF\eclipse\plugins
\com.businessobjects.webpath.InfoViewBranding.jar
3. Unpackage the BI launch pad branding bundle
com.businessobjects.webpath.InfoViewBranding.jar.
jar xf com.businessobjects.webpath.InfoViewBranding.jar
4. Customize the default favicon that is displayed in the browser URL bar for BI launch pad.
The BI launch pad branding bundle contains a sample favicon. Copy \web\sample\images
\favicon.ico up one level to \web\images\favicon.ico.
5. Repackage com.businessobjects.webpath.InfoViewBranding.jar containing your new favicon,
and include it in template.zip.
To repackage the web and META-INF folder contents back into
com.businessobjects.webpath.InfoViewBranding.jar:
Option Description
Use the bundled Tomcat server Selected during the installation process.
Use your own supported Java application Performed after the installation program completes. Use the WDeploy
server tool.
9. After successful installation and deployment, test your changes by accessing BI launch pad: http://<web
server name>:<port>/BOE/BI
You can see the new favicon in your browser URL bar:
You can customize the BI Launch pad either through in-app settings or through Theme Designer.
For more information on personalizing the BI Launch pad, refer to the Personalizing Your BI Launch Pad section
of the Business Intelligence Launch Pad User Guide.
You can customize the theme of BI Launch pad through Theme Designer. It lets you make a change as simple
as a logo change or as detailed as a complete re-skinning of the user interface.
Theme Designer helps you customize the view of Fiorified BI Launch pad.
It helps to differentiate your application by applying your unique corporate branding. It lets you personalize the
appearance of the Fiorified Bi Launch pad by applying your company logo and background colors, and
modifying other elements of the user interface.
● Logo
● Background Image and Color
● Background Opacity
● Background Image Repetition
● Icon Color
● Icon Hover and Select Color
● Title Text Color
● Text Color of UI elements
Note
The Theme Designer was developed specifically to customize the Fiorified BI Launch Pad. However, some
properties exposed in Theme Designer can also impact other web applications that don't support custom
themes such as Web Intelligence, making the UI unstable. Please make sure your customization has limited
impact on other applications.
This section is intended for administrators who are customizing the Fiorified BI Launch pad. If you are
deploying customization, then you should also be familiar with the methods to deploy the BI platform web
applications to an application server.
For more information on deploying the BI platform web applications using the WDeploy tool, see the Business
Intelligence Platform Web Application Deployment Guide.
As an administrator you can use Theme Designer to create a new theme or to customize the existing view of
the Fiorified BI Launch pad.
You can create a custom theme for the Login Page, My Home-Tile View, and My Home-List View.
1. Copy the ThemeDesigner.war file from the BusinessObjects Enterprise Installation Package:
Collaterals\themeDesigner\ folder and deploy into the respective web application server.
Note
Jboss and Tomcat web application servers are supported for ThemeDesigner.war file deployment.
The Theme Designer editor page appears, with a Global Settings pane to customize the Fiorified BI Launch
pad and a Preview pane.
3. On the Global Settings pane, customize your theme using the options below:
○ Company Logo - You can choose an image to change the company logo.
○ Background Image - You can choose a background image to customize the background of the Fiorified
BI Launch pad.
Note
○ You can choose an image, of filetype .png, from your local computer.
○ The image should be less than 2MB. An error message is displayed if the file size is too large.
○ Background Opacity - You can customize the brightness of the selected background image. You can set
the opacity in the slider between 0 (minimum) to 1 (maximum).
○ Background Repeat - You can enable this option to zoom in and repeat the background image.
Note
Upload the image of size 512*308 pixels for better performance of the Background Repeat
functionality.
○ Background Color - You can select the desired shade of colors from the color palette to customize your
background color.
○ Icon Color - You can choose a color from the color palette to customize the color of the icon.
○ Item Hover Color - You can choose the color that appears for the icon when you hover on it.
○ Item Select Color - You can choose the color that appears for the icon when you select it.
○ Title Text Color - You can customize the color of a UI text in the Header panel and Tool Bar of the
Fiorified BI Launch pad.
○ Text Color - You can customize the text of the other UI texts in the Fiorified BI Launch pad.
Note
The Details Drawer of the Home page in list view always remains in the default theme.
You can observe the reflected changes simultaneously in Preview pane beside the Global Settings pane.
The custom-css.zip file is downloaded to your local computer, containing the company logo,
background image, and theme.css.
Sample Code
4. To customize the URL of the Fiorified BI Launch pad with a custom naming like myBI, add the property
app.url.name=/myBI
Note
If you customize the URL to access the Fiorified BI Launch pad, the administrator must perform the
following steps to change the folder and category link.
1. Log on to the Central Management Console(CMC) and select Applications BI launch pad
Processing settings .
2. Make the changes in the default folder URL for the New Fiorified BI Launch Pad URL (must be URL
encoded) as http://(HOSTNAME):(WEB_APPLICATION_SERVER_PORT)/BOE/myBI?
startFolder=%SI_CUID%, where myBI is the custom name used in app.url.name property.
For information on using WDeploy, see the SAP BusinessObjects Business Intelligence Platform Web
Application Deployment Guide.
8. Restart the Web Application Server.
9. Log on to the Fiorified BI Launch pad to see the custom theme.
Make a backup of the extracted custom-css file before the BOE upgrade. After the upgrade, perform all the
steps mentioned above to apply the custom theme to Fiorified BI Launch pad.
As an administrator, you can use the Theme Designer or modify the rules in Theme.css file to edit the custom
theme.
Only the previously customized CSS features of the theme are shown in the preview pane. You can upload
the company logo, background image, and modify the desired theme properties to edit the selected theme.
3. Download the theme (custom-css.zip) and repeat the steps in to reflect the changes in the Fiorified BI
Launch pad.
For OpenDocument, you can customize the logo, backgrounds, and styles of the logon page. Most of these
customizations involve changing the CSS rules in the customize.css file. All customizations must be made
available in the web\service folder of com.businessobjects.webpath.OpenDocumentBranding to take
effect, as follows:
\web
\service
customize.css
\images
\theme
*.png
Note
Sample customizations are provided in the JAR file. For example, when you open
com.businessobjects.webpath.OpenDocumentBranding, there is a web\sample folder which
includes a sample CSS file, sample images, and a README file.
The following diagram shows the elements customized in the sample branding bundle, for reference purposes.
The numbers in the balloons refer to sections in the bundle's customize.css file.
This section shows how to customize the report viewer included in your BI platform deployment.
● A custom logo
● SAP Crystal Reports JavaScript API event and action listeners
● CSS files
● External JavaScript files or libraries
You can repackage the template.zip file with the files you are using to customize the report viewer.
Note
It is recommended to make a backup copy of the template.zip file before modifying its contents.
template.zip Modify
CrystalReports_oem.jar Modify
\WEB-INF\classes\JSAPI-properties.json Add a relative path to all images, JavaScript files, and CSS
files added to the \web folder. You can also change the logo
that will be displayed by the viewer.
{
"logo" :
{
"img" : "images/logo.gif",
&product=crystalreports&version=14%2E0
"
},
"scripts" :
[
CustomListener.js
\CustomFiles\*.js
],
"styles" :
[
\CustomStyle.css
]
}
Note
All files referenced in the JSAPI-
properties.json file must be included in the \web
folder.
SAP Crystal Reports 2020 can be repackaged and sold by partners. You can customize the installed product
and the installation program to create a seamless experience for customers. The SAP BusinessObjects
customization tool customizes SAP Crystal Reports and its installation program with changes such as the
following:
To make customizations, you write a configuration file to specify the customizations then run the SAP
BusinessObjects customization tool to create a customized installation program. Customers can then use this
installation program to install a customized version of the product.
The customization tool can be used to customize a full installation program, a Support Package installation
program, and a Patch installation program.
This section shows you how to run the customization tool to create a customized installation program for SAP
Crystal Reports. It uses the sample configuration file that is provided with this tool. When you finish this
tutorial, you can run your customized installation package and install a customized version of Crystal Reports.
The customizations include changing the default installation type, removing features, hard-coding the product
keycode, changing the default installation folder, renaming the product, and changing the Windows Start menu
shortcut. These customizations are described in more detail in the configuration file.
Note
The customization tool may take several minutes to complete. You can check its progress by viewing
the log file.
Crystal Reports is installed with the customizations described in the configuration file C:\SAPCustomTool
\packages\Collaterals\Tools\CustomizationTool\example_customization_win_cr.xml.
The software may take a long time to download, and you may need to contact the system administrator to
ensure that your company's firewall will not terminate the download process.
Support Packages and Patches are installation programs that contain updates to SAP Crystal Reports. You can
download them from https://support.sap.com/home.html . On the Find your software tab, under the A–Z
Index, click Support Packages and Patches. For more information on installing Support Packages and Patches,
see Customizing update installation programs [page 95].
1. Download the installation program. See To download the installation program [page 70].
2. Decide what customizations are required. See Creating the configuration file [page 72].
3. Write the configuration file to specify the customizations.
4. Run the customization tool to create a customized installation program.
5. Run the customized installation program to install a customized version of SAP Crystal Reports.
You may want to validate the configuration file before running the tool. Use the validate command-line
parameter.
Customers prefer a smaller installation program and a smaller installed product. To keep the product as small
as possible:
The product name and version number appear in several places in the installation program and in the installed
product. Ensure you verify customizations in the following locations:
It is good practice to consider how the customized name appears in all supported languages.
You must apply the same customizations to Support Packages and Patches that you applied to the main
release. If you release a customized main installation program and then try to release a Support Package or
Patch installation program with different customizations, you might see unpredictable results which might not
be repairable using standard rollback procedures.
Test rollback, modify, and repair installations for Support Packages and
Patches
Rollback, modify, and repair installations are supported for customized Support Packages and Patches,
provided they have been customized in a manner consistent with the main installation package. It is
recommended to test these scenarios.
Related Information
The following section describes the customizations you can make to the installation program by editing the
configuration file:
The SAP BusinessObjects customization tool uses information in the configuration file to perform the
customizations. The configuration file is an XML document, and you use XML elements to describe your
customizations. The sample configuration file is contained in this folder in the installation program:
Collaterals\Tools\CustomizationTool\example_customization_win_cr.xml
The configuration file for the full installation program can have any name, for example, oem.xml.
The configuration file for the Support Package installation program is described in the section How to
customize update installation programs [page 97].
Note
The configuration file must be written in correct XML syntax. Use an XML editor to create and edit the file,
and verify that the format is correct before running the tool.
Example
● Change the product's long name to “Custom Company Crystal Reports” for all languages.
● Change the product's short name to “Custom CR” for all languages.
● Change the publisher and product name for the Windows Add Remove Program entry.
● Remove the installation screen titled Choose Installation Type and set the installation type to Custom.
● Specify that the only language packs that are included in the installation package are English, French,
German, Italian, and Chinese.
<oem name="CustomCompanyCrystalReports">
<cloneProduct sourceId="product.crystalreports-4.0-core-32">
<replaceString id="product.cr_name" value="Custom Company Crystal
Reports" lang="all"/>
You can customize the product name and version number. Use the replaceString element with the desired
string ID:
There are four strings that represent the product name and version number: the product long name, the
product short name, the product version number, and the product major version number. The full product
name is composed of the product long name and the version number. The product short name and product
major version are used in the Windows shortcut menu.
Note
You should customize the product version and product major version together. For example, if you change
product version to “1.0” you should also customize product major version to “1”. Otherwise the version
number in the menus will not match the version number in the product.
Example
● Change the product long name to “Custom Company Crystal Reports” and the product short name to
“Custom CR” for English.
● Change the product long name to “Custom Company Crystal Reports (French)” and the product short
name to “Custom CR (French)” for French.
● Change the product version to “1.0” and the product major version to “1” for all languages.
The product name in languages other than English and French will remain as the default value, but the product
version and major version will be changed for all languages.
The result of the customization appears below. Notice the version number “FP3” is not removed:
When you run the installation program, you may see instances of “FP3” in the product name. To remove “FP3”,
modify the lines in the following files:
You must modify one file for every language that the installation program supports. For a list of language codes,
see Language codes [page 103]. When you run the customization tool, and then run the installation program,
all instances of “FP3” will be removed. This process will be simplified in a future release.
Example
To remove “FP3” from the English installation program, modify the following files:
● product.lang_en.uitext.xml
● setup.ui.framework.lang_en.uitext
The Windows Start menu contains shortcuts for features such as the ODBC Data Source Administrator. You
can customize the name, location, and tooltip for each shortcut. Any shortcut that you do not customize will be
grouped under the default Start menu entry, SAP Business Intelligence.
Use the shortcut element to customize the location, shortcut name, and tooltip for each feature:
Attribute Value
duSourceId The shortcut deployment unit ID that you want to modify. Typical values include:
● product.crystalreports.shortcut.crw-4.0-core
Crystal Reports 2020
● product.crystalreports.shortcut.odbc-4.0-core
ODBC Data Source Administrator
● product.crystalreports.shortcut.rptpubwiz-4.0-core
Report Upload Wizard
For a complete list of duSourceId values, see Shortcut deployment unit IDs [page 102].
linkFullPath The full path to the shortcut link. Be sure to add .lnk to the shortcut link or the link will not be
created. You can put the link in the Start menu or you can put it on the desktop. The SAP Busi
nessObjects customization tool will create the links correctly.
You can specify one link for each language. For a list of language codes, see Language codes
[page 103].
description The tooltip string to display when the user hovers the mouse over the shortcut. You can specify
one tooltip for each language.
● Change the name of the Crystal Reports 2020 shortcut to “Custom Company CR” for English.
● Customize the Crystal Reports 2020 tooltip to “Launch Custom Company CR” for English.
● Change the name of the “ODBC Data Source Administrator” shortcut to “Custom ODBC” for English.
● Customize the “ODBC Data Source Administrator” tooltip to “Custom ODBC” for English.
● Place the “Custom Company CR” and “Custom ODBC” shortcuts under the Start menu entry called
“Company Programs”.
● Change the name of the “Report Upload Wizard” shortcut to “Custom Wizard” for English.
● Place the “Custom Wizard” shortcut under the Start menu entry called “Custom Wizard”.
● Customize the “Custom Wizard” tooltip to “Launch Custom Wizard” for English.
The shortcut name and tooltip will remain unchanged for all other languages.
Note
To use this example you must create the following links and folders:
Place Custom Company CR.lnk and Custom ODBC.lnk in the folder Company Programs and place
Custom Wizard.lnk in the folder Custom Wizard. Place these folders in the same location you plan to
redirect the installation folder to.
In this example, the installation folder has been redirected to the C:\ drive. See Customizing the
installation folder [page 81] for more information.
<shortcut duSourceId="product.crystalreports.shortcut.crw-4.0-
core">
<arg id="linkFullPath" value="[programmenufolder]\Company Programs\Custom
Company CR.lnk" lang="en"/>
<arg id="description" value="Launch Custom Company CR" lang="en"/>
</shortcut>
<shortcut duSourceId="product.crystalreports.shortcut.odbc-4.0-
core">
<arg id="linkFullPath" value="[programmenufolder]\Company Programs\Custom
ODBC.lnk" lang="en"/>
<arg id="description" value="Custom ODBC" lang="en"/>
</shortcut>
<shortcut duSourceId="product.crystalreports.shortcut.rptpubwiz-4.0-
core">
<arg id="linkFullPath" value="[programmenufolder]\Custom Wizard\Custom
Wizard.lnk" lang="en"/>
<arg id="description" value="Launch Custom Wizard" lang="en"/>
</shortcut>
This example keeps the default name of the “Report Upload Wizard” feature shortcut, but places it under the
Start menu entry called “Custom Wizard” for all languages. It also changes the “Custom Wizard” tooltip to
“Launch Custom Wizard” for all languages.
Note
To use this example you must place the Report Upload Wizard.lnk in the folder Custom Wizard.
Place this folder in the same location as the installation folder.
In this example, the installation folder has been redirected to the C:\ drive.
<shortcut duSourceId="product.crystalreports.shortcut.rptpubwiz-4.0-
core">
<arg id="linkFullPath" value="[programmenufolder]\Custom Wizard\Report Upload
Wizard.lnk" lang="all"/>
<arg id="description" value="Launch Custom Wizard" lang="all"/>
</shortcut>
You can customize the display name, the publisher, and the icon in the Windows Add Remove Program (ARP)
utility. Use the following element:
<arp duSourceId="product.crystalreports.arp-4.0-core">
<arg id="publisher" value="<publisher name>"/>
<arg id="display_name" value="<product name>" lang="<language list>"/>
<arg id="display_icon" value="<full path to icon>"/>
</arp>
The display name must have a lang tag to specify a different display name for each language. Multiple
languages using the same display name must be separated by a semi-colon. Any unspecified languages will
use the default value.
Note
You must take additional steps in order for the customized value of the publisher to display correctly in the
ARP. Follow these steps:
After you customize the publisher name in the configuration file, run the customization tool, and then
install the customized product, your customized value for the publisher displays in the ARP. This process
will be simplified in a future release.
Icons displayed in the Windows ARP utility are typically 16x16. Refer to Windows documentation for complete
information on creating the icon.
Example
This example makes the following customizations in the Windows ARP utility:
● Change the product name to “Custom Company Crystal Reports Patch 1” for English and French.
● Change the product name to “Custom Company Crystal Reports (German)” for German.
● Change the publisher to “Custom Company”.
● Replace the display icon with the icon C:\SAPCustomTool\CC_logo.ico.
Note
To use this example you must put an icon called CC_logo.ico in the location C:\SAPCustomTool.
<arp duSourceId="product.crystalreports.arp-4.0-core">
<arg id="publisher" value="Custom Company"/>
<arg id="display_name" value="Custom Company Crystal Reports Patch 1"
lang="en;fr"/>
<arg id="display_name" value="Custom Company Crystal Reports (German)"
lang="de"/>
<arg id="display_icon" value="C:\SAPCustomTool\CC_logo.ico"/>
</arp>
You can customize the location of the default installation folder. Use the replaceProperty element with
id="<installation folder file path>":
Example
You can customize the default value of the user input that is collected by the installation program. Use the
replaceProperty element with id="<property id>" and the new default value:
For a list of property IDs, see Installation screen and property IDs [page 104].
The Windows installation program collects user input using dialog boxes, radio buttons, and other user
interface elements.
Example
On the installation screen called Choose Install Type, the default install type is Typical. This example changes
the default install type to Custom.
You can remove installation screens from the installation program. Use the removeDialog element with the
installation screen ID:
For a list of installation screen IDs, see Installation screen and property IDs [page 104].
Example
This example shows how to remove the installation screen titled Select Features.
<removeDialog id="SelectFeatures.dialog"/>
You can embed a keycode in the installation program so the customer does not need to enter one. This task
involves:
Example
Use the replaceProperty element with id="ProductKey" to provide a default keycode. Keycodes must
have the format XXXXX-XXXXXXX-XXXXXXX-XXXXXXX-XX.
Use the removeDialog element with id="CREnterProductKey.dialog" to remove the installation screen
for the license key.
Related Information
SAP Crystal Reports includes many optional features. You can remove a feature from the installation program.
Use the removeFeature element with id="<feature id>":
When you specify a feature to be removed, the SAP BusinessObjects customization tool removes all
executables, installation screens, and other files that belong to that feature. Removing unnecessary features is
a good way to reduce the size of the customized product.
Remove the geographic mapping feature. This ID will remove the program's ability to display relationships
between data and geographic regions:
<removeFeature id="Mapping"/>
Prerequisites are conditions that must exist on the host machine in order for the installation program to
succeed. The installation program verifies the existence of these prerequisites before starting, and displays the
results in the Prerequisite check screen. Removing the Prerequisite check screen prevents prerequisite checks
from being performed. Use the removeDialog element with id="CheckPreRequisites.dialog"
Note
It is recommended that you remove this installation screen only if you are performing the prerequisite
checks by some other means. If the prerequisites are not met, the installation program will fail.
Example
This example removes the Prerequisite check screen and prevents prerequisite checks from being performed.
<removeDialog id="CheckPreRequisites.dialog"/>
The installation program allows the user to select which language packs to install. A language pack contains
translated versions of all the strings that are used by the installed product. By default, all possible language
packs are included in the installation program. You can specify which language packs to include. Use the
languageIncludeList element with a list of language codes:
Note
Language packs can be large. The installation program will be smaller if fewer language packs are included.
Include English, French, and German language packs in the installation program. The user can select from this
list during installation.
<languageIncludeList value="en;fr;de"/>
The installation program stores image and text files as resources in this folder:
dunit\product.crystalreports-4.0-core-32\setup.ui.framework\resources
You can customize the resources in this folder. Resources that are commonly customized include:
To customize a resource:
1. Create a custom resources folder, for example C:\MyResources. The folder can have any name, but note
that it will be visible to customers. Use the same folder for all resources that you customize.
2. Create a new resource with the same name and filepath as the original resource, and place it into the
custom resources folder. See the related topics section for specific examples.
3. Add the <resources> element to the configuration file to specify the location of the custom resources
folder, for example:
<resources cleanTarget="no" sourcePath="C:\MyResources"/>
cleanTarget attribute
If you set cleanTarget='yes', the customization tool will delete the original resources folder and use only
those resources in the custom resources folder. This option is not recommended.
Related Information
You can customize the images in the installation program including the welcome screen, the top image for all
screens, and the billboard for the progress dialog. Images are stored as files in the resources folder:
You customize an image by creating a new image file, putting the file in the custom resources folder, and adding
the resources element to the configuration file.
Related Information
You can customize the license agreement that is presented to the user during installation. License agreements
are stored as text files in the resources folder:
dunit\product.crystalreports-4.0-core-32\setup.ui.framework\resources\<language
code>
dunit\product.crystalreports-4.0-core-32\setup.ui.framework\resources\en
\license_en.rft
You customize the license agreement by creating a new license file, putting the file in the custom resources
folder, and then adding the resources element to the configuration file.
dunit\product.crystalreports-4.0-core-32\setup.ui.framework\resources\en
\license_en.rtf
Related Information
The SAP Crystal Reports installation program stores tools, samples, and documentation in the Collaterals
folder of the installation program. By default, a customized installation program that is delivered to customers
will also contain the Collaterals folder with the same contents. You can remove unwanted items from the
Collaterals folder in order to reduce the size of your customized installation program. Use the
Note
You must set the cleanTarget attribute to yes so that the customization tool will replace the original
folder with the new folder.
1. Copy the contents of the existing Collaterals folder to a new location, for example C:\MyCollaterals.
2. Remove any items from C:\SAPCustomTool\Collaterals that are not required by your customized
installation program.
3. Add the <collaterals> element to the configuration file to specify the location of the custom collaterals
folder, for example:
Collaterals > Add- Provides connectivity to SAP systems. Remove this folder if there is no need to con
Ons > SAP nect to SAP systems.
Collaterals > Contains the sample template.zip file Remove this folder if the customers do not
CustomizationTempla for customizations to the report designer. need to provide a sample template.zip
te file.
Collaterals > Docs Documentation in every language that Remove any languages that are not included in
Crystal Reports supports. the customized installation program. For a list
of language codes, see Language codes [page
103].
Collaterals > Tools The SAP BusinessObjects customization Remove this folder if the customers do not
> CustomizationTool tool. need to customize their own installation pro
grams.
● Splash screen
● Start page
● String values on the menu
When Crystal Reports is run, a splash screen loads. You can replace this splash screen with your own bitmap.
Note
The following steps assume you already installed Crystal Reports. If you want to deploy the splash screen
into your customized installation program, rename the bitmap you want to use for the splash screen to
splash.bmp and follow the instructions in Deploying the OEM customization file [page 91].
1. Rename the bitmap you want to use for the splash screen to splash.bmp.
Note
The bitmap must be a valid .bmp file and can be of any size.
When Crystal Reports is run, splash.bmp should load. If it does not load, then the default splash screen loads
instead.
You can modify the content of the start page with your own HTML file. Most of your customizations will affect
the top part of the start page. You can also remove the bottom part, which contains links to SAP Crystal
Reports web pages.
Note
The following steps assume you already installed Crystal Reports. If you want to deploy the start page into
your customized installation program, rename the HTML file you want to use for the start page to
start.html and follow the instructions in Deploying the OEM customization file [page 91].
1. Rename the HTML file you want to use for the start page to start.html.
2. Place start.html in the Start Page\<language code> sub-folders, depending on the languages you
want to support.
Note
For a list of all language codes, see Language codes [page 103].
Tip
Your HTML file should use relative paths to point to this folder.
When Crystal Reports is run, the start page will display the customizations you made in start.html.
You can modify string values on the menu that contain the product name SAP Crystal Reports. Such values are:
AboutCrystalReport About product help Help menu About SAP Crystal Reports
To customize these strings, an XML file is required. The XML file name must have the following format:
crw_oem_res_<language code>.xml
crw_oem_res_en.xml
Note
If you have already installed Crystal Reports, then the XML file should be placed in the same folder as
crw32.exe. By default, this is found in:
When Crystal Reports is run in a specific language, the corresponding language XML file is loaded.
Note
If you want to deploy the customized strings into your customized installation program, follow the
instructions in Deploying the OEM customization file [page 91].
<Root>
<ProductName>Custom CR</ProductName>
<MainFrameMenu>
<Help>
<CrystalReportHelp>Custom CR help</CrystalReportHelp>
<AboutCrystalReport>About Custom CR</AboutCrystalReport>
</Help>
</MainFrameMenu>
</Root>
Note
● To support multiple languages, the attribution encoding should be UTF-8: <?xml version="1.0"
encoding="UTF-8"?>. In addition, when the XML file is saved with a text editor, select UTF-8 from the
Encoding menu.
● Keep the property name and value in the same line. For example the following is acceptable:
<ProductName>Custom CR</ProductName>
The following is not acceptable. There will be unrecognizable characters in the modified strings when
Crystal Reports is run:
<ProductName>
Custom CR
</ProductName>
After you prepare your customized files (splash images, start page, and menu strings), you can deploy your
customizations into the installation package. Place the customized files in a zip file.
Note
The folder structure within the zip file must match the structure of the folder where you want the files
placed, relative to the installation folder. Files must be placed in the following location in
template.zip: SAP BusinessObjects Enterprise XI 4.0\win32_x86.
For example, the following customized files are placed in these locations in template.zip:
Note
Note
In the install package of SAP Crystal Reports, there is a sample zip file located in:
Collaterals\CustomizationTemplate\template.zip
The SAP BusinessObjects customization tool customizationtool.exe is included with the SAP Crystal
Reports installation package in this location:
Collaterals\Tools\CustomizationTool
This section explains the command line parameters used for the tool.
Note
The SAP BusinessObjects customization tool may take several minutes to complete. You can check its
progress by viewing the log file.
Example
This example runs the customization tool and creates a log file located in the C:\ drive. To use this example,
you must do the following:
For more information on how to run the SAP BusinessObjects customization tool, see Quick start for Crystal
Reports [page 69].
packageDir Full path to the folder that contains the installation pro packageDir=C:\SAPCustomTool
gram you are modifying. \packages\DATA_UNITS
\BusinessObjectsServer_win
The installation program is downloaded from SAP
Service Marketplace in order to start the installation of
SAP Crystal Reports. It contains the folders
Collaterals, dunit, langs, and
setup.engine in addition to other binaries.
outputDir Full path to the folder where the customized installa outputDir=C:\SAPCustomTool
tion program will be created. Must be empty before \output
running the tool.
baselinePath Full path to a root folder containing the original, Assume you want to customize SAP Crystal
non-customized versions of all previous full and
Reports 2011 Support Package 5 and you cus
update installation programs you have custom
tomized the previous programs: 2011 (Full in
ized.
stall), 2011 SP4. Customize 2011 Support
Use a semicolon (;) to separate root folders. Package 5, and provide the root folder path to
the non-customized packages for the major
2011 release and Support Package 4 release.
For example, if the non-customized packages
are contained in the following directory struc
ture:
C:\productUpdates\2011\
\2011 Full\
\SP4\
logDetail The level of detail tracked in the log file. The de logDetail=warn
fault value is info. The following are the ac
cepted values:
● error
● warn
● info
● debut
● trace
action The tool mode. The following are the accepted action=validate
values:
Related Information
Update installation programs are Support Packages or Patches that contain updates to your existing SAP
Crystal Reports software. Support Packages contain more updates than Patches but are released less
frequently. You can use the SAP BusinessObjects customization tool to customize these installation programs,
but some modifications to the command line and configuration file are required.
You can customize the same aspects of update installation programs as you did in the main installation
program. Because Support Package and Patch updates contain fewer installation screens, not all of the
customization steps apply. It is recommended to run the Support Package or Patch before customizing it to
determine what customizations you require.
Update installation programs use the same architecture as a main installation program for Crystal Reports (full
installation), so you can use the customization tool as described in Creating the configuration file [page 72] and
Running the tool [page 92], with some modifications to the command line and the configuration file. For more
information, see How to customize update installation programs [page 97] in this section.
No. As with non-customized versions of Crystal Reports, you only need to install the updates that you want.
This may be a Support Package, a Patch, or both.
Yes. Both customized and non-customized Support Packages or Patches may be applied to your customized
installation. However, non-customized Support Package or Patch installation programs will not display your
branding or installation customizations you created for the main installation program.
This scenario is not supported. The customizations that you make to Support Packages and Patches must be
consistent with the original customizations.
Ensure that you have customized and installed the main (full) installation program (SAP Crystal Reports) using
the instructions in Quick start for Crystal Reports [page 69], and that the non-customized installation package
is located in C:\SAPCustomTool\packages.
This section shows you how to run the SAP BusinessObjects customization tool to customize the installation
program for a Support Package. It uses the sample configuration file provided with the customization tool.
Notice that the sample configuration file contains the <cloneProduct> element for the main installation
program as well as the <clonePatchProduct> element for a Support Package installation program.
Note
You can run this example only when a Support Package is available on https://support.sap.com/home.html
.
1. Download the installation program for the Crystal Reports Support Package to the folder C:
\SAPCustomTool\SupportPackage.
2. Ensure the product_cr_version for the <clonePatchProduct> element in the configuration file
matches the version number of the Support Package that you downloaded. See Customizing the product
name and version number [page 74].
Use the configuration tool as described in Creating the configuration file [page 72] and Running the tool [page
92] to customize update installation programs for Support Packages and Patches, with the following
differences:
● The configuration file must use the clonePatchProduct element (with the correct product ID), instead of
the cloneProduct element.
● The configuration file must contain the complete <cloneProduct> element for the main installation
package that you are updating. If it does not, it may cause unpredictable results, especially when
customizations involve removing features.
● The configuration file cannot contain more than one clonePatchProduct. If you are customizing both a
Support Package and a Patch, you must create two configuration files: one file containing cloneProduct
and clonePatchProduct for the Support Package, and the other file containing cloneProduct and
clonePatchProduct for the Patch.
● Refer to all prerequisite installation programs using the baselinePath command.
All configuration file elements and command-line parameters can be used to customize update installation
programs, but not all of them are applicable to every Support Package or Patch. Run the installation program
for the Support Package or Patch first to determine what you need to customize, then use the information in
Creating the configuration file [page 72] and IDs and codes for Crystal Reports customization [page 99] to
create the customization file.
The configuration file for update installation programs must contain the product version in the
clonePatchProduct element as shown below:
product.cr.patch-4.x.x.x-core-32
You can use the name of this folder as the product version.
Example
This example configuration file customizes SAP Crystal Reports 2011 Patch 1, which has the product version
product.cr.patch-4.1.0.1-core-32. The configuration file customizes the product long name to Custom
Company Crystal Reports and the product short name to Custom CR.
Use the command line parameter baselinePath to refer to a root folder containing the original, non-
customized versions of all previous full or update installation programs you have customized. This means you
must keep the original installation packages.
Note
This parameter replaces the baselinePackages parameter introduced in 2011 Feature Pack 3.
To simplify the baselinePath parameter value, reference a single root folder - the customization tool will
ignore unneeded files and folders. Otherwise, use a semicolon (;) in the baselinePath value to specify
multiple root folders. Consider the following examples.
Assume you are customizing Crystal Reports 2011 Support Package 5 and you customized the previous
programs: 2011 (Full install), 2011 SP4. Assume the non-customized installation programs are
located in the following directory structure:
C:\productUpdates\2011\
\2011 Full\
\SP4\
baselinePath=C:\productUpdates\2011\
Assume you are customizing Crystal Reports 2011 Support Package 5 Patch 2 and you customized the
previous programs: 2011 (Full install), 2011 SP4, 2011 SP5, 2011 SP5 Patch 1. Assume the
non-customized installation programs are located in the following directory structure:
C:\productUpdates\2011\
\2011 Full\
\SP4\
\SP5\
\SP5 Patch 1\
baselinePath=C:\productUpdates\2011\
Related Information
The following section contains a list of all the IDs and codes you can use to customize the installation program:
● Feature IDs
● Shortcut deployment unit IDs
● String IDs
● Language codes
● Installation screen and property IDs
Use feature IDs in the removeFeature element to remove features and their components from the installation
program and the installed product.
For example, this ID will remove support for displaying relationships between data and geographic regions:
<removeFeature id="Mapping"/>
● Data access
● Enterprise system integration
● Export support
● Other
ADO.NET ADO.NET
dBase dBase
HPNeoview HP Neoview
Informix Informix
MYSQL_DataAccess MySQL
NCRTeradata NCRTeradata
NETEZZA NETEZZA
Oracle Oracle
SIEBEL Siebel
Sybase Sybase
SymantecACT ACT!
SIEBEL Siebel
Export support
Feature ID Description
Related Information
Use the deployment unit IDs in the shortcut element to change the location and name of the program
shortcuts in the Windows Start menu.
Related Information
You can change the value of all strings in the installation program. You can replace a string for all languages or
for a specific language. Use the replaceString element, for example:
Related Information
The SAP BusinessObjects customization tool uses these language codes to represent supported languages:
Language Code
English EN
Czech CS
Danish DA
Dutch NL
Finnish FI
French FR
German DE
Hungarian HU
Italian IT
Japanese JA
Korean KO
Norwegian Bokmal NB
Polish PL
Portuguese PT
Romanian RO
Russian RU
Slovak SK
Spanish ES
Swedish SV
Thai TH
Turkish TR
Related Information
Use the installation screen IDs in the removeDialog element to remove screens from the installation program.
For example, use this element to remove the Select Features screen:
<removeDialog id="SelectFeatures.dialog"/>
Use the property IDs and the property values to prepopulate user input. For example, use this element to set
the default installation type to custom:
Screen IDs
Property IDs in installation
Title of installation screen Installation screen ID screen Property values
SAP Crystal Reports 2011 has ShowInstallComplete.dialo Not applicable Not applicable
been successfully installed g
SAP Crystal Reports 2011 has ShowInstallComplete_Patch Not applicable Not applicable
been successfully installed Update.dialog
SAP Crystal Reports 2011 has ShowUninstallComplete.dia Not applicable Not applicable
been successfully uninstalled log
6.1 Introduction
SAP Crystal Reports for Enterprise can be repackaged and sold by partners. You can customize the installed
product and the installation program in order to target a specific customer base, or to resell it as part of your
own product. The SAP BusinessObjects customization tool customizes SAP Crystal Reports for Enterprise and
its installation program with changes such as the following:
To make customizations, you write a configuration file to specify the customizations, then run the SAP
BusinessObjects customization tool to create a customized installation program. Customers can then use this
installation program to install a customized version of the product.
This section shows you how to run the customization tool to create a customized installation program for SAP
Crystal Reports for Enterprise. The customizations include changing the default installation type, removing one
of the installation screens, and renaming the product. When you finish this tutorial, you can run your
customized installation package and install a customized version of Crystal Reports for Enterprise.
This folder must be empty in order for the customization tool to run.
<oem name="CustomCompanyCrystalReports">
<cloneProduct sourceId="product.crystalreportsjava-4.0-core-32">
<!-- Remove the ProductKey dialog and set the default product key
-->
<removeDialog id="CREnterProductKey.dialog"/>
<replaceProperty id="ProductKey" defaultValue="PLEASE SET"/>
<!-- Specify the languages to keep in the OEM package. All other
language packs will be removed -->
<languageIncludeList value="en;fr;de"/>
<!-- Update the product name in each language. Rebrands the UI
dialog title. -->
<!-- The value for the lang attribute can be a single language
code, "all", or a CSV "en;fr;ja" -->
<replaceString id="product.crjava_name" value="Custom Company
Crystal Reports" lang="all"/>
</cloneProduct>
</oem>
cd C:\SAPCustomTool\packages\Collaterals\Tools\CustomizationTool
Note
The customization tool may take several minutes to complete. You can check its progress by viewing
the log file (C:\oemlog.log).
Verify that the customized installation package was created in the C:\SAPCustomTool\output folder.
Ensure that no errors were reported in the log file.
5. Use C:\SAPCustomTool\output\setup.exe to run the customized Crystal Reports for Enterprise
installation program.
After you run the installation program, Crystal Reports for Enterprise is installed with the customizations
described in the configuration file located at C:\SAPCustomTool\packages\Collaterals\Tools
\CustomizationTool\example_customization_win_cre.xml.
Note
The software may take a long time to download, and you may need to contact the system administrator
to ensure that your company's firewall will not terminate the download process.
You may want to validate the configuration file before running the tool. Use the validate command line
parameter.
Customers prefer a smaller installation program and a smaller installed product. To keep the product as small
as possible, do the following:
The product name and version number appear in several places in the installation program and in the installed
product. Ensure that you verify customizations in the following locations:
● Product name and product version in the installation program and the product.
● Windows Start menu entry.
● Windows Add Remove Program utility.
It is good practice to consider how the customized name appears in all supported languages.
The following section describes the customizations that you can make to the installation program by editing
the configuration file:
The SAP BusinessObjects customization tool uses the information in the configuration file to perform the
customizations. The configuration file is an XML document, and you use XML elements to describe your
customizations.
The configuration file for the full installation program can have any name. For example, it can be named
oem.xml.
Note
The configuration file must be written in correct XML syntax. Use an XML editor to create and edit the file,
and verify that the format is correct before running the tool.
● Change the product long name to Custom Company Crystal Reports for Enterprise for all languages.
● Change the publisher and product name for the Windows Add Remove Program entry.
● Remove the installation screen titled Choose Installation Type and set the installation type to Custom.
● Specify that the only language packs that are included in the installation package are English, French, and
German.
<oem name="CustomCompanyCrystalReportsforEnterprise">
<cloneProduct sourceId="product.crystalreportsjava-4.0-core-32">
<replaceString id="product.crjava_name" value="Custom Company Crystal
Reports for Enterprise" lang="all"/>
<arp duSourceId="product.crystalreportsjava.arp-4.0-core">
<arg id="publisher" value="Custom Company"/>
<arg id="display_name" value="Custom Company Crystal Reports for
Enterprise" lang="all"/>
</arp>
<replaceProperty id="InstallType" defaultValue="custom"/>
<removeDialog id="ChooseInstallType2.dialog"/>
<languageIncludeList value="en;fr;de"/>
</cloneProduct>
</oem>
You can customize the product name and version number. Use the replaceString element with the desired
string ID:
The full product name is composed of the product long name and the version number.
You can specify a different name and version number for each language. For a list of language codes, see
Language codes [page 133].
Example
● Change the product long name to “Custom Company Crystal Reports for Enterprise” for English.
● Change the product long name to “Custom Company Crystal Reports for Enterprise (French)” for French.
● Change the product version to 1.0 for both French and English.
The product name and version number in languages other than English and French will remain as the default
value.
When you run the installation program, you may see instances of “SP3” in the product name. To remove “SP3”,
modify the lines in the following files:
You must modify one file for every language that the installation program supports. For a list of language codes,
see Language codes [page 133]. When you run the customization tool and then run the installation program, all
instances of “SP3” will be removed.
Example
To remove “SP3” from the English installation program, modify the following files:
● product.lang_en.uitext.xml
● setup.ui.framework.lang_en.uitext
The Windows Start menu contains a shortcut for SAP Crystal Reports for Enterprise. The shortcut is located
under a Start menu entry with the name SAP Crystal Reports for Enterprise 4. For each language, you can
customize the name, location, and tooltip of the shortcut.
Use the shortcut element to customize the name, location, and tooltip of the shortcut:
Attribute Value
product.crystalreportsjava.shortcut-4.0
linkFullPath The full path to the shortcut link. Be sure to add .lnk to the shortcut link or the link will not be
created. You can put the link in the Start menu or you can put it on the desktop. The SAP Busi
nessObjects customization tool will create the link correctly.
You can specify one link for each language. For a list of language codes, see Language codes
[page 133].
description The tooltip string to display when the user hovers the mouse over the shortcut.
You can specify one tooltip for each language. For a list of language codes, see Language codes
[page 133].
● Change the name of the shortcut to “Custom CR for Enterprise” for English.
● Customize the “Custom CR for Enterprise” tooltip to display “Launch CR for Enterprise” for English.
● Place the “Custom CR for Enterprise” shortcut under the Start menu entry called “Custom Company”.
The shortcut name and tooltip will remain unchanged for all other languages.
<shortcut duSourceId="product.crystalreportsjava.shortcut-4.0-
core">
<arg id="linkFullPath" value="[programmenufolder]\Custom Company\Custom CR for
Enterprise.lnk" lang="en"/>
<arg id="description" value="Launch Custom CR for Enterprise" lang="en"/>
</shortcut>
You can customize the display name, the publisher, and the icon in the Windows Add or Remove Programs
(ARP) utility. Use the following element:
<arp duSourceId="product.crystalreportsjava.arp-4.0-core">
<arg id="publisher" value="<publisher name>"/>
<arg id="display_name" value="<product name>" lang="<language list>"/>
<arg id="display_icon" value="<full path to icon>"/>
</arp>
Note
The size of the icons displayed in the Windows ARP utility is 16 pixels by 16 pixels. Refer to Windows
documentation for complete information on creating the icon.
Example
This example makes the following customizations in the Windows ARP utility:
● Change the product name in the Windows ARP utility to “Custom Company Crystal Reports for
Enterprise”.
● Change the publisher to “Custom Company”.
● Replace the display icon with the icon located at C:\SAPCustomTool\CC_logo.ico
To use this example you must put an icon called CC_logo.ico in this location: C:\SAPCustomTool
<arp duSourceId="product.crystalreportsjava.arp-4.0-core">
<arg id="display_name" value="Custom Company Crystal Reports for Enterprise"
lang="all"/>
<arg id="publisher" value="Custom Company"/>
<arg id="display_icon" value="C:\SAPCustomTool\CC_logo.ico"/>
</arp>
The installation program collects user input using dialog boxes, radio buttons, and other user interface
elements. You can customize the default value of the user input. Use the replaceProperty element with the
property ID and the new default value:
For a list of property IDs, see Installation screen and property IDs [page 134].
Example
On the installation screen called Select Install Type, the default install type is Typical. This example changes the
default install type to Custom.
You can remove installation screens from the installation program. Use the removeDialog element with the
installation screen ID:
For a list of installation screen IDs, see Installation screen and property IDs [page 134].
<removeDialog id="SelectFeatures.dialog"/>
Prerequisites are conditions that must exist on the host machine in order for the installation program to
succeed. The installation program verifies the existence of these prerequisites before starting, and displays the
results in the Check Prerequisites screen. Removing the Check Prerequisites screen prevents prerequisite
checks from being performed. To remove the screen, use the removeDialog element with
id="CheckPreRequisites.dialog"
Note
It is recommended that you remove this installation screen only if you are performing the prerequisite
checks by some other means. If the prerequisites are not met, the installation program will fail.
Example
This example removes the Check Prerequisites screen and prevents prerequisite checks from being performed.
<removeDialog id="CheckPreRequisites.dialog"/>
The installation program allows the user to select which language packs to install. A language pack contains
translated versions of all the strings that are used by the installed product. By default, all possible language
packs are included in the installation program. You can specify which language packs to include. Use the
languageIncludeList element with a list of language codes:
Note
Language packs can be large. You can reduce the size of the installation program by including fewer
language packs.
This example includes the English, French, and German language packs in the installation program. The user
can select from this list during installation.
<languageIncludeList value="en;fr;de"/>
The installation program stores image and text files as resources in this folder:
dunit\product.crystalreportsjava-4.0-core-32\setup.ui.framework\resources
You can customize the resources in this folder. Resources that are commonly customized include:
Note
If you set cleanTarget="yes", the customization tool will delete the original resources folder and use
only those resources in the custom resources folder. This option is not recommended.
Related Information
You can customize the images in the installation program including the welcome screen, the top image for all
screens, and the billboard for the progress dialog box. Images are stored as files in the resources folder, which
is found in the following location:
dunit\product.crystalreportsjava-4.0-core-32\setup.ui.framework\resources
You change an image by creating a new image file, putting the file in the custom resources folder, and adding
the resources element to the configuration file.
Related Information
You can change the license agreement that is presented to the user in the installation program. License
agreements are stored as text files in the resources folder, in the following location:
dunit\product.crystalreportsjava-4.0-core-32\setup.ui.framework\resources\<language
code>
dunit\product.crystalreportsjava-4.0-core-32\setup.ui.framework\resources\en
\license_en.rft
dunit\product.crystalreportsjava-4.0-core-32\setup.ui.framework\resources\en
\license_en.rtf
Related Information
The SAP Crystal Reports for Enterprise installation program stores tools, samples, and documentation in the
Collaterals folder of the installation program. By default, a customized installation program that is delivered
to customers will also contain the Collaterals folder with the same contents. You can remove unwanted
items from the Collaterals folder in order to reduce the size of your customized installation program. Use
the collaterals element with cleanTarget="yes" and the full path to the custom Collaterals folder:
Note
You must set the cleanTarget attribute to yes so that the customization tool will replace the original
folder with the custom folder.
Collaterals > Docs Documentation in every language that Remove any languages that are not included in
Crystal Reports for Enterprise supports. the customized installation program. For a list
of language codes, see Language codes [page
133].
Collaterals > Tools The SAP BusinessObjects customization Remove this folder if the customers do not
> CustomizationTool tool. need to customize their own installation pro
grams.
You can customize the following parts of the Crystal Reports for Enterprise report designer:
● Splash screen.
● Start page.
● Menu, including the following parts:
○ Menu strings containing the product name “Crystal Reports for Enterprise”.
○ Register menu item.
○ Item links in the Help menu.
You can make these customizations after installing the program. You can also deploy your customizations to
your customized installation package, so that the customizations are applied when users install the program.
When Crystal Reports for Enterprise is run, a splash screen loads. You can replace this splash screen with your
own bitmap. Replacing the splash screen will also remove the default text (the version number and the
copyright statement) that appears with the default splash screen.
The following steps assume you already installed Crystal Reports for Enterprise. If you want to deploy the
splash screen into your customized installation program, rename the bitmap you want to use for the splash
screen to splash.bmp and follow the instructions in Deploying the OEM customization file [page 127].
When Crystal Reports for Enterprise is run, splash.bmp should load and the default text should not be
displayed. If your bitmap does not load, then the default splash screen loads instead and the default text is
displayed.
When you customize your splash screen, you can also remove the progress bar from the splash screen. You do
this by specifying the show_splash_progressbar attribute in a .properties file. The name of this file must
be cr_oem_config.properties, and it must be placed in the configuration folder.
Note
The following steps assume you already installed Crystal Reports for Enterprise. If you want to deploy this
customization into your customized installation program, specify show_splash_progressbar=no in a
file named cr_oem_config.properties and then follow the instructions in Deploying the OEM
customization file [page 127].
1. (Optional) If you do not already have the cr_oem_config.properties file, create it and save it in the
configuration folder.
Note
2. Open the cr_oem_config.properties file in a text editor and add the following attribute:
show_splash_progressbar=no
When Crystal Reports for Enterprise is run, the progress bar does not display on the splash screen.
You can choose to hide the top or bottom part of the start page, or both.
You make these customizations by specifying attributes in a .properties file. The name of this file must be
cr_oem_config.properties, and it must be placed in the configuration folder.
Note
To hide or display the file history that appears at the top of the start page, use the show_startpage_history
attribute:
show_startpage_history=<yes or no>
To hide or display the online feed that appears at the bottom of the start page, use the
show_startpage_onlinefeed attribute:
show_startpage_onlinefeed=<yes or no>
If you modify the content of the start page by using your own HTML file, then your HTML file replaces the online
feed even if you specify show_startpage_onlinefeed=yes in the .properties file. For more information
about this customization, see Customizing the start page [page 123].
Example
This example hides both the top and bottom parts of the start page.
If you have modified the content of the start page by using your own HTML file, then the contents of the HTML
file will appear at the top of the page; otherwise, the start page will be blank.
show_startpage_history=no
show_startpage_onlinefeed=no
If you want to deploy these customizations into your customized installation program, add the attributes to
a file named cr_oem_config.properties and then follow the instructions in Deploying the OEM
customization file [page 127].
Related Information
You can modify the content of the start page by using your own HTML file.
Note
The following steps assume you already installed Crystal Reports for Enterprise. If you want to deploy the
start page into your customized installation program, rename the HTML file you want to use for the start
page to startpage_<language code>.html, depending on the language you want the start page to
appear for, and then follow the instructions in Deploying the OEM customization file [page 127].
For example, the HTML file for the English start page would be startpage_en.html
Note
When Crystal Reports for Enterprise is run, the start page will display the customizations you made in
startpage_<language code>.html. This custom content replaces the online feed that appears at the
bottom of the start page by default.
If the top part of the start page is hidden, then the contents of startpage_<language code>.html will
appear at the top of the start page. For more information about this customization, see Hiding parts of the start
page [page 122].
You can modify the following strings in the program, which contain the product name “SAP Crystal Reports for
Enterprise” by default:
product_name The product name. Window title SAP Crystal Reports for Enterprise
help_help_menutitle The product help Help menu SAP Crystal Reports for Enterprise Help
menu item.
help_about_menutitle The About Help menu About SAP Crystal Reports for
<product name> Enterprise
menu item.
You customize these strings by specifying attributes in a languagespecific .properties file. The file must be
named cr_oem_config_<language code>.properties, and it must be placed in the configuration
folder.
Note
Example
● Change the product name in the window title to “Custom CR for Enterprise”.
● Change the text of the product help menu item to “Custom CR for Enterprise help”.
● Change the text of the About <product name> menu item to “About Custom CR for Enterprise”.
Note
If you want to deploy these customizations into your customized installation program, add the attributes to
a file named cr_oem_config.properties and then follow the instructions in Deploying the OEM
customization file [page 127].
Related Information
You can hide the Help Register menu item if you do not require your customers to register the product.
You make this customization by specifying the show_help_register_menu attribute in a .properties file:
show_help_register_menu=<yes or no>
The name of the .properties file must be cr_oem_config.properties, and it must be placed in the
configuration folder.
Note
Example
show_help_register_menu=no
Note
If you want to deploy this customization into your customized installation program, add the attribute to a
file named cr_oem_config.properties and then follow the instructions in Deploying the OEM
customization file [page 127].
By default, the Contact Us and Documentation items in the Help menu link to SAP content. You can redirect
these items so that they link to your content.
Both items can link to either a URL or a file path. There are no restrictions to the file type that you can use;
however, you cannot provide a relative file path.
You make these customizations by specifying attributes in a .properties file. The file must be named
cr_oem_config.properties, and it must be placed in the configuration folder.
Note
To redirect the link for the Contact Us menu item, use the help_contactus_location attribute:
To redirect the link for the Documentation menu item, use the help_documentation_location attribute:
Example
● Redirect the Contact Us menu item to link to the SAP home page.
● Redirect the Documentation menu item to link to C:\example.txt
To use this example, you must create a text file named example.txt and place it in the C:\ drive.
help_contactus_location=http://www.sap.com/index.html
help_documentation_location=C:\example.txt
If you want to deploy these customizations into your customized installation program, add the attributes to
a file named cr_oem_config.properties and then follow the instructions in Deploying the OEM
customization file [page 127].
Related Information
The About dialog box appears when you click Help About <product name> . It contains two SAP-
branded images: at the top is a banner with the words “SAP Crystal Reports for Enterprise” and at the bottom
is the SAP logo.
You can replace these two images with your own bitmaps.
Note
The following steps assume you already installed Crystal Reports for Enterprise. If you want to deploy the
banner and logo to your customized installation program, rename the bitmaps that you want to use to
about_banner.bmp and about_logo.bmp, and then follow the instructions in Deploying the OEM
customization file [page 127].
When you click Help About <product name> in Crystal Reports for Enterprise, the About dialog box
appears and your bitmaps should load. If they do not load, then the default banner and logo will load instead.
After you prepare your customized files (such as the splash image, start page, and .properties files), you
can deploy your customizations into the installation package.
Note
The folder structure in the .zip file must match the structure of the folder where you want to place the
files, relative to the installation folder. The files must be placed in a Crystal Reports for
Enterprise XI 4.0 folder inside template.zip.
For example, the following customized files must be placed in these locations in template.zip:
3. Copy the .zip file to the following location in your customized installation package:
dunit\product.crystalreportsjava.oemzips-4.0-core-nu\OEMZips
Note
You can use these attributes to make modifications such as hiding parts of the report designer. For example,
you can hide the file history that appears at the top of the start page with show_startpage_history=no and
hide the online feed at the bottom of the start page with show_startpage_onlinefeed=no.
Note
● There are no restrictions to the file
type that you can use.
● Relative file paths are not supported.
Note
● There are no restrictions to the file
type that you can use.
● Relative file paths are not supported.
You can use these attributes to modify strings in Crystal Reports for Enterprise. For example, you can modify
the product name that appears in the window title with product_name=Custom CR for Enterprise.
Attributes that require localized strings are specified in a languagespecific .properties file. The file must be
named cr_oem_config_<language code>.properties.
Note
Related Information
The SAP BusinessObjects customization tool (customizationtool.exe) is included with the SAP Crystal
Reports for Enterprise installation package in this location:
Collaterals\Tools\CustomizationTool
Example
This example runs the customization tool and creates a log file located in the C:\ drive. To use this example,
you must do the following:
cd C:\SAPCustomTool\packages\Collaterals\Tools\CustomizationTool
Note
The SAP BusinessObjects customization tool may take several minutes to complete. You can check its
progress by viewing the log file.
For more information on how to run the SAP BusinessObjects customization tool, see Quick start for Crystal
Reports for Enterprise [page 106].
This section explains the command line parameters that are used for the customization tool. Some parameters
are mandatory while others are optional.
Mandatory parameters
Parameter Description Example
packageDir Full path to the folder that contains the installation pro packageDir=C:\SAPCustomTool
gram you are modifying. \packages\DATA_UNITS
\BusinessObjectsServer_win
The installation program is downloaded from the SAP
Service Marketplace. It contains the folders
Collaterals, dunit, langs, and
setup.engine in addition to other binaries.
outputDir Full path to the folder where the customized installa outputDir=C:\SAPCustomTool
tion program will be created. \output
This folder must be empty before you can run the tool.
● error
● warn
● info
● debut
● trace
● generate
The tool performs the specified customiza
tions.
● validate
The tool validates the configuration file but
does not perform any customizations.
Related Information
The following section contains a list of all the IDs and codes you can use to customize the installation program,
including the following:
● String IDs
● Language codes
● Installation screen and property IDs
You can change the strings for the product name and version number in the installation program. You can
replace a string for all languages or for a specific language.
Related Information
The SAP BusinessObjects customization tool uses the following language codes to represent supported
languages.
Note
● If you include multiple languages in the same element, each language code must be separated by a
semicolon.
● If you want a customization to apply for every supported language, use all as the value instead of a
language code.
Language Code
English EN
Czech CS
Danish DA
Dutch NL
Finnish FI
French FR
German DE
Hungarian HU
Italian IT
Japanese JA
Korean KO
Norwegian Bokmal NB
Polish PL
Portuguese PT
Romanian RO
Russian RU
Slovak SK
Spanish ES
Swedish SV
Thai TH
Turkish TR
Related Information
The installation screen IDs are used in the removeDialog element. You use this element to remove screens
from the installation program. For example, use this element to remove the Select Features screen:
<removeDialog id="SelectFeatures.dialog"/>
The property IDs are used in the replaceProperty element. You use this element to change the default user
input for the fields and settings in the installation program. For example, use this element to set the default
installation type to Custom:
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such
links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.