Embed Size (px)
Citation preview
PUBLICCrystal Reports Server EmbeddedDocument Version: 2020 – 2020-06-12
SAP Crystal Reports Server 2020, OEM edition Installation Guide for Windows
© 2
020
SAP
SE o
r an
SAP affi
liate
com
pany
. All r
ight
s re
serv
ed.
THE BEST RUN
Content
1 About this guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
2 Installing an Unmanaged Report Application Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42.1 Installation overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42.2 Installing prerequisite software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.3 Installing RAS components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Installing RAS on a single machine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Installing RAS and SDK components separately. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.4 Configuring RAS components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.5 Creating virtual directories on the web server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72.6 Accessing the Java SDKs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72.7 Connecting the RAS SDK to RAS servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
To configure the clientSDKOptions.xml file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82.8 Working with RAS servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3 More Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2 P U B L I CSAP Crystal Reports Server 2020, OEM edition Installation Guide for Windows
Content
1 About this guide
This guide provides information about installing SAP Crystal Reports Server 2020, 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.
NoteCrystal Reports Server 2020, OEM edition is now 64bit. It requires 64bit middleware (e.g. ODBC drivers) and can only run on 64bit Windows.
Crystal Reports Server 2020, OEM edition was previously known as Crystal Reports Server Embedded.
SAP Crystal Reports Server 2020, OEM edition Installation Guide for WindowsAbout this guide P U B L I C 3
2 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.
TipTo 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 .
4 P U B L I CSAP Crystal Reports Server 2020, OEM edition Installation Guide for Windows
Installing an Unmanaged Report Application Server
2.2 Installing prerequisite software
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.
NoteThese 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 [page 6]
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.
SAP Crystal Reports Server 2020, OEM edition Installation Guide for WindowsInstalling an Unmanaged Report Application Server P U B L I C 5
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 [page 8].
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 [page 8].
2.4 Configuring RAS components
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 [page 7] and Accessing the Java SDKs [page 7].
6 P U B L I CSAP Crystal Reports Server 2020, OEM edition Installation Guide for Windows
Installing an Unmanaged Report Application Server
● 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 [page 8].
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.
NoteFor complete instructions on how to configure your Java environment, consult the documentation provided with your J2EE web application server.
SAP Crystal Reports Server 2020, OEM edition Installation Guide for WindowsInstalling an Unmanaged Report Application Server P U B L I C 7
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\win64_x64
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.
NoteEdit 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 [page 7].
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>
8 P U B L I CSAP Crystal Reports Server 2020, OEM edition Installation Guide for Windows
Installing an Unmanaged Report Application Server
NoteYou 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://archive.sap.com/documents/docs/DOC-27465 .
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.
SAP Crystal Reports Server 2020, OEM edition Installation Guide for WindowsInstalling an Unmanaged Report Application Server P U B L I C 9
3 More Information
Information Resource Location
SAP product information http://www.sap.com
SAP Help Portal http://help.sap.com/analytics
Access the most up-to-date English documentation covering all SAP Analytics products at the SAP Help Portal:
● BusinessObjects Business Intelligence● Enterprise Performance Management●
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: https://help.sap.com/viewer/product/SAP_ANALYTICS/latest/en-US
SAP Support Portal https://support.sap.com/en/index.html
The SAP Support Portal contains information about Customer Support 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.
Developer resources https://archive.sap.com/documents/docs/DOC-8777
(BI SDK Developer Library)
Articles and eLearning on the SAP Community Network These articles were formerly known as technical papers.
Notes https://support.sap.com/en/my-support/knowledge-base.html
These notes were formerly known as Knowledge Base articles.
Forums on the SAP Community https://community.sap.com/topics
10 P U B L I CSAP Crystal Reports Server 2020, OEM edition Installation Guide for Windows
More Information
Important Disclaimers and Legal Information
HyperlinksSome 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.
Beta and Other Experimental FeaturesExperimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the experimental features in a live operating environment or with data that has not been sufficiently backed up.The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.
Example CodeAny 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.
Gender-Related LanguageWe try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.
Videos Hosted on External PlatformsSome videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within the control or responsibility of SAP.
SAP Crystal Reports Server 2020, OEM edition Installation Guide for WindowsImportant Disclaimers and Legal Information P U B L I C 11
www.sap.com/contactsap
© 2020 SAP SE 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 SE or an SAP affiliate company. The information contained herein may be changed without prior notice.
Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company 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 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.
Please see https://www.sap.com/about/legal/trademark.html for additional trademark information and notices.
THE BEST RUN
