SAP BusinessObjects Enterprise XI 4.0 Web Services Administrator's Guide

SAP BusinessObjects Enterprise Web Services Administrator's Guide

■ SAP BusinessObjects Enterprise XI 4.0

2010-11-05

Copyright

© 2010 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP
Business ByDesign, and other SAP products and services mentioned herein as well as their respective
logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business
Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web
Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well
as their respective logos are trademarks or registered trademarks of Business Objects S.A. in the
United States and in other countries. Business Objects is an SAP company.All other product and
service names mentioned are the trademarks of their respective companies. Data contained in this
document serves informational purposes only. National product specifications may vary.These materials
are subject to change without notice. These materials are provided by SAP AG and its affiliated
companies ("SAP Group") for informational purposes only, without representation or warranty of any
kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The
only warranties for SAP Group products and services are those that are set forth in the express
warranty statements accompanying such products and services, if any. Nothing herein should be
construed as constituting an additional warranty.

2010-11-05

Contents

Getting Started........................................................................................................................5Chapter 1

1.1

1.1.1

1.1.2

1.2

1.3

2.1

2.2

2.3

2.4

2.5

3.1

3.2

3.3

3.4

3.5

3.6

About this documentation........................................................................................................5

Who should use this documentation?.......................................................................................5

About SAP BusinessObjects Enterprise Web Services............................................................5

Migrating your Web Services...................................................................................................7

Support for legacy consumer applications................................................................................7

Configuring your deployment..................................................................................................9Chapter 2

Verifying your deployment........................................................................................................9

To configure which Web Services are active..........................................................................10

Configuring the dsws.properties file.......................................................................................10

Deploying the Web Services with clustering...........................................................................14

Deploying the Web Services using a DMZ.............................................................................16

Securing your deployment....................................................................................................17Chapter 3

Public-key encryption ............................................................................................................17

Client and server certification ................................................................................................18

To make a secure connection using SSL................................................................................19

Generating certificates and keystores using JDK ..................................................................20

To configure your Tomcat servlet container for SSL ..............................................................21

Consuming the Web Services over SSL................................................................................22

Scaling and performance .....................................................................................................25Chapter 4

More Information...................................................................................................................27Appendix A

Index 29

2010-11-053

Contents

2010-11-054

Getting Started

Getting Started

1.1 About this documentation

This documentation provides you with information and procedures for configuring and administrating
your SAP BusinessObjects Enterprise Web Services deployment. Procedures are provided for common
tasks. Conceptual information and technical details are provided for all advanced topics.

For information on how to deploy SAP BusinessObjects Enterprise web applications to a supported
Java web application server, including the Web Services dswsbobje.war file, see the

BusinessObjects Enterprise Web Application Deployment Guide

SAP

.

For information about installing SAP BusinessObjects Enterprise, see the

Enterprise Installation Guide

For information related to the administration of an SAP BusinessObjects Enterprise server, see the

SAP BusinessObjects Enterprise Administrator's Guide

.

1.1.1 Who should use this documentation?

This help covers configuration tasks. We recommend consulting this guide if you are:

• Configuring your first deployment.

• Making significant changes to the architecture of an existing deployment.

This documentation is intended for system administrators who are responsible for configuring, managing,
and maintaining SAP BusinessObjects Enterprise Web Services. Familiarity with your operating system
and your network environment is beneficial, as is a general understanding of web application server
management and scripting technologies. However, to assist all levels of administrative experience, this
documentation aims to provide sufficient background and conceptual information to clarify all
administrative tasks and features.

SAP BusinessObjects

.

1.1.2 About SAP BusinessObjects Enterprise Web Services

2010-11-055

Getting Started

SAP BusinessObjects Enterprise Web Services allow you remotely interact with objects in your SAP
BusinessObjects Enterprise deployment over HTTP. This makes the integration of your Enterprise
deployment with other web-based applications easier. The SAP BusinessObjects Enterprise Web
Services are deployed in two parts: the provider web application and a set of consumer APIs.

Provider application

The provider application (dswsbobje.war) is one of many deployed web applications within an SAP
BusinessObjects Enterprise system. The provider application makes the Web Services available to
other client applications to interact with. The Web Services provider application follows the
WS-Interoperability Basic Profile 1.0 and is implemented using Apache Axis2 1.3.

Note:

Since Apache Axis2 is used for the implementation of the Web Services, the resulting provider application
is a Java web application which must be deployed on a Java web application server.

This documentation contains information on how to configure a deployed provider application (dsws
bobje.war). To learn how to deploy the provider application, see the

Web Application Deployment Guide

.

SAP BusinessObjects Enterprise

Consumer APIs

Client applications that consume and use the web services exposed by providers are consumer
applications. SAP BusinessObjects Enterprise offers a set of Java and .NET consumer APIs that allow
developers to implement user authentication and security, document and report access, scheduling,
publications, and server management within your SAP BusinessObjects Enterprise deployment. The
Consumer APIs follow WS-Interoperability Basic Profile 1.0 and it is recommended that they be used
when developing consumer applications with the SAP BusinessObjects Enterprise Web Services.

To learn how to develop custom applications using the Consumer APIs, see the

Enterprise Web Services Consumer SDK Developer Guide

. To learn how to install SAP BusinessObjects

SAP BusinessObjects

2010-11-056

Getting Started

Enterprise, which includes the consumer SDKs, see the

Guide

.

1.2 Migrating your Web Services

This section contains information about changes to be aware of when you upgrade from an earlier
version of the SAP BusinessObjects Enterprise Web Services.

Obsolete services

The QueryService, SaveService, and ReportEngine services are now obsolete and no longer
supported. Use the BIPlatform service as a replacement.

Lower case service names are now deprecated

Lower case names to reference the Web Services, such as session, biplatform, liveoffice,
bicatalog, and publish, are now deprecated. Since service names are case-sensitive, use the

following supported services names within your application:

• Session

• BIPlatform

• LiveOffice

• BICatalog (deprecated in XI 3.0 - use the BIPlatform service as a replacement)

• Publish (deprecated in XI 3.0 - use the BIPlatform service as a replacement)

SAP BusinessObjects Enterprise Installation

For example: http://<servername>:<port>/dswsbobje/services/Session

1.3 Support for legacy consumer applications

SAP BusinessObjects Enterprise XI 4.0 providers are backwards-compatible with the SAP
BusinessObjects Enterprise XI 3.x version of consumer applications. XI 4.0 and XI 3.x providers are
built on the Apache Axis2 web service framework. The SAP BusinessObjects Enterprise XI Release 2
consumers were built on the Apache Axis 1.1 framework, and are not compatible with XI 4.0 or XI 3.x
consumers.

2010-11-057

Getting Started

2010-11-058

Configuring your deployment

Configuring your deployment

This section explains how you can verify and configure your SAP BusinessObjects Enterprise Web
Services deployment. Instructions are provided on how to validate an existing deployment of the Web
Services provider application, and what configuration properties are available to customize the
deployment to your needs.

2.1 Verifying your deployment

To verify that the provider application is deployed correctly, open the following URL in a web browser:

http://<servername>:<port>/dswsbobje

The "Axis2 - Home" page appears displaying a greeting and a link to the listServices page.

Note:

• Substitute <servername> and <port> with the machine name and port where the Web Services

are deployed.

• If the "Axis2 - Home" page fails to appear or displays an error message, the provider application

has failed to deploy. See the
to troubleshoot and redeploy.

WSDL and service verification

To consume the Web Services from a custom application, developers can use the Java or .NET consumer
APIs that are provided with an installation of SAP BusinessObjects Enterprise. Developers may however
opt to generate the API from the WSDLs that are exposed by the provider. The WSDLs follows the
WS-Interoperability Basic Profile 1.0.

Note:

Only the Java and .NET consumer APIs provided by SAP are supported. APIs generated from the
WSDLs are not officially supported. For more information on the WSDL and consumer APIs, see the

SAP BusinessObjects Enterprise Web Services Consumer SDK Developer Guide

To verify that the WSDLs are deployed correctly and can be accessed, open the following URL in a
web browser:

SAP BusinessObjects Enterprise Web Application Deployment Guide

.

http://<servername>:<port>/dswsbobje/services/listServices

A list of all active Web Services appears. From here you can verify a few things:

• Click on the hyperlink for each named Web Service to view the WSDL for that service.

2010-11-059