SAP Crystal Reports Server 2013, OEM edition Installation Guide for

Windows
■ SAP Crystal Reports Server 2013, OEM edition Support Package 1

2013-08-07
Copyright © 2013 SAP AG or an SAP affiliate company. All rights reserved. No part of this publication may be
reproduced or transmitted in any form or for any purpose without the express permission of SAP AG.
The information contained herein may be changed without prior notice. Some software products
marketed by SAP AG and its distributors contain proprietary software components of other software
vendors. National product specifications may vary. These materials are provided by SAP AG and its
affiliated companies ("SAP Group") for informational purposes only, without representation or warranty
of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials.
The only warranties for SAP Group products and services are those that are set forth in the express
warranty statements accompanying such products and services, if any. Nothing herein should be
construed as constituting an additional warranty. SAP and other SAP products and services mentioned
herein as well as their respective logos are trademarks or registered trademarks of SAP AG in
Germany and other countries. Please see
http://www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark
information and notices.

2013-08-07
Contents

Chapter 1 About this guide......................................................................................................................5

Chapter 2 Installing an Unmanaged Report Application Server...............................................................7

2.1 Installation overview.................................................................................................................7
2.2 Installing prerequisite software.................................................................................................7
2.3 Installing RAS components......................................................................................................8
2.3.1 Installing RAS on a single machine...........................................................................................8
2.3.2 Installing RAS and SDK components separately......................................................................8
2.4 Configuring RAS components..................................................................................................9
2.5 Creating virtual directories on the web server........................................................................10
2.6 Accessing the Java SDKs......................................................................................................10
2.7 Connecting the RAS SDK to RAS servers.............................................................................11
2.7.1 To configure the clientSDKOptions.xml file............................................................................11
2.8 Working with RAS servers.....................................................................................................12

Appendix A More Information...................................................................................................................13

Index 15

3 2013-08-07
 Contents

4 2013-08-07
About this guide

About this guide

This guide provides information about installing SAP Crystal Reports Server 2013, OEM edition, also
known as the unmanaged Report Application Server (RAS). It shows you how to install and configure
an unmanaged RAS on Windows, for use with Microsoft Internet Information Services (IIS) and supported
J2EE web application servers.

Note:
Crystal Reports Server 2013, OEM edition was previously known as Crystal Reports Server Embedded.

5 2013-08-07
About this guide

6 2013-08-07
Installing an Unmanaged Report Application Server

Installing an Unmanaged Report Application Server

2.1 Installation overview

The Report Application Server (RAS) provides web developers with a rich set of server-based reporting
services for flexible report processing, zero-client report viewing, and runtime report modification.
The unmanaged RAS is not connected to the SAP BusinessObjects Business Intelligence (BI) platform
framework or managed by the Central Management Server (CMS). RAS works in conjunction with
Microsoft IIS and/or supported J2EE web application servers to fulfill web users' reporting requests.
This flexibility allows web developers to build ASP, .NET Framework, and JSP web applications that
incorporate RAS reporting features.

The RAS and the RAS Software Development Kit (SDK) work together to deliver reporting services.

RAS
The RAS runs as a Windows service and responds to reporting requests from the RAS SDK. The RAS
opens, processes, and saves Crystal reports (.rpt files) using the Crystal Reports Print Engine. The
setup program includes the same database drivers, export drivers, and charting components as Crystal
Reports.

Install the RAS on your web server machine or on a separate machine.

RAS SDK
The RAS SDK includes Java and .NET client interfaces through which web applications interact with
the RAS and the report viewers.

Install the RAS SDK on the web server that runs your application code. If the RAS is installed on a
different machine, you must configure the RAS SDK so it can communicate effectively with the RAS.

Tip:
To access the RAS SDK documentation, which includes reference material, tutorials, and sample code,
visit the Developer SDK Library: https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary.

2.2 Installing prerequisite software

7 2013-08-07
Installing an Unmanaged Report Application Server

Before you install the RAS, ensure that your web environment is installed and configured correctly to
Microsoft IIS for ASP and .NET development, or a supported J2EE web application server for JSP
development.

Install any necessary database client software on each machine that you plan to install RAS components.
The setup program automatically detects supported database client software and installs additional
files as required.

Note:
These files are the native database drivers that allow the Crystal Reports Print Engine to communicate
with your database client software.
Consult the Product Availability Matrix (PAM) at https://service.sap.com/sap/support/pam for a detailed
list of tested environments. The PAM includes specific version and service pack requirements for
supported operating systems, reporting databases, web servers, J2EE web application servers, and
web browsers.

2.3 Installing RAS components

You can install RAS components on a single machine, as well as install the components separately.

2.3.1 Installing RAS on a single machine

You can install all RAS components on a single machine that is already running Microsoft IIS, or a
supported J2EE web application server, or both. Run the setup program and complete the installation
according to the on-screen instructions.

To configure Microsoft IIS for ASP and .NET development, make sure to select the SAP Crystal Reports
.Net SDK feature during installation.

To configure a J2EE web application server for JSP development, you must complete additional steps
after installation. For more information, see Configuring RAS components.

2.3.2 Installing RAS and SDK components separately

You can distribute your installation across multiple machines.

First, install the RAS on one or more machines, and then install the RAS SDK on your web server or
J2EE web application server machines.

8 2013-08-07
Installing an Unmanaged Report Application Server

When you install components separately, you must connect the RAS SDK to the RAS through a
configuration file or through your application code. After completing the steps in this section, see
Connecting the RAS SDK to RAS servers.

2.3.2.1 To install the RAS

1. Run the RAS setup program on the machine that you will install the RAS server on.
2. Proceed through the setup program and follow the on-screen instructions until you reach the "Select
Features" dialog box.
3. Select Report Application Server.
You can modify the RAS default set of sub-features for your reporting environment, or you can install
the entire feature.
4. Click Next and follow the on-screen instructions to complete the installation.

2.3.2.2 To install the RAS SDKs

1. Run the RAS setup program on a machine that is running Microsoft IIS or a supported J2EE web
application server.
The setup program installs the .NET interfaces only if the .NET framework is already installed on
the local machine.
2. Proceed through the setup program and follow the on-screen instructions until you reach the "Select
Features" dialog box.
3. Select the following features:
• Client Components
• Developer Components
4. Clear all remaining features.
5. Click Next and follow the on-screen instructions to complete the installation.
6. Configure the RAS SDK to communicate with your RAS server.
For more information, see Connecting the RAS SDK to RAS servers.

2.4 Configuring RAS components

9 2013-08-07
Installing an Unmanaged Report Application Server

After installing RAS components, you may need to complete additional configurations before you can
run the sample applications or begin development with the RAS SDK:
• For JSP development, set up virtual directories and JAR files on your J2EE web application server.
For more information, see Creating virtual directories on the web server and Accessing the Java
SDKs.
• If you install RAS components on separate machines, you must configure the RAS SDK to
communicate with your RAS server(s). For more information, see Connecting the RAS SDK to RAS
servers.

2.5 Creating virtual directories on the web server

When the RAS setup program detects Microsoft IIS, it automatically creates virtual directories under
the default website (accessible through the Internet Services Manager).

The RAS setup program makes no configuration changes to your J2EE web application server. After
completing the installation, you must create the virtual directories according to your J2EE web application
server's documentation.

RAS requires the following virtual directory: /crystalreportviewers

This virtual directory is required by the Viewers SDK. Based on the default installation, this directory
must be mapped to the following directory on your web server machine: \Program Files (x86)\SAP
BusinessObjects\Crystal Reports\crystalreportviewers

2.6 Accessing the Java SDKs

The setup program installs a set of Java Archive (JAR) files that make up the RAS and Viewers Java
SDKs. By default, the setup program installs the JAR files to the following directory: \Program Files
(x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java\lib

Before you run any RAS web applications, ensure that all files in this directory are accessible to your
J2EE web application server. You can do this in a number of ways, depending on your development
requirements:
• Copy the contents of this directory to a folder that is already included in your web application server's
CLASSPATH environment variable.
• Add this directory to your web application server's CLASSPATH environment variable.
• Package the JAR files into a Web Archive (WAR file), along with your application's source files,
when you are ready to deploy your application.
Note:
For complete instructions on how to configure your Java environment, consult the documentation
provided with your J2EE web application server.

10 2013-08-07
Installing an Unmanaged Report Application Server

2.7 Connecting the RAS SDK to RAS servers

The RAS is installed with a Java SDK and a .NET SDK. If you install components on separate machines,
you must configure the RAS SDK so it can communicate effectively with one or more RAS servers. To
locate a RAS, the RAS SDK relies on a configuration file named clientSDKOptions.xml.

By default, the clientSDKOptions.xml file relevant to ASP and .NET development is installed to
the following directory: \Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects
Enterprise XI 4.0\win32_x86

By default, the clientSDKOptions.xml file relevant to Java development is installed in the same
directory as the JAR files that make up the SDK: \Program Files (x86)\SAP
BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java\lib

As with the JAR files, the clientSDKOptions.xml file must be accessible to your J2EE web application
server.

Note:
Edit a copy of the XML file that is located in the same directory as the JAR files that your J2EE web
application server is using. For more information about this directory, see Accessing the Java SDKs.

2.7.1 To configure the clientSDKOptions.xml file

1. Open the appropriate clientSDKOptions.xml file in a text editor such as Notepad and locate
these lines:
<ServerInfo xsi:type="CrystalReports.ServerInfo" version="2" id="2">
<Server>SERVERNAME:PORT</Server>
<Adapter>TCPIP</Adapter>
</ServerInfo>

By default, the setup program replaces SERVERNAME with the name of the machine that you ran the
installation on.
2. Modify the file to meet your requirements:
• To connect the RAS SDK to a RAS running on a different machine, replace SEVERNAME with the
qualified domain name of the machine that is running your RAS.
• To balance the reporting load across multiple RAS machines, create additional <ServerInfo>
elements and increment the value of the id attribute, as shown in the following example:
<ServerInfo xsi:type="CrystalReports.ServerInfo" version="2" id="2">
<Server>SERVER01:PORT</Server>
<Adapter>TCPIP</Adapter>
</ServerInfo>
<ServerInfo xsi:type="CrystalReports.ServerInfo" version="2" id="3">
<Server>SERVER02:PORT</Server>
<Adapter>TCPIP</Adapter>
</ServerInfo>

11 2013-08-07
Installing an Unmanaged Report Application Server

Note:
You can override the server value in clientSDKOptions.xml dynamically at runtime, through the
RAS SDK. This option is useful if you want each application on a single web server to use its own RAS
for report processing. For more information about using this option, see the Setting up the development
environment section in the RAS SDK Developer Guides, which are available on the Developer SDK
Library: https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary.

2.8 Working with RAS servers

Once you install the RAS, you can use a number of tools in the SAP BusinessObjects Business
Intelligence (BI) platform program group on the Windows Start menu.

Central Configuration Manager (CCM)

The Central Configuration Manager (CCM) is a server management tool that allows you to configure
servers for your BI platform products in Windows. You can start and stop servers, and you can view
and configure advanced server settings.

The CCM is used with BI platform, RAS, and the BI platform repository. The appearance and functionality
of the CCM change depending on which BI platform product components you install.

The CCM includes online help that explains the functionality available with different products in the BI
platform system. The online help also describes how to perform common server configuration tasks.
To access the help, start the CCM and click Help.

Registration Wizard
Use this wizard to register your product with BI platform and access a range of additional services,
including samples, product updates, and newsletters.

12 2013-08-07
More Information

More Information

Information Resource Location

SAP product information http://www.sap.com

http://help.sap.com/analytics

Access the most up-to-date English documentation covering all SAP

Analytics products at the SAP Help Portal:
• http://help.sap.com/bobi (BusinessObjects Business Intelligence)
• http://help.sap.com/boepm (Enterprise Performance Management)
• http://help.sap.com/boeim (Enterprise Information Management)
SAP Help Portal
Certain guides linked to from the SAP Help Portal are stored on the SAP
Service Marketplace. Customers with a maintenance agreement have
an authorized user ID to access this site. To obtain an ID, contact your
customer support representative.

To find a comprehensive list of product documentation in all supported

languages, visit:http://help.sap.com/boall.

http://service.sap.com/bosap-support

The SAP Support Portal contains information about Customer Support

SAP Support Portal programs and services. It also has links to a wide range of technical in-
formation and downloads. Customers with a maintenance agreement
have an authorized user ID to access this site. To obtain an ID, contact
your customer support representative.

http://www.sdn.sap.com/irj/sdn/bi-sdk-dev
Developer resources https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary (BI SDK
Developer Library)

Articles and eLearning on the SAP http://scn.sap.com/docs/DOC-19311

Community Network These articles were formerly known as technical papers.

13 2013-08-07
More Information

Information Resource Location

https://service.sap.com/notes
Notes
These notes were formerly known as Knowledge Base articles.

Forums on the SAP Community

https://www.sdn.sap.com/irj/scn/forums
Network

http://www.sap.com/services/education

Training From traditional classroom learning to targeted e-learning seminars, we

can offer a training package to suit your learning needs and preferred
learning style.

http://www.sap.com/services/bysubject/businessobjectsconsulting

Consultants can accompany you from the initial analysis stage to the
Consulting delivery of your deployment project. Expertise is available in topics such
as relational and multidimensional databases, connectivity, database
design tools, and customized embedding technology.

14 2013-08-07
Index
A installing (continued) RAS SDKs
RAS components (continued) connecting to RAS 11
accessing Java SDKs 10 separately 8 installing 9
RAS SDKs 9 Registration Wizard 12
Report Application Server (RAS) 7, 12
C
J
Central Configuration Manager (CCM) S
12 Java SDKs, accessing 10
configuring RAS components 9 SDK documentation 12
virtual directories 10 SDKs (Java), accessing 10
connecting RAS components 11
R
creating virtual directories 10 RAS V
connecting to RAS SDKs 11
I installing 9 virtual directories, creating 10
working with 12
installation overview 7 RAS components 7
installing configuring 9
W
prerequisite software 7 connecting 11 working with RAS 12
RAS 9 installing 8
RAS components 8 installing on a single machine 8
on a single machine 8 installing separately 8

15 2013-08-07
Index

16 2013-08-07